aboutsummaryrefslogtreecommitdiffstats
path: root/doc/MANUAL.html
diff options
context:
space:
mode:
authorTatsuya Kinoshita <tats@debian.org>2021-01-02 00:20:37 +0000
committerTatsuya Kinoshita <tats@debian.org>2021-01-02 00:20:37 +0000
commit1d0ba25a660483da1272a31dd077ed94441e3d9f (patch)
tree1d8dee52cd1e3d340fe178a8193dc96c4496db84 /doc/MANUAL.html
parentMerge branch 'cvstrunk' into upstream (diff)
downloadw3m-1d0ba25a660483da1272a31dd077ed94441e3d9f.tar.gz
w3m-1d0ba25a660483da1272a31dd077ed94441e3d9f.zip
New upstream version 0.5.3+git20210102upstream/0.5.3+git20210102upstream
Diffstat (limited to 'doc/MANUAL.html')
-rw-r--r--doc/MANUAL.html2902
1 files changed, 2402 insertions, 500 deletions
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 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
-<head><title>w3m manual</title>
-</head>
-<body>
-<h1>w3m MANUAL</h1>
-<div align=right>
-Akinori Ito<br>
-aito@fw.ipsj.or.jp
-</div>
-<h2>Index</h2>
-<menu>
-<li><a href="#Introduction">Introduction</a>
-<li><a href="#Options">Options</a>
-<li><a href="#Color">Document color</a>
-<li><a href="#Key:orig">Key binding</a>
-<li><a href="#Key:lynx">Lynx-like key binding</a>
-<li><a href="#Mouse">Mouse operation</a>
-<li><a href="#Key:custom">Key customization</a>
-<li><a href="#LocalCGI">Local CGI</a>
-</menu>
-
-<hr>
-<a name="Introduction"></a>
-<h2>Introduction</h2>
-w3m is a pager/text-based WWW browser. You can browse local documents and/or
-documents on the WWW using a terminal emulator.
-
-<hr>
-<a name="Options"></a>
-<h2>Options</h2>
-
-Command line usage is
-<p>
+ <head>
+ <title>w3m manual</title>
+ <style>
+ span.mono {
+ font-family:mono;
+ }
+ </style>
+ <meta http-equiv="content-type" content="text/html;charset=UTF-8">
+ </head>
+ <body>
+ <!--
+insertions tagged with "mh 2016-03-29" and "mh 2016-06-11" come from the latest version of manual page w3m (1)
+ -->
+
+ <h1>w3m MANUAL</h1>
+ <div align="right">
+ Akinori Ito<br>
+ aito@fw.ipsj.or.jp
+ </div>
+ <h2>Index</h2>
+ <ul>
+ <li>
+ <a href="#Introduction">
+ Introduction
+ </a>
+ </li>
+ <li>
+ <a href="#Options">
+ Options
+ </a>
+ </li>
+ <li>
+ <a href="#Color">
+ Document Colors
+ </a>
+ </li>
+ <li>
+ <a href="#Functions">
+ Functions and Key bindings
+ </a>
+ </li>
+<!-- mh 2016-06-13 obsolete
+ <li>
+ <a href="#Key:lynx">
+ Lynx-like key bindings
+ </a>
+ </li>
+-->
+ <li>
+ <a href="#Mouse">
+ Mouse Operation
+ </a>
+ </li>
+<!-- mh 2016-06-13 obsolete
+ <li>
+ <a href="#Key:custom">
+ Key customization
+ </a>
+ </li>
+ -->
+ <li>
+ <a href="#LocalCGI">
+ Local CGI scripts
+ </a>
+ </li>
+ </ul>
+ <hr>
+ <h2 id="Introduction">
+ Introduction
+ </h2>
+ <p>
+ w3m is a pager/text-based WWW browser. You can browse local
+ documents and/or documents on the WWW using a terminal emulator.
+ </p>
+ <hr>
+ <h2 id="Options">
+ Options
+ </h2>
+ <p>
+ Command line usage is
+ </p>
+<!-- mh 2016-08-06 invocation adapted to w3m(1). w3m accepts several options and several targets -->
<pre>
- w3m [options] [file|URL]
+ w3m [option]... [file|URL]...
</pre>
-<P>
-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.
+ <p>
+ 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.
+ </p>
+ <p>
+ Options include:
+ </p>
+ <dl>
+<h3>General options</h3>
+ <dt>
+ -B
+ </dt>
+ <dd>
+ <p>
+ <!-- mh 2016-03-29-->
+ with no other target defined, use the bookmark page for startup
+ </p>
+ </dd>
+ <dt>
+ -M
+ </dt>
+ <dd>
+ <p>
+ <!-- mh 2016-03-29-->
+ monochrome display
+ </p>
+ </dd>
+ <dt>
+ -no-mouse
+ </dt>
+ <dd>
+ <p>
+ deactivate mouse support.
+ </p>
+ </dd>
+ <dt>
+ -num
+ </dt>
+ <dd>
+ <p>
+ <!-- mh 2016-03-29-->
+ display each line's number
-<p>
-Options are as follows:
-<dl>
-<dt>+&lt;line number&gt;
-<dd>Move to the specified line.
-<dt>-t width
-<dd>Specify tab width. Default is 8.
-<dt>-r
-<dd>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.
-<dt>-l number
-<dd>Specify line number preserved internally when reading text/plain document
-fron standard input. Default is 10000.
-<dt>-s
-<dd>Display documents with Shift_JIS code.
-<dt>-e
-<dd>Display documents with EUC_JP code.
-<dt>-j
-<dd>Display documents with ISO-2022-JP code.
-<dt>-T type
-<dd>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.
-<p>
-Example:<br>
-Read HTML document from standard input and display it
+ </p>
+ </dd>
+<!-- mh 2016-08-06 commented out. As implementation is not verified.
+ <dt>
+ -ppc <i>num</i>
+ </dt>
+ <dd>
+ <p>
+ width of <i>num</i> pixels per character. Range of 4.0 to 32.0,
+ default 8.0. Larger values will make tables
+ narrower. (Implementation not verified)
+ </p>
+ </dd>
+-->
+ <dt>
+ -v
+ </dt>
+ <dd>
+ <p>
+ <!-- mh 2016-03-29-->
+ with no other target defined, welcome users with a built-in page
+ </p>
+ </dd>
+ <dt>
+ -W
+ </dt>
+ <dd>
+ <p>
+ <!-- mh 2016-03-29-->
+ toggle wrapping mode in searches
+ </p>
+ </dd>
+ <dt>
+ -X
+ </dt>
+ <dd>
+ <p>
+ upon exit, do not reinitialize the terminal.
+ </p>
+ </dd>
+ <dt>
+ +<i>num</i>
+ </dt>
+ <dd>
+ <p><!--mh 2016-06-11 -->
+ go to line <i>num</i>; only effective for numbers larger
+ than the number of lines in the terminal
+ </p>
+ </dd>
+<h3>Browser options</h3>
+ <dt>
+ -cols <i>num</i>
+ </dt>
+ <dd>
+ <p>
+ <!-- mh 2016-06-11 -->
+ with stdout as destination; HTML is rendered to lines of <i>num</i>
+ characters
+ </p>
+ </dd>
+ <dt>
+ -cookie
+ </dt>
+ <dd>
+ <p>
+ <!-- mh 2016-03-29-->
+ use stored cookies and accept new ones
+ </p>
+ </dd>
+ <dt>
+ -no-cookie
+ </dt>
+ <dd>
+ <p>
+ <!-- mh 2016-03-29-->
+ neither use stored cookies nor accept new ones
+
+ </p>
+ </dd>
+ <dt>
+ -F
+ </dt>
+ <dd>
+ <p>
+ <!-- mh 2016-03-29-->
+ render frames
+ </p>
+ </dd>
+ <dt>
+ -no-graph
+ </dt>
+ <dd>
+ <p>
+ <!-- mh 2016-03-29-->
+ do not use graphic characters for drawing HTML table and frame
+ borders
+ </p>
+ </dd>
+ <dt>
+ -header <i>string</i>
+ </dt>
+ <dd>
+ <p>
+ <!-- mh 2016-03-29-->
+ append <i>string</i> to the HTTP(S) request. Expected to match
+ the header syntax <span class="mono">"Variable: Value"</span>
+ </p>
+ </dd>
+ <dt>
+ -m
+ </dt>
+ <dd>
+ <p>
+ display document using <q>Internet message mode</q>. With this
+ option, w3m determines document type from header information.
+ This is useful when reading e-mail or Usenet news posts.
+<!-- mh 2016-03-29
+Render the body of Usenet messages according to the header <q>Content-type</q>
+-->
+ </p>
+ </dd>
+ <dt>
+ -no-proxy
+ </dt>
+ <dd>
+ <p>
+ <!-- mh 2016-06-11-->
+ do not use proxy
+ </p>
+ </dd>
+ <dt>
+ -post <i>file</i>
+ </dt>
+ <dd>
+ <p><!--funktionierend 2016-06-28T08:22>-->
+ use POST method to upload data defined in <i>file</i>. The
+ syntax to be used is <span class="mono">"var1=value1[&amp;var2=value2]…"</span>
+ </p>
+ </dd>
+<h3>Text pager options</h3>
+ <dt>
+ -l <i>num</i>
+ </dt>
+ <dd>
+ <p>
+ <!-- mh2016-06-11-->
+ number of lines preserved internally when receiving plain text
+ from stdin (default 10,000)
+ </p>
+ </dd>
+ <dt>
+ -r
+ </dt>
+ <dd>
+ <p>
+ <!-- mh 2016-03-29 -->
+ 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
+ </p>
+ </dd>
+ <dt>
+ -s
+ </dt>
+ <dd>
+ <p>
+ <!-- mh 2016-03-29-->
+ squeeze multiple blank lines into one
+ </p>
+ </dd>
+
+ <dt>
+ <!--mh 2016-03-29 --> -t <i>num</i>
+ </dt>
+ <dd>
+ <p>
+ <!--mh 2016-03-29--> set tab width to <i>num</i> columns. No effect on stdout
+ </p>
+ </dd>
+<h3>Data type/encoding options</h3>
+ <dt>
+ -I <i>charset</i>
+ </dt>
+ <dd>
+ <p>
+ <!-- mh 2016-03-29-->
+ user defined character encoding of input data
+ </p>
+ </dd>
+ <dt>
+ -O <i>charset</i>
+ </dt>
+ <dd>
+ <p>
+ <!-- mh 2016-03-29 -->
+ user defined character encoding of output data
+ </p>
+ </dd>
+ <dt>
+ -T <i>type</i>
+ </dt>
+ <dd>
+ <p>
+ <!-- mh 2016-06-11-->
+ 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:
+ </p>
+ <p>
+ Read HTML document from standard input and display it
+ </p>
<pre>
- cat hoge.html | w3m -T text/html
+ cat example.html | w3m -T text/html
</pre>
-<p>
-Display HTML source
+ <p>
+ Display HTML source
+ </p>
<pre>
- w3m -T text/plain hoge.html
+ w3m -T text/plain example.html
</pre>
-<dt>-m
-<dd>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.
-<dt>-v
-<dd>visual startup mode.
-<dt>-B
-<dd>Show the bookmark.
-<dt>-bookmark file
-<dd>Specify bookmark file.
-<dt>-M
-<dd>Monochrome display mode.
-<dt>-F
-<dd>Automatically render frame.
-<dt>-S
-<dd>Squeeze blank lines.
-<dt>-X
-<dd>Upon exit, do not display preserved screen.
-<dt>-W
-<dd>Toggle wrap search mode.
-<dt>-o option=value
-<dd>Specify option. The option names and values are
-same as that appears in ~/.w3m/config.
-<dt>-cookie
-<dd>Process cookies.
-<dt>-no-cookie
-<dd>Don't process cookies.
-<dt>-num
-<dd>Show linenumber.
-<dt>-dump
-<dd>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.
-<dt>-cols width
-<dd>Specify document width. Used with -dump option.
-<dt>-ppc count
-<dd> Specify the number of pixels per character (default 8.0). Larger
- values will make tables narrower.
-<dt>-dump_source
-<dd>Read document specified by URL and dump the source.
-<dt>-dump_head
-<dd>Read document specified by URL and dump headers.
-<dt>-dump_both
-<dd>Read document specified by URL and dump headers and the source.
-<dt>-dump_extra
-<dd>Read document specified by URL and dump extra informations, headers and the source.
-<dt>-post file
-<dd>use POST method with file content.
-<dt>-header string
-<dd>insert string as a header.
-<dt>-no-proxy
-<dd>Don't use proxy server.
-<dt>-no-graph
-<dd>Use ASCII character to draw frames.
-<dt>-no-mouse
-<dd>Don't activate mouse.
-<dt>-config file
-<dd>specify config file.
-</dl>
-
-<hr>
-<a name="Color"></a>
-<h2>Document color</h2>
-
-Links and images are displayed as follows.
-<div align="center">
-<table border="1">
-<tr><th>&nbsp;</th><th>Color mode</th><th>Monochrome mode</th></tr>
-<tr><td>links</td><td>blue</td><td>underline</td></tr>
-<tr><td>inline images</td><td>green</td><td>reverse</td></tr>
-<tr><td>form input</td><td>red</td><td>reverse</td></tr>
-</table>
-</div>
-These colors can be customized using option setting command "o".
-
-<hr>
-<a name="Key:orig"></a>
-<h2>Key binding</h2>
-
-After invocation, you can operate w3m by one-character commands from
-the keyboard.
-<P>
-Here's the original key-binding table. If you are using Lynx-like key
-bindings, see <a href="#Key:lynx">the Lynx-like key binding</a>.
-
-<H3>Page/Cursor motion</H3>
-<table>
-<TR><TD WIDTH=100>SPC,C-v<TD>Forward page
-<TR><TD>b,ESC v<TD>Backward page
-<TR><TD>l,C-f<TD>Cursor right
-<TR><TD>h,C-b<TD>Cursor left
-<TR><TD>j,C-n<TD>Cursor down
-<TR><TD>k,C-p<TD>Cursor up
-<TR><TD>J<TD>Roll up one line
-<TR><TD>K<TD>Roll down one line
-<TR><TD>^,C-a<TD>Go to the beginning of line
-<TR><TD>$,C-e<TD>Go to the end of line
-<TR><TD>w<TD>Go to next word
-<TR><TD>W<TD>Go to previous word
-<TR><TD>&gt;<TD>Shift screen right
-<TR><TD>&lt;<TD>Shift screen left
-<TR><TD>.<TD>Shift screen one column right
-<TR><TD>,<TD>Shift screen one column left
-<TR><TD>g,M-&lt;<TD>Go to the first line
-<TR><TD>G,M-&gt;<TD>Go to the last line
-<TR><TD>ESC g<TD>Go to specified line
-<TR><TD>Z<TD>Move to the center line
-<TR><TD>z<TD>Move to the center column
-<TR><TD>TAB<TD>Move to next hyperlink
-<TR><TD>C-u,ESC TAB<TD>Move to previous hyperlink
-<TR><TD>[<TD>Move to the first hyperlink
-<TR><TD>]<TD>Move to the last hyperlink
-</table>
-
-<H3>Hyperlink operation</H3>
-<table>
-<TR><TD WIDTH=100>RET<TD>Follow hyperlink
-<TR><TD>a, ESC RET<TD>Save link to file
-<TR><TD>u<TD>Peek link URL
-<TR><TD>i<TD>Peek image URL
-<TR><TD>I<TD>View inline image
-<TR><TD>ESC I<TD>Save inline image to file
-<TR><TD>:<TD>Mark URL-like strings as anchors
-<TR><TD>ESC :<TD>Mark Message-ID-like strings as news anchors
-<TR><TD>c<TD>Peek current URL
-<TR><TD>=<TD>Display information about current document
-<TR><TD>C-g<TD>Show current line number
-<TR><TD>C-h<TD>View history of URL
-<TR><TD>F<TD>Render frame
-<TR><TD>M<TD>Browse current document using external browser
-(use 2M and 3M to invoke second and third browser)
-<TR><TD>ESC M<TD>Browse link using external browser
-(use 2ESC M and 3ESC M to invoke second and third browser)
-</table>
-
-<H3>File/Stream operation</H3>
-<table>
-<TR><TD WIDTH=100>U<TD>Open URL
-<TR><TD>V<TD>View new file
-<TR><TD>@<TD>Execute shell command and load
-<TR><TD>#<TD>Execute shell command and browse
-</table>
-
-<H3>Buffer operation</H3>
-<table>
-<TR><TD WIDTH=100>B<TD>Back to the previous buffer
-<TR><TD>v<TD>View HTML source
-<TR><TD>s<TD>Select buffer
-<TR><TD>E<TD>Edit buffer source
-<TR><TD>C-l<TD>Redraw screen
-<TR><TD>R<TD>Reload buffer
-<TR><TD>S<TD>Save buffer
-<TR><TD>ESC s<TD>Save source
-<TR><TD>ESC e<TD>Edit buffer image
-</table>
-
-<H3>Buffer selection mode</H3>
-<table>
-<TR><TD WIDTH=100>k, C-p<TD>Select previous buffer
-<TR><TD>j, C-n<TD>Select next buffer
-<TR><TD>D<TD>Delect current buffer
-<TR><TD>RET<TD>Go to the selected buffer
-</table>
-
-<H3>Bookmark operation</H3>
-<table>
-<TR><TD WIDTH=100>ESC b<TD>Load bookmark
-<TR><TD>ESC a<TD>Add current to bookmark
-</table>
-
-<H3>Search</H3>
-<table>
-<TR><TD WIDTH=100>/,C-s<TD>Search forward
-<TR><TD>?,C-r<TD>Search backward
-<TR><TD>n<TD>Search next
-<TR><TD>N<TD>Search previous
-<TR><TD>C-w<TD>Toggle wrap search mode
-</table>
-
-<H3>Mark operation</H3>
-<table>
-<TR><TD WIDTH=100>C-SPC<TD>Set/unset mark
-<TR><TD>ESC p<TD>Go to previous mark
-<TR><TD>ESC n<TD>Go to next mark
-<TR><TD>"<TD>Mark by regular expression
-</table>
-
-<H3>Miscellany</H3>
-<table>
-<TR><TD WIDTH=100>!<TD>Execute shell command
-<TR><TD>H<TD>Help (load this file)
-<TR><TD>o<TD>Set option
-<TR><TD>C-k<TD>Show cookie jar
-<TR><TD>C-c<TD>Stop
-<TR><TD>C-z<TD>Suspend
-<TR><TD>q<TD>Quit (with confirmation, if you like)
-<TR><TD>Q<TD>Quit without confirmation
-</table>
-
-<H3>Line-edit mode</H3>
-<table>
-<TR><TD WIDTH=100>C-f<TD>Move cursor forward
-<TR><TD>C-b<TD>Move cursor backward
-<TR><TD>C-h<TD>Delete previous character
-<TR><TD>C-d<TD>Delete current character
-<TR><TD>C-k<TD>Kill everything after cursor
-<TR><TD>C-u<TD>Kill everything before cursor
-<TR><TD>C-a<TD>Move to the top of line
-<TR><TD>C-e<TD>Move to the bottom of line
-<TR><TD>C-p<TD>Fetch the previous string from the history list
-<TR><TD>C-n<TD>Fetch the next string from the history list
-<TR><TD>TAB,SPC<TD>Complete filename
-<TR><TD>RETURN<TD>Accept
-</table>
-
-<hr>
-<a name="Key:lynx"></a>
-<h2>Lynx-like key binding</h2>
-
-If you have chosen `Lynx-like key binding' at the compile time,
-you can use the following key binding.
-
-<H3>Page/Cursor motion</H3>
-<table>
-<TR><TD WIDTH=100>SPC,C-v,+<TD>Forward page
-<TR><TD>b,ESC v,-<TD>Previous page
-<TR><TD>l<TD>Cursor right
-<TR><TD>h<TD>Cursor left
-<TR><TD>j<TD>Cursor down
-<TR><TD>k<TD>Cursor up
-<TR><TD>J<TD>Roll up one line
-<TR><TD>K<TD>Roll down one line
-<TR><TD>^<TD>Go to the beginning of line
-<TR><TD>$<TD>Go to the end of line
-<TR><TD>&gt;<TD>Shift screen right
-<TR><TD>&lt;<TD>Shift screen left
-<TR><TD>C-a<TD>Go to the first line
-<TR><TD>C-e<TD>Go to the last line
-<TR><TD>G<TD>Go to the specified line
-<TR><TD>Z<TD>Move to the center line
-<TR><TD>z<TD>Move to the center column
-<TR><TD>TAB,C-n,Down arrow<TD>Move to next hyperlink
-<TR><TD>ESC TAB,C-p,Up arrow<TD>Move to previous link
-<TR><TD>C-g<TD>Show current page position
-</table>
-
+ </dd>
+<h3>Options for data output, followed by immediate exit</h3>
+ <dt>
+ -dump
+ </dt>
+ <dd>
+ <p>
+ read document specified by URL and dump page rendered as text
+ into standard output.
+ <!-- mh 2016-03-29 -->
+ 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.
+ </p>
+ </dd>
+ <dt>
+ -dump_source
+ </dt>
+ <dd>
+ <p>
+ <!-- mh 2016-03-29-->
+ dump the page's source code into stdout
+ </p>
+ </dd>
+ <dt>
+ -dump_head
+ </dt>
+ <dd>
+ <p>
+ <!-- mh 2016-03-29-->
+ dump response of a HEAD request for a URL into stdout
+ </p>
+ </dd>
+ <dt>
+ -dump_both
+ </dt>
+ <dd>
+ <p>
+ <!-- mh 2016-03-29-->
+ dump HEAD, and source code for a URL into stdout
-<H2>Hyperlink operation</H2>
-<table>
-<TR><TD WIDTH=100>RET, C-f, Right arrow<TD>Follow hyperlink
-<TR><TD>d, ESC RET<TD>Save link to file
-<TR><TD>u<TD>Peek link URL
-<TR><TD>i<TD>Peek image URL
-<TR><TD>I<TD>View inline image
-<TR><TD>ESC I<TD>Save inline image to file
-<TR><TD>:<TD>Mark URL-like strings as anchors
-<TR><TD>ESC :<TD>Mark Message-ID-like strings as news anchors
-<TR><TD>c<TD>Peek current URL
-<TR><TD>=<TD>Display information about current document
-<TR><TD>C-h<TD>View history of URL
-<TR><TD>F<TD>Render frame
-<TR><TD>M<TD>Browse current document using external browser
-(use 2M and 3M to invoke second and third browser)
-<TR><TD>ESC M<TD>Browse link using external browser
-(use 2ESC M and 3ESC M to invoke second and third browser)
-</table>
+ </p>
+ </dd>
+ <dt>
+ -dump_extra
+ </dt>
+ <dd>
+ <p>
+ <!-- mh 2016-03-29-->
+ dump HEAD, source code, and extra information for a URL into
+ stdout
+ </p>
+ </dd>
-<H2>File/Stream operation</H2>
-<table>
-<TR><TD WIDTH=100>g,U<TD>Open URL
-<TR><TD>V<TD>View new file
-<TR><TD>@<TD>Execute shell command and load
-<TR><TD>#<TD>Execute shell command and browse
-</table>
+<h3>Options for overriding default settings and resources</h3>
+
+ <dt>
+ -bookmark <i>file</i>
+ </dt>
+ <dd>
+ <p>
+ <!-- mh 2016-03-29-->
+ use <i>file</i> instead of the default bookmark.html file
+ </p>
+ </dd>
+ <dt>
+ -config <i>file</i>
+ </dt>
+ <dd>
+ <p>
+ <!--mh 2016-06-11-->
+ use <i>file</i> instead of the default configuration file
+ </p>
+ </dd>
+ <dt>
+ -o <i>option</i>=<i>value</i>
+ </dt>
+ <dd>
+ <p>
+ <!-- mh 2016-03-29-->
+ modify one configuration item with an explicitly given value; without <i>option=value</i>, equivalent to <i>-show-option</i>
+ </p>
+ </dd>
+ </dl>
+ <hr>
+ <h2 id="Color">
+ Document Colors
+ </h2>
+ <p>
+ Hyperlinks and images are displayed as follows.
+ </p>
+ <div align="center">
+ <table border="1">
+ <tr>
+ <th>
+ </th>
+ <th>
+ Color mode
+ </th>
+ <th>
+ Monochrome mode
+ </th>
+ </tr>
+ <tr>
+ <td>
+ Hyperlinks
+ </td>
+ <td>
+ blue
+ </td>
+ <td>
+ underline
+ </td>
+ </tr>
+ <tr>
+ <td>
+ Inline images
+ </td>
+ <td>
+ green
+ </td>
+ <td>
+ reverse
+ </td>
+ </tr>
+ <tr>
+ <td>
+ Form input
+ </td>
+ <td>
+ red
+ </td>
+ <td>
+ reverse
+ </td>
+ </tr>
+ </table>
+ </div>
+ <p>
+ These colors can be customized using the options setting command
+ <i>o</i>.
+ </p>
+ <hr>
+ <h2 id="Functions">
+ Functions and Key bindings
+ </h2>
+
+ <p>
+ 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.
+<!-- mh 2016-06-13 obsolete
+ If you prefer using Lynx-like
+ key bindings, make w3m start with the respective keymap file keymap.lynx. (see w3m (1)).-->
+ </p>
+<!--
+ <h2 id="Key:custom">
+ Key customization
+ </h2>
+-->
+ <p>
+ You can customize the key bindings (except those for menu
+ operations and line-editing) in a ~/.w3m/keymap file. For example,
+ </p>
-<H2>Buffer operation</H2>
-<table>
-<TR><TD WIDTH=100>B, C-b, Left arrow<TD>Back to the previous buffer
-<TR><TD>\<TD>View HTML source
-<TR><TD>s, C-h<TD>Select buffer
-<TR><TD>E<TD>Edit buffer source
-<TR><TD>C-l, C-w<TD>Redraw screen
-<TR><TD>R, C-r<TD>Reload buffer
-<TR><TD>S, p<TD>Save buffer
-<TR><TD>ESC s<TD>Save source
-<TR><TD>ESC e<TD>Edit buffer image
-</table>
-
-<H2>Buffer selection mode</H2>
-<table>
-<TR><TD WIDTH=100>k, C-p<TD>Select previous buffer
-<TR><TD>j, C-n<TD>Select next buffer
-<TR><TD>D<TD>Delect current buffer
-<TR><TD>RET<TD>Go to the selected buffer
-</table>
-
-<H2>Bookmark operation</H2>
-<table>
-<TR><TD WIDTH=100>v, ESC b<TD>Load bookmark
-<TR><TD>a, ESC a<TD>Add current to bookmark
-</table>
-
-<H2>Search</H2>
-<table>
-<TR><TD WIDTH=100>/, C-s<TD>Search forward
-<TR><TD>n<TD>Search next
-<TR><TD>w<TD>Toggle wrap search mode
-</table>
-
-<H2>Mark operation</H2>
-<table>
-<TR><TD WIDTH=100>C-SPC<TD>Set/unset mark
-<TR><TD>P<TD>Go to previous mark
-<TR><TD>N<TD>Go to next mark
-<TR><TD>"<TD>Mark by regular expression
-</table>
-
-<H2>Miscellany</H2>
-<table>
-<TR><TD WIDTH=100>!<TD>Execute shell command
-<TR><TD>H, ?<TD>Help (load this file)
-<TR><TD>o<TD>Set option
-<TR><TD>C-k<TD>Show cookie jar
-<TR><TD>C-c<TD>Stop
-<TR><TD>C-z<TD>Suspend
-<TR><TD>q<TD>Quit (with confirmation, if you like)
-<TR><TD>Q<TD>Quit without confirmation
-</table>
-
-<H2>Line-edit mode</H2>
-<table>
-<TR><TD WIDTH=100>C-f<TD>Move cursor forward
-<TR><TD>C-b<TD>Move cursor backward
-<TR><TD>C-h<TD>Delete previous character
-<TR><TD>C-d<TD>Delete current character
-<TR><TD>C-k<TD>Kill everything after cursor
-<TR><TD>C-u<TD>Kill everything before cursor
-<TR><TD>C-a<TD>Move to the top of line
-<TR><TD>C-e<TD>Move to the bottom of line
-<TR><TD>C-p<TD>Fetch the previous string from the history list
-<TR><TD>C-n<TD>Fetch the next string from the history list
-<TR><TD>TAB,SPC<TD>Complete filename
-<TR><TD>RETURN<TD>Accept
-</table>
-
-<hr>
-<a name="Mouse"></a>
-<h2>Mouse operation</h2>
-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.
-<p>
-<table border=0>
-<tr><td>left click
-<td>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.
-<tr><td>middle click
-<td>Back to the previous buffer.
-<tr><td>right click
-<td>Open pop-up menu. You can choose an item by clicking it.
-<tr><td>left drag
-<td>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.
-</table>
-<p>
+<pre>
+ keymap C-o NEXT_PAGE
+</pre>
+ <p>
+ binds the command <span class="mono">NEXT_PAGE</span> (normally bound to SPC and C-v)
+ to control-o. See <a href="README.func">README.func</a> for a list
+ of available functions. Original and Lynx-like keymap definitions
+ are provided as examples: <a href="keymap.default">keymap.default</a>
+ and <a href="keymap.lynx">keymap.lynx</a>.
+ </p>
-<hr>
-<a name="Key:custom"></a>
-<h2>Key customization</h2>
-You can customize the key binding (except line-editing keymap)
-by describing ~/.w3m/keymap. For example,
-<pre>
+ <p>
+ Throughout, the <i>C-</i> and <i>M-</i> notations indicate the
+ modifiers <i>control</i> and <i>meta</i>. The <i>ALT</i>-key
+ replaces the latter whereas pressing the <i>ESC</i>-key toggles
+ between <i>meta</i>-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. <i>2 M</i>
+ simply means <i>2</i> followed by <i>M</i>.
+ </p>
- keymap C-o NEXT_PAGE
-</pre>
-binds `NEXT_PAGE' function (normally bound to SPC and C-v)
-to control-o. See <a href="README.func">README.func</a> for
-list of available functions. Original and Lynx-like keymap
-definitions are provided (<a href="keymap.default">keymap.default</a>
-and <a href="keymap.lynx">keymap.lynx</a>) as examples.
+ <table border="1" width="100%">
+ <colgroup>
+ <col width="20%">
+ <col width="20%">
+ <col width="20%">
+ <col width="40%">
+ </colgroup>
+ <tr>
+ <th rowspan="2">
+ Function
+ </th>
+ <th colspan="2">Key binding
+ </th>
+ <th rowspan="2">
+ Description
+ </th>
+ </tr>
+ <tr>
+ <th>
+ Default
+ </th>
+ <th>
+ Lynx-like
+ </th>
+ </tr>
+ <tr>
+ <td colspan="4">
+ <h3>In-page navigation</h3>
+</td>
+ </tr>
+ <tr>
+ <td>
+ NEXT_PAGE
+ </td>
+ <td>
+ SPC, C-v, +, PGDN
+ </td>
+ <td>
+ SPC, C-v, +
+ </td>
+ <td>
+ Scroll one page downwards
+ </td>
+ </tr>
+ <tr>
+ <td>
+ PREVIOUS_PAGE
+ </td>
+ <td>
+ b, M-v, -, PGUP
+ </td>
+ <td>
+ b, M-v, -
+ </td>
+ <td>
+ Scroll one page upwards
+ </td>
+ </tr>
+ <tr>
+ <td>
+ MOVE_RIGHT
+ </td>
+ <td>
+ l, C-f, RIGHT
+ </td>
+ <td>
+ l
+ </td>
+ <td>
+ Move cursor right (with a half-screen shift at the screen edge)
+ </td>
+ </tr>
+ <tr>
+ <td>
+ MOVE_LEFT
+ </td>
+ <td>
+ h, C-b, LEFT
+ </td>
+ <td>
+ h
+ </td>
+ <td>
+ Move cursor left (with a half-screen shift at the screen edge)
+ </td>
+ </tr>
+ <tr>
+ <td>
+ MOVE_DOWN
+ </td>
+ <td>
+ j, C-n, DOWN
+ </td>
+ <td>
+ j
+ </td>
+ <td>
+ Move cursor down (with a one-line scroll at the screen edge)
+ </td>
+ </tr>
+ <tr>
+ <td>
+ MOVE_UP
+ </td>
+ <td>
+ k, C-p, UP
+ </td>
+ <td>
+ k
+ </td>
+ <td>
+ Move cursor up (with a one-line scroll at the screen edge)
+ </td>
+ </tr>
+ <tr>
+ <td>
+ UP
+ </td>
+ <td>
+ J
+ </td>
+ <td>
+ J
+ </td>
+ <td>
+ Scroll the screen up one line
+ </td>
+ </tr>
+ <tr>
+ <td>
+ DOWN
+ </td>
+ <td>
+ K
+ </td>
+ <td>
+ K
+ </td>
+ <td>
+ Scroll the screen down one line
+ </td>
+ </tr>
+ <tr>
+ <td>
+ LINE_BEGIN
+ </td>
+ <td>
+ ^, C-a
+ </td>
+ <td>
+ ^
+ </td>
+ <td>
+ Go to the beginning of the line
+ </td>
+ </tr>
+ <tr>
+ <td>
+ LINE_END
+ </td>
+ <td>
+ $, C-e
+ </td>
+ <td>
+ $
+ </td>
+ <td>
+ Go to the end of the line
+ </td>
+ </tr>
+ <tr>
+ <td>
+ NEXT_WORD
+ </td>
+ <td>
+ w
+ </td>
+ <td>
+ w
+ </td>
+ <td>
+ Move to the next word
+ </td>
+ </tr>
+ <tr>
+ <td>
+ PREVIOUS_WORD
+ </td>
+ <td>
+ W
+ </td>
+ <td>
+ W
+ </td>
+ <td>
+ Move to the previous word
+ </td>
+ </tr>
+ <tr>
+ <td>
+ SHIFT_RIGHT
+ </td>
+ <td>
+ >
+ </td>
+ <td>
+ >
+ </td>
+ <td>
+ Shift screen right
+ </td>
+ </tr>
+ <tr>
+ <td>
+ SHIFT_LEFT
+ </td>
+ <td>
+ <
+ </td>
+ <td>
+ <
+ </td>
+ <td>
+ Shift screen left
+ </td>
+ </tr>
+ <tr>
+ <td>
+ RIGHT
+ </td>
+ <td>
+ .
+ </td>
+ <td>
+ .
+ </td>
+ <td>
+ Shift screen one column right
+ </td>
+ </tr>
+ <tr>
+ <td>
+ LEFT
+ </td>
+ <td>
+ ,
+ </td>
+ <td>
+ ,
+ </td>
+ <td>
+ Shift screen one column left
+ </td>
+ </tr>
+ <tr>
+ <td>
+ BEGIN
+ </td>
+ <td>
+ g, M-<, HOME
+ </td>
+ <td>
+ C-a, M-<
+ </td>
+ <td>
+ Go to the first line
+ </td>
+ </tr>
+ <tr>
+ <td>
+ END
+ </td>
+ <td>
+ G, M->, END
+ </td>
+ <td>
+ C-e, M->
+ </td>
+ <td>
+ Go to the last line
+ </td>
+ </tr>
+ <tr>
+ <td>
+ GOTO_LINE
+ </td>
+ <td>
+ M-g
+ </td>
+ <td>
+ G
+ </td>
+ <td>
+ Go to the specified line
+ </td>
+ </tr>
+ <tr>
+ <td>
+ LINE_INFO
+ </td>
+ <td>
+ C-g
+ </td>
+ <td>
+ C-g
+ </td>
+ <td>
+ Display current position in document
+ </td>
+ </tr>
+ <tr>
+ <td>
+ CENTER_H
+ </td>
+ <td>
+ Z
+ </td>
+<!--Correction by mh 2014-04-06
+Description for keybinding of z and Z had been mingled
+-->
+ <td>
+ Z
+ </td>
+ <td>
+ Center screen right and left of the cursor column
+ </td>
+ </tr>
+ <tr>
+ <td>
+ CENTER_V
+ </td>
+ <td>
+ z
+ </td>
+ <td>
+ z
+ </td>
+ <td>
+ Center screen above and below the cursor line
+ </td>
+ </tr>
+ <tr>
+ <td>
+ NEXT_LINK
+ </td>
+ <td>
+ TAB
+ </td>
+ <td>
+ TAB, C-n, DOWN
+ </td>
+ <td>
+ Move to the next hyperlink
+ </td>
+ </tr>
+ <tr>
+ <td>
+ PREVIOUS_LINK
+ </td>
+ <td>
+ M-TAB, C-u
+ </td>
+ <td>
+ M-TAB, C-u, C-p, UP
+ </td>
+ <td>
+ Move to the previous hyperlink
+ </td>
+<!-- Annotion mh 2016-04-06
+Keybinding description for C-g had been moved as it did not fit to "Hyperlink operation" and position in the default and lynx-like series differed
+ -->
+ </tr>
+ <tr>
+ <td>
+ LINK_BEGIN
+ </td>
+ <td>
+ [
+ </td>
+ <td>
+ [
+ </td>
+ <td>
+ Move to the first hyperlink
+ </td>
+ </tr>
+ <tr>
+ <td>
+ LINK_END
+ </td>
+ <td>
+ ]
+ </td>
+ <td>
+ ]
+ </td>
+ <td>
+ Move to the last hyperlink
+ </td>
+ </tr>
+<tr>
+<td>MOVE_LIST_MENU</td>
+<td>M-m</td>
+<td>M-m</td>
+<td>Pop up menu to navigate between hyperlinks</td>
+</tr>
+<!-- </table>-->
+ <tr>
+ <td colspan="4">
+ <h3>Hyperlink Operations</h3>
+ </td>
+ </tr>
+<!-- <table>-->
+ <tr>
+ <td>
+ GOTO_LINK
+ </td>
+ <td>
+ C-j, C-m, RET
+ </td>
+ <td width="100">
+ C-f, C-j, C-m, RET, RIGHT
+ </td>
+ <td>
+ Follow current hyperlink in a new buffer
+ </td>
+ </tr>
+<tr>
+<td>LIST_MENU</td>
+<td>M-l</td>
+<td>M-l</td>
+<td>Pop up hyperlink menu and select one to be followed</td>
+</tr>
+ <tr>
+ <td>
+ SAVE_LINK
+ </td>
+ <td>
+ a, M-RET
+ </td>
+ <td>
+ d, M-RET
+ </td>
+ <td>
+ Save the hyperlink target
+ </td>
+ </tr>
+ <tr>
+ <td>
+ PEEK_LINK
+ </td>
+ <td>
+ u
+ </td>
+ <td>
+ u
+ </td>
+ <td>
+ Show target address
+ </td>
+ </tr>
+ <tr>
+ <td>
+ PEEK_IMG
+ </td>
+ <td>
+ i
+ </td>
+ <td>
+ i
+ </td>
+ <td>
+ Show image address
+ </td>
+ </tr>
+ <tr>
+ <td>
+ VIEW_IMAGE
+ </td>
+ <td>
+ I
+ </td>
+ <td>
+ I
+ </td>
+ <td>
+ Display image in viewer
+ </td>
+ </tr>
+ <tr>
+ <td>
+ SAVE_IMAGE
+ </td>
+ <td>
+ M-I
+ </td>
+ <td>
+ M-I
+ </td>
+ <td>
+ Save inline image
+ </td>
+ </tr>
+<tr>
+<td>MARK_WORD</td>
+<td>;</td>
+<td>;</td>
+<td>Turn current word into hyperlink</td>
+</tr>
+ <tr>
+ <td>
+ MARK_URL
+ </td>
+ <td>
+ :
+ </td>
+ <td>
+ :
+ </td>
+ <td>
+ Turn URL-like strings into hyperlinks
+ </td>
+ </tr>
+ <tr>
+ <td>
+ MARK_MID
+ </td>
+ <td>
+ M-:
+ </td>
+ <td>
+ M-:
+ </td>
+ <td>
+<!-- changed due to mail dated Mon, 04 Apr 2016 00:47:09 +0900 (JST)
+from Tatsuya Kinoshita -->
+ Turn Message-ID-like strings into hyperlinks
+ </td>
+ </tr>
+ <tr>
+ <td>
+ PEEK
+ </td>
+ <td>
+ c
+ </td>
+ <td>
+ c
+ </td>
+ <td>
+ Show current address
+ </td>
+ </tr>
+ <tr>
+ <td>
+ INFO
+ </td>
+ <td>
+ =
+ </td>
+ <td>
+ =
+ </td>
+ <td>
+ Display information about the current document
+ </td>
+ </tr>
+ <tr>
+ <td>
+ HISTORY
+ </td>
+ <td>
+ C-h
+ </td>
+ <td>
+ C-h
+ </td>
+ <td>
+ Show browsing history
+ </td>
+ </tr>
+ <tr>
+ <td>
+ EXTERN
+ </td>
+ <td>
+ M
+ </td>
+ <td>
+ M
+ </td>
+ <td>
+ Browse current document using external browser (prefix 2, 3, ...,
+ or 9 to invoke alternate configured browsers, e.g. 3 M)
+ </td>
+ </tr>
+ <tr>
+ <td>
+ EXTERN_LINK
+ </td>
+ <td>
+ M-M
+ </td>
+ <td>
+ M-M
+ </td>
+ <td>
+ Browse link using external browser (prefixed as above, e.g.
+ 3 M-M)
+ </td>
+ </tr>
+<!-- </table>-->
+ <tr>
+ <td colspan="4">
+ <h3>Bookmark management</h3>
+ </td>
+ </tr>
+<!-- <table>-->
+ <tr>
+ <td>
+ BOOKMARK
+ </td>
+ <td>
+ M-b
+ </td>
+ <td>
+ v, M-b
+ </td>
+ <td>
+ View bookmarks
+ </td>
+ </tr>
+ <tr>
+ <td>
+ ADD_BOOKMARK
+ </td>
+ <td>
+ M-a
+ </td>
+ <td>
+ a, M-a
+ </td>
+ <td>
+ Add current page to bookmarks
+ </td>
+ </tr>
+<!-- </table>-->
+ <tr>
+ <td colspan="4">
+ <h3>File/Stream Operations</h3>
+ </td>
+ </tr>
+<!-- <table>-->
+ <tr>
+ <td>
+ GOTO
+ </td>
+ <td>
+ U
+ </td>
+ <td>
+ g, U
+ </td>
+ <td>
+ Open specified document in a new buffer
+ </td>
+ </tr>
+<tr>
+<td>GOTO_RELATIVE</td>
+<td>M-u</td>
+<td>M-u</td>
+<td>Open relative address in a new buffer</td>
+</tr>
+ <tr>
+ <td>
+ LOAD
+ </td>
+ <td>
+ V
+ </td>
+ <td>
+ V
+ </td>
+ <td>
+ Open local file in a new buffer
+ </td>
+ </tr>
+ <tr>
+ <td>
+ READ_SHELL
+ </td>
+ <td>
+ @
+ </td>
+ <td>
+ @
+ </td>
+ <td>
+ <!--Execute shell command and view output-->
+ <!--mh 2016-06-13 No difference to PIPE_SHELL could be discerned-->
+ Execute shell command and display output in a new buffer
+ </td>
+ </tr>
+ <tr>
+ <td>
+ PIPE_SHELL
+ </td>
+ <td>
+ #
+ </td>
+ <td>
+ #
+ </td>
+ <td>
+ <!--Execute shell command and browse output-->
+ <!--mh 2016-06-13 No difference to READ_SHELL could be discerned-->
+ Execute shell command and display output in a new buffer
+ </td>
+ </tr>
+<!-- </table>-->
+ <tr>
+ <td colspan="4">
+ <h3>Content Operations</h3>
+ </td>
+ </tr>
+<!-- <table>-->
+ <tr>
+ <td>
+ VIEW <!-- is an alias to SOURCE -->
+ </td>
+ <td>
+ v
+ </td>
+ <td>
+ \
+ </td>
+ <td>
+ Toggle between source code and rendered view of the document
+ </td>
+ </tr>
+<tr>
+<td>LIST</td>
+<td>L</td>
+<td>L</td>
+<td>List link elements, hyperlinks and images</td>
+</tr>
+ <tr>
+ <td>
+ FRAME
+ </td>
+ <td>
+ F
+ </td>
+ <td>
+ F
+ </td>
+ <td>
+ Toggle rendering HTML frames
+ </td>
+ </tr>
+ <tr>
+ <td>
+ REDRAW
+ </td>
+ <td>
+ C-l
+ </td>
+ <td>
+ C-l, C-w
+ </td>
+ <td>
+ Draw the screen anew
+ </td>
+ </tr>
+ <tr>
+ <td>
+ RELOAD
+ </td>
+ <td>
+ R
+ </td>
+ <td>
+ R, C-r
+ </td>
+ <td>
+ Load current document anew
+ </td>
+ </tr>
+ <tr>
+ <td>
+ EDIT
+ </td>
+ <td>
+ E
+ </td>
+ <td>
+ E
+ </td>
+ <td>
+ Edit local source
+ </td>
+ </tr>
+ <tr>
+ <td>
+ EDIT_SCREEN
+ </td>
+ <td>
+ M-e
+ </td>
+ <td>
+ M-e
+ </td>
+ <td>
+ Edit rendered copy of document
+ </td>
+ </tr>
+<tr>
+<td>PIPE_BUF</td>
+<td>|</td>
+<td>|</td>
+<td>Pipe current buffer through a shell command and display output</td>
+</tr>
+ <tr>
+ <td>
+ DOWNLOAD <!-- is an alias to SAVE -->
+ </td>
+ <td>
+ M-s
+ </td>
+ <td>
+ M-s
+ </td>
+ <td>
+ Save document source
+ </td>
+ </tr>
+ <tr>
+ <td>
+ SAVE_SCREEN
+ </td>
+ <td>
+ S
+ </td>
+ <td>
+ S, p
+ </td>
+ <td>
+ Save rendered document
+ </td>
+ </tr>
+<!-- </table>-->
+ <tr>
+ <td colspan="4">
+ <h3>Buffer/Tab Navigation</h3>
+ </td>
+ </tr>
+<!-- <table>-->
+ <tr>
+ <td>
+ BACK
+ </td>
+ <td>
+ B
+ </td>
+ <td>
+ B, C-b, LEFT
+ </td>
+ <td>
+ Close current buffer and return to the one below in stack
+ </td>
+ </tr>
+ <tr>
+ <td>
+ GOTO_HOME
+ </td>
+ <td>
+ C-_
+ </td>
+ <td>
+ </td>
+ <td>
+ Return to the homepage (specified HTTP_HOME or WWW_HOME variable)
+ </td>
+ </tr>
+ <tr>
+ <td>
+ SELECT_MENU
+ </td>
+ <td>
+ s
+ </td>
+ <td>
+ s, C-h
+ </td>
+ <td>
+ Pop up buffer-stack menu
+ </td>
+ </tr>
+ <tr>
+ <td>
+ TAB_MENU
+ </td>
+ <td>
+ M-t
+ </td>
+ <td>
+ M-t
+ </td>
+ <td>
+ Pop up tab selection menu
+ </td>
+ </tr>
+ <tr>
+ <td>
+ NEW_TAB
+ </td>
+ <td>
+ T
+ </td>
+ <td>
+ T
+ </td>
+ <td>
+ Open a new tab (with current document)
+ </td>
+ </tr>
+ <tr>
+ <td>
+ TAB_LINK
+ </td>
+ <td>
+ C-t
+ </td>
+ <td>
+ C-t
+ </td>
+ <td>
+ Follow current hyperlink in a new tab
+ </td>
+ </tr>
+ <tr>
+ <td>
+ NEXT_TAB
+ </td>
+ <td>
+ }
+ </td>
+ <td>
+ }
+ </td>
+ <td>
+ Switch to the next tab
+ </td>
+ </tr>
+ <tr>
+ <td>
+ PREV_TAB
+ </td>
+ <td>
+ {
+ </td>
+ <td>
+ {
+ </td>
+ <td>
+ Switch to the previous tab
+ </td>
+ </tr>
+ <tr>
+ <td>
+ CLOSE_TAB
+ </td>
+ <td>
+ C-q
+ </td>
+ <td>
+ C-q
+ </td>
+ <td>
+ Close the current tab
+ </td>
+ </tr>
+<!-- </table>-->
+ <tr>
+ <td colspan="4">
+ <h3>Searches</h3>
+ </td>
+ </tr>
+<!-- <table>-->
+ <tr>
+ <td>
+ SEARCH
+ </td>
+ <td>
+ /
+ </td>
+ <td>
+ /, C-s
+ </td>
+ <td>
+ Search forward
+ </td>
+ </tr>
+ <tr>
+ <td>
+ SEARCH_BACK
+ </td>
+ <td>
+ ?
+ </td>
+ <td>
+ </td>
+ <td>
+ Search backward
+ </td>
+ </tr>
+ <tr>
+ <td>
+ ISEARCH
+ </td>
+ <td>
+ C-s
+ </td>
+ <td>
+ </td>
+ <td>
+ Incremental search forward
+ </td>
+ </tr>
+ <tr>
+ <td>
+ ISEARCH_BACK
+ </td>
+ <td>
+ C-r
+ </td>
+ <td>
+ </td>
+ <td>
+ Incremental search backward
+ </td>
+ </tr>
+ <tr>
+ <td>
+ SEARCH_NEXT
+ </td>
+ <td>
+ n
+ </td>
+ <td>
+ n
+ </td>
+ <td>
+ Continue search forward
+ </td>
+ </tr>
+ <tr>
+ <td>
+ SEARCH_PREV
+ </td>
+ <td>
+ N
+ </td>
+ <td>
+ </td>
+ <td>
+ Continue search backward
+ </td>
+ </tr>
+ <tr>
+ <td>
+ WRAP_TOGGLE
+ </td>
+ <td>
+ C-w
+ </td>
+ <td>
+ w
+ </td>
+ <td>
+ Toggle wrapping mode in searches
+ </td>
+ </tr>
+<!-- </table>-->
+ <tr>
+ <td colspan="4">
+ <h3>Mark Management</h3>
+ </td>
+ </tr>
+<!-- <table>-->
+ <tr>
+ <td>
+ MARK
+ </td>
+ <td>
+ C-SPC
+ </td>
+ <td>
+ C-SPC
+ </td>
+ <td>
+ Set/unset mark
+ </td>
+ </tr>
+ <tr>
+ <td>
+ PREV_MARK
+ </td>
+ <td>
+ M-p
+ </td>
+ <td>
+ P
+ </td>
+ <td>
+ Go to the previous mark
+ </td>
+ </tr>
+ <tr>
+ <td>
+ NEXT_MARK
+ </td>
+ <td>
+ M-n
+ </td>
+ <td>
+ N
+ </td>
+ <td>
+ Go to the next mark
+ </td>
+ </tr>
+ <tr>
+ <td>
+ REG_MARK
+ </td>
+ <td>
+ "
+ </td>
+ <td>
+ "
+ </td>
+ <td>
+ Mark all occurrences of a pattern
+ </td>
+ </tr>
+<!-- </table>-->
+ <tr>
+ <td colspan="4">
+ <h3>Miscellaneous</h3>
+ </td>
+ </tr>
+<!-- <table>-->
+ <tr>
+ <td>
+ COMMAND
+ </td>
+ <td>
+ M-c
+ </td>
+ <td>
+ M-c
+ </td>
+ <td>
+ Invoke one or more semicolon-separated w3m functions
+ </td>
+ </tr>
+<!--
+TODO: Where does this key binding M-Fn come from. I do not find a Fn-key on my keyboard. I do not know how to type in the keystroke combinations listed in keymap.default which are
+keymap M-[E MENU
+keymap M-[L MENU
+keymap M-[2~ MENU
+keymap M-[28~ MENU
+<tr>
+<td>MENU</td>
+<Td>M-Fn</Td>
+<td></td>
+<td>Pop up menu</td>
+</tr>
+-->
+ <tr>
+ <td>
+ HELP
+ </td>
+ <td>
+ H
+ </td>
+ <td>
+ H, ?
+ </td>
+ <td>
+ Show help panel
+ </td>
+ </tr>
+ <tr>
+ <td>
+ OPTIONS
+ </td>
+ <td>
+ o
+ </td>
+ <td>
+ o
+ </td>
+ <td>
+ Display options setting panel
+ </td>
+ </tr>
+<tr>
+<td>SET_OPTION</td>
+<td>M-o</td>
+<td>M-o</td>
+<td>Set option</td>
+</tr>
+<tr>
+<td>DEFINE_KEY</td>
+<td>M-k</td>
+<td>M-k</td>
+<td>Define a binding between a key stroke combination and a command</td>
+</tr>
+<tr>
+<td>MOUSE_TOGGLE</td>
+<td>m</td>
+<td>m</td>
+<td>Toggle mouse support</td>
+</tr>
+<tr>
+<td>DOWNLOAD_LIST</td>
+<td>D</td>
+<td>D</td>
+<td>Display downloads panel</td>
+</tr>
+ <tr>
+ <td>
+ COOKIE
+ </td>
+ <td>
+ C-k
+ </td>
+ <td>
+ C-k
+ </td>
+ <td>
+ Show cookie jar
+ </td>
+ </tr>
+<!--
+mh 2016-06-12 Interrupt is an alias to SUSPEND, no need to mention it here
+ <tr>
+ <td>
+ INTERRUPT
+ </td>
+ <td>
+ C-c
+ </td>
+ <td>
+ C-c
+ </td>
+ <td>
+ Interrupt
+ </td>
+ </tr>
+-->
+<tr>
+<td>UNDO</td>
+<td>(</td>
+<td>(</td>
+<td>Cancel the last cursor movement</td>
+</tr>
+<tr>
+<td>REDO</td>
+<td>)</td>
+<td>)</td>
+<td>Cancel the last undo</td>
+</tr>
+ <tr>
+ <td>
+ EXEC_SHELL <!-- is an alias of SHELL -->
+ </td>
+ <td>
+ !
+ </td>
+ <td>
+ !
+ </td>
+ <td>
+ Execute shell command
+ </td>
+ </tr>
+<tr>
+<td>DICT_WORD</td>
+<td>M-w</td>
+<td>M-w</td>
+<td>Execute dictionary command (see <a href="README.dict">README.dict</a>)</td>
+</tr>
+<tr>
+<td>DICT_WORD_AT</td>
+<td>M-W</td>
+<td>M-W</td>
+<td>Execute dictionary command for word at cursor</td>
+</tr>
+<tr>
+<td>VERSION</td>
+<td>r</td>
+<td>r</td>
+<td>Display the version of w3m</td>
+</tr>
+ <tr>
+ <td>
+ SUSPEND
+ </td>
+ <td>
+ C-z
+ </td>
+ <td>
+ C-z
+ </td>
+ <td>
+ Suspend w3m to background. (To be withdrawn with shell
+ command <span class="mono">fg</span>.)
+ </td>
+ </tr>
+ <tr>
+ <td>
+ QUIT
+ </td>
+ <td>
+ q
+ </td>
+ <td>
+ q
+ </td>
+ <td>
+ Quit with confirmation request
+ </td>
+ </tr>
+ <tr>
+ <td>
+ EXIT
+ </td>
+ <td>
+ Q
+ </td>
+ <td>
+ Q
+ </td>
+ <td>
+ Quit at once
+ </td>
+ </tr>
+ </table>
-<hr>
-<a name="LocalCGI"></a>
-<h2>Local CGI</h2>
-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
-<a href="file:///$LIB/w3mbookmark?mode=panel&bmark=~/.w3m/bookmark.html&url=MANUAL.html&title=w3m+manual">bookmark registration</a>
-and <a href="file:///$LIB/w3mhelperpanel?mode=panel">helper-app editor</a>
-are realized as local CGI scripts.
-Using local CGI, w3m can be used as a general purpose form interface.
-<P>
-For security reason, CGI scripts invoked by w3m must be in one of
-these directories.
-<ul>
-<li>The directory where w3m-related files are stored
-(typically /usr/local/lib/w3m). This directory can be referred
-as $LIB.
-<li>/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:
+ <p>
+ 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.
+ </p>
+
+ <table border="1" width="100%">
+ <colgroup>
+ <col width="20%">
+ <col width="40%">
+ <col width="40%">
+ </colgroup>
+ <tr>
+ <th>
+ Function<br>(internal name)
+ </th>
+ <th>Key binding
+ </th>
+ <th>
+ Description
+ </th>
+ </tr>
+ <tr>
+ <td colspan="3">
+ <h3>Menu Selection Mode</h3>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ BUF:NEXT</td>
+ <td>
+ j, C-n, DOWN
+ </td>
+ <td>
+ Next item
+ </td>
+ </tr>
+ <tr>
+ <td>BUF:PREV
+ </td>
+ <td>
+ k, C-p, UP
+ </td>
+ <td>
+ Previous item
+ </td>
+ </tr>
+ <tr>
+ <td>
+ BUF:DELETE</td>
+ <td>
+ D
+ </td>
+ <td>
+ Delete item
+ </td>
+ </tr>
+ <tr>
+ <td>
+ BUF:GO
+ </td>
+ <td>
+ SPC, RET, RIGHT
+ </td>
+ <td>
+ Select item
+ </td>
+ </tr>
+<!-- </table>-->
+ <tr>
+ <td colspan="3">
+ <h3>Popup Menu Mode</h3>
+ </td>
+ </tr>
+<!-- <table>-->
+ <tr>
+ <td>
+MENU:SELECT
+ </td>
+ <td>
+ SPC, RET, RIGHT</td>
+ <td>
+ Select
+ </td>
+ </tr>
+ <tr>
+ <td>
+MENU:CLOSE
+ </td>
+ <td>C-c
+ </td>
+ <td>
+ Close menu
+ </td>
+ </tr>
+ <tr>
+ <td>
+MENU:CANCEL
+ </td>
+ <td>
+ LEFT, BKSPC, C-h</td>
+ <td>
+ One selection step backward
+ </td>
+ </tr>
+ <tr>
+ <td>
+MENU:DOWN
+ </td>
+ <td>j, C-n, DOWN
+ </td>
+ <td>
+ Move to the next item
+ </td>
+ </tr>
+ <tr>
+ <td>
+MENU:UP
+ </td>
+ <td>
+ k, C-p, UP</td>
+ <td>
+ Move to the previous item
+ </td>
+ </tr>
+ <tr>
+ <td>
+MENU:LINE_UP
+ </td>
+ <td>K
+ </td>
+ <td>
+ Scroll up one item
+ </td>
+ </tr>
+ <tr>
+ <td>
+MENU:LINE_DOWN
+ </td>
+ <td>J
+ </td>
+ <td>
+ Scroll down one item
+ </td>
+ </tr>
+ <tr>
+ <td>
+MENU:TOP
+ </td>
+ <td>C-a
+ </td>
+ <td>
+ Move to the first item
+ </td>
+ </tr>
+ <tr>
+ <td>
+MENU:LAST
+ </td>
+ <td>C-e
+ </td>
+ <td>
+ Move to the final item
+ </td>
+ </tr>
+ <tr>
+ <td>
+MENU:NEXT
+ </td>
+ <td>C-v, C-f
+ </td>
+ <td>Go to the next page
+ </td>
+ </tr>
+ <tr>
+ <td>
+MENU:PREV
+ </td>
+ <td>ESC v, C-b
+ </td>
+ <td>
+ Go to the previous page
+ </td>
+ </tr>
+ <tr>
+ <td>
+MENU:SEARCH_FORE
+ </td>
+ <td>C-s, /
+ </td>
+ <td>
+ Search forward
+ </td>
+ </tr>
+ <tr>
+ <td>
+MENU:SEARCH_BACK
+ </td>
+ <td>
+ C-r, ?</td>
+ <td>
+ Search backward
+ </td>
+ </tr>
+ <tr>
+ <td>
+MENU:SEARCH_NEXT
+ </td>
+ <td>
+ n</td>
+ <td>
+ Search for the next match</td>
+ </tr>
+ <tr>
+ <td>
+MENU:SEARCH_PREV
+ </td>
+ <td>
+ N</td>
+ <td>
+ Search for the previous match</td>
+ </tr>
+<!--mh 2016-06-12 Pressing C-z in menu mode (with menu active) has the same effect as in normal operation of w3m: Browser gets in the background
+ <tr>
+ <td>
+MENU:SUSPEND
+ </td>
+ <td>
+ C-z</td>
+ <td>
+ Suspend</td>
+ </tr>
+-->
+<!-- </table>-->
+ <tr>
+ <td colspan="3">
+ <h3>Line-editing Mode</h3>
+ </td>
+ </tr>
+<!-- <table>-->
+ <tr>
+ <td>
+ LINEEDIT:FORWARD
+ </td>
+ <td width="100">
+ C-f, RIGHT
+ </td>
+ <td>
+ Move cursor forward
+ </td>
+ </tr>
+ <tr>
+ <td>
+LINEEDIT:BACK
+ </td>
+ <td>
+ C-b, LEFT
+ </td>
+ <td>
+ Move cursor backward
+ </td>
+ </tr>
+ <tr>
+ <td>
+LINEEDIT:BS
+ </td>
+ <td>
+ C-h, BKSPC
+ </td>
+ <td>
+ Delete previous character
+ </td>
+ </tr>
+ <tr>
+ <td>
+LINEEDIT:DEL
+ </td>
+ <td>
+ C-d
+ </td>
+ <td>
+ Delete current character
+ </td>
+ </tr>
+ <tr>
+ <td>
+LINEEDIT:KILL_AFTER
+ </td>
+ <td>
+ C-k
+ </td>
+ <td>
+ Delete everything after cursor
+ </td>
+ </tr>
+ <tr>
+ <td>
+LINEEDIT:KILL_BEFORE
+ </td>
+ <td>
+ C-u
+ </td>
+ <td>
+ Delete everything before cursor
+ </td>
+ </tr>
+ <tr>
+ <td>
+LINEEDIT:TOP
+ </td>
+ <td>
+ C-a
+ </td>
+ <td>
+ Move to the beginning of the line
+ </td>
+ </tr>
+ <tr>
+ <td>
+LINEEDIT:BOTTOM
+ </td>
+ <td>
+ C-e
+ </td>
+ <td>
+ Move to the end of the line
+ </td>
+ </tr>
+ <tr>
+ <td>
+LINEEDIT:PREV
+ </td>
+ <td>
+ C-p, UP
+ </td>
+ <td>
+ Fetch the previous string from the history list
+ </td>
+ </tr>
+ <tr>
+ <td>
+LINEEDIT:NEXT
+ </td>
+ <td>
+ C-n, DOWN
+ </td>
+ <td>
+ Fetch the next string from the history list
+ </td>
+ </tr>
+ <tr>
+ <td>
+LINEEDIT:COMPLETE
+ </td>
+ <td>
+ TAB, SPC
+ </td>
+ <td>
+ Try to complete filename
+ </td>
+ </tr>
+ <tr>
+ <td>
+LINEEDIT:EDITOR
+ </td>
+ <td>
+ C-o
+ </td>
+ <td>
+ Edit with external editor
+ </td>
+ </tr>
+ <tr>
+ <td>
+LINEEDIT:ACCEPT
+ </td>
+ <td>
+ RET
+ </td>
+ <td>
+ Accept input line
+ </td>
+ </tr>
+ </table>
+<!-- mh 2016-06-12 As it suffices to use the provided keymap file for Lynx-like keybindings and this file is listed in section FILES of man w3m (1), the following hint for getting w3m with Lynx-like key bindings has been deleted.
+ <p>
+ If w3m was compiled with <q>Lynx-like key bindings</q>, you can use
+ the following key bindings.
+ </p>
+-->
+<!-- mh 2016-06-12 Remark is obsolete as the two sets key binding are presented along within tables
+ <hr>
+ <h2 id="Key:lynx">
+ <p>
+ The Lynx-like configuration leaves keymappings unchanged in the
+ menu-selection and line-editing modes.
+ </p>
+ </h2>
+-->
+ <hr>
+ <h2 id="Mouse">
+ Mouse Operation
+ </h2>
+ <p>
+ 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 <q>xterm</q> or <q>kterm</q>).
+ </p>
+ <p>An introduction to configure mouse actions is provided
+ with <a href="README.mouse">README.mouse</a>.
+ </p>
+ <table border="1">
+ <colgroup>
+ <col width="20%">
+ <col width="80%">
+ </colgroup>
+ <tr>
+ <th>Operation
+ </th>
+ <th>Description
+ </th>
+ </tr>
+ <tr>
+ <td>
+ left click
+ </td>
+ <td>
+<b>First:</b><br>
+Moves the cursor to the place indicated by the mouse pointer.<br>
+<b>Then:</b><br>
+Follows a hyperlink the cursor is currently located and the mouse points to.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ middle click
+ </td>
+ <td>
+ Back to the previous buffer.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ right click
+ </td>
+ <td>
+ Open pop-up menu. You can choose an item by clicking it.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ left drag
+ </td>
+ <td>
+ 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.
+ </td>
+ </tr>
+ </table>
+ <hr>
+ <h2 id="LocalCGI">
+ Local CGI scripts
+ </h2>
+ <p>
+ 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.
+ </p>
+ <p>
+ For security reason, CGI scripts invoked by w3m must be in one of
+ the following directories:
+ </p>
+ <ul>
+ <li>
+ The directory where w3m-related files are stored (typically
+ /usr/local/lib/w3m). This directory can be referenced as $LIB.
+ </li>
+ <li>
+ The /cgi-bin/ directory. You can map /cgi-bin/ to any directory you
+ like in the options setting panel (the <q>Directory corresponds to
+ /cgi-bin</q> field). You can specify multiple paths separated by
+ <q>:</q>, 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:
+ </li>
<pre>
w3m -o cgi_bin=/path/to/cgi-bin file:/cgi-bin/script.cgi
</pre>
-It is not recommended to include current directory to this path.
-</ul>
-<p>
-The CGI script can use special header `w3m-control:' to control w3m.
-This field can take any function (see <a href="README.func">README.func</a>),
-and the specified function is invoked after the document is displayed.
-For example, The CGI output
+ </ul>
+ <p>
+ The CGI script can use the special header
+ <span class="mono">w3m-control:</span> to
+ control w3m. This field can take any function (see
+ <a href="README.func">README.func</a>), and the specified function
+ is invoked after the document is displayed. For example, the CGI
+ output
+ </p>
<pre>
-
Content-Type: text/plain
W3m-control: BACK
-
</pre>
-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
+ <p>
+ 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
+ </p>
<pre>
-
Content-Type: text/plain
W3m-control: DELETE_PREVBUF
-
contents.....
</pre>
-will override the current buffer.
-<p>
-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:
+ <p>
+ will override the current buffer.
+ </p>
+ <p>
+ Each header <span class="mono">w3m-control:</span> can
+ contain only one function, but you can
+ include more than one <span class="mono">w3m-control:</span>
+ line in the HTTP header.
+ In addition, you can specify an argument to the GOTO function:
+ </p>
<pre>
-
Content-Type: text/plain
-W3m-control: GOTO http://www.yahoo.com/
-
+W3m-control: GOTO http://www.example.org/
</pre>
-This example works exactly the same way to the Location header:
+ <p>
+ This example works exactly the same way as the Location header:
+ </p>
<pre>
-
Content-Type: text/plain
-Location: http://www.yahoo.com/
-
+Location: http://www.example.org/
</pre>
-Note that this header has no effect when the CGI script is invoked
-through HTTP server.
-
-</body>
+ <p>
+ Note that this header has no effect when the CGI script is invoked
+ through an HTTP server.
+ </p>
+ </body>
</html>
generated by cgit v1.2.3 (git 2.25.1) at 2025-10-31 10:25:51 +0000