From 72f72d64a422d6628c4796f5c0bf2e508f134214 Mon Sep 17 00:00:00 2001 From: Tatsuya Kinoshita Date: Wed, 4 May 2011 16:05:14 +0900 Subject: Adding upstream version 0.5.1 --- doc/MANUAL.html | 537 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 537 insertions(+) create mode 100644 doc/MANUAL.html (limited to 'doc/MANUAL.html') diff --git a/doc/MANUAL.html b/doc/MANUAL.html new file mode 100644 index 0000000..4877f72 --- /dev/null +++ b/doc/MANUAL.html @@ -0,0 +1,537 @@ + + +w3m manual + + +

w3m MANUAL

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

Index

+ +
  • Introduction +
  • Options +
  • Document color +
  • Key binding +
  • Lynx-like key binding +
  • Mouse operation +
  • Key customization +
  • Local CGI +
  • + +
    + +

    Introduction

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

    Options

    + +Command line usage is +

    +

    +    w3m [options] [file|URL]
    +
    +

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

    +Options are as follows: +

    +
    +<line number> +
    Move to the specified line. +
    -t width +
    Specify tab width. Default is 8. +
    -r +
    When displaying text/plain document, prohibit emphasis using backspace. +If you don't specify this option, +``A^H_'' is interpreted as underlined character and ``A^HA'' as a bold character. +
    -l number +
    Specify line number preserved internally when reading text/plain document +fron standard input. Default is 10000. +
    -s +
    Display documents with Shift_JIS code. +
    -e +
    Display documents with EUC_JP code. +
    -j +
    Display documents with ISO-2022-JP code. +
    -T type +
    Specify document type. Without this option, document type +is determined from extension of a file. If the determination +fails, the document is regarded as text/plain. +

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

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

    +Display HTML source +

    +   w3m -T text/plain hoge.html
    +
    +
    -m +
    Display document with Internet message mode. +With this option, w3m determines document type from header information. +It is useful when reading E-mail or NetNews messages. +
    -v +
    visual startup mode. +
    -B +
    Show the bookmark. +
    -bookmark file +
    Specify bookmark file. +
    -M +
    Monochrome display mode. +
    -F +
    Automatically render frame. +
    -S +
    Squeeze blank lines. +
    -X +
    Upon exit, do not display preserved screen. +
    -W +
    Toggle wrap search mode. +
    -o option=value +
    Specify option. The option names and values are +same as that appears in ~/.w3m/config. +
    -cookie +
    Process cookies. +
    -no-cookie +
    Don't process cookies. +
    -pauth username:password +
    Set username and password for (basic) proxy authentication. +
    -num +
    Show linenumber. +
    -dump +
    Read document specified by URL and dump formatted text into standard +output. The width of the document become 80. This width can be overridden +with -cols option. +
    -cols width +
    Specify document width. Used with -dump option. +
    -ppc count +
    Specify the number of pixels per character (default 8.0). Larger + values will make tables narrower. +
    -dump_source +
    Read document specified by URL and dump the source. +
    -dump_head +
    Read document specified by URL and dump headers. +
    -dump_both +
    Read document specified by URL and dump headers and the source. +
    -dump_extra +
    Read document specified by URL and dump extra informations, headers and the source. +
    -post file +
    use POST method with file content. +
    -header string +
    insert string as a header. +
    -no-proxy +
    Don't use proxy server. +
    -no-graph +
    Don't use graphic character to draw frames. +
    -no-mouse +
    Don't activate mouse. +
    -config file +
    specify config file. +
    + +
    + +

    Document color

    + +Links and images are displayed as follows. +
    + + + + + +
     Color modeMonochrome mode
    linksblueunderline
    inline imagesgreenreverse
    form inputredreverse
    +
    +These colors can be customized using option setting command "o". + +
    + +

    Key binding

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

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

    Page/Cursor motion

    + +
    SPC,C-vForward page +
    b,ESC vBackward page +
    l,C-fCursor right +
    h,C-bCursor left +
    j,C-nCursor down +
    k,C-pCursor up +
    JRoll up one line +
    KRoll down one line +
    ^,C-aGo to the beginning of line +
    $,C-eGo to the end of line +
    wGo to next word +
    WGo to previous word +
    >Shift screen right +
    <Shift screen left +
    .Shift screen one column right +
    ,Shift screen one column left +
    g,M-<Go to the first line +
    G,M->Go to the last line +
    ESC gGo to specified line +
    ZMove to the center line +
    zMove to the center column +
    TABMove to next hyperlink +
    C-u,ESC TABMove to previous hyperlink +
    [Move to the first hyperlink +
    ]Move to the last hyperlink +
    + +

    Hyperlink operation

    + +
    RETFollow hyperlink +
    a, ESC RETSave link to file +
    uPeek link URL +
    iPeek image URL +
    IView inline image +
    ESC ISave inline image to file +
    :Mark URL-like strings as anchors +
    ESC :Mark Message-ID-like strings as news anchors +
    cPeek current URL +
    =Display information about current document +
    C-gShow current line number +
    C-hView history of URL +
    FRender frame +
    MBrowse current document using external browser +(use 2M and 3M to invoke second and third browser) +
    ESC MBrowse link using external browser +(use 2ESC M and 3ESC M to invoke second and third browser) +
    + +

    File/Stream operation

    + +
    UOpen URL +
    VView new file +
    @Execute shell command and load +
    #Execute shell command and browse +
    + +

    Buffer operation

    + +
    BBack to the previous buffer +
    vView HTML source +
    sSelect buffer +
    EEdit buffer source +
    C-lRedraw screen +
    RReload buffer +
    SSave buffer +
    ESC sSave source +
    ESC eEdit buffer image +
    + +

    Buffer selection mode

    + +
    k, C-pSelect previous buffer +
    j, C-nSelect next buffer +
    DDelect current buffer +
    RETGo to the selected buffer +
    + +

    Bookmark operation

    + +
    ESC bLoad bookmark +
    ESC aAdd current to bookmark +
    + +

    Search

    + +
    /,C-sSearch forward +
    ?,C-rSearch backward +
    nSearch next +
    NSearch previous +
    C-wToggle wrap search mode +
    + +

    Mark operation

    + +
    C-SPCSet/unset mark +
    ESC pGo to previous mark +
    ESC nGo to next mark +
    "Mark by regular expression +
    + +

    Miscellany

    + +
    !Execute shell command +
    HHelp (load this file) +
    oSet option +
    C-kShow cookie jar +
    C-cStop +
    C-zSuspend +
    qQuit (with confirmation, if you like) +
    QQuit without confirmation +
    + +

    Line-edit mode

    + +
    C-fMove cursor forward +
    C-bMove cursor backward +
    C-hDelete previous character +
    C-dDelete current character +
    C-kKill everything after cursor +
    C-uKill everything before cursor +
    C-aMove to the top of line +
    C-eMove to the bottom of line +
    C-pFetch the previous string from the history list +
    C-nFetch the next string from the history list +
    TAB,SPCComplete filename +
    RETURNAccept +
    + +
    + +

    Lynx-like key binding

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

    Page/Cursor motion

    + +
    SPC,C-v,+Forward page +
    b,ESC v,-Previous page +
    lCursor right +
    hCursor left +
    jCursor down +
    kCursor up +
    JRoll up one line +
    KRoll down one line +
    ^Go to the beginning of line +
    $Go to the end of line +
    >Shift screen right +
    <Shift screen left +
    C-aGo to the first line +
    C-eGo to the last line +
    GGo to the specified line +
    ZMove to the center line +
    zMove to the center column +
    TAB,C-n,Down arrowMove to next hyperlink +
    ESC TAB,C-p,Up arrowMove to previous link +
    C-gShow current page position +
    + + +

    Hyperlink operation

    + +
    RET, C-f, Right arrowFollow hyperlink +
    d, ESC RETSave link to file +
    uPeek link URL +
    iPeek image URL +
    IView inline image +
    ESC ISave inline image to file +
    :Mark URL-like strings as anchors +
    ESC :Mark Message-ID-like strings as news anchors +
    cPeek current URL +
    =Display information about current document +
    C-hView history of URL +
    FRender frame +
    MBrowse current document using external browser +(use 2M and 3M to invoke second and third browser) +
    ESC MBrowse link using external browser +(use 2ESC M and 3ESC M to invoke second and third browser) +
    + +

    File/Stream operation

    + +
    g,UOpen URL +
    VView new file +
    @Execute shell command and load +
    #Execute shell command and browse +
    + +

    Buffer operation

    + +
    B, C-b, Left arrowBack to the previous buffer +
    \View HTML source +
    s, C-hSelect buffer +
    EEdit buffer source +
    C-l, C-wRedraw screen +
    R, C-rReload buffer +
    S, pSave buffer +
    ESC sSave source +
    ESC eEdit buffer image +
    + +

    Buffer selection mode

    + +
    k, C-pSelect previous buffer +
    j, C-nSelect next buffer +
    DDelect current buffer +
    RETGo to the selected buffer +
    + +

    Bookmark operation

    + +
    v, ESC bLoad bookmark +
    a, ESC aAdd current to bookmark +
    + +

    Search

    + +
    /, C-sSearch forward +
    nSearch next +
    wToggle wrap search mode +
    + +

    Mark operation

    + +
    C-SPCSet/unset mark +
    PGo to previous mark +
    NGo to next mark +
    "Mark by regular expression +
    + +

    Miscellany

    + +
    !Execute shell command +
    H, ?Help (load this file) +
    oSet option +
    C-kShow cookie jar +
    C-cStop +
    C-zSuspend +
    qQuit (with confirmation, if you like) +
    QQuit without confirmation +
    + +

    Line-edit mode

    + +
    C-fMove cursor forward +
    C-bMove cursor backward +
    C-hDelete previous character +
    C-dDelete current character +
    C-kKill everything after cursor +
    C-uKill everything before cursor +
    C-aMove to the top of line +
    C-eMove to the bottom of line +
    C-pFetch the previous string from the history list +
    C-nFetch the next string from the history list +
    TAB,SPCComplete filename +
    RETURNAccept +
    + +
    + +

    Mouse operation

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

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

    + + +


    + +

    Key customization

    +You can customize the key binding (except line-editing keymap) +by describing ~/.w3m/keymap. For example, +
    +
    +   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. + +
    + +

    Local CGI

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

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

    +

    +The 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 +

    +
    +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: +

    +
    +Content-Type: text/plain
    +W3m-control: GOTO http://www.yahoo.com/
    +
    +
    +This example works exactly the same way to the Location header: +
    +
    +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. + + + -- cgit v1.2.3 From 5397d09e585a1938fb64bc9c5cd5daed1959eb90 Mon Sep 17 00:00:00 2001 From: Tatsuya Kinoshita Date: Wed, 4 May 2011 16:41:45 +0900 Subject: Adding upstream version 0.5.3 --- doc/MANUAL.html | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) (limited to 'doc/MANUAL.html') diff --git a/doc/MANUAL.html b/doc/MANUAL.html index 4877f72..aff0189 100644 --- a/doc/MANUAL.html +++ b/doc/MANUAL.html @@ -103,8 +103,6 @@ same as that appears in ~/.w3m/config.
    Process cookies.
    -no-cookie
    Don't process cookies. -
    -pauth username:password -
    Set username and password for (basic) proxy authentication.
    -num
    Show linenumber.
    -dump @@ -131,7 +129,7 @@ with -cols option.
    -no-proxy
    Don't use proxy server.
    -no-graph -
    Don't use graphic character to draw frames. +
    Use ASCII character to draw frames.
    -no-mouse
    Don't activate mouse.
    -config file -- cgit v1.2.3 From 1d0ba25a660483da1272a31dd077ed94441e3d9f Mon Sep 17 00:00:00 2001 From: Tatsuya Kinoshita Date: Sat, 2 Jan 2021 09:20:37 +0900 Subject: New upstream version 0.5.3+git20210102 --- doc/MANUAL.html | 2902 +++++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 2402 insertions(+), 500 deletions(-) (limited to 'doc/MANUAL.html') diff --git a/doc/MANUAL.html b/doc/MANUAL.html index aff0189..91a3485 100644 --- a/doc/MANUAL.html +++ b/doc/MANUAL.html @@ -1,535 +1,2437 @@ - + -w3m manual - - -

    w3m MANUAL

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

    Index

    - -
  • Introduction -
  • Options -
  • Document color -
  • Key binding -
  • Lynx-like key binding -
  • Mouse operation -
  • Key customization -
  • Local CGI -
  • - -
    - -

    Introduction

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

    Options

    - -Command line usage is -

    + + w3m manual + + + + + + +

    w3m MANUAL

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

    Index

    + +
    +

    + Introduction +

    +

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

    +
    +

    + Options +

    +

    + Command line usage is +

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

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

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

    +

    + Options include: +

    +
    +

    General options

    +
    + -B +
    +
    +

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

    +
    +
    + -M +
    +
    +

    + + monochrome display +

    +
    +
    + -no-mouse +
    +
    +

    + deactivate mouse support. +

    +
    +
    + -num +
    +
    +

    + + display each line's number -

    -Options are as follows: -

    -
    +<line number> -
    Move to the specified line. -
    -t width -
    Specify tab width. Default is 8. -
    -r -
    When displaying text/plain document, prohibit emphasis using backspace. -If you don't specify this option, -``A^H_'' is interpreted as underlined character and ``A^HA'' as a bold character. -
    -l number -
    Specify line number preserved internally when reading text/plain document -fron standard input. Default is 10000. -
    -s -
    Display documents with Shift_JIS code. -
    -e -
    Display documents with EUC_JP code. -
    -j -
    Display documents with ISO-2022-JP code. -
    -T type -
    Specify document type. Without this option, document type -is determined from extension of a file. If the determination -fails, the document is regarded as text/plain. -

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

    +
    + +
    + -v +
    +
    +

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

    +
    +
    + -W +
    +
    +

    + + toggle wrapping mode in searches +

    +
    +
    + -X +
    +
    +

    + upon exit, do not reinitialize the terminal. +

    +
    +
    + +num +
    +
    +

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

    +
    +

    Browser options

    +
    + -cols num +
    +
    +

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

    +
    +
    + -cookie +
    +
    +

    + + use stored cookies and accept new ones +

    +
    +
    + -no-cookie +
    +
    +

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

    +
    +
    + -F +
    +
    +

    + + render frames +

    +
    +
    + -no-graph +
    +
    +

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

    +
    +
    + -header string +
    +
    +

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

    +
    +
    + -m +
    +
    +

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

    +
    +
    + -no-proxy +
    +
    +

    + + do not use proxy +

    +
    +
    + -post file +
    +
    +

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

    +
    +

    Text pager options

    +
    + -l num +
    +
    +

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

    +
    +
    + -r +
    +
    +

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

    +
    +
    + -s +
    +
    +

    + + squeeze multiple blank lines into one +

    +
    + +
    + -t num +
    +
    +

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

    +
    +

    Data type/encoding options

    +
    + -I charset +
    +
    +

    + + user defined character encoding of input data +

    +
    +
    + -O charset +
    +
    +

    + + user defined character encoding of output data +

    +
    +
    + -T type +
    +
    +

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

    +

    + Read HTML document from standard input and display it +

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

    -Display HTML source +

    + Display HTML source +

    -   w3m -T text/plain hoge.html
    +   w3m -T text/plain example.html
     
    -
    -m -
    Display document with Internet message mode. -With this option, w3m determines document type from header information. -It is useful when reading E-mail or NetNews messages. -
    -v -
    visual startup mode. -
    -B -
    Show the bookmark. -
    -bookmark file -
    Specify bookmark file. -
    -M -
    Monochrome display mode. -
    -F -
    Automatically render frame. -
    -S -
    Squeeze blank lines. -
    -X -
    Upon exit, do not display preserved screen. -
    -W -
    Toggle wrap search mode. -
    -o option=value -
    Specify option. The option names and values are -same as that appears in ~/.w3m/config. -
    -cookie -
    Process cookies. -
    -no-cookie -
    Don't process cookies. -
    -num -
    Show linenumber. -
    -dump -
    Read document specified by URL and dump formatted text into standard -output. The width of the document become 80. This width can be overridden -with -cols option. -
    -cols width -
    Specify document width. Used with -dump option. -
    -ppc count -
    Specify the number of pixels per character (default 8.0). Larger - values will make tables narrower. -
    -dump_source -
    Read document specified by URL and dump the source. -
    -dump_head -
    Read document specified by URL and dump headers. -
    -dump_both -
    Read document specified by URL and dump headers and the source. -
    -dump_extra -
    Read document specified by URL and dump extra informations, headers and the source. -
    -post file -
    use POST method with file content. -
    -header string -
    insert string as a header. -
    -no-proxy -
    Don't use proxy server. -
    -no-graph -
    Use ASCII character to draw frames. -
    -no-mouse -
    Don't activate mouse. -
    -config file -
    specify config file. -
    - -
    - -

    Document color

    - -Links and images are displayed as follows. -
    - - - - - -
     Color modeMonochrome mode
    linksblueunderline
    inline imagesgreenreverse
    form inputredreverse
    -
    -These colors can be customized using option setting command "o". - -
    - -

    Key binding

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

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

    Page/Cursor motion

    - -
    SPC,C-vForward page -
    b,ESC vBackward page -
    l,C-fCursor right -
    h,C-bCursor left -
    j,C-nCursor down -
    k,C-pCursor up -
    JRoll up one line -
    KRoll down one line -
    ^,C-aGo to the beginning of line -
    $,C-eGo to the end of line -
    wGo to next word -
    WGo to previous word -
    >Shift screen right -
    <Shift screen left -
    .Shift screen one column right -
    ,Shift screen one column left -
    g,M-<Go to the first line -
    G,M->Go to the last line -
    ESC gGo to specified line -
    ZMove to the center line -
    zMove to the center column -
    TABMove to next hyperlink -
    C-u,ESC TABMove to previous hyperlink -
    [Move to the first hyperlink -
    ]Move to the last hyperlink -
    - -

    Hyperlink operation

    - -
    RETFollow hyperlink -
    a, ESC RETSave link to file -
    uPeek link URL -
    iPeek image URL -
    IView inline image -
    ESC ISave inline image to file -
    :Mark URL-like strings as anchors -
    ESC :Mark Message-ID-like strings as news anchors -
    cPeek current URL -
    =Display information about current document -
    C-gShow current line number -
    C-hView history of URL -
    FRender frame -
    MBrowse current document using external browser -(use 2M and 3M to invoke second and third browser) -
    ESC MBrowse link using external browser -(use 2ESC M and 3ESC M to invoke second and third browser) -
    - -

    File/Stream operation

    - -
    UOpen URL -
    VView new file -
    @Execute shell command and load -
    #Execute shell command and browse -
    - -

    Buffer operation

    - -
    BBack to the previous buffer -
    vView HTML source -
    sSelect buffer -
    EEdit buffer source -
    C-lRedraw screen -
    RReload buffer -
    SSave buffer -
    ESC sSave source -
    ESC eEdit buffer image -
    - -

    Buffer selection mode

    - -
    k, C-pSelect previous buffer -
    j, C-nSelect next buffer -
    DDelect current buffer -
    RETGo to the selected buffer -
    - -

    Bookmark operation

    - -
    ESC bLoad bookmark -
    ESC aAdd current to bookmark -
    - -

    Search

    - -
    /,C-sSearch forward -
    ?,C-rSearch backward -
    nSearch next -
    NSearch previous -
    C-wToggle wrap search mode -
    - -

    Mark operation

    - -
    C-SPCSet/unset mark -
    ESC pGo to previous mark -
    ESC nGo to next mark -
    "Mark by regular expression -
    - -

    Miscellany

    - -
    !Execute shell command -
    HHelp (load this file) -
    oSet option -
    C-kShow cookie jar -
    C-cStop -
    C-zSuspend -
    qQuit (with confirmation, if you like) -
    QQuit without confirmation -
    - -

    Line-edit mode

    - -
    C-fMove cursor forward -
    C-bMove cursor backward -
    C-hDelete previous character -
    C-dDelete current character -
    C-kKill everything after cursor -
    C-uKill everything before cursor -
    C-aMove to the top of line -
    C-eMove to the bottom of line -
    C-pFetch the previous string from the history list -
    C-nFetch the next string from the history list -
    TAB,SPCComplete filename -
    RETURNAccept -
    - -
    - -

    Lynx-like key binding

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

    Page/Cursor motion

    - -
    SPC,C-v,+Forward page -
    b,ESC v,-Previous page -
    lCursor right -
    hCursor left -
    jCursor down -
    kCursor up -
    JRoll up one line -
    KRoll down one line -
    ^Go to the beginning of line -
    $Go to the end of line -
    >Shift screen right -
    <Shift screen left -
    C-aGo to the first line -
    C-eGo to the last line -
    GGo to the specified line -
    ZMove to the center line -
    zMove to the center column -
    TAB,C-n,Down arrowMove to next hyperlink -
    ESC TAB,C-p,Up arrowMove to previous link -
    C-gShow current page position -
    - +
    +

    Options for data output, followed by immediate exit

    +
    + -dump +
    +
    +

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

    +
    +
    + -dump_source +
    +
    +

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

    +
    +
    + -dump_head +
    +
    +

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

    +
    +
    + -dump_both +
    +
    +

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

    Hyperlink operation

    - -
    RET, C-f, Right arrowFollow hyperlink -
    d, ESC RETSave link to file -
    uPeek link URL -
    iPeek image URL -
    IView inline image -
    ESC ISave inline image to file -
    :Mark URL-like strings as anchors -
    ESC :Mark Message-ID-like strings as news anchors -
    cPeek current URL -
    =Display information about current document -
    C-hView history of URL -
    FRender frame -
    MBrowse current document using external browser -(use 2M and 3M to invoke second and third browser) -
    ESC MBrowse link using external browser -(use 2ESC M and 3ESC M to invoke second and third browser) -
    +

    +
    +
    + -dump_extra +
    +
    +

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

    +
    -

    File/Stream operation

    - -
    g,UOpen URL -
    VView new file -
    @Execute shell command and load -
    #Execute shell command and browse -
    +

    Options for overriding default settings and resources

    + +
    + -bookmark file +
    +
    +

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

    +
    +
    + -config file +
    +
    +

    + + use file instead of the default configuration file +

    +
    +
    + -o option=value +
    +
    +

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

    +
    +
    +
    +

    + Document Colors +

    +

    + Hyperlinks and images are displayed as follows. +

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

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

    +
    +

    + Functions and Key bindings +

    + +

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

    + +

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

    -

    Buffer operation

    - -
    B, C-b, Left arrowBack to the previous buffer -
    \View HTML source -
    s, C-hSelect buffer -
    EEdit buffer source -
    C-l, C-wRedraw screen -
    R, C-rReload buffer -
    S, pSave buffer -
    ESC sSave source -
    ESC eEdit buffer image -
    - -

    Buffer selection mode

    - -
    k, C-pSelect previous buffer -
    j, C-nSelect next buffer -
    DDelect current buffer -
    RETGo to the selected buffer -
    - -

    Bookmark operation

    - -
    v, ESC bLoad bookmark -
    a, ESC aAdd current to bookmark -
    - -

    Search

    - -
    /, C-sSearch forward -
    nSearch next -
    wToggle wrap search mode -
    - -

    Mark operation

    - -
    C-SPCSet/unset mark -
    PGo to previous mark -
    NGo to next mark -
    "Mark by regular expression -
    - -

    Miscellany

    - -
    !Execute shell command -
    H, ?Help (load this file) -
    oSet option -
    C-kShow cookie jar -
    C-cStop -
    C-zSuspend -
    qQuit (with confirmation, if you like) -
    QQuit without confirmation -
    - -

    Line-edit mode

    - -
    C-fMove cursor forward -
    C-bMove cursor backward -
    C-hDelete previous character -
    C-dDelete current character -
    C-kKill everything after cursor -
    C-uKill everything before cursor -
    C-aMove to the top of line -
    C-eMove to the bottom of line -
    C-pFetch the previous string from the history list -
    C-nFetch the next string from the history list -
    TAB,SPCComplete filename -
    RETURNAccept -
    - -
    - -

    Mouse operation

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

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

    +

    +   keymap C-o NEXT_PAGE
    +
    +

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

    -
    - -

    Key customization

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

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

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

    In-page navigation

    +
    + NEXT_PAGE + + SPC, C-v, +, PGDN + + SPC, C-v, + + + Scroll one page downwards +
    + PREVIOUS_PAGE + + b, M-v, -, PGUP + + b, M-v, - + + Scroll one page upwards +
    + MOVE_RIGHT + + l, C-f, RIGHT + + l + + Move cursor right (with a half-screen shift at the screen edge) +
    + MOVE_LEFT + + h, C-b, LEFT + + h + + Move cursor left (with a half-screen shift at the screen edge) +
    + MOVE_DOWN + + j, C-n, DOWN + + j + + Move cursor down (with a one-line scroll at the screen edge) +
    + MOVE_UP + + k, C-p, UP + + k + + Move cursor up (with a one-line scroll at the screen edge) +
    + UP + + J + + J + + Scroll the screen up one line +
    + DOWN + + K + + K + + Scroll the screen down one line +
    + LINE_BEGIN + + ^, C-a + + ^ + + Go to the beginning of the line +
    + LINE_END + + $, C-e + + $ + + Go to the end of the line +
    + NEXT_WORD + + w + + w + + Move to the next word +
    + PREVIOUS_WORD + + W + + W + + Move to the previous word +
    + SHIFT_RIGHT + + > + + > + + Shift screen right +
    + SHIFT_LEFT + + < + + < + + Shift screen left +
    + RIGHT + + . + + . + + Shift screen one column right +
    + LEFT + + , + + , + + Shift screen one column left +
    + BEGIN + + g, M-<, HOME + + C-a, M-< + + Go to the first line +
    + END + + G, M->, END + + C-e, M-> + + Go to the last line +
    + GOTO_LINE + + M-g + + G + + Go to the specified line +
    + LINE_INFO + + C-g + + C-g + + Display current position in document +
    + CENTER_H + + Z + + Z + + Center screen right and left of the cursor column +
    + CENTER_V + + z + + z + + Center screen above and below the cursor line +
    + NEXT_LINK + + TAB + + TAB, C-n, DOWN + + Move to the next hyperlink +
    + PREVIOUS_LINK + + M-TAB, C-u + + M-TAB, C-u, C-p, UP + + Move to the previous hyperlink +
    + LINK_BEGIN + + [ + + [ + + Move to the first hyperlink +
    + LINK_END + + ] + + ] + + Move to the last hyperlink +
    MOVE_LIST_MENUM-mM-mPop up menu to navigate between hyperlinks
    +

    Hyperlink Operations

    +
    + GOTO_LINK + + C-j, C-m, RET + + C-f, C-j, C-m, RET, RIGHT + + Follow current hyperlink in a new buffer +
    LIST_MENUM-lM-lPop up hyperlink menu and select one to be followed
    + SAVE_LINK + + a, M-RET + + d, M-RET + + Save the hyperlink target +
    + PEEK_LINK + + u + + u + + Show target address +
    + PEEK_IMG + + i + + i + + Show image address +
    + VIEW_IMAGE + + I + + I + + Display image in viewer +
    + SAVE_IMAGE + + M-I + + M-I + + Save inline image +
    MARK_WORD;;Turn current word into hyperlink
    + MARK_URL + + : + + : + + Turn URL-like strings into hyperlinks +
    + MARK_MID + + M-: + + M-: + + + Turn Message-ID-like strings into hyperlinks +
    + PEEK + + c + + c + + Show current address +
    + INFO + + = + + = + + Display information about the current document +
    + HISTORY + + C-h + + C-h + + Show browsing history +
    + EXTERN + + M + + M + + Browse current document using external browser (prefix 2, 3, ..., + or 9 to invoke alternate configured browsers, e.g. 3 M) +
    + EXTERN_LINK + + M-M + + M-M + + Browse link using external browser (prefixed as above, e.g. + 3 M-M) +
    +

    Bookmark management

    +
    + BOOKMARK + + M-b + + v, M-b + + View bookmarks +
    + ADD_BOOKMARK + + M-a + + a, M-a + + Add current page to bookmarks +
    +

    File/Stream Operations

    +
    + GOTO + + U + + g, U + + Open specified document in a new buffer +
    GOTO_RELATIVEM-uM-uOpen relative address in a new buffer
    + LOAD + + V + + V + + Open local file in a new buffer +
    + READ_SHELL + + @ + + @ + + + + Execute shell command and display output in a new buffer +
    + PIPE_SHELL + + # + + # + + + + Execute shell command and display output in a new buffer +
    +

    Content Operations

    +
    + VIEW + + v + + \ + + Toggle between source code and rendered view of the document +
    LISTLLList link elements, hyperlinks and images
    + FRAME + + F + + F + + Toggle rendering HTML frames +
    + REDRAW + + C-l + + C-l, C-w + + Draw the screen anew +
    + RELOAD + + R + + R, C-r + + Load current document anew +
    + EDIT + + E + + E + + Edit local source +
    + EDIT_SCREEN + + M-e + + M-e + + Edit rendered copy of document +
    PIPE_BUF||Pipe current buffer through a shell command and display output
    + DOWNLOAD + + M-s + + M-s + + Save document source +
    + SAVE_SCREEN + + S + + S, p + + Save rendered document +
    +

    Buffer/Tab Navigation

    +
    + BACK + + B + + B, C-b, LEFT + + Close current buffer and return to the one below in stack +
    + GOTO_HOME + + C-_ + + + Return to the homepage (specified HTTP_HOME or WWW_HOME variable) +
    + SELECT_MENU + + s + + s, C-h + + Pop up buffer-stack menu +
    + TAB_MENU + + M-t + + M-t + + Pop up tab selection menu +
    + NEW_TAB + + T + + T + + Open a new tab (with current document) +
    + TAB_LINK + + C-t + + C-t + + Follow current hyperlink in a new tab +
    + NEXT_TAB + + } + + } + + Switch to the next tab +
    + PREV_TAB + + { + + { + + Switch to the previous tab +
    + CLOSE_TAB + + C-q + + C-q + + Close the current tab +
    +

    Searches

    +
    + SEARCH + + / + + /, C-s + + Search forward +
    + SEARCH_BACK + + ? + + + Search backward +
    + ISEARCH + + C-s + + + Incremental search forward +
    + ISEARCH_BACK + + C-r + + + Incremental search backward +
    + SEARCH_NEXT + + n + + n + + Continue search forward +
    + SEARCH_PREV + + N + + + Continue search backward +
    + WRAP_TOGGLE + + C-w + + w + + Toggle wrapping mode in searches +
    +

    Mark Management

    +
    + MARK + + C-SPC + + C-SPC + + Set/unset mark +
    + PREV_MARK + + M-p + + P + + Go to the previous mark +
    + NEXT_MARK + + M-n + + N + + Go to the next mark +
    + REG_MARK + + " + + " + + Mark all occurrences of a pattern +
    +

    Miscellaneous

    +
    + COMMAND + + M-c + + M-c + + Invoke one or more semicolon-separated w3m functions +
    + HELP + + H + + H, ? + + Show help panel +
    + OPTIONS + + o + + o + + Display options setting panel +
    SET_OPTIONM-oM-oSet option
    DEFINE_KEYM-kM-kDefine a binding between a key stroke combination and a command
    MOUSE_TOGGLEmmToggle mouse support
    DOWNLOAD_LISTDDDisplay downloads panel
    + COOKIE + + C-k + + C-k + + Show cookie jar +
    UNDO((Cancel the last cursor movement
    REDO))Cancel the last undo
    + EXEC_SHELL + + ! + + ! + + Execute shell command +
    DICT_WORDM-wM-wExecute dictionary command (see README.dict)
    DICT_WORD_ATM-WM-WExecute dictionary command for word at cursor
    VERSIONrrDisplay the version of w3m
    + SUSPEND + + C-z + + C-z + + Suspend w3m to background. (To be withdrawn with shell + command fg.) +
    + QUIT + + q + + q + + Quit with confirmation request +
    + EXIT + + Q + + Q + + Quit at once +
    -
    - -

    Local CGI

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

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

      -
    • The directory where w3m-related files are stored -(typically /usr/local/lib/w3m). This directory can be referred -as $LIB. -
    • /cgi-bin/ directory. You can map /cgi-bin/ to any directory you like -with option setting panel (``Directory corresponds to /cgi-bin'' field). -You can specify multiple paths separated by `:', like -/usr/local/cgi-bin:/home/aito/cgi-bin. To use /cgi-bin/ directory, -you must use file:/cgi-bin URL as follows: +

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

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      + Function
      (internal name) +
      Key binding + + Description +
      +

      Menu Selection Mode

      +
      + BUF:NEXT + j, C-n, DOWN + + Next item +
      BUF:PREV + + k, C-p, UP + + Previous item +
      + BUF:DELETE + D + + Delete item +
      + BUF:GO + + SPC, RET, RIGHT + + Select item +
      +

      Popup Menu Mode

      +
      +MENU:SELECT + + SPC, RET, RIGHT + Select +
      +MENU:CLOSE + C-c + + Close menu +
      +MENU:CANCEL + + LEFT, BKSPC, C-h + One selection step backward +
      +MENU:DOWN + j, C-n, DOWN + + Move to the next item +
      +MENU:UP + + k, C-p, UP + Move to the previous item +
      +MENU:LINE_UP + K + + Scroll up one item +
      +MENU:LINE_DOWN + J + + Scroll down one item +
      +MENU:TOP + C-a + + Move to the first item +
      +MENU:LAST + C-e + + Move to the final item +
      +MENU:NEXT + C-v, C-f + Go to the next page +
      +MENU:PREV + ESC v, C-b + + Go to the previous page +
      +MENU:SEARCH_FORE + C-s, / + + Search forward +
      +MENU:SEARCH_BACK + + C-r, ? + Search backward +
      +MENU:SEARCH_NEXT + + n + Search for the next match
      +MENU:SEARCH_PREV + + N + Search for the previous match
      +

      Line-editing Mode

      +
      + LINEEDIT:FORWARD + + C-f, RIGHT + + Move cursor forward +
      +LINEEDIT:BACK + + C-b, LEFT + + Move cursor backward +
      +LINEEDIT:BS + + C-h, BKSPC + + Delete previous character +
      +LINEEDIT:DEL + + C-d + + Delete current character +
      +LINEEDIT:KILL_AFTER + + C-k + + Delete everything after cursor +
      +LINEEDIT:KILL_BEFORE + + C-u + + Delete everything before cursor +
      +LINEEDIT:TOP + + C-a + + Move to the beginning of the line +
      +LINEEDIT:BOTTOM + + C-e + + Move to the end of the line +
      +LINEEDIT:PREV + + C-p, UP + + Fetch the previous string from the history list +
      +LINEEDIT:NEXT + + C-n, DOWN + + Fetch the next string from the history list +
      +LINEEDIT:COMPLETE + + TAB, SPC + + Try to complete filename +
      +LINEEDIT:EDITOR + + C-o + + Edit with external editor +
      +LINEEDIT:ACCEPT + + RET + + Accept input line +
      + + +
      +

      + Mouse Operation +

      +

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

      +

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

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

      + Local CGI scripts +

      +

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

      +

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

      +
        +
      • + The directory where w3m-related files are stored (typically + /usr/local/lib/w3m). This directory can be referenced as $LIB. +
      • +
      • + The /cgi-bin/ directory. You can map /cgi-bin/ to any directory you + like in the options setting panel (the Directory corresponds to + /cgi-bin field). You can specify multiple paths separated by + :, like /usr/local/cgi-bin:/home/aito/cgi-bin. It is not + recommended to include the current directory to this path. To use + a /cgi-bin/ directory, you must use a file:/cgi-bin URL as follows: +
      •   w3m -o cgi_bin=/path/to/cgi-bin file:/cgi-bin/script.cgi
         
        -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 CGI script can use the special header + w3m-control: to + control w3m. This field can take any function (see + README.func), and the specified function + is invoked after the document is displayed. For example, the CGI + output +

    -
     Content-Type: text/plain
     W3m-control: BACK
    -
     
    -will display blank page and delete that buffer immediately. -This is useful when you don't want to display any page after -the script is invoked. The next example +

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

    -
     Content-Type: text/plain
     W3m-control: DELETE_PREVBUF
    -
     contents.....
     
    -will override the current buffer. -

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

    + will override the current buffer. +

    +

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

    -
     Content-Type: text/plain
    -W3m-control: GOTO http://www.yahoo.com/
    -
    +W3m-control: GOTO http://www.example.org/
     
    -This example works exactly the same way to the Location header: +

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

    -
     Content-Type: text/plain
    -Location: http://www.yahoo.com/
    -
    +Location: http://www.example.org/
     
    -Note that this header has no effect when the CGI script is invoked -through HTTP server. - - +

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

    + -- cgit v1.2.3