W3m Manual

User Manual: Pdf

Open the PDF directly: View PDF .
Page Count: 9

Download
Open PDF In Browser	View PDF

9/16/2016

w3m manual

w3m MANUAL
Akinori Ito
aito@ei5sun.yz.yamagata-u.ac.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 ﬁlenames/URLs on command line, these documents are displayed. If you specify
nothing, w3m reads a document from standard input and display it. If no ﬁlename and/or URLs
are speciﬁed and standard input is tty, w3m terminates without displaying anything.
Options are as follows:
+
Move to the speciﬁed 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 ﬁle. If the determination fails, the document is regarded as text/plain.
http://w3m.sourceforge.net/MANUAL#Key:orig

1/9

9/16/2016

w3m manual

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 ﬁle
Specify bookmark ﬁle.
-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/conﬁg.
-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 speciﬁed 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 speciﬁed by URL and dump the source.
-dump_head
Read document speciﬁed by URL and dump headers.
-dump_both
Read document speciﬁed by URL and dump headers and the source.
-dump_extra
Read document speciﬁed by URL and dump extra informations, headers and the source.
-post ﬁle
use POST method with ﬁle content.
-header string
insert string as a header.
http://w3m.sourceforge.net/MANUAL#Key:orig

2/9

9/16/2016

w3m manual

-no-proxy
Don't use proxy server.
-no-graph
Don't use graphic character to draw frames.
-no-mouse
Don't activate mouse.
-conﬁg ﬁle
specify conﬁg ﬁle.

Document color
Links and images are displayed as follows.
Color mode Monochrome mode
links
blue
underline
inline images green
reverse
form input red
reverse
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-v
b,ESC v
l,C-f
h,C-b
j,C-n
k,C-p
J
K
^,C-a
$,C-e
w
W
>
<
.
,
g,M-<
G,M->
ESC g
Z
z

Forward page
Backward page
Cursor right
Cursor left
Cursor down
Cursor up
Roll up one line
Roll down one line
Go to the beginning of line
Go to the end of line
Go to next word
Go to previous word
Shift screen right
Shift screen left
Shift screen one column right
Shift screen one column left
Go to the ﬁrst line
Go to the last line
Go to speciﬁed line
Move to the center line
Move to the center column

http://w3m.sourceforge.net/MANUAL#Key:orig

3/9

9/16/2016

TAB
C-u,ESC TAB
[
]

w3m manual

Move to next hyperlink
Move to previous hyperlink
Move to the ﬁrst hyperlink
Move to the last hyperlink

Hyperlink operation
RET
a, ESC RET
u
i
I
ESC I
:
ESC :
c
=
C-g
C-h
F
M
ESC M

Follow hyperlink
Save link to ﬁle
Peek link URL
Peek image URL
View inline image
Save inline image to ﬁle
Mark URL-like strings as anchors
Mark Message-ID-like strings as news anchors
Peek current URL
Display information about current document
Show current line number
View history of URL
Render frame
Browse current document using external browser (use 2M and 3M to invoke
second and third browser)
Browse link using external browser (use 2ESC M and 3ESC M to invoke second and
third browser)

File/Stream operation
U
V
@
#

Open URL
View new ﬁle
Execute shell command and load
Execute shell command and browse

Buﬀer operation
B
v
s
E
C-l
R
S
ESC s
ESC e

Back to the previous buﬀer
View HTML source
Select buﬀer
Edit buﬀer source
Redraw screen
Reload buﬀer
Save buﬀer
Save source
Edit buﬀer image

Buﬀer selection mode
k, C-p
j, C-n

Select previous buﬀer
Select next buﬀer

http://w3m.sourceforge.net/MANUAL#Key:orig

4/9

9/16/2016

D
RET

w3m manual

Delect current buﬀer
Go to the selected buﬀer

Bookmark operation
ESC b
ESC a

Load bookmark
Add current to bookmark

Search
/,C-s
?,C-r
n
N
C-w

Search forward
Search backward
Search next
Search previous
Toggle wrap search mode

Mark operation
C-SPC
ESC p
ESC n
"

Set/unset mark
Go to previous mark
Go to next mark
Mark by regular expression

Miscellany
!
H
o
C-k
C-c
C-z
q
Q

Execute shell command
Help (load this ﬁle)
Set option
Show cookie jar
Stop
Suspend
Quit (with conﬁrmation, if you like)
Quit without conﬁrmation

Line-edit mode
C-f
C-b
C-h
C-d
C-k
C-u
C-a
C-e
C-p
C-n
TAB,SPC
RETURN

Move cursor forward
Move cursor backward
Delete previous character
Delete current character
Kill everything after cursor
Kill everything before cursor
Move to the top of line
Move to the bottom of line
Fetch the previous string from the history list
Fetch the next string from the history list
Complete ﬁlename
Accept

http://w3m.sourceforge.net/MANUAL#Key:orig

5/9

9/16/2016

w3m manual

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
l
Cursor right
h
Cursor left
j
Cursor down
k
Cursor up
J
Roll up one line
K
Roll down one line
^
Go to the beginning of line
$
Go to the end of line
>
Shift screen right
<
Shift screen left
C-a
Go to the ﬁrst line
C-e
Go to the last line
G
Go to the speciﬁed line
Z
Move to the center line
z
Move to the center column
TAB,C-n,Down arrow Move to next hyperlink
ESC TAB,C-p,Up arrow Move to previous link
C-g
Show current page position

Hyperlink operation
RET, C-f,
Right arrow
d, ESC RET
u
i
I
ESC I
:
ESC :
c
=
C-h
F
M
ESC M

Follow hyperlink
Save link to ﬁle
Peek link URL
Peek image URL
View inline image
Save inline image to ﬁle
Mark URL-like strings as anchors
Mark Message-ID-like strings as news anchors
Peek current URL
Display information about current document
View history of URL
Render frame
Browse current document using external browser (use 2M and 3M to invoke
second and third browser)
Browse link using external browser (use 2ESC M and 3ESC M to invoke second and
third browser)

http://w3m.sourceforge.net/MANUAL#Key:orig

6/9

9/16/2016

w3m manual

File/Stream operation
g,U
V
@
#

Open URL
View new ﬁle
Execute shell command and load
Execute shell command and browse

Buﬀer operation
B, C-b, Left
arrow
\
s, C-h
E
C-l, C-w
R, C-r
S, p
ESC s
ESC e

Back to the previous buﬀer
View HTML source
Select buﬀer
Edit buﬀer source
Redraw screen
Reload buﬀer
Save buﬀer
Save source
Edit buﬀer image

Buﬀer selection mode
k, C-p
j, C-n
D
RET

Select previous buﬀer
Select next buﬀer
Delect current buﬀer
Go to the selected buﬀer

Bookmark operation
v, ESC b
a, ESC a

Load bookmark
Add current to bookmark

Search
/, C-s
n
w

Search forward
Search next
Toggle wrap search mode

Mark operation
C-SPC
P
N
"

Set/unset mark
Go to previous mark
Go to next mark
Mark by regular expression

Miscellany
http://w3m.sourceforge.net/MANUAL#Key:orig

7/9

9/16/2016

!
H, ?
o
C-k
C-c
C-z
q
Q

w3m manual

Execute shell command
Help (load this ﬁle)
Set option
Show cookie jar
Stop
Suspend
Quit (with conﬁrmation, if you like)
Quit without conﬁrmation

Line-edit mode
C-f
C-b
C-h
C-d
C-k
C-u
C-a
C-e
C-p
C-n
TAB,SPC
RETURN

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
Move the cursor to the place pointed by the mouse cursor. If you click the cursor and it is
click on an anchor, follow the anchor.
middle
Back to the previous buﬀer.
click
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 it. You can
drag 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

http://w3m.sourceforge.net/MANUAL#Key:orig

8/9

9/16/2016

w3m manual

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 deﬁnitions 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 directory where w3m-related ﬁles 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'' ﬁeld). You can specify multiple paths separated by `:',
like /usr/local/cgi-bin:/home/aito/cgi-bin. It is not recommended to include current
directory to this path.
The CGI script can use special header `w3m-control:' to control w3m. This ﬁeld can take any
function (see README.func), and the speciﬁed 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 buﬀer 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 buﬀer.
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 eﬀect when the CGI script is invoked through HTTP server.

http://w3m.sourceforge.net/MANUAL#Key:orig

9/9

Source Exif Data:

File Type                       : PDF
File Type Extension             : pdf
MIME Type                       : application/pdf
PDF Version                     : 1.4
Linearized                      : No
Page Count                      : 9
Creator                         : Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/53.0.2785.116 Safari/537.36
Producer                        : Skia/PDF m53
Create Date                     : 2016:09:15 17:34:31+00:00
Modify Date                     : 2016:09:15 17:34:31+00:00

EXIF Metadata provided by EXIF.tools

W3m Manual

Navigation menu

Versions of this User Manual:

Views

Navigation