Miscellaneous changes to improve English manpage

Origin: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=766550#30
This commit is contained in:
Markus Hiereth
2014-11-30 06:04:11 +09:00
committed by Tatsuya Kinoshita
parent d225ffa47a
commit 7d4a592721

302
doc/w3m.1
View File

@@ -1,13 +1,11 @@
.nr N -1 .nr N -1
.nr D 5 .nr D 5
.TH W3M 1 Local .TH w3m 1 "2014-11-24"
.UC 4 .UC 4
.SH NAME .SH NAME
w3m \- a text based Web browser and pager w3m \- a text based web browser and pager
.SH SYNOPSIS .SH SYNOPSIS
.B w3m w3m [OPTION]... [ \fIfile\fP | \fIURL\fP ]...
[options] [URL or filename]
.PP
.SH DESCRIPTION .SH DESCRIPTION
.\" This defines appropriate quote strings for nroff and troff .\" This defines appropriate quote strings for nroff and troff
.ds lq \&" .ds lq \&"
@@ -17,166 +15,177 @@ w3m \- a text based Web browser and pager
.\" Just in case these number registers aren't set yet... .\" Just in case these number registers aren't set yet...
.if \nN==0 .nr N 10 .if \nN==0 .nr N 10
.if \nD==0 .nr D 5 .if \nD==0 .nr D 5
.I
w3m \fIw3m\fP is a text based browser which can display local or remote
is a World Wide Web (WWW) text based client. It has English and web pages as well as other documents. It is able to process HTML
Japanese help files and an option menu and can be configured to tables and frames but it ignores JavaScript and Cascading Style
use either language. It will display hypertext markup language Sheets. \fIw3m\fP can also serve as a pager for text files named as
(HTML) documents containing links to files residing on the local arguments or passed on standard input, and as a general purpose
system, as well as files residing on remote systems. It can directory browser.
display HTML tables and frames.
In addition, it can be used as a "pager" in much the same manner \fIw3m\fP organizes its content in buffers or tabs, allowing easy
as "more" or "less". navigation between them. With the w3m-img extension installed, \fIw3m\fP can
Current versions of display inline graphics in web pages. And whenever \fIw3m\fP's HTML
.I rendering capabilities do not meet your needs, the target URL can be
w3m handed over to a graphical browser with a single command.
run on
Unix (Solaris, SunOS, HP-UX, Linux, FreeBSD, and EWS4800) For help with runtime options, press \(lqH\(rq while running \fIw3m\fP.
and on
Microsoft Windows 9x/NT. .SH ARGUMENTS
.PP
When given one or more command line arguments, \fIw3m\fP will handle
targets according to content type. For web, \fIw3m\fP gets this
information from HTTP headers; for relative or absolute file system
paths, it relies on filenames.
With no argument, \fIw3m\fP expects data from standard input and
assumes \(lqtext/plain\(rq unless another MIME type is given by the user.
If provided with no target and no fallback target (see for instance
option \fB\-v\fP below), \fIw3m\fP will exit with usage information.
.SH OPTIONS .SH OPTIONS
At start up, \fIw3m\fR will load any local Command line options are introduced with a single \(lq\-\(rq character and
file or remote URL specified at the command may take an argument.
line. For help with runtime options, press \fB"H"\fR .SS General options:
while running \fIw3m\fR.
Command line options are:
.PP
.TP .TP
.B -t tab \fB\-B\fP
set tab width with no other target defined, use the bookmark page for startup
.TP .TP
.B -r \fB\-M\fP
ignore backspace effect
.TP
.B -l line
# of preserved line (default 10000)
.TP
.B -I charset
document charset
.TP
.B -O charset
display/output charset
.TP
.B -B
load bookmark
.TP
.B -bookmark file
specify bookmark file
.TP
.B -T type
specify content-type
.TP
.B -m
internet message mode
.TP
.B -v
visual startup mode
.TP
.B -M
monochrome display monochrome display
.TP .TP
.B -N \fB\-no-mouse\fP
deactivate mouse support
.TP
\fB\-num\fP
display each line's number
.TP
\fB\-N\fP
distribute multiple command line arguments to tabs. By default, a distribute multiple command line arguments to tabs. By default, a
stack of buffers is used stack of buffers is used
.TP .TP
.B -F \fB\-ppc \fInum\fR
automatically render frame width of \fInum\fR pixels per character. Range of 4.0 to 32.0, default 8.0.
Larger values will make tables narrower. (Implementation not verified)
.TP .TP
.B -dump \fB\-ppl \fInum\fR
dump formatted page into stdout height of \fInum\fR pixels per line. Range of 4.0 to 64.0. (Implementation not verified)
.TP .TP
.B -cols num \fB\-title\fP, \fB\-title=TERM\fP
use the buffer name as terminal title string. With specified TERM,
this sets the title configuration style accordingly
.TP
\fB\-v\fP
with no other target defined, welcome users with a built-in page
.TP
\fB\-W\fP
toggle wrapping in searches
.TP
\fB\-X\fP
do not initialize/deinitialize the terminal
.TP
\fB+\fInum\fR
go to line \fInum\fR; only effective for \fInum\fR larger than the number of lines in the terminal
.SS Browser options:
.TP
\fB\-cols \fInum\fR
with stdout as destination; HTML is rendered to lines of \fInum\fR characters with stdout as destination; HTML is rendered to lines of \fInum\fR characters
.TP .TP
.B -ppc count \fB\-cookie\fP, \fB\-no-cookie\fP
specify the number of pixels per character (4.0...32.0). use stored cookies and accept new ones, or do neither
Larger values will make tables narrower. [default 8.0]
.TP .TP
.B -ppl count \fB\-F\fP
specify the number of pixels per line (4.0...64.0) render frames
.TP .TP
.B -dump_source \fB\-graph\fP, \fB\-no-graph\fP
dump page source into stdout use or do not use graphic characters for drawing HTML table and frame borders
.TP .TP
.B -dump_head \fB\-header \fIstring\fR
dump response of HEAD request into stdout append \fIstring\fR to the HTTP(S) request. Expected to match the header syntax \f(CW Variable: Value\fP
.TP .TP
.B -dump_both \fB\-m\fP
dump HEAD and source into stdout Render the body of Usenet messages according to the header \(lqContent-type\(rq
.TP .TP
.B -dump_extra \fB\-no-proxy\fP
dump HEAD, source, and extra information into stdout do not use proxy
.TP .TP
.B -post file \fB\-post \fIfile\fR
use POST method with file content use POST method to upload data defined in \fIfile\fR. The syntax to be used
is \f(CWvar1=value1[&var2=value2]...\fP
.TP .TP
.B -header string \fB\-4\fP
insert string as a header IPv4 only. Corresponds to dns_order=4 in configuration files
.TP .TP
.B +<num> \fB\-6\fP
goto <num> line IPv6 only. Corresponds to dns_order=6 in configuration files
.SS Text pager options:
.TP .TP
.B -num \fB\-l \fInum\fR
show line number number of lines preserved internally when receiving plain text from
stdin (default 10 000)
.TP .TP
.B -no-proxy \fB\-r\fP
don't use proxy 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
.TP .TP
.B -4 \fB\-s\fP
IPv4 only (-o dns_order=4) squeeze multiple blank lines into one
.TP .TP
.B -6 \fB\-t\fP \fInum\fP
IPv6 only (-o dns_order=6) set tab width to \fInum\fR columns. No effect on stdout
.SS Data type/encoding options:
.TP .TP
.B -no-mouse \fB\-I \fIcharset\fR
don't use mouse user defined character encoding of input data
.TP .TP
.B -cookie \fB\-O \fIcharset\fR
use cookie. user defined character encoding of output data
.TP .TP
.B -no-cookie \fB\-T \fItype\fR
don't use cookie explicit characterization of input data by MIME type
.SS Options for data output, followed by immediate exit:
.TP .TP
.B -graph \fB\-dump\fP
use graphic character dump rendered page into stdout. Set implicitly when output is directed
to a file or pipe
.TP .TP
.B -no-graph \fB\-dump_source\fP
don't use graphic character dump the page's source code into stdout
.TP .TP
.B -s \fB\-dump_head\fP
squeeze multiple blank lines dump response of a HEAD request for a URL into stdout
.TP .TP
.B -W \fB\-dump_both\fP
toggle wrap search mode dump HEAD, and source code for a URL into stdout
.TP .TP
.B -X \fB\-dump_extra\fP
don't use termcap init/deinit dump HEAD, source code, and extra information for a URL into stdout
.TP .TP
.B -title [=TERM] \fB\-help\fP
set buffer name to terminal title string. show a summary of compiled-in features and command line options
If TERM is specified, use the TERM style title configuration.
.TP .TP
.B -o option=value \fB\-show-option\fP
show all available config options
.TP
\fB\-version\fP
show the version of \fIw3m\fP
.SS Options for overriding default settings and resources:
.TP
\fB\-bookmark \fIfile\fR
use \fIfile\fR instead of the default bookmark.html file
.TP
\fB\-config \fIfile\fR
use \fIfile\fR instead of the default config file
.TP
\fB\-debug\fP
DO NOT USE
.TP
\fB\-o \fIoption=value\fR
modify one configuration item with an explicitly given value; without \fIoption=value\fR, equivalent to -show-option modify one configuration item with an explicitly given value; without \fIoption=value\fR, equivalent to -show-option
.TP .TP
.B -show-option \fB\-reqlog\fP
show all available config option log headers of HTTP communication in file \f(CW~/.w3m/request.log\fP
.TP
.B -config file
specify config file
.TP
.B -help
show usage
.TP
.B -version
show w3m version
.TP
.B -reqlog
write request logfile
.TP
.B -debug
DO NOT USE
.SH EXAMPLES .SH EXAMPLES
.SS Pager-like usage .SS Pager-like usage
.TP .TP
@@ -232,6 +241,10 @@ Welcome users with a built-in page
.EX .EX
$ w3m -v $ w3m -v
.EE .EE
.\".SH Errors
.SH ENVIRONMENT
\fIw3m\fP recognises the environment variable WWW_HOME as defining a
fallback target for use if it is invoked without one.
.SH FILES .SH FILES
.TP .TP
\f(CW~/.w3m/bookmark.html\fP \f(CW~/.w3m/bookmark.html\fP
@@ -270,26 +283,17 @@ contains predefined values to fill recurrent HTML forms
.\" .I $~/.w3m/urimethodmap .\" .I $~/.w3m/urimethodmap
.\" ??? .\" ???
.SH NOTES .SH NOTES
This is the This is the \fIw3m\fP 0.5.3 Release.
.I .SH SEE ALSO
w3m README and example files are to be found in the doc directory of your \fIw3m\fP installation. Recent information about \fIw3m\fP may be found on
0.5.3 Release. .UR http://w3m.sourceforge.net
.PP the project's web pages at
Please see the MANUAL.html file distributed with w3m for .UE
more detailed documentation.
Additional information about
.I
w3m
may be found on its Japanese language Web site located at:
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 .SH ACKNOWLEDGMENTS
.I \fIw3m\fP has incorporated code from several sources.
w3m
has incorporated code from several sources.
Users have contributed patches and suggestions over time. Users have contributed patches and suggestions over time.
.SH AUTHOR .SH AUTHOR
Akinori ITO <aito@fw.ipsj.or.jp> .UR aito@fw.ipsj.or.jp
Akinori ITO
.UE