[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: FAQ.html and MANUAL.html, was Re: fwd: Re: Re: Please review changed man-file of w3m



Finally getting round to a basic review of README.func:

> ABORT		Quit w3m without confirmation
> ACCESSSKEY	Popup acceskey menu

 * There is no such function as ACCESSSKEY - it's ACCESSKEY.
 * "Popup" is the noun; the verb is "Pop up" (here and elsewhere).
 * "Acceskey" is the opposite typo.
 * I can't make out what this command is supposed to do.

That first typo is a good sign, though: I'd been worrying that maybe
this file was autogenerated somehow from comments in the code, so it
would be pointless to correct it.

Make it:
  ACCESSKEY      Pop up accesskey menu

> ADD_BOOKMARK	Add current page to bookmark
                                            ^s
> ALARM		Set alarm
> BACK		Back to previous buffer
> BEGIN		Go to the first line
> BOOKMARK	Read bookmark

                View bookmarks

> CENTER_H	Move to the center line
> CENTER_V	Move to the center column
> CHARSET		Change the current document charset

Tab inconsistencies fixed throughout.

[...]
> DOWN		Scroll down one line
> DOWNLOAD	Save document source to file

This also works when what you're viewing is just a textfile, so

  DOWNLOAD	Save document (source) to file

[...]
> EXEC_SHELL	Execute shell command
> EXIT		Quit w3m without confirmation

Make that:
  EXIT		(See ABORT)
and likewise throughout.

> EXTERN		Execute external browser
> EXTERN_LINK	View current link using external browser
> FRAME		Render frame
                            ^s
> GOTO		Go to URL
> GOTO_LINE	Go to specified line
> GOTO_LINK	Go to current link

That makes it sound as if it moved the cursor to the nearest "click
here"; what it means is:
  GOTO_LINK	Follow current link

> GOTO_RELATIVE	Go to relative URL
> HELP		View help
> HISTORY		View history of URL

That makes it sound like a sort of serverinfo archive trawl.

  HISTORY		View browser history

[...]
> 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

s/anchor/link/g.

> MENU		Popup menu
> MENU_MOUSE	Popup menu at mouse cursor (for mouse action)

(Those are cases of s/Popup/Pop up/)

> MOUSE_TOGGLE   Toggle activity of mouse

"Toggle mouse support".

> 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)

1 column, singular (and likewise for RIGHT1).

[...]
> NEXT		Move to next buffer
> NEXT_DOWN      Move to next downward link 

A downward link would be a link that leads to a point later in the
same page.  All these need to be rephrased as, e.g.:

  NEXT_DOWN      Move downward to next link

Oh, there was also trailing whitespace - I've fixed all those by
accident.

[...]
> NOTHING		Do nothing
> NULL		Do nothing

"(See NOTHING)"

> OPTIONS		Option setting panel

No verb; I would suggest "Display option setting panel"

> PEEK		Peek current URL
> PEEK_IMG	Peek image URL 
> PEEK_LINK      Peek link URL

"Peek" isn't a transitive verb (except perhaps in programmerese); say
"Peek at".

[...]
> WRAP_TOGGLE    Toggle wrap search mode

That's "Toggle search wrap mode". 
-- 
JBR	with qualifications in linguistics, experience as a Debian
 	sysadmin, and probably no clue about this particular package
ABORT		Quit w3m without confirmation
ACCESSKEY	Pop up accesskey menu
ADD_BOOKMARK	Add current page to bookmarks
ALARM		Set alarm
BACK		Back to previous buffer
BEGIN		Go to the first line
BOOKMARK	View bookmarks
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)
COOKIE		View cookie list
DEFAULT_CHARSET Change the default document charset
DEFINE_KEY	Define a binding between a keystroke and a user command
DELETE_PREVBUF	Delete previous buffer (mainly for local-CGI)
DICT_WORD	Execute dictionary command (see README.dict)
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
END		Go to the last line
EXEC_SHELL	Execute shell command
EXIT		(See ABORT)
EXTERN		Execute external browser
EXTERN_LINK	View current link using external browser
FRAME		Render frames
GOTO		Go to URL
GOTO_LINE	Go to specified line
GOTO_LINK	Follow current link
GOTO_RELATIVE	Go to relative URL
HELP		View help
HISTORY 	View browser history
INFO		View info of current document
INTERRUPT	Send w3m to background
INIT_MAILCAP	Reread mailcap (mainly for local-CGI)
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	Pop up link element menu
LIST		Show all links and images
LIST_MENU	Pop up link list menu and go to selected link
LOAD		Load local file
MAIN_MENU	Pop up menu
MARK		Set/unset mark
MARK_MID	Mark Message-ID-like strings as links
MARK_URL	Mark URL-like strings as links
MARK_WORD	Mark current word as link
MENU		Pop up menu
MENU_MOUSE	Pop up menu at mouse cursor (for mouse action)
MOUSE_TOGGLE	Toggle mouse support
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 column shift at the left edge)
MOVE_LIST_MENU	Pop up 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 column 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 scroll at the top of screen)
MSGS		Display error messages
NEW_TAB 	Open new tab
NEXT		Move to next buffer
NEXT_DOWN	Move downward to next link
NEXT_LEFT	Move left to next link
NEXT_LEFT_UP	Move left (or upward) to next link
NEXT_LINK	Move to next link
NEXT_MARK	Move to next word
NEXT_PAGE	Move to next page
NEXT_RIGHT	Move right to next link
NEXT_RIGHT_DOWN	Move right (or downward) to next link
NEXT_TAB	Move to next tab
NEXT_UP		Move upward to next link
NEXT_VISITED	Move to next visited link
NEXT_WORD	Move to next word
NOTHING 	Do nothing
NULL		(See NOTHING)
OPTIONS 	Display option setting panel
PEEK		Peek at current URL
PEEK_IMG	Peek at image URL
PEEK_LINK	Peek at 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
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
RIGHT		Shift screen one column right
SAVE		(See DOWNLOAD)
SAVE_IMAGE	Save image to file
SAVE_LINK	Save link to file
SAVE_SCREEN	(See PRINT)
SEARCH		Search forward
SEARCH_BACK	Search backward
SEARCH_FORE	(See SEARCH)
SEARCH_NEXT	Search next regexp
SEARCH_PREV	Search previous regexp
SELECT		Go to buffer selection panel
SELECT_MENU	Pop up buffer selection menu
SETENV		Set environment variable
SET_OPTION	Set option
SHELL		(See EXEC_SHELL)
SHIFT_LEFT	Shift screen left
SHIFT_RIGHT	Shift screen right
SOURCE		View HTML source
STOP_IMAGE	Stop loading and drawing of images
SUBMIT		Submit form
SUSPEND 	(See INTERRUPT)
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	Pop up tab selection menu
TAB_MOUSE	Move to tab on mouse cursor (for mouse action)
TAB_RIGHT	Move current tab right
UNDO		Cancel the last cursor movement
UP		Scroll up one line
VERSION		Display version of w3m
VIEW		(See SOURCE)
VIEW_BOOKMARK	(See BOOKMARK)
VIEW_IMAGE	View image
WHEREIS 	(See SEARCH)
WRAP_TOGGLE	Toggle search wrap mode
--- README.func.orig	2003-09-22 22:02:22.000000000 +0100
+++ README.func	2015-02-22 13:50:39.394615803 +0000
@@ -1,102 +1,102 @@
 ABORT		Quit w3m without confirmation
-ACCESSSKEY	Popup acceskey menu
-ADD_BOOKMARK	Add current page to bookmark
+ACCESSKEY	Pop up accesskey menu
+ADD_BOOKMARK	Add current page to bookmarks
 ALARM		Set alarm
 BACK		Back to previous buffer
 BEGIN		Go to the first line
-BOOKMARK	Read bookmark
+BOOKMARK	View bookmarks
 CENTER_H	Move to the center line
 CENTER_V	Move to the center column
-CHARSET		Change the current document charset
+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)
+CLOSE_TAB_MOUSE Close tab on mouse cursor (for mouse action)
+COMMAND 	Execute w3m command(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)
+DEFAULT_CHARSET Change the default document charset
+DEFINE_KEY	Define a binding between a keystroke and a user command
+DELETE_PREVBUF	Delete previous buffer (mainly for local-CGI)
 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	Save document (source) to file
 DOWNLOAD_LIST	Display download list panel
 EDIT		Edit current document
 EDIT_SCREEN	Edit currently rendered document
 END		Go to the last line
 EXEC_SHELL	Execute shell command
-EXIT		Quit w3m without confirmation
+EXIT		(See ABORT)
 EXTERN		Execute external browser
 EXTERN_LINK	View current link using external browser
-FRAME		Render frame
+FRAME		Render frames
 GOTO		Go to URL
 GOTO_LINE	Go to specified line
-GOTO_LINK	Go to current link
+GOTO_LINK	Follow current link
 GOTO_RELATIVE	Go to relative URL
 HELP		View help
-HISTORY		View history of URL
+HISTORY 	View browser history
 INFO		View info of current document
-INTERRUPT	Stop loading document
-INIT_MAILCAP    Reread mailcap (mainly for local-CGI)
-ISEARCH		Incremental search forward
+INTERRUPT	Send w3m to background
+INIT_MAILCAP	Reread mailcap (mainly for local-CGI)
+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
+LINK_BEGIN	Go to the first link
+LINK_END	Go to the last link
+LINK_MENU	Pop up link element menu
 LIST		Show all links and images
-LIST_MENU	Popup link list menu and go to selected link
+LIST_MENU	Pop up link list menu and go to selected link
 LOAD		Load local file
-MAIN_MENU	Popup menu
+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
+MARK_MID	Mark Message-ID-like strings as links
+MARK_URL	Mark URL-like strings as links
+MARK_WORD	Mark current word as link
+MENU		Pop up menu
+MENU_MOUSE	Pop up menu at mouse cursor (for mouse action)
+MOUSE_TOGGLE	Toggle mouse support
+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 column shift at the left edge)
+MOVE_LIST_MENU	Pop up 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
+MOVE_RIGHT	Move cursor right (a half screen shift at the right edge)
+MOVE_RIGHT1	Move cursor right (1 column 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 scroll 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_DOWN	Move downward to next link
+NEXT_LEFT	Move left to next link
+NEXT_LEFT_UP	Move left (or upward) to next 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_RIGHT	Move right to next link
+NEXT_RIGHT_DOWN	Move right (or downward) to next link
 NEXT_TAB	Move to next tab
-NEXT_UP                Move to next upward link 
-NEXT_VISITED    Move to next visited link
+NEXT_UP		Move upward to next link
+NEXT_VISITED	Move to next visited link
 NEXT_WORD	Move to 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
+NOTHING 	Do nothing
+NULL		(See NOTHING)
+OPTIONS 	Display option setting panel
+PEEK		Peek at current URL
+PEEK_IMG	Peek at image URL
+PEEK_LINK	Peek at 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_VISITED	Move to previous visited link
 PREV_WORD	Move to previous word
 PRINT		Save buffer to file
 QUIT		Quit w3m
@@ -106,40 +106,40 @@
 REG_MARK	Set mark using regexp
 REINIT		Reload configuration files
 RELOAD		Reload buffer
-RESHAPE		Re-render buffer
+RESHAPE 	Re-render buffer
 RIGHT		Shift screen one column right
-SAVE		Save document source to file
+SAVE		(See DOWNLOAD)
 SAVE_IMAGE	Save image to file
 SAVE_LINK	Save link to file
-SAVE_SCREEN	Save rendered document to file
+SAVE_SCREEN	(See PRINT)
 SEARCH		Search forward
 SEARCH_BACK	Search backward
-SEARCH_FORE	Search forward
+SEARCH_FORE	(See SEARCH)
 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
+SELECT_MENU	Pop up buffer selection menu
+SETENV		Set environment variable
+SET_OPTION	Set option
+SHELL		(See EXEC_SHELL)
 SHIFT_LEFT	Shift screen left
 SHIFT_RIGHT	Shift screen right
 SOURCE		View HTML source
 STOP_IMAGE	Stop loading and drawing of images
 SUBMIT		Submit form
-SUSPEND		Stop loading document
+SUSPEND 	(See INTERRUPT)
 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_MENU	Pop up tab selection menu
 TAB_MOUSE	Move to tab on mouse cursor (for mouse action)
 TAB_RIGHT	Move current tab right
 UNDO		Cancel the last cursor movement
 UP		Scroll up one line
-VERSION                Display version of w3m
-VIEW		View HTML source
-VIEW_BOOKMARK	View bookmark
+VERSION		Display version of w3m
+VIEW		(See SOURCE)
+VIEW_BOOKMARK	(See BOOKMARK)
 VIEW_IMAGE	View image
-WHEREIS		Search forward
-WRAP_TOGGLE    Toggle wrap search mode
+WHEREIS 	(See SEARCH)
+WRAP_TOGGLE	Toggle search wrap mode

Reply to: