diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/FAQ.html | 1040 | ||||
| -rw-r--r-- | doc/HISTORY | 12 | ||||
| -rw-r--r-- | doc/MANUAL.html | 2902 | ||||
| -rw-r--r-- | doc/README | 11 | ||||
| -rw-r--r-- | doc/README.cookie | 18 | ||||
| -rw-r--r-- | doc/README.dict | 10 | ||||
| -rw-r--r-- | doc/README.func | 257 | ||||
| -rw-r--r-- | doc/README.img | 20 | ||||
| -rw-r--r-- | doc/README.m17n | 2 | ||||
| -rw-r--r-- | doc/README.pre_form | 24 | ||||
| -rw-r--r-- | doc/README.siteconf | 73 | ||||
| -rw-r--r-- | doc/README.sixel | 27 | ||||
| -rw-r--r-- | doc/README.tab | 2 | ||||
| -rw-r--r-- | doc/keymap.default | 1 | ||||
| -rw-r--r-- | doc/keymap.lynx | 2 | ||||
| -rw-r--r-- | doc/menu.submenu | 2 | ||||
| -rw-r--r-- | doc/w3m.1 | 421 | 
17 files changed, 3682 insertions, 1142 deletions
| 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 @@ -<HTML> -<HEAD> -<TITLE>W3M FAQ</TITLE> -</HEAD> -<BODY> -<p>  -<center><h1>Frequently Asked Questions and Answers about w3m</h1></center> -<div align=right> -Akinori Ito<br> -aito@fw.ipsj.or.jp<br> -Corrected by Tom Berger <tom.be@gmx.net> -</div> -<p> -<b><center><font size=+1><u><a name="index">Index</a></u></font></center></b> -<p> -<br> -<ul> -<li><h2><a href="#general">General Questions, How to Get It, Required Environment</a></h2></li> -<ul> -<li><h3>How do I pronounce "w3m"?</h3> -<li><h3>Why is it called "w3m"?</h3> -<li><h3>On which platforms does w3m work?</h3> -<li><h3>Where can I get more information about w3m?</h3> -<li><h3>Is there a mailing list for w3m?</h3> -<li><h3>Are there any binary distributions?</h3> -</ul> -<br> -<li><a href="#install"><h2>Compile and Install</h2></a> -<br> -<li><a href="#command"><h2>Options, Commands, Usage</h2></a> -<ul> -<li><h3>w3m quits if started without parameters. What's wrong?</h3> -<li><h3>w3m starts with black characters on a black screen. How do I change this?</h3> -<li><h3>Does w3m support colours?</h3> -<li><h3>Does w3m support monochrome display?</h3> -<li><h3>How do I shift the display?</h3> -<li><h3>How do I move from anchor to anchor?</h3> -<li><h3>Netscape displays a word red, but w3m doesn't. Why?</h3> -<li><h3>How do I change the colour of anchor-/image-/form links?</h3> -<li><h3>w3m doesn't seem to use the variable EDITOR. Why? </h3> -<li><h3>How do I quit a search or URL text input?</h3> -</ul> -<br> -<li><a href="#www"><h2>Questions about WWW usage</h2></a> -<ul> -<li><h3>How do I fill in forms with w3m?</h3> -<li><h3>Seems like w3m is slower than Netscape or Lynx. Why?</h3> -<li><h3>Loading time doesn't decrease when loading a previously seen page</h3> -<li><h3>How do I download a linked file?</h3> -<li><h3>How do I specify a proxy server?</h3> -<li><h3>w3m freezes when I invoke an external browser.</h3> -<li><h3>How do I change the default image viewer?</h3> -<li><h3>How do I enter a URL?</h3> -<li><h3>w3m appends a URL to the former one despite of having cleared the line with Ctrl-u. What to do?</h3> -</ul> -<br> -<li><a href="#other"><h2>Misc</a></h2> -<ul> -<li><h3>What is w3m's configuration file?</h3> -<li><h3>What are these w3mxxxx files in my ~/.w3m directory for?</h3> -</ul> -<br>  -<br> -<u><h2><a name="general">General Questions, How to Get It, Required Environment</a></h2></u> -<br> -<dl> -<dt><h3>How do I pronounce "w3m"?</h3> -<dd>It's "W-three-M". It doesn't rhyme with "pteranodon". -<p> -<dt><h3>Why is it called "w3m"?</h3> -<dd>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". -<p> -<dt><h3>On which platforms does w3m work?</h3> -<dd>It runs on various versions of Unix, since version 990226 on OS/2 and since -version 990303 also on MS-Windows with Cygwin32. -<br> -Current versions have been confirmed to run on: -<ul> -<li>SunOS 4.1.x -<li>HP-UX 9.x, 10.x -<li>Solaris 2.5.x, 2.6, 8 -<li>Linux 2.0.30 -<li>FreeBSD 2.2.8, 3.1, 3.2, 4.6 -<li>NetBSD/macppc, m68k -<li>EWS4800 Rel.12.2 Rev.A -<li>Digital UNIX: v3.2D, v4.0D -<li>IRIX 5.3, IRIX 6.5 -<li>OS/2 with emx -<li>Windows 9x/NT with Cygwin32 b20.1 -<li>MS-DOS with DJGPP and WATT32 packet driver -<li>MacOS X Server -<li>MacOS X 10.1, 10.2 -</ul> -<dt><h3>Where can I get more information about w3m?</h3> -<dd>At the <a href="http://w3m.sourceforge.net/index.en.html">English w3m home page</a>. -<dt><h3>Is there a mailing list for w3m?</h3> -<dd>There is a mailing list for developpers (w3m-dev-en). Please see -<a href="http://w3m.sourceforge.net/index.en.html">w3m page</a> -for details. You may also mail your comments to <a href="mailto:aito@fw.ipsj.or.jp">the author</a>. -<dt><h3>Are there any binary distributions?</h3> -<dd>So far there are only binaries for the win/cygnus32 version. You can get -them from <a href="http://prdownloads.sourceforge.net/w3m/">here</a>. -Contact <a href="mailto:aito@fw.ipsj.or.jp">the author</a> if you want to contribute binaries for other platforms. -</dd> -</dl> -<br> -<div align=right> -<i>Up to <a href="#index">index</a></i> -</div> -<br> -<u><h2><a name="install">Compile and Install</a></h2></u> -No problem :-) -<u><h2><a name="command">Options, Commands, Usage</a></h2></u> -<br> -<dl> -<dt><h3>w3m quits if started without parameters. What's wrong?</h3> -<dd>w3m is a <b>pager</b>. Therefore it just quits when invoked without any -arguments. Possible arguments are: -<ol> -<li>A filename or an URL -<li>Pipe from standard input -<li>The -B option (Show bookmark file) -<li>The -v option (visual startup) -<li>From a specified HTTP_HOME or WWW_HOME variable -</ol> -<p> -<dt><h3>w3m starts with black characters on black background. How do I change -this?</h3> -<dd> -When compiled with colour support, w3m assumes a white background and therefore -displays black characters.  -<br> -You may either change the background colour of your terminal (e.g. with the -bg -option in a xterm) or take these steps: -<ul> -<li>invoke w3m with 'w3m -M' (for monochrome), -<li>type 'o' for getting to the options screen -<li><b>Mark 'Display with colour' as ON</b> and choose an arbitrary colour. -Click on [OK]. -</ul> -<p> -<dt><h3>Does w3m support colours?</h3> -<dd>Yes. When you run './configure', answer the question -<p> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> + <head> +   <style> +      span.mono { +        font-family:mono; +      } +    </style> +   <meta http-equiv=content-type content="text/html;charset=US-ASCII"> +  <title>W3M FAQ</title> + </head> + <body> +  <h1 align="center"> +   Frequently Asked Questions and Answers about w3m +  </h1> +  <p align="right"> +   Akinori Ito  <aito@fw.ipsj.or.jp><br> +   Corrected by Tom Berger <tom.be@gmx.net> +  </p> +  <h2 id="index"> +   <u> +    Index +   </u> +  </h2> +  <ul> +   <li> +    <a href="#general"> +     <b> +      General Questions, How to Get It, Required Environment +     </b> +    </a> +   </li> +    <ul> +     <li> +      <b> +       How do I pronounce <q>w3m</q>? +      </b> +     </li> +     <li> +      <b> +       Why is it called <q>w3m</q>? +      </b> +     </li> +     <li> +      <b> +       On which platforms does w3m work? +      </b> +     </li> +     <li> +      <b> +       Where can I get more information about w3m? +      </b> +     </li> +     <li> +      <b> +       Is there a mailing list for w3m? +      </b> +     </li> +     <li> +      <b> +       Are there any binary distributions? +      </b> +     </li> +    </ul> +   <li> +    <a href="#install"> +     <b> +      Compile and Install +     </b> +    </a> +   </li> +   <li> +    <a href="#command"> +     <b> +      Options, Commands, Usage +     </b> +    </a> +   </li> +    <ul> +     <li> +      <b> +       w3m quits if started without parameters. What's wrong? +      </b> +     </li> +     <li> +      <b> +       w3m starts with black characters on a black background. How do +       I change this? +      </b> +     </li> +     <li> +      <b> +       Does w3m support colors? +      </b> +     </li> +     <li> +      <b> +       Does w3m support monochrome displays? +      </b> +     </li> +     <li> +      <b> +       How do I shift the display? +      </b> +     </li> +     <li> +      <b> +       How do I move between hyperlinks? +      </b> +     </li> +     <li> +      <b> +       Graphical browsers display a word red, but w3m doesn't. Why? +      </b> +     </li> +     <li> +      <b> +        How do I change the colors for hyperlinks, images and form fields? +      </b> +     </li> +     <li> +      <b> +       w3m doesn't seem to use the variable EDITOR. Why? +      </b> +     </li> +     <li> +      <b> +       How do I quit a search or URL text input? +      </b> +     </li> +    </ul> +   <li> +    <a href="#www"> +     <b> +      Questions about WWW usage +     </b> +    </a> +   </li> +    <ul> +     <li> +      <b> +       How do I fill in forms with w3m? +      </b> +     </li> +     <li> +      <b> +       Seems like w3m is slower than some other browsers. Why? +      </b> +     </li> +     <li> +      <b> +       Loading time doesn't decrease when loading a previously seen +       page. +      </b> +     </li> +     <li> +      <b> +       How do I download a linked file? +      </b> +     </li> +     <li> +      <b> +       How do I specify a proxy server? +      </b> +     </li> +<!-- deleted, see mail dated Mon, 04 Apr 2016 20:50:27 +0900 (JST) +from Tatsuya Kinoshita <tats@debian.org> +     <li> +      <b> +       w3m freezes when I invoke an external browser. +      </b> +     </li> +--> +     <li> +      <b> +       How do I change the default image viewer? +      </b> +     </li> +     <li> +      <b> +       How do I enter a URL? +      </b> +     </li> +     <li> +       <b> +	 w3m appends a URL to the former one even when I clear the line +     with <span class="mono">CTRL-u</span>. What should I do? +      </b> +     </li> +    </ul> +   <li> +    <a href="#other"> +     <b> +      Miscellaneous +     </b> +    </a> +   </li> +    <ul> +     <li> +      <b> +       What is w3m's configuration file? +      </b> +     </li> +     <li> +      <b> +       What are these w3mxxxx files in my ~/.w3m directory for? +      </b> +     </li> +    </ul> +  </ul> +  <h2 id="general"> +   <u> +    General Questions, How to Get It, Required Environment +   </u> +  </h2> +  <dl> +   <dt> +    <b> +     How do I pronounce <q>w3m</q>? +    </b> +   </dt> +   <dd> +    <p> +     It's <q>W-three-M</q>. It doesn't rhyme with <q>pteranodon</q>. +    </p> +   </dd> +   <dt> +    <b> +     Why is it called <q>w3m</q>? +    </b> +   </dt> +   <dd> +    <p> +     It's an abbreviation of <q>WWW-wo-Miru</q>, which is Japanese +     for <q>See the WWW</q>. So in English the name of this browser +     would be something like <q>stw3</q>. +    </p> +   </dd> +   <dt> +    <b> +     On which platforms does w3m work? +    </b> +   </dt> +   <dd> +    <p> +     It runs on various versions of Unix, since version 990226 on OS/2 +     and since version 990303 also on MS-Windows with Cygwin32. +    </p> +    <p> +     More recent versions have been confirmed to run on: +    </p> +    <ul> +     <li> +      SunOS 4.1.x +     </li> +     <li> +      HP-UX 9.x, 10.x +     </li> +     <li> +      Solaris 2.5.x, 2.6, 8 +     </li> +     <li> +      Linux 2.0.1 to 3.17 +     </li> +     <li> +      FreeBSD 2.2.8, 3.1, 3.2, 4.6 +     </li> +     <li> +      NetBSD/macppc, m68k +     </li> +     <li> +      EWS4800 Rel.12.2 Rev.A +     </li> +     <li> +      Digital UNIX: v3.2D, v4.0D +     </li> +     <li> +      IRIX 5.3, IRIX 6.5 +     </li> +     <li> +      OS/2 with emx +      </li> +     <li> +      Windows 9x/NT with Cygwin32 b20.1 +     </li> +     <li> +      MS-DOS with DJGPP and WATT32 packet driver +     </li> +     <li> +      MacOS X Server +     </li> +     <li> +      MacOS X 10.1, 10.2 +     </li> +    </ul> +   </dd> +   <dt> +    <b> +     Where can I get more information about w3m? +    </b> +   </dt> +   <dd> +    <p> +     At the +     <a href="http://w3m.sourceforge.net/index.en.html">English w3m +     home page</a>. +    </p> +   </dd> +   <dt> +    <b> +     Is there a mailing list for w3m? +    </b> +   </dt> +   <dd> +    <p> +     There is a mailing list for developers (w3m-dev-en). Please see +     the <a href="http://w3m.sourceforge.net/index.en.html">w3m home +     page</a> for details. You may also mail your comments to +     <a href="mailto:aito@fw.ipsj.or.jp">the author</a>. +    </p> +   </dd> +   <dt> +    <b> +     Are there any binary distributions? +    </b> +   </dt> +   <dd> +    <p> +     So far there are only binaries for the win/cygnus32 version. +<!-- +     You can get them from +     <a href="http://prdownloads.sourceforge.net/w3m/">here</a>. +!--> +     Contact <a href="mailto:aito@fw.ipsj.or.jp">the author</a> if you +     want to contribute binaries for other platforms. +    </p> +   </dd> +  </dl> +  <p align="right"> +   <i> +    Up to <a href="#index">index</a> +   </i> +  </p> +  <h2 id="install"> +   <u> +    Compile and Install +   </u> +  </h2> +  <p> +   No problem :-) +  </p> +  <h2 id="command"> +   <u> +    Options, Commands, Usage +   </u> +  </h2> +  <dl> +   <dt> +    <b> +     w3m quits if started without parameters. What's wrong? +    </b> +   </dt> +   <dd> +    <p> +     w3m is a <b>pager</b>. Therefore it just quits when invoked +     without any arguments. It keeps running  +    </p> +    <ul> +     <li> +      with a filename or URL as argument +     </li> +     <li> +      with data piped from standard input +     </li> +     <li> +      when invoked with option -B to show the bookmark file +     </li> +     <li> +      when invoked with option -v to welcome users with a built-in page +     </li> +     <li> +      with specified HTTP_HOME or WWW_HOME variable +     </li> +    </ul> +   </dd> +   <dt> +    <b> +     w3m starts with black characters on a black background. How do I +     change this? +    </b> +   </dt> +   <dd> +    <p> +     When compiled with color support, w3m assumes a white background +     and therefore displays black characters. +    </p> +    <p> +     You may either change the background color of your terminal +     (e.g. with the -bg option in a xterm) or take these steps +    </p> +    <ol> +     <li> +      invoke monochrome mode of w3m with <span class="mono">w3m -M</span> +     </li> +     <li> +      type <q>o</q> to get to the options setting panel +     </li> +     <li> +      mark <q>Display with color</q> as <q>YES</q> and choose an +      arbitrary color +     </li> +     <li> +      click on [OK]. +     </li> +    </ol> +   </dd> +   <dt> +    <b> +     Does w3m support colors? +    </b> +   </dt> +   <dd> +    <p> +     Yes. When you run <q>./configure</q>, answer the question +    </p>  <pre> -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?  </pre> -<p> -with 2,3,4 or 5. -<p> -<dt><h3>Does w3m support monochrome display?</h3> -<dd>Yes. You may either -<ol> -<li>Answer the above mentioned 'configure' question with 1, or -<li>Invoke w3m with the -M option, or -<li>Type 'o' within w3m to enter the options screen and turn off colour display -mode. -</ol> -<dt><h3>How do I shift the display?</h3> -<dd>You can shift the display by moving the cursor to the edge of the screen. You -may also use the ">"/"<" or "."/"," keys. -<br> -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'). -<dt><h3>How do I move from anchor to anchor?</h3> -<dd>You can move to the next anchor using TAB. ESC TAB moves cursor to the previous anchor. -<p> -<dt><h3>Netscape displays a word red, but w3m doesn't. Why?</h3> -<dd>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. -<p> -<dt><h3>How do I change the colour of anchor-/image-/form links?</h3> -<dd>Type 'o' within w3m to get the 'options' screen. You can change these -settings there. -<dt> -<dt><h3>w3m doesn't seem to use the variable EDITOR. Why? </h3> -<dd><dd>Go to the 'options' screen using the "o" key. Any entry in the 'Editor' field will override the environment variable. -<br> -If you want to use the editor specified by EDITOR blank the field and push [OK]. -<p> -<dt><h3>How do I quit a search or URL text input?</h3> -<dd>Clear input text using Ctrl-u and hit RETURN. -</dd> -</dl> -<br> -<div align=right> -<i>Up to <a href="#index">index</a></i> -</div> -<br> -<u><h2><a name="www">Questions about WWW usage</a></h2></u> -<br> -<dl> -<dt><h3>How do I fill in forms with w3m?</h3> -<dd>Form input fields are displayed in red (or reverse). Move the cursor to -them and hit RETURN. Then, -<ul> -<li>if it is a text input field, put in your text on the bottom line, -<li>if it is a radiobutton or checkbox, that item is selected, -<li>if it is a textarea, an editor is spawned, -<li>if it is 'submit' or 'reset', well, just do it. -</ul> -<dt><h3>Seems like w3m is slower than Netscape or Lynx. Why?</h3> -<dd>w3m renders a HTML document in two passes. Therefore it displays the documentnot before having read the entire document. -<br> -Netscape or Lynx display the document before having read the whole page, -and therefore seem faster. -<p> -<dt><h3>Loading time doesn't decrease when loading a previously seen page</h3> -<dd>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.  -<p> -<dt><h3>How do I download a linked file?</h3> -<dd>Use 'a' (or 'd' with Lynx-like keybindings) or ESC RET. If you want to download an inline image, use ESC 'I'. -<p> -<dt><h3>How do I specify a proxy server?</h3> -<dd>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 -<p> -<pre> -    http://proxy.hogege.com:8000/ -</pre> -<p> -<dt><h3>w3m freezes when I invoke an external browser.</h3> -<dd>Enter w3m's option screen using the 'o' key and specify -<p> -<pre> -    netscape %s & -</pre> -<p> -(if you are using netscape). -<p> -<dt><h3>How do I change the default image viewer?</h3> -<dd>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. -<p> +    <p> +     with 2, 3, 4, or 5. +    </p> +   </dd> +   <dt> +    <b> +     Does w3m support monochrome displays? +    </b> +   </dt> +   <dd> +    <p> +     Yes. You may either +    </p> +    <ul> +     <li> +      Answer the above-mentioned <q>configure</q> question with 1, +      or +     </li> +     <li> +      Invoke w3m with the -M option, or +     </li> +     <li> +      Type <q>o</q> within w3m to enter the options setting panel and turn +      off color display mode. +     </li> +    </ul> +   </dd> +   <dt> +    <b> +     How do I shift the display? +    </b> +   </dt> +   <dd> +    <p> +     You can shift the display by moving the cursor to the edge of +     the screen. You may also use the following commands +    </p> +     <ul> +       <li>SHIFT_LEFT and SHIFT_RIGHT, bound to the keys <span class="mono">></span> and <span class="mono"><</span></li> +       <li>SHIFT_LEFT1 and SHIFT_RIGHT1, bound to the keys <span class="mono">.</span> and <span class="mono">,</span></li> +     </ul> +    <p> +     Another idea would be adjusting the xterm with the -geometry +     option e.g. something like +    </p> +     <pre>  xterm -geometry 110x45 -bg white -name w3m -e w3m -B</pre> +   </dd> +   <dt> +    <b> +     How do I move between hyperlinks? +    </b> +   </dt> +   <dd> +    <p> + +      You can move to the next hyperlink +     using <span class="mono">TAB</span>. <span class="mono">ESC +     TAB</span> moves the cursor to the previous hyperlink. (see +     Section <a href="MANUAL.html#Functions" target="_blank"> +     Functions and Key bindings</a> of w3m's manual) + +    </p> +   </dd> +   <dt> +    <b> +     Graphical browsers display a word red, but w3m doesn't. Why? +    </b> +   </dt> +   <dd> +    <p> +     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. +    </p> +   </dd> +   <dt> +    <b> +     How do I change the colors for hyperlinks, images and form fields? +    </b> +   </dt> +   <dd> +    <p> +     Type <q>o</q> within w3m to get the options panel. You +     can change these settings there. +    </p> +   </dd> +   <dt> +    <b> +     w3m doesn't seem to use the variable EDITOR. Why? +    </b> +   </dt> +    <dd> +     <p> +     Go to the options setting panel using the <q>o</q> key. Any +     entry in the <q>Editor</q> field overrides the environment +     variable. +    </p> +    <p> +     If you want to use the editor specified by EDITOR, blank the +     field and save the settings using the button [OK]. +     </p> +   </dd> +   <dt> +    <b> +     How do I quit a search or URL text input? +    </b> +   </dt> +   <dd> +    <p> +     Clear input text using <span class="mono">CTRL-u</span> and hit <span class="mono">RETURN</span>. +    </p> +   </dd> +  </dl> +  <p align="right"> +   <i> +    Up to <a href="#index">index</a> +   </i> +  </p> +  <h2 id="www"> +   <u> +    Questions about WWW usage +   </u> +  </h2> +  <dl> +   <dt> +    <b> +     How do I fill in forms with w3m? +    </b> +   </dt> +   <dd> +    <p> +     Form input fields are displayed in red (or reverse). Move the +     cursor to them. Then, if it is +    </p> +    <ul> +     <li> +       a text input field, hit <span class="mono">RETURN</span> +       put in your text on the bottom line. Press +       <span class="mono">RETURN</span> again +     </li> +     <li> +       a radiobutton or checkbox, pressing +       <span class="mono">RETURN</span> changes or toggles the selection +     </li> +     <li> +       a textarea, pressing +       <span class="mono">RETURN</span> spawns an editor  +     </li> +     <li> +       a <q>submit</q> or <q>reset</q> field, +       the respective action is performed. +     </li> +    </ul> +   </dd> +   <dt> +    <b> +     Seems like w3m is slower than some other browsers. Why? +    </b> +   </dt> +   <dd> +    <p> +     w3m renders a HTML document in two passes. Therefore it doesn't +     start to display the document until it has finished reading it. +    </p> +    <p> +     Most other browsers display the document before having read the +     whole page, and therefore seem faster. +    </p> +   </dd> +   <dt> +    <b> +     Loading time doesn't decrease when loading a previously seen +     page. +    </b> +   </dt> +   <dd> +    <p> +     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. +    </p> +   </dd> +   <dt> +    <b> +     How do I download a linked file? +    </b> +   </dt> +   <dd> +    <p> +      Use <q>a</q> (or <q>d</q> with Lynx-like keybindings) or +      <span class="mono">ESC RET</span>. +      If you want to download an inline image, use +      <span class="mono">ESC I</span>. (see +     Section <a href="MANUAL.html#Functions" target="_blank"> +     Functions and Key bindings</a> of w3m's manual) +    </p> +   </dd> +   <dt> +    <b> +     How do I specify a proxy server? +    </b> +   </dt> +   <dd> +    <p> +     Set the environment variables HTTP_PROXY, HTTPS_PROXY, GOPHER_PROXY +     and FTP_PROXY, or use the options setting panel (<q>o</q> key). For +     example, if you want to use port 8000 of proxy.example.org, specify +    </p> +    <pre>  http://proxy.example.org:8000/</pre> +   </dd> +<!-- deleted, see mail dated Mon, 04 Apr 2016 20:50:27 +0900 (JST) +from Tatsuya Kinoshita <tats@debian.org> +   <dt> +    <b> +     w3m freezes when I invoke an external browser. +    </b> +   </dt> +   <dd> +    <p> +     Enter w3m's option screen using the <q>o</q> key and specify +    </p> +    <pre>  firefox %s &</pre> +    <p> +     (if you are using Firefox). Note that %s is replaced with the URL +     when invoking. +    </p> +   </dd> +   --> +   <dt> +    <b> +     How do I change the default image viewer? +    </b> +    </dt> +    <dd> +     <p> +      By default w3m uses xv to view images. If you want to change it +      into, let's say, <q>display</q>, add the following line to +      ~/.w3m/mailcap or /etc/mailcap: +     </p>  <pre> -image/*; display %s +  image/*; display %s  </pre> -<p> -You can specify external viewers of other file types as well: -<p> +     <p> +      You can specify external viewers of other file types as well: +     </p>  <pre> -image/*;                     display %s -application/postscript;      ghostview %s -application/x-dvi;           xdvi %s +  image/*;                     display %s +  application/postscript;      ghostview %s +  application/x-dvi;           xdvi %s  </pre> -<dt><h3>How do I enter a URL?</h3> -<dd>Type SHIFT-U -<p> -<dt><h3>w3m appends a URL to the former one despite of having cleared the line -with Ctrl-u. What to do?</h3> -<dd>Enter the <i>complete</i> adress, e.g. http://www.slashdot.org. -</dd> -</dl> -<br> -<div align=right> -<i>Up to <a href="#index">index</a></i> -</div> -<br> -<u><h2><a name="other">Miscellaneous</a></h2></u> -<br> -<dl> -<dt><h3>What is w3m's configuration file?</h3> -<dd>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. -<p> -<dt><h3>What are these w3mxxxx files in my ~/.w3m directory for?</h3> -<dd>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. -<p> -</dd> -</dl> -<br> -<div align=right> -<i>Up to <a href="#index">index</a></i> -</div> -<br> -</BODY> -</HTML> +    </dd> +    <dt> +     <b> +      How do I enter a URL? +     </b> +   </dt> +   <dd> +    <p> +     Type <span class="mono">U</span> +    </p> +   </dd> +   <dt> +    <b> +     w3m appends a URL to the former one even when I clear the line +     with <span class="mono">CTRL-u</span>. What should I do? +    </b> +   </dt> +   <dd> +    <p> +     Enter the <i>complete</i> address, e.g. http://www.slashdot.org. +    </p> +   </dd> +  </dl> +  <p align="right"> +   <i> +    Up to <a href="#index">index</a> +   </i> +  </p> +  <h2 id="other"> +   <u> +    Miscellaneous +   </u> +  </h2> +  <dl> +   <dt> +    <b> +     What is w3m's configuration file? +    </b> +   </dt> +   <dd> +    <p> +     It is ~/.w3m/config. +    </p> + +    <p> +     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. +    </p> +     +    <p>Without a user-specific configuration file, w3m honours +    the system wide configuration file /etc/w3m/config. +    </p> +     +   </dd> +   <dt> +    <b> +     What are these w3mxxxx files in my ~/.w3m directory for? +    </b> +   </dt> +   <dd> +    <p> +     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. +    </p> +   </dd> +  </dl> +  <p align="right"> +   <i> +    Up to <a href="#index">index</a> +   </i> +  </p> + </body> +</html> 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 <okabek@guitar.ocn.ne.jp>    * 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) <okada@furuno.co.jp> +From: Tsutomu Okada <okada@furuno.co.jp>  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 <okabe@fphy.hep.okayama-u.ac.jp>  table get weird when it contains <input type=hidden>. -$B=$@5!%(B +Fixed.  2000.2.12  From: Rogue Metal - Jake Moorman <roguemtl@stampede.org> @@ -1649,15 +1649,15 @@ From: patakuti  If an <input type=button> 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 <okada@furuno.co.jp> +From: Okada <okada@furuno.co.jp>  Now C-a/C-e are bound to 'jump to the first/last item in menu.'  From: "OMAE, jun" <jun-o@osb.att.ne.jp> 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>+<line number> -<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[&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> </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>><TD>Shift screen right -<TR><TD><<TD>Shift screen left -<TR><TD>.<TD>Shift screen one column right -<TR><TD>,<TD>Shift screen one column left -<TR><TD>g,M-<<TD>Go to the first line -<TR><TD>G,M-><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>><TD>Shift screen right -<TR><TD><<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> @@ -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 <https://www.debian.org>, +forked from the original version <https://sourceforge.net/projects/w3m/>. 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 <img> 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 <n> -      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 <n>        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       <url>|/<re-url>/  form      [<name>] <action> @@ -23,21 +23,21 @@ textarea  <name>     :  /textarea -If <action> is set, form which has matched <action> attributes +If <action> is set, a form which has matched <action> 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 <value> in input, select or textarea element which   name  attribute matches with <name>. -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 <name> and <value> -respectively.  If <checked> is 0, no, or off, disable check of the checkbox. +respectively.  If <checked> 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 <name> (and value attribute -matches with <value>), or submit last <input type=submit> element if no -<name> specified. +A line beginning with submit or image means that it will submit input +element whose name attribute matches with <name> (and value attribute +matches with <value>), or submit on the last <input type=submit> element if no +<name> 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 <url>|/<re-url>/|m@<re-url>@i [exact] +substitute_url "<destination-url>" +url_charset <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 @@ -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 +<num> -goto <num> 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 <aito@fw.ipsj.or.jp> +.MT aito@fw.ipsj.or.jp +Akinori ITO +.ME + | 
