Re: FAQ.html and MANUAL.html, was Re: fwd: Re: Re: Please review changed man-file of w3m
Hello Justin,
below, a couple of annotations to the last part of MANUAL.html
Best regards
Markus
---
Justin B Rye schrieb am 8. Dec 2014 um 23:21
> Okay, revised FAQ.html attached. I also have a revised and
> re-HTMLified MANUAL.html, but it still has a few points I'm not sure
> about. Going through the original in rendered form:
> > Lynx-like key binding
> >
> > If you have chosen `Lynx-like key binding' at the compile time, you can use the
> > following key binding.
>
> I've never been the person who makes this choice. Say "If w3m was
> compiled with the <q>Lynx-like key bindings</q> option, you can use
> the following key bindings."
OK
> > C-g Show current page position
>
> As above, with the addition of hyphenation for "(direction)-arrow".
> And wait, that last one: is "Show current page position" the same
> thing as "Show current line number" (non-Lynx-like "C-g")?
C-g for default and C-g for Lynx-like key binding produce the same
LINE_INFO command. With it, I get the current vertical (line) and
horizontal (column) position of the cursor and a character encoding
set is mentioned.
> > Hyperlink operation
[...]
> > TAB,SPC Complete filename
> > RETURN Accept
>
> All as previous.
Yes.
> > Mouse operation
> >
> > If w3m is compiled with mouse option and you are using xterm/kterm/rxvt (in
> > this case, you have to set the TERM environment variable to `xterm' or
> > `kterm'.) or GPM environment, you can use mouse for the navigation.
> Fixed version: "If w3m is compiled with mouse support and you are
> using either xterm/kterm/rxvt (in the latter case, you have to set the
> TERM environment variable to <q>xterm</q> or <q>kterm</q>) or GPM, you
> can use the mouse for navigation."
>
> (I wonder if these terminals do still behave as specified here?)
>
> > left Move the cursor to the place pointed by the mouse cursor. If you click
> > click the cursor and it is on an anchor, follow the anchor.
>
> s/pointed/indicated/, s/anchor/(hyper)link/.
>
In other words: A left-click repositions the cursor. In case the
position belongs to an link, this get highlighted. A left-click at
exactly the same position belonging to a link makes w3m follow the
addresse and display the target in a new buffer.
> > middle Back to the previous buffer.
> > click
>
> (Buffer-centric.)
The command in the background is BACK, as described above,
> > right Open pop-up menu. You can choose an item by clicking it.
> > click
> > left Scroll document. The default behavior is to grab the document and drag
> > drag it. You can reverse the behavior (grab the window and drag it) with the
> > option setting panel.
> >
> > ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????
> >
> > Key customization
> >
> > You can customize the key binding (except line-editing keymap) by describing ~
> > /.w3m/keymap. For example,
>
> s/by describing/in/
>
> >
> > keymap C-o NEXT_PAGE
> >
> >
> > binds `NEXT_PAGE' function (normally bound to SPC and C-v) to control-o. See
> > README.func for list of available functions. Original and Lynx-like keymap
> > definitions are provided (keymap.default and keymap.lynx) as examples.
>
> Needs some articles. Trickier: on Debian those keymap files aren't
> sitting in the same directory, so the links fail.
There are three sections of the MANUAL.html closely related: "Key
customization", "Key Binding" and "Lynx-like key binding". From my
point of view, "Key customization" should be the heading. The role of
the keymap file and its syntax should be explained. Then, one table
could explain a function in one column and one column gives the
defauld key combination, another column the Lynx-like key
combinantion.
Maybe HELP and README.functions would deserve being a section of
MANUAL.html
> > ?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????
> >
> > Local CGI
> >
> > You can run CGI scripts using w3m, without any HTTP server. It means that w3m
> This
> > behaves like an HTTP server and activates CGI script, then w3m reads the output
> runs the then reads
> > of the script and display it. The bookmark registration and helper-app editor
>
> Insert "system" after "registration"; I'm not sure what it means by
> "helper-app editor".
I'm not sure, too. But w3mhelp.cgi loads a file like
/usr/share/w3m/w3mhelp-funcdesc.en.pl that contains the strings that
appear as explanations.
To internationalize the HELP function, w3mhelp.cgi shall take the
system's locale language code and use this to load a localized version
of /w3mhelp-funcdesc.XX.pl
The interaction of these scripts and files is flexible and the
function description file can be editied, but the whole arrangement is
no "helper-app editor"
> > are realized as local CGI scripts. Using local CGI, w3m can be used as a
> > general purpose form interface.
>
> "Using X, Y can be used" is awkward. "Local CGI scripts allow w3m to
> be used".
>
> >
> > For security reason, CGI scripts invoked by w3m must be in one of these
> > directories.
>
> "...one of the following directories:"
>
> >
> > ??? The directory where w3m-related files are stored (typically /usr/local/lib/
> > w3m). This directory can be referred as $LIB.
> referenced
> > ??? /cgi-bin/ directory. You can map /cgi-bin/ to any directory you like with
> in the
> > 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:
>
> More minor rearticlings.
>
> >
> > w3m -o cgi_bin=/path/to/cgi-bin file:/cgi-bin/script.cgi
> >
> > It is not recommended to include current directory to this path.
> >
> > The CGI script can use special header `w3m-control:' to control w3m. This field
> > can take any function (see README.func), and the specified function is invoked
> > after the document is displayed. For example, The CGI output
> the
> >
> > Content-Type: text/plain
> > W3m-control: BACK
> >
> >
> > will display blank page and delete that buffer immediately. This is useful when
> > you don't want to display any page after the script is invoked. The next
> > example
> >
> >
> > Content-Type: text/plain
> > W3m-control: DELETE_PREVBUF
> >
> > contents.....
> >
> > will override the current buffer.
> >
> > One w3m-control: header have to contain only one function, but you can include
> > more than one w3m-control: lines in the HTTP header. In addition, you can
> > specify an argument to GOTO function:
>
> "Each w3m-control: header can contain only one function, but you can
> include more than one w3m-control: line in the HTTP header."
>
> >
> >
> > Content-Type: text/plain
> > W3m-control: GOTO http://www.yahoo.com/
>
> Make that example.org, here and below.
>
> >
> >
> > This example works exactly the same way to the Location header:
>
> s/to/as/
>
> >
> > Content-Type: text/plain
> > Location: http://www.yahoo.com/
> >
> >
> > Note that this header has no effect when the CGI script is invoked through HTTP
> > server.
>
> There, that didn't take as long as I expec... wait, what day is this?
This explanations on how to write cgi-scripts are quite
superficial. But I do not know whether it is worth to improve the
matter. Curious users will explore this field on their own.
Reply to: