Package: w3m
Version: 0.5.3-8
Severity: normal
Dear Tatsuya,
while working on a German version of w3m's manpage, I found a lot of
things that could be improved about it.
Therefore, I revized the document. Maybe, this version allows closing
the bugreports
268211
530468
345084
285251
Please have check the attached draft for an improved manpage. I also
passed it to the English language team, hoping to get hints on style
and language.
Best regards
Markus
-- System Information:
Debian Release: 7.6
APT prefers stable
APT policy: (500, 'stable')
Architecture: i386 (i686)
Kernel: Linux 3.2.0-4-486
Locale: LANG=de_DE, LC_CTYPE=de_DE (charmap=ISO-8859-1)
Shell: /bin/sh linked to /bin/dash
Versions of packages w3m depends on:
ii libc6 2.13-38+deb7u2
ii libgc1c2 1:7.1-9.1
ii libgpm2 1.20.4-6
ii libssl1.0.0 1.0.1e-2+deb7u11
ii libtinfo5 5.9-10
ii zlib1g 1:1.2.7.dfsg-13
Versions of packages w3m recommends:
ii ca-certificates 20130119
Versions of packages w3m suggests:
ii man-db 2.6.2-1
pn menu <none>
pn migemo <none>
ii mime-support 3.52-1
pn w3m-el <none>
ii w3m-img 0.5.3-8
-- no debconf information
.nr N -1
.nr D 5
.TH W3M 1 "2014-10-23"
.\"improvements with respeckt to bugreport 268211
.UC 4
.SH NAME
w3m \- a text based Web browser and pager
.SH SYNOPSIS
.SS
pager mode
\fBw3m\fP [-t | -r | -M | -config \fIfile\fP | -I \fIcharset\fP | -O \fIcharset\fP ]
.SS
browse and file view mode
.\"fixes bugreports 530468 345084
\fBw3m\fP [-t | -r | -B | -M | -N | -W | -X | -num | -graph | -cookie | -title | -reqlog ] \fIfile\fP | \fIURL\fP [...]
.SS
remote target data mode
\fBw3m\fP [-m | -dump_source | -dump_head | -dump_both | -dump_extra ] \fIURL\fP
.SS
filter mode
\fBw3m\fP [ -dump | -cols \fIN\fP | -I \fIcharset\fP | -O \fIcharset\fP | -T \fItype\fP ] [ \fIfile\fP | \fIURL\fP ]
.SS
special startups
\fBw3m\fP [ -v | -B | -bookmark \fIfile\fP ]
.SS
usage information
\fBw3m\fP [ -o | -show-option | -help | -version ]
.SH DESCRIPTION
.\".\" This defines appropriate quote strings for nroff and troff
.\".ds lq \&"
.\".ds rq \&"
.\".if t .ds lq ``
.\".if t .ds rq ''
.\".\" Just in case these number registers aren't set yet...
.\".if \nN==0 .nr N 10
.\".if \nD==0 .nr D 5
\fIw3m\fP 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 \fBw3m\fP run on
Unix (Solaris, SunOS, HP-UX, Linux, FreeBSD, and EWS4800) and on
Microsoft Windows 9x/NT.
.SH OPTIONS
At start up, \fBw3m\fP will load any local ile or remote URL specified
at the command line. For help with runtime options, press \fI"H"\fP
while running \fBw3m\fP. Command line options are:
.TP
\fB-t\fP \fIN\fP
set tab width to N columns
.TP
\fB-r\fP
ignore backspace effect
.TP
\fB-l \fIN\fR
preserve N lines of STDIN input (default 10000)
.TP
\fB-I \fIcharset\fR
user defined character encoding of input data
.TP
\fB-O \fIcharset\fR
user defined character encoding of output data
.TP
\fB-T \fItype\fR
explicite characterization of input data by MIME type
.TP
\fB-B\fP
load stored bookmarks
.TP
\fB-bookmark \fIfile\fR
specifies bookmark file to be used (default \fC~/.w3m/bookmark.html\fP)
.TP
\fB-v\fP
allows starting with no defined input via STDIN, file or URL
.TP
\fB-F\fP
render frames
.TP
.\"fixes bugreports 530468 345084
\fB-N\fP
distributes series of input, one tab per file or URL. By default series of input files loaded in a stack of buffers.
.TP
\fB-M\fP
monochrome display
.TP
\fB-no-mouse\fP
do not use mouse
.TP
\fB-num\fP
display each line's number
.TP
\fB+\fIN\fR
go to line N, only effective for N larger than number of lines in the terminal
.TP
\fB-m\fP
internet message mode
.TP
\fB-graph\fP
use graphic characters for borders of frames and tables
.TP
\fBno-graph\fP
do not use graphic characters for borders of frames and tables
.TP
\fB-S\fP
squeeze multiple blank lines
.TP
\fB-W\fP
toggle wrap search mode
.TP
\fB-title\fP
use the buffer name as terminal title string.
If TERM is specified, TERM style title configuration is used
.TP
\fB-X\fP
do not use termcap init/deinit
.TP
\fB-ppc \fIN\fR
width of N pixels per character. Range of 4.0 to 32.0, default 8.0.
Larger values will make tables narrower.
.TP
\fB-ppl \fIN\fR
height of N pixels per line. Range of 4.0 to 64.0.
.TP
\fB-dump\fP
dump formatted/rendered page into STDOUT
.\" bugreport 285251
.TP
\fB-dump_source\fP
dump source code into STDOUT
.TP
\fB-dump_head\fP
dump response of HEAD request into STDOUT
.TP
\fB-dump_both\fP
dump HEAD and source code into STDOUT
.TP
\fB-dump_extra\fP
dump HEAD, source code and extra information into STDOUT
.TP
\fB-cols \fIN\fR
renders HTML input to lines of N characters length (to be used with -dump)
.TP
\fB-post \fIfile\fR
use POST method with file content
.TP
\fB-header \fIstring\fR
insert string as a header
.TP
\fB-no-proxy\fP
do not use proxy
.TP
\fB-4\fP
IPv4 only (equivalent to -o dns_order=4)
.TP
\fB-6\fP
IPv6 only (equivalent to -o dns_order=6)
.TP
\fB-cookie\fP
accept and use cookies
.TP
\fB-no-cookie\fP
neither accept nor use cookies
.TP
\fB-show-option\fP
show all available config option
.TP
\fB-config \fIfile\fR
use file instead of the default configuration file \fC~/.w3m/config
.TP
\fB-o \fIoption=value\fR
assign value to config option
.TP
\fB-help\fP
show \fBw3m's\fP version and help on invocation of the programm in the command line
.TP
\fB-version\fP
show version version of \fBw3m\fP
.TP
\fB-reqlog\fP
log headers of HTTP communication in file \fC~/.w3m/request.log
.TP
\fB-debug\fP
DO NOT USE
.SH EXAMPLES
.\"fixes Bug report 380560 Use simplest example
.TP
\fBw3m\fP as a pager
\fC$ ls | w3m\fP
.TP
HTML files displayed by \fBw3m\fP
\fC$ w3m foo.html |
.br
$ cat foo.html | w3m -T text/html\fP
.TP
Conversion of HTML content by \fBw3m\fP
$ cat foo.html | w3m -dump -T text/html >foo.txt
.\"fixes bug report 403634 man w3m: add a FILES section
.SH FILES
.TP
\fC${HOME}/.w3m/config\fP
user defined configuration file, overrides \fC$/etc/w3m/config\fP
.TP
\fC${HOME}/.w3m/keymap\fP
user defined key binding, overrides default key binding
.TP
\fC${HOME}/.w3m/menu\fP
user defined menu, overrides default menu
.TP
\fC${HOME}/.w3m/mouse\fP
user defined mouse settings
.TP
\fC${HOME}/.w3m/cookie\fP
deposit of cookies between termination and start of of \fBw3m\fP
.TP
\fC${HOME}/.w3m/history\fP
history of visited files and URLs
.TP
\fC${HOME}/.w3m/passwd\fP
password and username file
.TP
\fC${HOME}/.w3m/pre_form\fP
contains predefined values to fill recurrent html forms with
.TP
\fC${HOME}/.w3m/mailcap\fP
external viewer configuration file
.TP
\fC${HOME}/.w3m/mime.types\fP
MIME types file
.\" .TP
.\" .I ${HOME}/.w3m/urimethodmap
.\" ???
.SH NOTES
This is the \fBw3m\fP 0.5.3 Release.
.PP
Please see the MANUAL.html file distributed with \fBw3m\fP for
more detailed documentation.
.PP
Additional information about \fBw3m\fP may be found on its Japanese
language Web site located at:
.br
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 ACKNOWLEDGMENTS
\fBw3m\fP has incorporated code from several sources.
Users have contributed patches and suggestions over time.
.SH AUTHOR
Akinori ITO <a...@fw.ipsj.or.jp>
