From 1d0ba25a660483da1272a31dd077ed94441e3d9f Mon Sep 17 00:00:00 2001 From: Tatsuya Kinoshita Date: Sat, 2 Jan 2021 09:20:37 +0900 Subject: New upstream version 0.5.3+git20210102 --- doc/FAQ.html | 1040 +++++++++++++----- doc/HISTORY | 12 +- doc/MANUAL.html | 2902 ++++++++++++++++++++++++++++++++++++++++++--------- doc/README | 11 +- doc/README.cookie | 18 +- doc/README.dict | 10 +- doc/README.func | 257 ++--- doc/README.img | 20 +- doc/README.m17n | 2 +- doc/README.pre_form | 24 +- doc/README.siteconf | 73 ++ doc/README.sixel | 27 + doc/README.tab | 2 +- doc/keymap.default | 1 + doc/keymap.lynx | 2 +- doc/menu.submenu | 2 +- doc/w3m.1 | 421 ++++---- 17 files changed, 3682 insertions(+), 1142 deletions(-) create mode 100644 doc/README.siteconf create mode 100644 doc/README.sixel (limited to 'doc') diff --git a/doc/FAQ.html b/doc/FAQ.html index ed2a704..ca82c67 100644 --- a/doc/FAQ.html +++ b/doc/FAQ.html @@ -1,291 +1,763 @@ - - -W3M FAQ - - -

Frequently Asked Questions and Answers about w3m

-Akinori Ito
-aito@fw.ipsj.or.jp
-Corrected by Tom Berger <tom.be@gmx.net> -

Index -

-
-

General Questions, How to Get It, Required Environment

How do I pronounce "w3m"?
-
Why is it called "w3m"?
-
On which platforms does w3m work?
-
Where can I get more information about w3m?
-
Is there a mailing list for w3m?
-
Are there any binary distributions?
-

Compile and Install
-
-
Options, Commands, Usage
-
- w3m quits if started without parameters. What's wrong?
  -
- w3m starts with black characters on a black screen. How do I change this?
  -
- Does w3m support colours?
  -
- Does w3m support monochrome display?
  -
- How do I shift the display?
  -
- How do I move from anchor to anchor?
  -
- Netscape displays a word red, but w3m doesn't. Why?
  -
- How do I change the colour of anchor-/image-/form links?
  -
- w3m doesn't seem to use the variable EDITOR. Why?
  -
- How do I quit a search or URL text input?
  -
-
-
Questions about WWW usage
-
- How do I fill in forms with w3m?
  -
- Seems like w3m is slower than Netscape or Lynx. Why?
  -
- Loading time doesn't decrease when loading a previously seen page
  -
- How do I download a linked file?
  -
- How do I specify a proxy server?
  -
- w3m freezes when I invoke an external browser.
  -
- How do I change the default image viewer?
  -
- How do I enter a URL?
  -
- w3m appends a URL to the former one despite of having cleared the line with Ctrl-u. What to do?
  -
-
-

Misc

What is w3m's configuration file?
-
What are these w3mxxxx files in my ~/.w3m directory for?
-

-
-
-

General Questions, How to Get It, Required Environment

-
-

How do I pronounce "w3m"? -

It's "W-three-M". It doesn't rhyme with "pteranodon". -

Why is it called "w3m"? -

It's an abbreviation of "WWW-wo-Miru", which is Japanese for -"See the WWW". So in English the name of this browser would be -something like "stw3". -

On which platforms does w3m work? -

It runs on various versions of Unix, since version 990226 on OS/2 and since -version 990303 also on MS-Windows with Cygwin32. -
-Current versions have been confirmed to run on: -

SunOS 4.1.x -
HP-UX 9.x, 10.x -
Solaris 2.5.x, 2.6, 8 -
Linux 2.0.30 -
FreeBSD 2.2.8, 3.1, 3.2, 4.6 -
NetBSD/macppc, m68k -
EWS4800 Rel.12.2 Rev.A -
Digital UNIX: v3.2D, v4.0D -
IRIX 5.3, IRIX 6.5 -
OS/2 with emx -
Windows 9x/NT with Cygwin32 b20.1 -
MS-DOS with DJGPP and WATT32 packet driver -
MacOS X Server -
MacOS X 10.1, 10.2 -

Where can I get more information about w3m? -

At the English w3m home page. -

Is there a mailing list for w3m? -

There is a mailing list for developpers (w3m-dev-en). Please see -w3m page -for details. You may also mail your comments to the author. -

Are there any binary distributions? -

So far there are only binaries for the win/cygnus32 version. You can get -them from here. -Contact the author if you want to contribute binaries for other platforms. -

-
-

-Up to index -

-
-

Compile and Install

-No problem :-) -

Options, Commands, Usage

-
-

w3m quits if started without parameters. What's wrong? -

w3m is a pager. Therefore it just quits when invoked without any -arguments. Possible arguments are: -

A filename or an URL -
Pipe from standard input -
The -B option (Show bookmark file) -
The -v option (visual startup) -
From a specified HTTP_HOME or WWW_HOME variable -

w3m starts with black characters on black background. How do I change -this? -

-When compiled with colour support, w3m assumes a white background and therefore -displays black characters. -
-You may either change the background colour of your terminal (e.g. with the -bg -option in a xterm) or take these steps: -

invoke w3m with 'w3m -M' (for monochrome), -
type 'o' for getting to the options screen -
Mark 'Display with colour' as ON and choose an arbitrary colour. -Click on [OK]. -

Does w3m support colours? -

Yes. When you run './configure', answer the question -

+ + + + + + W3M FAQ + + +

+ Frequently Asked Questions and Answers about w3m +

+ Akinori Ito <aito@fw.ipsj.or.jp>
+ Corrected by Tom Berger <tom.be@gmx.net> +

+ + Index + +

+ + + General Questions, How to Get It, Required Environment + + +

+ + How do I pronounce w3m? + +
+ + Why is it called w3m? + +
+ + On which platforms does w3m work? + +
+ + Where can I get more information about w3m? + +
+ + Is there a mailing list for w3m? + +
+ + Are there any binary distributions? + +

+ + + Compile and Install + + +
+ + + Options, Commands, Usage + + +

+ + w3m quits if started without parameters. What's wrong? + +
+ + w3m starts with black characters on a black background. How do + I change this? + +
+ + Does w3m support colors? + +
+ + Does w3m support monochrome displays? + +
+ + How do I shift the display? + +
+ + How do I move between hyperlinks? + +
+ + Graphical browsers display a word red, but w3m doesn't. Why? + +
+ + How do I change the colors for hyperlinks, images and form fields? + +
+ + w3m doesn't seem to use the variable EDITOR. Why? + +
+ + How do I quit a search or URL text input? + +

+ + + Questions about WWW usage + + +

+ + How do I fill in forms with w3m? + +
+ + Seems like w3m is slower than some other browsers. Why? + +
+ + Loading time doesn't decrease when loading a previously seen + page. + +
+ + How do I download a linked file? + +
+ + How do I specify a proxy server? + +
+ + How do I change the default image viewer? + +
+ + How do I enter a URL? + +
+ + w3m appends a URL to the former one even when I clear the line + with CTRL-u. What should I do? + +

+ + + Miscellaneous + + +

+ + What is w3m's configuration file? + +
+ + What are these w3mxxxx files in my ~/.w3m directory for? + +

+ + General Questions, How to Get It, Required Environment + +

+ + How do I pronounce w3m? + +

+ It's W-three-M. It doesn't rhyme with pteranodon. +

+ + Why is it called w3m? + +

+ It's an abbreviation of WWW-wo-Miru, which is Japanese + for See the WWW. So in English the name of this browser + would be something like stw3. +

+ + On which platforms does w3m work? + +

+ It runs on various versions of Unix, since version 990226 on OS/2 + and since version 990303 also on MS-Windows with Cygwin32. +

+ More recent versions have been confirmed to run on: +

+ SunOS 4.1.x +
+ HP-UX 9.x, 10.x +
+ Solaris 2.5.x, 2.6, 8 +
+ Linux 2.0.1 to 3.17 +
+ FreeBSD 2.2.8, 3.1, 3.2, 4.6 +
+ NetBSD/macppc, m68k +
+ EWS4800 Rel.12.2 Rev.A +
+ Digital UNIX: v3.2D, v4.0D +
+ IRIX 5.3, IRIX 6.5 +
+ OS/2 with emx +
+ Windows 9x/NT with Cygwin32 b20.1 +
+ MS-DOS with DJGPP and WATT32 packet driver +
+ MacOS X Server +
+ MacOS X 10.1, 10.2 +

+ + Where can I get more information about w3m? + +

+ At the + English w3m + home page. +

+ + Is there a mailing list for w3m? + +

+ There is a mailing list for developers (w3m-dev-en). Please see + the w3m home + page for details. You may also mail your comments to + the author. +

+ + Are there any binary distributions? + +

+ So far there are only binaries for the win/cygnus32 version. + + Contact the author if you + want to contribute binaries for other platforms. +

+ + Up to index + +

+ + Compile and Install + +

+ No problem :-) +

+ + Options, Commands, Usage + +

+ + w3m quits if started without parameters. What's wrong? + +

+ w3m is a pager. Therefore it just quits when invoked + without any arguments. It keeps running +

+ with a filename or URL as argument +
+ with data piped from standard input +
+ when invoked with option -B to show the bookmark file +
+ when invoked with option -v to welcome users with a built-in page +
+ with specified HTTP_HOME or WWW_HOME variable +

+ + w3m starts with black characters on a black background. How do I + change this? + +

+ When compiled with color support, w3m assumes a white background + and therefore displays black characters. +

+ You may either change the background color of your terminal + (e.g. with the -bg option in a xterm) or take these steps +

+ invoke monochrome mode of w3m with w3m -M +
+ type o to get to the options setting panel +
+ mark Display with color as YES and choose an + arbitrary color +
+ click on [OK]. +

+ + Does w3m support colors? + +

+ Yes. When you run ./configure, answer the question +

-Let's do some configurations. Choose config option among the list."
+  Let's do some configurations. Choose config option among the list.
 
-1 - Baby model    (no color, no menu, no mouse, no cookie, no SSL)
-2 - Little model  (color, menu, no mouse, no cookie, no SSL)
-3 - Mouse model   (color, menu, mouse, no cookie, no SSL)
-4 - Cookie model  (color, menu, mouse, cookie, no SSL)
-5 - Monster model (with everything; you need openSSL library)
-6 - Customize
-Which? 
+  1 - Baby model    (no color, no menu, no mouse, no cookie, no SSL)
+  2 - Little model  (color, menu, no mouse, no cookie, no SSL)
+  3 - Mouse model   (color, menu, mouse, no cookie, no SSL)
+  4 - Cookie model  (color, menu, mouse, cookie, no SSL)
+  5 - Monster model (with everything; you need openSSL library)
+  6 - Customize
+  Which?

-with 2,3,4 or 5. -

Does w3m support monochrome display? -

Yes. You may either -

Answer the above mentioned 'configure' question with 1, or -
Invoke w3m with the -M option, or -
Type 'o' within w3m to enter the options screen and turn off colour display -mode. -

How do I shift the display? -

You can shift the display by moving the cursor to the edge of the screen. You -may also use the ">"/"<" or "."/"," keys. -
-Another idea would be adjusting the xterm with the -geometry option (e.g. -something like 'xterm -geometry 110x45 -bg white -name w3m -e w3m -B'). -

How do I move from anchor to anchor? -

You can move to the next anchor using TAB. ESC TAB moves cursor to the previous anchor. -

Netscape displays a word red, but w3m doesn't. Why? -

w3m doesn't support <FONT COLOR=".."> tags. It won't be impossible to implement this, but I think it would make the document more difficult to read. -

How do I change the colour of anchor-/image-/form links? -

Type 'o' within w3m to get the 'options' screen. You can change these -settings there. -

-

w3m doesn't seem to use the variable EDITOR. Why? -

Go to the 'options' screen using the "o" key. Any entry in the 'Editor' field will override the environment variable. -
-If you want to use the editor specified by EDITOR blank the field and push [OK]. -

How do I quit a search or URL text input? -

Clear input text using Ctrl-u and hit RETURN. -

-
-

-Up to index -

-
-

Questions about WWW usage

-
-

How do I fill in forms with w3m? -

Form input fields are displayed in red (or reverse). Move the cursor to -them and hit RETURN. Then, -

if it is a text input field, put in your text on the bottom line, -
if it is a radiobutton or checkbox, that item is selected, -
if it is a textarea, an editor is spawned, -
if it is 'submit' or 'reset', well, just do it. -

Seems like w3m is slower than Netscape or Lynx. Why? -

w3m renders a HTML document in two passes. Therefore it displays the documentnot before having read the entire document. -
-Netscape or Lynx display the document before having read the whole page, -and therefore seem faster. -

Loading time doesn't decrease when loading a previously seen page -

w3m doesn't have its own cache. Therefore, it reads the document -from the server each time it accesses it. If possible, use a cache server. -

How do I download a linked file? -

Use 'a' (or 'd' with Lynx-like keybindings) or ESC RET. If you want to download an inline image, use ESC 'I'. -

How do I specify a proxy server? -

Set the environment variable HTTP_PROXY or use the option setting panel -("o" key). For example, if you want to use port 8000 of proxy.hogege.com, specify -

-    http://proxy.hogege.com:8000/
-

w3m freezes when I invoke an external browser. -

Enter w3m's option screen using the 'o' key and specify -

-    netscape %s &
-

-(if you are using netscape). -

How do I change the default image viewer? -

By default w3m uses xv to view images. If you want to change it into, let's say, 'display', add the following line to ~/.w3m/mailcap or /etc/mailcap. -

+ with 2, 3, 4, or 5. +

+ + Does w3m support monochrome displays? + +

+ Yes. You may either +

+ Answer the above-mentioned configure question with 1, + or +
+ Invoke w3m with the -M option, or +
+ Type o within w3m to enter the options setting panel and turn + off color display mode. +

+ + How do I shift the display? + +

+ You can shift the display by moving the cursor to the edge of + the screen. You may also use the following commands +

SHIFT_LEFT and SHIFT_RIGHT, bound to the keys > and <
SHIFT_LEFT1 and SHIFT_RIGHT1, bound to the keys . and ,

+ Another idea would be adjusting the xterm with the -geometry + option e.g. something like +

  xterm -geometry 110x45 -bg white -name w3m -e w3m -B

+ + How do I move between hyperlinks? + +

+ + You can move to the next hyperlink + using TAB. ESC + TAB moves the cursor to the previous hyperlink. (see + Section + Functions and Key bindings of w3m's manual) + +

+ + Graphical browsers display a word red, but w3m doesn't. Why? + +

+ w3m doesn't support the attribute COLOR="..." of HTML. It wouldn't + be impossible to implement this, but I think it would make + documents more difficult to read. +

+ + How do I change the colors for hyperlinks, images and form fields? + +

+ Type o within w3m to get the options panel. You + can change these settings there. +

+ + w3m doesn't seem to use the variable EDITOR. Why? + +

+ Go to the options setting panel using the o key. Any + entry in the Editor field overrides the environment + variable. +

+ If you want to use the editor specified by EDITOR, blank the + field and save the settings using the button [OK]. +

+ + How do I quit a search or URL text input? + +

+ Clear input text using CTRL-u and hit RETURN. +

+ + Up to index + +

+ + Questions about WWW usage + +

+ + How do I fill in forms with w3m? + +

+ Form input fields are displayed in red (or reverse). Move the + cursor to them. Then, if it is +

+ a text input field, hit RETURN + put in your text on the bottom line. Press + RETURN again +
+ a radiobutton or checkbox, pressing + RETURN changes or toggles the selection +
+ a textarea, pressing + RETURN spawns an editor +
+ a submit or reset field, + the respective action is performed. +

+ + Seems like w3m is slower than some other browsers. Why? + +

+ w3m renders a HTML document in two passes. Therefore it doesn't + start to display the document until it has finished reading it. +

+ Most other browsers display the document before having read the + whole page, and therefore seem faster. +

+ + Loading time doesn't decrease when loading a previously seen + page. + +

+ w3m doesn't have its own cache. Therefore, it reads the document + from the server each time it accesses it. If possible, use a + cache server. +

+ + How do I download a linked file? + +

+ Use a (or d with Lynx-like keybindings) or + ESC RET. + If you want to download an inline image, use + ESC I. (see + Section + Functions and Key bindings of w3m's manual) +

+ + How do I specify a proxy server? + +

+ Set the environment variables HTTP_PROXY, HTTPS_PROXY, GOPHER_PROXY + and FTP_PROXY, or use the options setting panel (o key). For + example, if you want to use port 8000 of proxy.example.org, specify +

  http://proxy.example.org:8000/

+ + How do I change the default image viewer? + +

+ By default w3m uses xv to view images. If you want to change it + into, let's say, display, add the following line to + ~/.w3m/mailcap or /etc/mailcap: +

-image/*; display %s
+  image/*; display %s

-You can specify external viewers of other file types as well: -

+ You can specify external viewers of other file types as well: +

-image/*;                     display %s
-application/postscript;      ghostview %s
-application/x-dvi;           xdvi %s
+  image/*;                     display %s
+  application/postscript;      ghostview %s
+  application/x-dvi;           xdvi %s

How do I enter a URL? -

Type SHIFT-U -

w3m appends a URL to the former one despite of having cleared the line -with Ctrl-u. What to do? -

Enter the complete adress, e.g. http://www.slashdot.org. -

-
-

-Up to index -

-
-

Miscellaneous

-
-

What is w3m's configuration file? -: It is ~/.w3m/config. -With this file, you can adjust w3m's behavior by changing values of options -that are described to be varied with the option setting panel. -Each line contains setting for one option, which is a pair of an option name -and its value with a space as a separator. -
-
What are these w3mxxxx files in my ~/.w3m directory for? -: These are temporary files used by w3m when reading documents from a -WWW server. They are not cache files and are usually deleted when w3m is -terminated. If there remain any temp files, please remove them by yourself. -
-

-
-

-Up to index -

-
- - +

+ + How do I enter a URL? + +

+ Type U +

+ + w3m appends a URL to the former one even when I clear the line + with CTRL-u. What should I do? + +

+ Enter the complete address, e.g. http://www.slashdot.org. +

+ + Up to index + +

+ + Miscellaneous + +

+ + What is w3m's configuration file? + +

+ It is ~/.w3m/config. +

+ +

+ With this file, each user can adjust w3m's behavior by changing + the values of options whose effects are described in the options + setting panel. Each line contains one option setting, consisting + of an option name and its value with a space as a separator. +

+ +

Without a user-specific configuration file, w3m honours + the system wide configuration file /etc/w3m/config. +

+ +

+ + What are these w3mxxxx files in my ~/.w3m directory for? + +

+ These are temporary files used by w3m when reading documents + from a WWW server. They are not cache files and are usually + deleted when w3m is terminated. If any temp files are left + behind, please remove them yourself. +

+ + Up to index + +

+ + diff --git a/doc/HISTORY b/doc/HISTORY index b8f5b94..7f7ae2b 100644 --- a/doc/HISTORY +++ b/doc/HISTORY @@ -588,7 +588,7 @@ From: Okabe Katsuya * space characters in a buffer are mapped into 0x80-0x9f. * unprintable characters (0x80-0xa0) are displayed as \xxx. -From: Tsutomu Okada ($B2,ED(B $BJY(B) +From: Tsutomu Okada Subject: [w3m-dev 01354] minimize when #undef USE_GOPHER or USE_NNTP 2000/11/16 @@ -1422,7 +1422,7 @@ HTML4.0 ID attribute support. From: Okabe Katsuya table get weird when it contains . -$B=$@5!%(B +Fixed. 2000.2.12 From: Rogue Metal - Jake Moorman @@ -1649,15 +1649,15 @@ From: patakuti If an tag has no `name' attribute, w3m adds it an inappropriate name attribute. -From: $B$d$^(B +From: Yama Now w3m can handle a frameset that has both ROWS and COLS. From: aito Now bookmarking is done by a separate command w3mbookmark. -C-s $B$G2hLLI=<($,;_$^$C$F$$$?%P%0$N=$@5!%(B +Bug fix that C-s hangs. -$BJ8;zF~NO;~$K(B C-g $B$GCf;_$G$-$k$h$&$K$7$?!%(B +Enable C-g to quit for keyboard input. From: hovav@cs.stanford.edu When downloading a file, an attempt to save it to a non-exist @@ -1699,7 +1699,7 @@ Menu behavior is changed. * Clicking outside the menu causes cancellation of sub-menu. * <, >, +, - abandoned -From: $B$*$+$@(B +From: Okada Now C-a/C-e are bound to 'jump to the first/last item in menu.' From: "OMAE, jun" diff --git a/doc/MANUAL.html b/doc/MANUAL.html index aff0189..91a3485 100644 --- a/doc/MANUAL.html +++ b/doc/MANUAL.html @@ -1,535 +1,2437 @@ - + -w3m manual - - -

w3m MANUAL

-Akinori Ito
-aito@fw.ipsj.or.jp -

Index

- -

Introduction -

Options -

Document color -

Key binding -

Lynx-like key binding -

Mouse operation -

Key customization -

Local CGI -

- -

Introduction

-w3m is a pager/text-based WWW browser. You can browse local documents and/or -documents on the WWW using a terminal emulator. - -

- -

Options

- -Command line usage is -

+ + w3m manual + + + + + + +

w3m MANUAL

+ Akinori Ito
+ aito@fw.ipsj.or.jp +

+ Introduction +

+ w3m is a pager/text-based WWW browser. You can browse local + documents and/or documents on the WWW using a terminal emulator. +

+ Options +

+ Command line usage is +

-    w3m [options] [file|URL]
+  w3m [option]... [file|URL]...

-If you specify filenames/URLs on command line, these documents are displayed. -If you specify nothing, w3m reads a document from standard input and display it. -If no filename and/or URLs are specified and standard input is tty, w3m terminates -without displaying anything. +

+ If you specify filenames/URLs on the command line, these documents + are displayed. If you specify nothing, w3m will read a document + from standard input and display it. If it doesn't find a document + there either then normally w3m will terminate. +

+ Options include: +

General options

+ -B +

+ + with no other target defined, use the bookmark page for startup +

+ -M +

+ + monochrome display +

+ -no-mouse +

+ deactivate mouse support. +

+ -num +

+ + display each line's number -

-Options are as follows: -

+<line number> -

Move to the specified line. -

-t width -

Specify tab width. Default is 8. -

-r -

When displaying text/plain document, prohibit emphasis using backspace. -If you don't specify this option, -``A^H_'' is interpreted as underlined character and ``A^HA'' as a bold character. -

-l number -

Specify line number preserved internally when reading text/plain document -fron standard input. Default is 10000. -

-s -

Display documents with Shift_JIS code. -

-e -

Display documents with EUC_JP code. -

-j -

Display documents with ISO-2022-JP code. -

-T type -

Specify document type. Without this option, document type -is determined from extension of a file. If the determination -fails, the document is regarded as text/plain. -

-Example:
-Read HTML document from standard input and display it +

+ -v +

+ + with no other target defined, welcome users with a built-in page +

+ -W +

+ + toggle wrapping mode in searches +

+ -X +

+ upon exit, do not reinitialize the terminal. +

+ +num +

+ go to line num; only effective for numbers larger + than the number of lines in the terminal +

Browser options

+ -cols num +

+ + with stdout as destination; HTML is rendered to lines of num + characters +

+ -cookie +

+ + use stored cookies and accept new ones +

+ -no-cookie +

+ + neither use stored cookies nor accept new ones + +

+ -F +

+ + render frames +

+ -no-graph +

+ + do not use graphic characters for drawing HTML table and frame + borders +

+ -header string +

+ + append string to the HTTP(S) request. Expected to match + the header syntax "Variable: Value" +

+ -m +

+ display document using Internet message mode. With this + option, w3m determines document type from header information. + This is useful when reading e-mail or Usenet news posts. + +

+ -no-proxy +

+ + do not use proxy +

+ -post file +

+ use POST method to upload data defined in file. The + syntax to be used is "var1=value1[&var2=value2]…" +

Text pager options

+ -l num +

+ + number of lines preserved internally when receiving plain text + from stdin (default 10,000) +

+ -r +

+ + use caret notation to display special escape characters (such as + ANSI escapes or nroff-style backspaces for bold and underlined + characters) instead of processing them +

+ -s +

+ + squeeze multiple blank lines into one +

+ -t num +

+ set tab width to num columns. No effect on stdout +

Data type/encoding options

+ -I charset +

+ + user defined character encoding of input data +

+ -O charset +

+ + user defined character encoding of output data +

+ -T type +

+ + explicit characterization of input data by MIME type. Without + this option, document type is determined from the extension of a + file. If the determination fails, the document is regarded as + text/plain. For example: +

+ Read HTML document from standard input and display it +

-   cat hoge.html | w3m -T text/html
+   cat example.html | w3m -T text/html

-Display HTML source +

+ Display HTML source +

-   w3m -T text/plain hoge.html
+   w3m -T text/plain example.html

-m -

Display document with Internet message mode. -With this option, w3m determines document type from header information. -It is useful when reading E-mail or NetNews messages. -

-v -

visual startup mode. -

-B -

Show the bookmark. -

-bookmark file -

Specify bookmark file. -

-M -

Monochrome display mode. -

-F -

Automatically render frame. -

-S -

Squeeze blank lines. -

-X -

Upon exit, do not display preserved screen. -

-W -

Toggle wrap search mode. -

-o option=value -

Specify option. The option names and values are -same as that appears in ~/.w3m/config. -

-cookie -

Process cookies. -

-no-cookie -

Don't process cookies. -

-num -

Show linenumber. -

-dump -

Read document specified by URL and dump formatted text into standard -output. The width of the document become 80. This width can be overridden -with -cols option. -

-cols width -

Specify document width. Used with -dump option. -

-ppc count -

Specify the number of pixels per character (default 8.0). Larger - values will make tables narrower. -

-dump_source -

Read document specified by URL and dump the source. -

-dump_head -

Read document specified by URL and dump headers. -

-dump_both -

Read document specified by URL and dump headers and the source. -

-dump_extra -

Read document specified by URL and dump extra informations, headers and the source. -

-post file -

use POST method with file content. -

-header string -

insert string as a header. -

-no-proxy -

Don't use proxy server. -

-no-graph -

Use ASCII character to draw frames. -

-no-mouse -

Don't activate mouse. -

-config file -

specify config file. -

- -

Document color

- -Links and images are displayed as follows. -

- - - - - -

	Color mode	Monochrome mode
links	blue	underline
inline images	green	reverse
form input	red	reverse

-These colors can be customized using option setting command "o". - -

- -

Key binding

- -After invocation, you can operate w3m by one-character commands from -the keyboard. -

-Here's the original key-binding table. If you are using Lynx-like key -bindings, see the Lynx-like key binding. - -

Page/Cursor motion

- -

SPC,C-v	Forward page -
b,ESC v	Backward page -
l,C-f	Cursor right -
h,C-b	Cursor left -
j,C-n	Cursor down -
k,C-p	Cursor up -
J	Roll up one line -
K	Roll down one line -
^,C-a	Go to the beginning of line -
$,C-e	Go to the end of line -
w	Go to next word -
W	Go to previous word -
>	Shift screen right -
<	Shift screen left -
.	Shift screen one column right -
,	Shift screen one column left -
g,M-<	Go to the first line -
G,M->	Go to the last line -
ESC g	Go to specified line -
Z	Move to the center line -
z	Move to the center column -
TAB	Move to next hyperlink -
C-u,ESC TAB	Move to previous hyperlink -
[	Move to the first hyperlink -
]	Move to the last hyperlink -

- -

Hyperlink operation

- -

RET	Follow hyperlink -
a, ESC RET	Save link to file -
u	Peek link URL -
i	Peek image URL -
I	View inline image -
ESC I	Save inline image to file -
:	Mark URL-like strings as anchors -
ESC :	Mark Message-ID-like strings as news anchors -
c	Peek current URL -
=	Display information about current document -
C-g	Show current line number -
C-h	View history of URL -
F	Render frame -
M	Browse current document using external browser -(use 2M and 3M to invoke second and third browser) -
ESC M	Browse link using external browser -(use 2ESC M and 3ESC M to invoke second and third browser) -

- -

File/Stream operation

- -

U	Open URL -
V	View new file -
@	Execute shell command and load -
#	Execute shell command and browse -

- -

Buffer operation

- -

B	Back to the previous buffer -
v	View HTML source -
s	Select buffer -
E	Edit buffer source -
C-l	Redraw screen -
R	Reload buffer -
S	Save buffer -
ESC s	Save source -
ESC e	Edit buffer image -

- -

Buffer selection mode

- -

k, C-p	Select previous buffer -
j, C-n	Select next buffer -
D	Delect current buffer -
RET	Go to the selected buffer -

- -

Bookmark operation

- -

ESC b	Load bookmark -
ESC a	Add current to bookmark -

- -

Search

- -

/,C-s	Search forward -
?,C-r	Search backward -
n	Search next -
N	Search previous -
C-w	Toggle wrap search mode -

- -

Mark operation

- -

C-SPC	Set/unset mark -
ESC p	Go to previous mark -
ESC n	Go to next mark -
"	Mark by regular expression -

- -

Miscellany

- -

!	Execute shell command -
H	Help (load this file) -
o	Set option -
C-k	Show cookie jar -
C-c	Stop -
C-z	Suspend -
q	Quit (with confirmation, if you like) -
Q	Quit without confirmation -

- -

Line-edit mode

- -

C-f	Move cursor forward -
C-b	Move cursor backward -
C-h	Delete previous character -
C-d	Delete current character -
C-k	Kill everything after cursor -
C-u	Kill everything before cursor -
C-a	Move to the top of line -
C-e	Move to the bottom of line -
C-p	Fetch the previous string from the history list -
C-n	Fetch the next string from the history list -
TAB,SPC	Complete filename -
RETURN	Accept -

- -

Lynx-like key binding

- -If you have chosen `Lynx-like key binding' at the compile time, -you can use the following key binding. - -

Page/Cursor motion

- -

SPC,C-v,+	Forward page -
b,ESC v,-	Previous page -
l	Cursor right -
h	Cursor left -
j	Cursor down -
k	Cursor up -
J	Roll up one line -
K	Roll down one line -
^	Go to the beginning of line -
$	Go to the end of line -
>	Shift screen right -
<	Shift screen left -
C-a	Go to the first line -
C-e	Go to the last line -
G	Go to the specified line -
Z	Move to the center line -
z	Move to the center column -
TAB,C-n,Down arrow	Move to next hyperlink -
ESC TAB,C-p,Up arrow	Move to previous link -
C-g	Show current page position -

- +

Options for data output, followed by immediate exit

+ -dump +

+ read document specified by URL and dump page rendered as text + into standard output. + + Is set implicitly when output is directed + to a file or pipe. A width of 80 columns is used unless option + -cols sets another value. +

+ -dump_source +

+ + dump the page's source code into stdout +

+ -dump_head +

+ + dump response of a HEAD request for a URL into stdout +

+ -dump_both +

+ + dump HEAD, and source code for a URL into stdout -

Hyperlink operation

- -

RET, C-f, Right arrow	Follow hyperlink -
d, ESC RET	Save link to file -
u	Peek link URL -
i	Peek image URL -
I	View inline image -
ESC I	Save inline image to file -
:	Mark URL-like strings as anchors -
ESC :	Mark Message-ID-like strings as news anchors -
c	Peek current URL -
=	Display information about current document -
C-h	View history of URL -
F	Render frame -
M	Browse current document using external browser -(use 2M and 3M to invoke second and third browser) -
ESC M	Browse link using external browser -(use 2ESC M and 3ESC M to invoke second and third browser) -

+ -dump_extra +

+ + dump HEAD, source code, and extra information for a URL into + stdout +

File/Stream operation

g,U	Open URL -
V	View new file -
@	Execute shell command and load -
#	Execute shell command and browse -

Options for overriding default settings and resources

+ -bookmark file +

+ + use file instead of the default bookmark.html file +

+ -config file +

+ + use file instead of the default configuration file +

+ -o option=value +

+ + modify one configuration item with an explicitly given value; without option=value, equivalent to -show-option +

+ Document Colors +

+ Hyperlinks and images are displayed as follows. +

+ + + + + + + + + + + + + + + + + + + + + +

+	+ Color mode +	+ Monochrome mode +
+ Hyperlinks +	+ blue +	+ underline +
+ Inline images +	+ green +	+ reverse +
+ Form input +	+ red +	+ reverse +

+ These colors can be customized using the options setting command + o. +

+ Functions and Key bindings +

+ +

+ After invocation, you can control w3m by typing in functions by name + or with keystroke combinations bound to a function. There are + default key bindings. + +

+ +

+ You can customize the key bindings (except those for menu + operations and line-editing) in a ~/.w3m/keymap file. For example, +

Buffer operation

- -

B, C-b, Left arrow	Back to the previous buffer -
\	View HTML source -
s, C-h	Select buffer -
E	Edit buffer source -
C-l, C-w	Redraw screen -
R, C-r	Reload buffer -
S, p	Save buffer -
ESC s	Save source -
ESC e	Edit buffer image -

- -

Buffer selection mode

- -

k, C-p	Select previous buffer -
j, C-n	Select next buffer -
D	Delect current buffer -
RET	Go to the selected buffer -

- -

Bookmark operation

- -

v, ESC b	Load bookmark -
a, ESC a	Add current to bookmark -

- -

Search

- -

/, C-s	Search forward -
n	Search next -
w	Toggle wrap search mode -

- -

Mark operation

- -

C-SPC	Set/unset mark -
P	Go to previous mark -
N	Go to next mark -
"	Mark by regular expression -

- -

Miscellany

- -

!	Execute shell command -
H, ?	Help (load this file) -
o	Set option -
C-k	Show cookie jar -
C-c	Stop -
C-z	Suspend -
q	Quit (with confirmation, if you like) -
Q	Quit without confirmation -

- -

Line-edit mode

- -

C-f	Move cursor forward -
C-b	Move cursor backward -
C-h	Delete previous character -
C-d	Delete current character -
C-k	Kill everything after cursor -
C-u	Kill everything before cursor -
C-a	Move to the top of line -
C-e	Move to the bottom of line -
C-p	Fetch the previous string from the history list -
C-n	Fetch the next string from the history list -
TAB,SPC	Complete filename -
RETURN	Accept -

- -

Mouse operation

-If w3m is compiled with mouse option and you are using -xterm/kterm/rxvt (in this case, you have to set the TERM -environment variable to `xterm' or `kterm'.) or GPM -environment, you can use mouse -for the navigation. -

- -
left click - Move the cursor to the place pointed by the mouse cursor. -If you click the cursor and it is on an anchor, follow the anchor. -
middle click - Back to the previous buffer. -
right click - Open pop-up menu. You can choose an item by clicking it. -
left drag - Scroll document. The default behavior is to grab the document -and drag it. You can reverse the behavior (grab the window and drag it) -with the option setting panel. -
-

+   keymap C-o NEXT_PAGE
+

+ binds the command NEXT_PAGE (normally bound to SPC and C-v) + to control-o. See README.func for a list + of available functions. Original and Lynx-like keymap definitions + are provided as examples: keymap.default + and keymap.lynx. +

- -

Key customization

-You can customize the key binding (except line-editing keymap) -by describing ~/.w3m/keymap. For example, -

+ Throughout, the C- and M- notations indicate the + modifiers control and meta. The ALT-key + replaces the latter whereas pressing the ESC-key toggles + between meta-modified and simple keystrokes. The minus + indicates pressing the keys simultaneously wheras a space + represents that one key is pressed after the other, i.e. 2 M + simply means 2 followed by M. +

- keymap C-o NEXT_PAGE -

-binds `NEXT_PAGE' function (normally bound to SPC and C-v) -to control-o. See README.func for -list of available functions. Original and Lynx-like keymap -definitions are provided (keymap.default -and keymap.lynx) as examples. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ Function +	Key binding +		+ Description +
+ Function +	+ Default +	+ Lynx-like +	+ Description +
+ In-page navigation +
+ NEXT_PAGE +	+ SPC, C-v, +, PGDN +	+ SPC, C-v, + +	+ Scroll one page downwards +
+ PREVIOUS_PAGE +	+ b, M-v, -, PGUP +	+ b, M-v, - +	+ Scroll one page upwards +
+ MOVE_RIGHT +	+ l, C-f, RIGHT +	+ l +	+ Move cursor right (with a half-screen shift at the screen edge) +
+ MOVE_LEFT +	+ h, C-b, LEFT +	+ h +	+ Move cursor left (with a half-screen shift at the screen edge) +
+ MOVE_DOWN +	+ j, C-n, DOWN +	+ j +	+ Move cursor down (with a one-line scroll at the screen edge) +
+ MOVE_UP +	+ k, C-p, UP +	+ k +	+ Move cursor up (with a one-line scroll at the screen edge) +
+ UP +	+ J +	+ J +	+ Scroll the screen up one line +
+ DOWN +	+ K +	+ K +	+ Scroll the screen down one line +
+ LINE_BEGIN +	+ ^, C-a +	+ ^ +	+ Go to the beginning of the line +
+ LINE_END +	+ $, C-e +	+ $ +	+ Go to the end of the line +
+ NEXT_WORD +	+ w +	+ w +	+ Move to the next word +
+ PREVIOUS_WORD +	+ W +	+ W +	+ Move to the previous word +
+ SHIFT_RIGHT +	+ > +	+ > +	+ Shift screen right +
+ SHIFT_LEFT +	+ < +	+ < +	+ Shift screen left +
+ RIGHT +	+ . +	+ . +	+ Shift screen one column right +
+ LEFT +	+ , +	+ , +	+ Shift screen one column left +
+ BEGIN +	+ g, M-<, HOME +	+ C-a, M-< +	+ Go to the first line +
+ END +	+ G, M->, END +	+ C-e, M-> +	+ Go to the last line +
+ GOTO_LINE +	+ M-g +	+ G +	+ Go to the specified line +
+ LINE_INFO +	+ C-g +	+ C-g +	+ Display current position in document +
+ CENTER_H +	+ Z +	+ Z +	+ Center screen right and left of the cursor column +
+ CENTER_V +	+ z +	+ z +	+ Center screen above and below the cursor line +
+ NEXT_LINK +	+ TAB +	+ TAB, C-n, DOWN +	+ Move to the next hyperlink +
+ PREVIOUS_LINK +	+ M-TAB, C-u +	+ M-TAB, C-u, C-p, UP +	+ Move to the previous hyperlink +
+ LINK_BEGIN +	+ [ +	+ [ +	+ Move to the first hyperlink +
+ LINK_END +	+ ] +	+ ] +	+ Move to the last hyperlink +
MOVE_LIST_MENU	M-m	M-m	Pop up menu to navigate between hyperlinks
+ Hyperlink Operations +
+ GOTO_LINK +	+ C-j, C-m, RET +	+ C-f, C-j, C-m, RET, RIGHT +	+ Follow current hyperlink in a new buffer +
LIST_MENU	M-l	M-l	Pop up hyperlink menu and select one to be followed
+ SAVE_LINK +	+ a, M-RET +	+ d, M-RET +	+ Save the hyperlink target +
+ PEEK_LINK +	+ u +	+ u +	+ Show target address +
+ PEEK_IMG +	+ i +	+ i +	+ Show image address +
+ VIEW_IMAGE +	+ I +	+ I +	+ Display image in viewer +
+ SAVE_IMAGE +	+ M-I +	+ M-I +	+ Save inline image +
MARK_WORD	;	;	Turn current word into hyperlink
+ MARK_URL +	+ : +	+ : +	+ Turn URL-like strings into hyperlinks +
+ MARK_MID +	+ M-: +	+ M-: +	+ + Turn Message-ID-like strings into hyperlinks +
+ PEEK +	+ c +	+ c +	+ Show current address +
+ INFO +	+ = +	+ = +	+ Display information about the current document +
+ HISTORY +	+ C-h +	+ C-h +	+ Show browsing history +
+ EXTERN +	+ M +	+ M +	+ Browse current document using external browser (prefix 2, 3, ..., + or 9 to invoke alternate configured browsers, e.g. 3 M) +
+ EXTERN_LINK +	+ M-M +	+ M-M +	+ Browse link using external browser (prefixed as above, e.g. + 3 M-M) +
+ Bookmark management +
+ BOOKMARK +	+ M-b +	+ v, M-b +	+ View bookmarks +
+ ADD_BOOKMARK +	+ M-a +	+ a, M-a +	+ Add current page to bookmarks +
+ File/Stream Operations +
+ GOTO +	+ U +	+ g, U +	+ Open specified document in a new buffer +
GOTO_RELATIVE	M-u	M-u	Open relative address in a new buffer
+ LOAD +	+ V +	+ V +	+ Open local file in a new buffer +
+ READ_SHELL +	+ @ +	+ @ +	+ + + Execute shell command and display output in a new buffer +
+ PIPE_SHELL +	+ # +	+ # +	+ + + Execute shell command and display output in a new buffer +
+ Content Operations +
+ VIEW +	+ v +	+ \ +	+ Toggle between source code and rendered view of the document +
LIST	L	L	List link elements, hyperlinks and images
+ FRAME +	+ F +	+ F +	+ Toggle rendering HTML frames +
+ REDRAW +	+ C-l +	+ C-l, C-w +	+ Draw the screen anew +
+ RELOAD +	+ R +	+ R, C-r +	+ Load current document anew +
+ EDIT +	+ E +	+ E +	+ Edit local source +
+ EDIT_SCREEN +	+ M-e +	+ M-e +	+ Edit rendered copy of document +
PIPE_BUF	\|	\|	Pipe current buffer through a shell command and display output
+ DOWNLOAD +	+ M-s +	+ M-s +	+ Save document source +
+ SAVE_SCREEN +	+ S +	+ S, p +	+ Save rendered document +
+ Buffer/Tab Navigation +
+ BACK +	+ B +	+ B, C-b, LEFT +	+ Close current buffer and return to the one below in stack +
+ GOTO_HOME +	+ C-_ +	+	+ Return to the homepage (specified HTTP_HOME or WWW_HOME variable) +
+ SELECT_MENU +	+ s +	+ s, C-h +	+ Pop up buffer-stack menu +
+ TAB_MENU +	+ M-t +	+ M-t +	+ Pop up tab selection menu +
+ NEW_TAB +	+ T +	+ T +	+ Open a new tab (with current document) +
+ TAB_LINK +	+ C-t +	+ C-t +	+ Follow current hyperlink in a new tab +
+ NEXT_TAB +	+ } +	+ } +	+ Switch to the next tab +
+ PREV_TAB +	+ { +	+ { +	+ Switch to the previous tab +
+ CLOSE_TAB +	+ C-q +	+ C-q +	+ Close the current tab +
+ Searches +
+ SEARCH +	+ / +	+ /, C-s +	+ Search forward +
+ SEARCH_BACK +	+ ? +	+	+ Search backward +
+ ISEARCH +	+ C-s +	+	+ Incremental search forward +
+ ISEARCH_BACK +	+ C-r +	+	+ Incremental search backward +
+ SEARCH_NEXT +	+ n +	+ n +	+ Continue search forward +
+ SEARCH_PREV +	+ N +	+	+ Continue search backward +
+ WRAP_TOGGLE +	+ C-w +	+ w +	+ Toggle wrapping mode in searches +
+ Mark Management +
+ MARK +	+ C-SPC +	+ C-SPC +	+ Set/unset mark +
+ PREV_MARK +	+ M-p +	+ P +	+ Go to the previous mark +
+ NEXT_MARK +	+ M-n +	+ N +	+ Go to the next mark +
+ REG_MARK +	+ " +	+ " +	+ Mark all occurrences of a pattern +
+ Miscellaneous +
+ COMMAND +	+ M-c +	+ M-c +	+ Invoke one or more semicolon-separated w3m functions +
+ HELP +	+ H +	+ H, ? +	+ Show help panel +
+ OPTIONS +	+ o +	+ o +	+ Display options setting panel +
SET_OPTION	M-o	M-o	Set option
DEFINE_KEY	M-k	M-k	Define a binding between a key stroke combination and a command
MOUSE_TOGGLE	m	m	Toggle mouse support
DOWNLOAD_LIST	D	D	Display downloads panel
+ COOKIE +	+ C-k +	+ C-k +	+ Show cookie jar +
UNDO	(	(	Cancel the last cursor movement
REDO	)	)	Cancel the last undo
+ EXEC_SHELL +	+ ! +	+ ! +	+ Execute shell command +
DICT_WORD	M-w	M-w	Execute dictionary command (see README.dict)
DICT_WORD_AT	M-W	M-W	Execute dictionary command for word at cursor
VERSION	r	r	Display the version of w3m
+ SUSPEND +	+ C-z +	+ C-z +	+ Suspend w3m to background. (To be withdrawn with shell + command fg.) +
+ QUIT +	+ q +	+ q +	+ Quit with confirmation request +
+ EXIT +	+ Q +	+ Q +	+ Quit at once +

- -

Local CGI

-You can run CGI scripts using w3m, without any HTTP server. -It means that w3m behaves like an HTTP server and activates CGI script, -then w3m reads the output of the script and display it. The -bookmark registration -and helper-app editor -are realized as local CGI scripts. -Using local CGI, w3m can be used as a general purpose form interface. -

-For security reason, CGI scripts invoked by w3m must be in one of -these directories. -

The directory where w3m-related files are stored -(typically /usr/local/lib/w3m). This directory can be referred -as $LIB. -

/cgi-bin/ directory. You can map /cgi-bin/ to any directory you like -with option setting panel (``Directory corresponds to /cgi-bin'' field). -You can specify multiple paths separated by `:', like -/usr/local/cgi-bin:/home/aito/cgi-bin. To use /cgi-bin/ directory, -you must use file:/cgi-bin URL as follows: +

+ There are the following operational modes with built-in key + bindings for relevant functions. These bindings are not subject to + the DEFINE_KEY function or entries in the file keymap. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ Function (internal name) +	Key binding +	+ Description +
+ Menu Selection Mode +
+ BUF:NEXT	+ j, C-n, DOWN +	+ Next item +
BUF:PREV +	+ k, C-p, UP +	+ Previous item +
+ BUF:DELETE	+ D +	+ Delete item +
+ BUF:GO +	+ SPC, RET, RIGHT +	+ Select item +
+ Popup Menu Mode +
+MENU:SELECT +	+ SPC, RET, RIGHT	+ Select +
+MENU:CLOSE +	C-c +	+ Close menu +
+MENU:CANCEL +	+ LEFT, BKSPC, C-h	+ One selection step backward +
+MENU:DOWN +	j, C-n, DOWN +	+ Move to the next item +
+MENU:UP +	+ k, C-p, UP	+ Move to the previous item +
+MENU:LINE_UP +	K +	+ Scroll up one item +
+MENU:LINE_DOWN +	J +	+ Scroll down one item +
+MENU:TOP +	C-a +	+ Move to the first item +
+MENU:LAST +	C-e +	+ Move to the final item +
+MENU:NEXT +	C-v, C-f +	Go to the next page +
+MENU:PREV +	ESC v, C-b +	+ Go to the previous page +
+MENU:SEARCH_FORE +	C-s, / +	+ Search forward +
+MENU:SEARCH_BACK +	+ C-r, ?	+ Search backward +
+MENU:SEARCH_NEXT +	+ n	+ Search for the next match
+MENU:SEARCH_PREV +	+ N	+ Search for the previous match
+ Line-editing Mode +
+ LINEEDIT:FORWARD +	+ C-f, RIGHT +	+ Move cursor forward +
+LINEEDIT:BACK +	+ C-b, LEFT +	+ Move cursor backward +
+LINEEDIT:BS +	+ C-h, BKSPC +	+ Delete previous character +
+LINEEDIT:DEL +	+ C-d +	+ Delete current character +
+LINEEDIT:KILL_AFTER +	+ C-k +	+ Delete everything after cursor +
+LINEEDIT:KILL_BEFORE +	+ C-u +	+ Delete everything before cursor +
+LINEEDIT:TOP +	+ C-a +	+ Move to the beginning of the line +
+LINEEDIT:BOTTOM +	+ C-e +	+ Move to the end of the line +
+LINEEDIT:PREV +	+ C-p, UP +	+ Fetch the previous string from the history list +
+LINEEDIT:NEXT +	+ C-n, DOWN +	+ Fetch the next string from the history list +
+LINEEDIT:COMPLETE +	+ TAB, SPC +	+ Try to complete filename +
+LINEEDIT:EDITOR +	+ C-o +	+ Edit with external editor +
+LINEEDIT:ACCEPT +	+ RET +	+ Accept input line +

+ + +

+ Mouse Operation +

+ If w3m is compiled with mouse support and you are invoking w3m + either from a console with GPM or from an X terminal emulator, you + can use the mouse for navigation (in the case of rxvt, you need to + set the TERM environment variable to xterm or kterm). +

An introduction to configure mouse actions is provided + with README.mouse. +

+ + + + + + + + + + + + + + + + + + + + + + + + + +

Operation +	Description +
+ left click +	+First: +Moves the cursor to the place indicated by the mouse pointer. +Then: +Follows a hyperlink the cursor is currently located and the mouse points to. +
+ middle click +	+ Back to the previous buffer. +
+ right click +	+ Open pop-up menu. You can choose an item by clicking it. +
+ left drag +	+ Scroll document. The default behavior is to grab the document + and drag it. You can reverse the behavior (grab the window and + drag it) with the options setting panel. +

+ Local CGI scripts +

+ You can run CGI scripts using w3m, without any HTTP server. + This means that w3m behaves like an HTTP server and runs the CGI + script, then reads the output of the script and displays it. For + example, the bookmark registration system and default directory + browser are realized as local CGI scripts. Moreover, such scripts + allow w3m to be used as a form interface to acquire all kinds of + data. +

+ For security reason, CGI scripts invoked by w3m must be in one of + the following directories: +

+ The directory where w3m-related files are stored (typically + /usr/local/lib/w3m). This directory can be referenced as $LIB. +
+ The /cgi-bin/ directory. You can map /cgi-bin/ to any directory you + like in the options setting panel (the Directory corresponds to + /cgi-bin field). You can specify multiple paths separated by + :, like /usr/local/cgi-bin:/home/aito/cgi-bin. It is not + recommended to include the current directory to this path. To use + a /cgi-bin/ directory, you must use a file:/cgi-bin URL as follows: +

  w3m -o cgi_bin=/path/to/cgi-bin file:/cgi-bin/script.cgi

-The CGI script can use special header `w3m-control:' to control w3m. -This field can take any function (see README.func), -and the specified function is invoked after the document is displayed. -For example, The CGI output +

+ The CGI script can use the special header + w3m-control: to + control w3m. This field can take any function (see + README.func), and the specified function + is invoked after the document is displayed. For example, the CGI + output +

-
 Content-Type: text/plain
 W3m-control: BACK
-

-will display blank page and delete that buffer immediately. -This is useful when you don't want to display any page after -the script is invoked. The next example +

+ will display a blank page and delete that buffer immediately. + This is useful when you don't want to display any page after + the script is invoked. The next example +

-
 Content-Type: text/plain
 W3m-control: DELETE_PREVBUF
-
 contents.....

-will override the current buffer. -

-One w3m-control: header have to contain only one function, but you can -include more than one w3m-control: lines in the HTTP header. -In addition, you can specify an argument to GOTO function: +

+ will override the current buffer. +

+ Each header w3m-control: can + contain only one function, but you can + include more than one w3m-control: + line in the HTTP header. + In addition, you can specify an argument to the GOTO function: +

-
 Content-Type: text/plain
-W3m-control: GOTO http://www.yahoo.com/
-
+W3m-control: GOTO http://www.example.org/

-This example works exactly the same way to the Location header: +

+ This example works exactly the same way as the Location header: +

-
 Content-Type: text/plain
-Location: http://www.yahoo.com/
-
+Location: http://www.example.org/

-Note that this header has no effect when the CGI script is invoked -through HTTP server. - - +

+ Note that this header has no effect when the CGI script is invoked + through an HTTP server. +

+ diff --git a/doc/README b/doc/README index 324ea3e..0dc1901 100644 --- a/doc/README +++ b/doc/README @@ -110,12 +110,5 @@ Initial author: Faculty of Engineering, Tohoku University aito@fw.ipsj.or.jp -Current Maintainer - Dai Sato - Tohoku University Hospital - satodai@w3m.jp - -Feel free to send your opinion to the w3m mailing-lists. - w3m-dev@sic.med.tohoku.ac.jp (Japanese) - w3m-dev-en@sic.med.tohoku.ac.jp (English) - http://w3m.sourceforge.net/ +This package is maintained for Debian , +forked from the original version . diff --git a/doc/README.cookie b/doc/README.cookie index 56cca50..71523e0 100644 --- a/doc/README.cookie +++ b/doc/README.cookie @@ -9,21 +9,21 @@ cookie support of w3m http://www.ics.uci.edu/pub/ietf/http/draft-ietf-http-state-man-mec-12.txt) cookie. - * If you wont to disable cookie support, run configure script with + * If you want to disable cookie support, run the configure script with --disable-cookie option. - * You can choose to use cookie or not on the Option Setting Panel or + * You can choose to use cookies or not on the Option Setting Panel or -cookie and -no-cookie option. - * You can disable cookie on the Option Setting Panel. In this case - all cookies are rejected, however, cookies which accepted before - disable cookie are used. + * You can disable cookies on the Option Setting Panel. In this case + all new cookies are rejected, however, cookies which were accepted before + cookies were disabled are used. - * You can see list of accepted cookies with C-k. In this panel, you + * You can see the list of accepted cookies with C-k. In this panel, you can choose to use each cookie or not. - * You can specify domains accept or not accept cookies on the Option - Setting Panel. Domains are specified with following format. + * You can specify domains from which to accept or not accept cookies + on the Option Setting Panel. Domains are specified in the following format: domain-list = domains | "" @@ -37,7 +37,7 @@ cookie support of w3m (HDN: host domain name) - �� If the number of "." in domain name is lesser than 2, it is + * If the number of "." in domain name is fewer than 2, it is assumed as invalid cookie (cf. RFC 2109 4.3.2), however, you can use cookie_avoid_wrong_number_of_dots to avoid this restriction. You can set this in "Domains to avoid [wrong number diff --git a/doc/README.dict b/doc/README.dict index bd82cdb..88f4b1a 100644 --- a/doc/README.dict +++ b/doc/README.dict @@ -2,14 +2,14 @@ Dictionary look-up hack for w3m 1. INTRODUCTION -If you have dictionary look-up command (like 'webster'), you can -look a word in a document using w3m. This dictionary-lookup code +If you have a dictionary look-up command (such as 'webster'), you can +look up words in a document using w3m. This dictionary-lookup code was contributed by `Rubikitch' (rubikitch@ruby-lang.org), and -further modifed by Tushar Samant (scribble at pobox.com). +further modified by Tushar Samant (scribble at pobox.com). 2. INSTALLATION -To make use of dictionary look-up, you currently must change a +To make use of the dictionary look-up, you currently must change a compile option by hand. After running configure, edit config.h and change @@ -19,7 +19,7 @@ to #define USE_DICT -and recompile w3me (i.e. type "make install"). +and recompile w3m (i.e. type "make install"). Note that w3m/0.3+cvs-1.373 or later, USE_DICT is defined by default. Then find or install a CGI program which takes a word as a query diff --git a/doc/README.func b/doc/README.func index 0b2c034..3bdec74 100644 --- a/doc/README.func +++ b/doc/README.func @@ -1,145 +1,150 @@ -ABORT Quit w3m without confirmation -ACCESSSKEY Popup acceskey menu -ADD_BOOKMARK Add current page to bookmark +ABORT Quit at once +ACCESSKEY Pop up accesskey menu +ADD_BOOKMARK Add current page to bookmarks ALARM Set alarm -BACK Back to previous buffer +BACK Close current buffer and return to the one below in stack BEGIN Go to the first line -BOOKMARK Read bookmark -CENTER_H Move to the center line -CENTER_V Move to the center column -CHARSET Change the current document charset -CLOSE_TAB Close current tab -CLOSE_TAB_MOUSE Close tab on mouse cursor (for mouse action) -COMMAND Execute w3m command(s) +BOOKMARK View bookmarks +CENTER_H Center on cursor column +CENTER_V Center on cursor line +CHARSET Change the character encoding for the current document +CLOSE_TAB Close tab +CLOSE_TAB_MOUSE Close tab at mouse pointer +COMMAND Invoke w3m function(s) COOKIE View cookie list -DEFAULT_CHARSET Change the default document charset -DEFINE_KEY Define a binding between a key stroke and a user command -DELETE_PREVBUF Delete previous buffer (mainly for local-CGI) +CURSOR_TOP Move cursor to the top line on the screen +CURSOR_MIDDLE Move cursor to the middle line on the screen +CURSOR_BOTTOM Move cursor to the bottom line on the screen +DEFAULT_CHARSET Change the default character encoding +DEFINE_KEY Define a binding between a key stroke combination and a command +DELETE_PREVBUF Delete previous buffer (mainly for local CGI-scripts) DICT_WORD Execute dictionary command (see README.dict) -DICT_WORD_AT Execute dictionary command for word at cursor +DICT_WORD_AT Execute dictionary command for word at cursor DISPLAY_IMAGE Restart loading and drawing of images -DOWN Scroll down one line -DOWNLOAD Save document source to file -DOWNLOAD_LIST Display download list panel -EDIT Edit current document -EDIT_SCREEN Edit currently rendered document +DOWN Scroll the screen down one line +DOWNLOAD Save document source +DOWNLOAD_LIST Display downloads panel +EDIT Edit local source +EDIT_SCREEN Edit rendered copy of document END Go to the last line -EXEC_SHELL Execute shell command -EXIT Quit w3m without confirmation -EXTERN Execute external browser -EXTERN_LINK View current link using external browser -FRAME Render frame -GOTO Go to URL -GOTO_LINE Go to specified line -GOTO_LINK Go to current link -GOTO_RELATIVE Go to relative URL -HELP View help -HISTORY View history of URL -INFO View info of current document -INTERRUPT Stop loading document -INIT_MAILCAP Reread mailcap (mainly for local-CGI) -ISEARCH Incremental search forward +EXEC_SHELL Execute shell command and display output +EXIT Quit at once +EXTERN Display using an external browser +EXTERN_LINK Display target using an external browser +FRAME Toggle rendering HTML frames +GOTO Open specified document in a new buffer +GOTO_HOME Return to the homepage (specified HTTP_HOME or WWW_HOME variable) +GOTO_LINE Go to the specified line +GOTO_LINK Follow current hyperlink in a new buffer +GOTO_RELATIVE Go to relative address +HELP Show help panel +HISTORY Show browsing history +INFO Display information about the current document +INTERRUPT Suspend w3m to background +ISEARCH Incremental search forward ISEARCH_BACK Incremental search backward -LEFT Shift screen one column -LINE_BEGIN Go to the beginning of line -LINE_END Go to the end of line -LINE_INFO Show current line number -LINK_BEGIN Go to the first link -LINK_END Go to the last link -LINK_MENU Popup link element menu -LIST Show all links and images -LIST_MENU Popup link list menu and go to selected link -LOAD Load local file -MAIN_MENU Popup menu +LEFT Shift screen one column left +LINE_BEGIN Go to the beginning of the line +LINE_END Go to the end of the line +LINE_INFO Display current position in document +LINK_BEGIN Move to the first hyperlink +LINK_END Move to the last hyperlink +LINK_MENU Pop up link element menu +LIST Show all URLs referenced +LIST_MENU Pop up menu for hyperlinks to browse to +LOAD Open local file in a new buffer +MAIN_MENU Pop up menu MARK Set/unset mark -MARK_MID Mark Message-ID-like strings as anchors -MARK_URL Mark URL-like strings as anchors -MARK_WORD Mark current word as anchor -MENU Popup menu -MENU_MOUSE Popup menu at mouse cursor (for mouse action) -MOUSE_TOGGLE Toggle activity of mouse -MOVE_DOWN Move cursor down (a half screen scroll at the end of screen) -MOVE_DOWN1 Move cursor down (1 line scroll at the end of screen) -MOVE_LEFT Move cursor left (a half screen shift at the left edge) -MOVE_LEFT1 Move cursor left (1 columns shift at the left edge) -MOVE_LIST_MENU Popup link list menu and move cursor to selected link -MOVE_MOUSE Move cursor to mouse cursor (for mouse action) -MOVE_RIGHT Move cursor right (a half screen shift at the right edge) -MOVE_RIGHT1 Move cursor right (1 columns shift at the right edge) -MOVE_UP Move cursor up (a half screen scroll at the top of screen) -MOVE_UP1 Move cursor up (1 line scrol at the top of screen) -MSGS Display error messages -NEW_TAB Open new tab -NEXT Move to next buffer -NEXT_DOWN Move to next downward link -NEXT_LEFT Move to next left link -NEXT_LEFT_UP Move to next left (or upward) link -NEXT_LINK Move to next link -NEXT_MARK Move to next word -NEXT_PAGE Move to next page -NEXT_RIGHT Move to next right link -NEXT_RIGHT_DOWN Move to next right (or downward) link -NEXT_TAB Move to next tab -NEXT_UP Move to next upward link -NEXT_VISITED Move to next visited link -NEXT_WORD Move to next word -NOTHING Do nothing +MARK_MID Turn Message-ID-like strings into hyperlinks +MARK_URL Turn URL-like strings into hyperlinks +MARK_WORD Turn current word into hyperlink +MENU Pop up menu +MENU_MOUSE Pop up menu at mouse pointer +MOUSE_TOGGLE Toggle mouse support +MOVE_DOWN Cursor down +MOVE_DOWN1 Cursor down. With edge touched, slide +MOVE_LEFT Cursor left +MOVE_LEFT1 Cursor left. With edge touched, slide +MOVE_LIST_MENU Pop up menu to navigate between hyperlinks +MOVE_MOUSE Move cursor to mouse pointer +MOVE_RIGHT Cursor right +MOVE_RIGHT1 Cursor right. With edge touched, slide +MOVE_UP Cursor up +MOVE_UP1 Cursor up. With edge touched, slide +MSGS Display error messages +NEW_TAB Open a new tab (with current document) +NEXT Switch to the next buffer +NEXT_DOWN Move downward to the next hyperlink +NEXT_HALF_PAGE Scroll down half a page +NEXT_LEFT Move left to the next hyperlink +NEXT_LEFT_UP Move left or upward to the next hyperlink +NEXT_LINK Move to the next hyperlink +NEXT_MARK Go to the next mark +NEXT_PAGE Scroll down one page +NEXT_RIGHT Move right to the next hyperlink +NEXT_RIGHT_DOWN Move right or downward to the next hyperlink +NEXT_TAB Switch to the next tab +NEXT_UP Move upward to the next hyperlink +NEXT_VISITED Move to the next visited hyperlink +NEXT_WORD Move to the next word +NOTHING Do nothing NULL Do nothing -OPTIONS Option setting panel -PEEK Peek current URL -PEEK_IMG Peek image URL -PEEK_LINK Peek link URL -PIPE_BUF Send rendered document to pipe -PIPE_SHELL Execute shell command and browse -PREV Move to previous buffer -PREV_LINK Move to previous link -PREV_MARK Move to previous mark -PREV_PAGE Move to previous page -PREV_TAB Move to previous tab -PREV_VISITED Move to previous visited link -PREV_WORD Move to previous word -PRINT Save buffer to file -QUIT Quit w3m -READ_SHELL Execute shell command and load +OPTIONS Display options setting panel +PEEK Show current address +PEEK_IMG Show image address +PEEK_LINK Show target address +PIPE_BUF Pipe current buffer through a shell command and display output +PIPE_SHELL Execute shell command and display output +PREV Switch to the previous buffer +PREV_HALF_PAGE Scroll up half a page +PREV_LINK Move to the previous hyperlink +PREV_MARK Go to the previous mark +PREV_PAGE Scroll up one page +PREV_TAB Switch to the previous tab +PREV_VISITED Move to the previous visited hyperlink +PREV_WORD Move to the previous word +PRINT Save rendered document +QUIT Quit with confirmation request +READ_SHELL Execute shell command and display output REDO Cancel the last undo -REDRAW Redraw screen -REG_MARK Set mark using regexp -REINIT Reload configuration files -RELOAD Reload buffer -RESHAPE Re-render buffer +REDRAW Draw the screen anew +REG_MARK Mark all occurences of a pattern +REINIT Reload configuration file +RELOAD Load current document anew +RESHAPE Re-render document RIGHT Shift screen one column right -SAVE Save document source to file -SAVE_IMAGE Save image to file -SAVE_LINK Save link to file -SAVE_SCREEN Save rendered document to file +SAVE Save document source +SAVE_IMAGE Save inline image +SAVE_LINK Save hyperlink target +SAVE_SCREEN Save rendered document SEARCH Search forward SEARCH_BACK Search backward SEARCH_FORE Search forward -SEARCH_NEXT Search next regexp -SEARCH_PREV Search previous regexp -SELECT Go to buffer selection panel -SELECT_MENU Popup buffer selection menu -SETENV Set environment variable -SET_OPTION Set option -SHELL Execute shell command +SEARCH_NEXT Continue search forward +SEARCH_PREV Continue search backward +SELECT Display buffer-stack panel +SELECT_MENU Pop up buffer-stack menu +SETENV Set environment variable +SET_OPTION Set option +SHELL Execute shell command and display output SHIFT_LEFT Shift screen left SHIFT_RIGHT Shift screen right -SOURCE View HTML source +SOURCE Toggle between HTML shown or processed STOP_IMAGE Stop loading and drawing of images SUBMIT Submit form -SUSPEND Stop loading document -TAB_GOTO Open URL on new tab -TAB_GOTO_RELATIVE Open relative URL on new tab -TAB_LEFT Move current tab left -TAB_LINK Open current link on new tab -TAB_MENU Popup tab selection menu -TAB_MOUSE Move to tab on mouse cursor (for mouse action) -TAB_RIGHT Move current tab right +SUSPEND Suspend w3m to background +TAB_GOTO Open specified document in a new tab +TAB_GOTO_RELATIVE Open relative address in a new tab +TAB_LEFT Move left along the tab bar +TAB_LINK Follow current hyperlink in a new tab +TAB_MENU Pop up tab selection menu +TAB_MOUSE Select tab by mouse action +TAB_RIGHT Move right along the tab bar UNDO Cancel the last cursor movement -UP Scroll up one line -VERSION Display version of w3m -VIEW View HTML source -VIEW_BOOKMARK View bookmark -VIEW_IMAGE View image -WHEREIS Search forward -WRAP_TOGGLE Toggle wrap search mode +UP Scroll the screen up one line +VERSION Display the version of w3m +VIEW Toggle between HTML shown or processed +VIEW_BOOKMARK View bookmarks +VIEW_IMAGE Display image in viewer +WHEREIS Search forward +WRAP_TOGGLE Toggle wrapping mode in searches diff --git a/doc/README.img b/doc/README.img index 0c10114..af6d9db 100644 --- a/doc/README.img +++ b/doc/README.img @@ -11,8 +11,8 @@ Introduction Support - * Display inline image (GIF,PNG,JPEG, etc.) on terminals - (xterm,rxvt, etc.) of X11, Linux framebuffer device or + * Display inline images (GIF, PNG, JPEG, etc.) on terminals + (xterm, rxvt, etc.) of X11, Linux framebuffer device or terminals of Windows. * Support inline image of tag. Support of attributes "width", "height", and "align". @@ -41,7 +41,7 @@ Key functions Specify the following keymaps in ~/.w3m/keymap. keymap X DISPLAY_IMAGE keymap C-c STOP_IMAGE - keyamp t SET_OPTION display_image=toggle + keymap t SET_OPTION display_image=toggle Commandline options @@ -66,7 +66,7 @@ Option panel Automatic loading of inline image. The default is ON. If it is OFF, loading starts with a command DISPLAY_IMAGE. max_load_image - Maximum process for downloading of inline image. The default is 4. + Maximum # of processes for downloading inline images. The default is 4. 1 to 8 can be set. ext_image_viewer Use external image viewer, when a command VIEW_IMAGE or @@ -75,8 +75,8 @@ Option panel image_scale Scale of image (%). The default value is 100(%). imgdisplay - External command to display image". The default value is "w3mimgdisplay". - See "Setting w3mimgdisplay". + External command to display image. The default value is "w3mimgdisplay". + See "Setting w3mimgdisplay." Required programs @@ -124,8 +124,8 @@ Setting w3mimgdisplay The default value for Linux framebuffer device is #000000 (black). When the color is specified as #RRGGBB, escape '#'. -anim - Maximum number of frames for animation. It means without limit - if the number is 0. Negative value count backward from the end + Maximum number of frames for animation. It will run everything + if the number is 0. Negative values count backward from the end of the frames. The default value is 100. -margin Margin of an area to clear an image. The default value is 0. @@ -135,13 +135,13 @@ Setting w3mimgdisplay Notice If you want to see GIF animation, please hit a suitable key, such - as 'h', 'l', etc., repeatedly, because a frame is rewritten + as 'h', 'l', etc., repeatedly, because a new frame is only requested according to the re-drawing demand from w3m. Some code in w3mimg/fb/fb.c was originally written by Mr. Yamasaki. http://www.sainet.or.jp/~yamasaki/download/fb-sample.tar.gz - On Windows, we check the behaver on standard console, Cygwin rxvt + On Windows, we check the behavior on standard console, Cygwin rxvt and PuTTY. diff --git a/doc/README.m17n b/doc/README.m17n index c064d76..da5408b 100644 --- a/doc/README.m17n +++ b/doc/README.m17n @@ -49,7 +49,7 @@ Supported encoding schemes (character set) * Thai TIS-620 (ISO-8859-11), CP874 * Other - US_ASCII, ISO-8859-1 �� 10, 13 �� 15, + US_ASCII, ISO-8859-1 - 10, 13 - 15, KOI8-R, KOI8-U, NeXT, CP437, CP737, CP775, CP850, CP852, CP855, CP856, CP857, CP860, CP861, CP862, CP863, CP864, CP865, CP866, CP869, CP1006, CP1250, CP1251, CP1252, CP1253, CP1254, CP1255, CP1256, CP1257 diff --git a/doc/README.pre_form b/doc/README.pre_form index 972ef90..dad62f8 100644 --- a/doc/README.pre_form +++ b/doc/README.pre_form @@ -1,12 +1,12 @@ -pre_form: Feature to configure form parameters when opening specific site. +pre_form: Feature to pre-fill form parameters when opening a specific site. -It would be convinient for sites where you often visit, but it may introduce -some security issues. Be careful to use this feature, especially `submit' +It is convenient for sites that you visit often, but it may introduce +some security issues. Be careful when using this feature, especially `submit' params described below. Default configuration file for pre_form is ~/.w3m/pre_form. -Syntax as follows: +The syntax of entries in the configuration file is as follows: url |// form [] @@ -23,21 +23,21 @@ textarea : /textarea -If is set, form which has matched attributes +If is set, a form which has matched attributes will be configured by this pre_form. -The line begining with text, file, passwd, select, textarea means that +A line beginning with text, file, passwd, select, textarea means that it will set value to in input, select or textarea element which name attribute matches with . -The line beginning with checkbox, radio means that it will check +A line beginning with checkbox, radio means that it will check input element which name and value attribute matches with and -respectively. If is 0, no, or off, disable check of the checkbox. +respectively. If is 0, no, or off, the checkbox will be unchecked. -The line beginning with submit or image means that it will submit input -element which name attribute matches with (and value attribute -matches with ), or submit last element if no - specified. +A line beginning with submit or image means that it will submit input +element whose name attribute matches with (and value attribute +matches with ), or submit on the last element if no + was specified. You quote \, ' (single-quote) or " (double quote) as you do in shell. diff --git a/doc/README.siteconf b/doc/README.siteconf new file mode 100644 index 0000000..8514edf --- /dev/null +++ b/doc/README.siteconf @@ -0,0 +1,73 @@ +The siteconf: Site-specific preferences + +The siteconf consists of URL patterns and preferences associated to them. +You can improve "decode_url" feature by giving charsets of URLs site by site, +or bypass Google's redirector for performance and your privacy. + +The siteconf is read from ~/.w3m/siteconf by default. + +===== The syntax ===== + +url |//|m@@i [exact] +substitute_url "" +url_charset +no_referer_from on|off +no_referer_to on|off +user_agent "string" + +The last match wins. + +===== Examples ===== + +url m!^https?://([a-z]+\.)?twitter\.com/! +substitute_url "https://nitter.net/" + +This forwards twitter.com to the alternative site. + +url "http://your.bookmark.net/" +no_referer_from on + +This prevents HTTP referers from being sent when you follow links +at the your.bookmark.net. + +url "http://www.google.com/url?" exact +substitute_url "file:///cgi-bin/your-redirector.cgi?" + +This forwards the Google's redirector to your local CGI. + +url /^http:\/\/[a-z]*\.wikipedia\.org\// +url_charset utf-8 + +When combinated with "decode_url" option turned on, links to +Wikipedia will be human-readable. + +url m@^https?://(.*\.)google\.com/@ +user_agent "Lynx/2.8.8dev.3 libwww-FM/2.14 SSL-MM/1.4.1" + +Tell Google we're actually Lynx. (So they send us a text-browser friendly +results page.) + +url m!^https?://([a-z]+\.)?twitter\.com/! +user_agent "Googlebot/2.1" + +Tell Twitter we're actually Googlebot. (So they send us a page without +rejection of a JavaScript disabled browser.) + +===== Regular expressions notes ===== + +Following expressions are all equivalent: + +/http:\/\/www\.example\.com\// +m/http:\/\/www\.example\.com\// +m@http://www\.example\.com/@ +m!http://www\.example\.com/! + +With a trailing 'i' modifier, you can specify a case-insensitive match. +For example, m@^http://www\.example\.com/abc/@i matches to: + +http://www.example.com/abc/ +http://www.example.com/Abc/ +http://www.example.com/ABC/ + +Hostnames, however, are always converted to lowercases before compared. + diff --git a/doc/README.sixel b/doc/README.sixel new file mode 100644 index 0000000..588afc4 --- /dev/null +++ b/doc/README.sixel @@ -0,0 +1,27 @@ +Sixel support of w3m + 2014/11/05 + K. Araki + +Introduction + + This is the extension for w3m to show inline images by sixel graphics. + +Requirements + + Install 'img2sixel' command provided by libsixel project. + (https://github.com/saitoha/libsixel) + +Build + + $ ./configure --enable-image ... + $ make + $ make install + +Usage + + $ w3m -sixel http://... + + You can specify options of 'img2sixel' command by "W3M_IMG2SIXEL" + environmental variable. + + $ W3M_IMG2SIXEL="img2sixel -d atkinson" w3m -sixel http://... diff --git a/doc/README.tab b/doc/README.tab index 8e98e1c..f237f70 100644 --- a/doc/README.tab +++ b/doc/README.tab @@ -39,7 +39,7 @@ Options: open_tab_blank ... open new tab if target is _blank or _new default: OFF close_tab_back ... close the tab when you back from last buffer in the tab - default: OFF (= Can't back...) + default: OFF (= Can't go back...) diff --git a/doc/keymap.default b/doc/keymap.default index 0ecf14f..174e4ed 100644 --- a/doc/keymap.default +++ b/doc/keymap.default @@ -11,6 +11,7 @@ # Left : LEFT, ^[[D keymap C-@ MARK +keymap C-_ GOTO_HOME keymap C-a LINE_BEGIN keymap C-b MOVE_LEFT keymap C-e LINE_END diff --git a/doc/keymap.lynx b/doc/keymap.lynx index 869c716..e4085c8 100644 --- a/doc/keymap.lynx +++ b/doc/keymap.lynx @@ -46,7 +46,7 @@ keymap - PREV_PAGE keymap . RIGHT keymap / SEARCH keymap : MARK_URL -keymap ; MARK_WORD +keymap ";" MARK_WORD keymap < SHIFT_LEFT keymap = INFO keymap > SHIFT_RIGHT diff --git a/doc/menu.submenu b/doc/menu.submenu index e55193d..e837f46 100644 --- a/doc/menu.submenu +++ b/doc/menu.submenu @@ -39,6 +39,6 @@ menu Link end menu Bookmark - func "Read bookmark (b)" BOOKMARK "bB" + func "View bookmarks (b)" BOOKMARK "bB" func "Add page to bookmark(a)" ADD_BOOKMARK "aA" end diff --git a/doc/w3m.1 b/doc/w3m.1 index 8f071c6..5daecbf 100644 --- a/doc/w3m.1 +++ b/doc/w3m.1 @@ -1,13 +1,10 @@ .nr N -1 .nr D 5 -.TH W3M 1 Local -.UC 4 +.TH W3M 1 "2016-08-06" "w3m 0.5.3" .SH NAME -w3m \- a text based Web browser and pager +w3m \- a text based web browser and pager .SH SYNOPSIS -.B w3m -[options] [URL or filename] -.PP +w3m [OPTION]... [ \fIfile\fP | \fIURL\fP ]... .SH DESCRIPTION .\" This defines appropriate quote strings for nroff and troff .ds lq \&" @@ -17,234 +14,304 @@ w3m \- a text based Web browser and pager .\" Just in case these number registers aren't set yet... .if \nN==0 .nr N 10 .if \nD==0 .nr D 5 -.I -w3m -is a World Wide Web (WWW) text based client. It has English and -Japanese help files and an option menu and can be configured to -use either language. It will display hypertext markup language -(HTML) documents containing links to files residing on the local -system, as well as files residing on remote systems. It can -display HTML tables and frames. -In addition, it can be used as a "pager" in much the same manner -as "more" or "less". -Current versions of -.I -w3m -run on -Unix (Solaris, SunOS, HP-UX, Linux, FreeBSD, and EWS4800) -and on -Microsoft Windows 9x/NT. -.PP + +\fIw3m\fP is a text based browser which can display local or remote +web pages as well as other documents. +It is able to process HTML +tables and frames but it ignores JavaScript and Cascading Style +Sheets. +\fIw3m\fP can also serve as a pager for text files named as +arguments or passed on standard input, and as a general purpose +directory browser. + +\fIw3m\fP organizes its content in buffers or tabs, allowing easy +navigation between them. +With the w3m-img extension installed, \fIw3m\fP can +display inline graphics in web pages. +And whenever \fIw3m\fP's HTML +rendering capabilities do not meet your needs, the target URL can be +handed over to a graphical browser with a single command. + +For help with runtime options, press \(lqH\(rq while running \fIw3m\fP. + +.SH ARGUMENTS + +When given one or more command line arguments, \fIw3m\fP will handle +targets according to content type. +For web, \fIw3m\fP gets this +information from HTTP headers; for relative or absolute file system +paths, it relies on filenames. + +With no argument, \fIw3m\fP expects data from standard input and +assumes \(lqtext/plain\(rq unless another MIME type is given by the user. + +If provided with no target and no fallback target (see for instance +option \fB\-v\fP below), \fIw3m\fP will exit with usage information. .SH OPTIONS -At start up, \fIw3m\fR will load any local -file or remote URL specified at the command -line. For help with runtime options, press \fB"H"\fR -while running \fIw3m\fR. -Command line options are: -.PP -.TP -.B -t tab -set tab width -.TP -.B -r -ignore backspace effect +Command line options are introduced with a single \(lq\-\(rq character and +may take an argument. +.SS General options .TP -.B -l line -# of preserved line (default 10000) +\fB\-B\fP +with no other target defined, use the bookmark page for startup .TP -.B -I charset -document charset +\fB\-M\fP +monochrome display .TP -.B -O charset -display/output charset +\fB\-no-mouse\fP +deactivate mouse support .TP -.B -B -load bookmark +\fB\-num\fP +display each line's number .TP -.B -bookmark file -specify bookmark file +\fB\-N\fP +distribute multiple command line arguments to tabs. +By default, a +stack of buffers is used .TP -.B -T type -specify content-type +\fB\-ppc \fInum\fR +width of \fInum\fR pixels per character. +Range of 4.0 to 32.0, default 8.0. +Larger values will make tables narrower. +(Implementation not verified) .TP -.B -m -internet message mode +\fB\-ppl \fInum\fR +height of \fInum\fR pixels per line. +Range of 4.0 to 64.0. +(Implementation not verified) .TP -.B -v -visual startup mode +\fB\-title\fP, \fB\-title=TERM\fP +use the buffer name as terminal title string. +With specified TERM, +this sets the title configuration style accordingly .TP -.B -M -monochrome display +\fB\-v\fP +with no other target defined, welcome users with a built-in page .TP -.B -N -open URL of command line on each new tab +\fB\-W\fP +toggle wrapping mode in searches .TP -.B -F -automatically render frame +\fB\-X\fP +do not initialize/deinitialize the terminal .TP -.B -dump -dump formatted page into stdout +\fB+\fInum\fR +go to line \fInum\fR; +only effective for \fInum\fR larger than the number of lines in the terminal +.SS Browser options .TP -.B -cols width -specify column width (used with -dump) +\fB\-cols \fInum\fR +with stdout as destination; HTML is rendered to lines of \fInum\fR characters .TP -.B -ppc count -specify the number of pixels per character (4.0...32.0). -Larger values will make tables narrower. [default 8.0] +\fB\-cookie\fP, \fB\-no-cookie\fP +use stored cookies and accept new ones, or do neither .TP -.B -ppl count -specify the number of pixels per line (4.0...64.0) +\fB\-F\fP +render frames .TP -.B -dump_source -dump page source into stdout +\fB\-graph\fP, \fB\-no-graph\fP +use or do not use graphic characters for drawing HTML table and frame borders .TP -.B -dump_head -dump response of HEAD request into stdout +\fB\-header \fIstring\fR +append \fIstring\fR to the HTTP(S) request. +Expected to match the header syntax \f(CWVariable: Value\fP .TP -.B -dump_both -dump HEAD and source into stdout +\fB\-m\fP +Render the body of Usenet messages according to the header \(lqContent-type\(rq .TP -.B -dump_extra -dump HEAD, source, and extra information into stdout +\fB\-no-proxy\fP +do not use proxy .TP -.B -post file -use POST method with file content +\fB\-post \fIfile\fR +use POST method to upload data defined in \fIfile\fR. +The syntax to be used +is \f(CWvar1=value1[&var2=value2]...\fP .TP -.B -header string -insert string as a header +\fB\-4\fP +IPv4 only. +Corresponds to dns_order=4 in configuration files .TP -.B + -goto line +\fB\-6\fP +IPv6 only. +Corresponds to dns_order=6 in configuration files +.SS Text pager options .TP -.B -num -show line number +\fB\-l \fInum\fR +number of lines preserved internally when receiving plain text from +stdin (default 10,000) .TP -.B -no-proxy -don't use proxy +\fB\-r\fP +use caret notation to display special escape characters (such +as ANSI escapes or nroff-style backspaces for bold and underlined +characters) instead of processing them .TP -.B -4 -IPv4 only (-o dns_order=4) +\fB\-s\fP +squeeze multiple blank lines into one .TP -.B -6 -IPv6 only (-o dns_order=6) +\fB\-t\fP \fInum\fP +set tab width to \fInum\fR columns. +No effect on stdout +.SS Data type/encoding options .TP -.B -no-mouse -don't use mouse +\fB\-I \fIcharset\fR +user defined character encoding of input data .TP -.B -cookie -use cookie. +\fB\-O \fIcharset\fR +user defined character encoding of output data .TP -.B -no-cookie -don't use cookie +\fB\-T \fItype\fR +explicit characterization of input data by MIME type +.SS Options for data output, followed by immediate exit .TP -.B -graph -use graphic character +\fB\-dump\fP +dump rendered page into stdout. +Set implicitly when output is directed +to a file or pipe .TP -.B -no-graph -don't use graphic character +\fB\-dump_source\fP +dump the page's source code into stdout .TP -.B -S -squeeze multiple blank lines +\fB\-dump_head\fP +dump response of a HEAD request for a URL into stdout .TP -.B -W -toggle wrap search mode +\fB\-dump_both\fP +dump HEAD, and source code for a URL into stdout .TP -.B -X -don't use termcap init/deinit +\fB\-dump_extra\fP +dump HEAD, source code, and extra information for a URL into stdout .TP -.B -title [=TERM] -set buffer name to terminal title string. -If TERM is specified, use the TERM style title configuration. +\fB\-help\fP +show a summary of compiled-in features and command line options .TP -.B -o opt=value -assign value to config option +\fB\-show-option\fP +show all available configuration options .TP -.B -show-option -show all available config option +\fB\-version\fP +show the version of \fIw3m\fP +.SS Options for overriding default settings and resources .TP -.B -config file -specify config file +\fB\-bookmark \fIfile\fR +use \fIfile\fR instead of the default bookmark.html file .TP -.B -help -show usage +\fB\-config \fIfile\fR +use \fIfile\fR instead of the default configuration file .TP -.B -version -show w3m version +\fB\-debug\fP +DO NOT USE .TP -.B -reqlog -write request logfile +\fB\-o \fIoption=value\fR +modify one configuration item with an explicitly given value; +without \fIoption=value\fR, equivalent to \fB\-show-option\fR .TP -.B -debug -DO NOT USE +\fB\-reqlog\fP +log headers of HTTP communication in file \f(CW~/.w3m/request.log\fP .SH EXAMPLES +.SS Pager-like usage +.TP +Combine snippets of HTML code and preview the page +.EX +$ cat header.html footer.html | w3m \-T text/html +.EE +.TP +Compare two files using tabs +.EX +$ w3m \-N config.old config +.EE +.SS Browser-like usage +.TP +Display web content in monochrome terminal +.EX +$ w3m \-M http://w3m.sourceforge.net +.EE +.TP +Display embedded graphics +.EX +$ w3m \-o auto_image=TRUE http://w3m.sourceforge.net +.EE +.TP +Display content from Usenet +.EX +$ w3m \-m nntp://news.aioe.org/comp.os.linux.networking +.EE +.TP +Upload data for a URL using the POST method +.EX +$ w3m \-post \- http://example.com/form.php <<<'a=0&b=1' +.EE +.SS Filter-like usage +.TP +Convert an HTML file to plain text with a defined line length +.EX +$ w3m \-cols 40 foo.html > foo.txt +.EE +.TP +Output the bookmarks page as text with an appended list of links +.EX +$ w3m \-B \-o display_link_number=1 > out.txt +.EE +.TP +Conversion of file format and character encoding +.EX +$ w3m \-T text/html \-I EUC-JP \-O UTF-8 < foo.html > foo.txt +.EE +.SS Start with no input +.TP +Welcome users with a built-in page +.EX +$ w3m \-v +.EE +.\".SH Errors +.SH ENVIRONMENT +\fIw3m\fP recognises the environment variable WWW_HOME as defining a +fallback target for use if it is invoked without one. +.SH FILES .TP -To use w3m as a pager: -.br -$ ls | w3m -.br -.TP -To use w3m to translate HTML files: -.br -$ cat foo.html | w3m -T text/html +\f(CW~/.w3m/bookmark.html\fP +default bookmark file .TP -or -.br -$ cat foo.html | w3m -dump -T text/html >foo.txt -.SH FILES +\f(CW~/.w3m/config\fP +user defined configuration file; overrides \f(CW/etc/w3m/config\fP .TP -.I ${HOME}/.w3m/config -configuration file +\f(CW~/.w3m/cookie\fP +cookie jar; written on exit, read on launch .TP -.I ${HOME}/.w3m/keymap -key binding configuration file -.\" .TP -.\" .I ${HOME}/.w3m/menu -.\" ??? +\f(CW~/.w3m/history\fP +browser history - visited files and URLs .TP -.I ${HOME}/.w3m/mouse -mouse configuration file +\f(CW~/.w3m/keymap\fP +user defined key bindings; overrides default key bindings .TP -.I ${HOME}/.w3m/cookie -cookie file +\f(CW~/.w3m/mailcap\fP +external viewer configuration file .TP -.I ${HOME}/.w3m/history -history file +\f(CW~/.w3m/menu\fP +user defined menu; overrides default menu .TP -.I ${HOME}/.w3m/passwd -passowrd and username file +\f(CW~/.w3m/mime.types\fP +MIME types file .TP -.I ${HOME}/.w3m/pre_form -form parameters file +\f(CW~/.w3m/mouse\fP +user defined mouse settings .TP -.I ${HOME}/.w3m/mailcap -external viewer configuration file +\f(CW~/.w3m/passwd\fP +password and username file .TP -.I ${HOME}/.w3m/mime.types -MIME types file +\f(CW~/.w3m/pre_form\fP +contains predefined values to fill recurrent HTML forms .\" .TP -.\" .I ${HOME}/.w3m/urimethodmap +.\" .I $~/.w3m/urimethodmap .\" ??? -.SH NOTES -This is the -.I -w3m -0.5.3 Release. -.PP -Please see the MANUAL.html file distributed with w3m for -more detailed documentation. - -Additional information about -.I -w3m -may be found on its Japanese language Web site located at: - http://w3m.sourceforge.net/index.ja.html -.br -or on its English version of the site at: - http://w3m.sourceforge.net/index.en.html +.SH SEE ALSO +README and example files are to be found in the doc directory of your +\fIw3m\fP installation. +Recent information about \fIw3m\fP may be found on +.UR http://w3m.sourceforge.net +the project's web pages at +.UE .SH ACKNOWLEDGMENTS -.I -w3m -has incorporated code from several sources. +\fIw3m\fP has incorporated code from several sources. Users have contributed patches and suggestions over time. .SH AUTHOR -Akinori ITO +.MT aito@fw.ipsj.or.jp +Akinori ITO +.ME + -- cgit v1.2.3

left click -	Move the cursor to the place pointed by the mouse cursor. -If you click the cursor and it is on an anchor, follow the anchor. -
middle click -	Back to the previous buffer. -
right click -	Open pop-up menu. You can choose an item by clicking it. -
left drag -	Scroll document. The default behavior is to grab the document -and drag it. You can reverse the behavior (grab the window and drag it) -with the option setting panel. -

Frequently Asked Questions and Answers about w3m

General Questions, How to Get It, Required Environment

How do I pronounce "w3m"?

Why is it called "w3m"?

On which platforms does w3m work?

Where can I get more information about w3m?

Is there a mailing list for w3m?

Are there any binary distributions?

Compile and Install

Options, Commands, Usage

w3m quits if started without parameters. What's wrong?

w3m starts with black characters on a black screen. How do I change this?

Does w3m support colours?

Does w3m support monochrome display?

How do I shift the display?

How do I move from anchor to anchor?

Netscape displays a word red, but w3m doesn't. Why?

How do I change the colour of anchor-/image-/form links?

w3m doesn't seem to use the variable EDITOR. Why?

How do I quit a search or URL text input?

Questions about WWW usage

How do I fill in forms with w3m?

Seems like w3m is slower than Netscape or Lynx. Why?

Loading time doesn't decrease when loading a previously seen page

How do I download a linked file?

How do I specify a proxy server?

w3m freezes when I invoke an external browser.

How do I change the default image viewer?

How do I enter a URL?

w3m appends a URL to the former one despite of having cleared the line with Ctrl-u. What to do?

Misc

What is w3m's configuration file?

What are these w3mxxxx files in my ~/.w3m directory for?

General Questions, How to Get It, Required Environment

How do I pronounce "w3m"?

Why is it called "w3m"?

On which platforms does w3m work?

Where can I get more information about w3m?

Is there a mailing list for w3m?

Are there any binary distributions?

Compile and Install

Options, Commands, Usage

w3m quits if started without parameters. What's wrong?

w3m starts with black characters on black background. How do I change -this?

Does w3m support colours?

+ Frequently Asked Questions and Answers about w3m +

+ + Index + +

+ + General Questions, How to Get It, Required Environment + +

+ + Compile and Install + +

+ + Options, Commands, Usage + +

Does w3m support monochrome display?

How do I shift the display?

How do I move from anchor to anchor?

Netscape displays a word red, but w3m doesn't. Why?

How do I change the colour of anchor-/image-/form links?

w3m doesn't seem to use the variable EDITOR. Why?

How do I quit a search or URL text input?

Questions about WWW usage

How do I fill in forms with w3m?

Seems like w3m is slower than Netscape or Lynx. Why?

Loading time doesn't decrease when loading a previously seen page

How do I download a linked file?

How do I specify a proxy server?

w3m freezes when I invoke an external browser.

How do I change the default image viewer?

+ + Questions about WWW usage + +

How do I enter a URL?

w3m appends a URL to the former one despite of having cleared the line -with Ctrl-u. What to do?

Miscellaneous

What is w3m's configuration file?

What are these w3mxxxx files in my ~/.w3m directory for?

+ + Miscellaneous + +

w3m MANUAL

Index

Introduction

Options

w3m MANUAL

Index

+ Introduction +

+ Options +