Fix some source formatting in the manual
- Begin a sentence on a new line. - Split long lines (> 80). - Fix warnings from "mandoc -Tlint" - Remove space at end of lines. - Change a HYPHEN-MINUS (code 0x55, 2D) to a dash (minus) if it matches " -[:alpha:]" or \[aq]-[:alpha:] (for options). - Use the macros .MT/.ME for e-mail addresses Origin: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=963801#5
This commit is contained in:
committed by
Tatsuya Kinoshita
parent
aa078ed98a
commit
baefa5f5f8
83
doc/w3m.1
83
doc/w3m.1
@@ -16,15 +16,19 @@ w3m [OPTION]... [ \fIfile\fP | \fIURL\fP ]...
|
|||||||
.if \nD==0 .nr D 5
|
.if \nD==0 .nr D 5
|
||||||
|
|
||||||
\fIw3m\fP is a text based browser which can display local or remote
|
\fIw3m\fP is a text based browser which can display local or remote
|
||||||
web pages as well as other documents. It is able to process HTML
|
web pages as well as other documents.
|
||||||
|
It is able to process HTML
|
||||||
tables and frames but it ignores JavaScript and Cascading Style
|
tables and frames but it ignores JavaScript and Cascading Style
|
||||||
Sheets. \fIw3m\fP can also serve as a pager for text files named as
|
Sheets.
|
||||||
|
\fIw3m\fP can also serve as a pager for text files named as
|
||||||
arguments or passed on standard input, and as a general purpose
|
arguments or passed on standard input, and as a general purpose
|
||||||
directory browser.
|
directory browser.
|
||||||
|
|
||||||
\fIw3m\fP organizes its content in buffers or tabs, allowing easy
|
\fIw3m\fP organizes its content in buffers or tabs, allowing easy
|
||||||
navigation between them. With the w3m-img extension installed, \fIw3m\fP can
|
navigation between them.
|
||||||
display inline graphics in web pages. And whenever \fIw3m\fP's HTML
|
With the w3m-img extension installed, \fIw3m\fP can
|
||||||
|
display inline graphics in web pages.
|
||||||
|
And whenever \fIw3m\fP's HTML
|
||||||
rendering capabilities do not meet your needs, the target URL can be
|
rendering capabilities do not meet your needs, the target URL can be
|
||||||
handed over to a graphical browser with a single command.
|
handed over to a graphical browser with a single command.
|
||||||
|
|
||||||
@@ -33,7 +37,8 @@ For help with runtime options, press \(lqH\(rq while running \fIw3m\fP.
|
|||||||
.SH ARGUMENTS
|
.SH ARGUMENTS
|
||||||
|
|
||||||
When given one or more command line arguments, \fIw3m\fP will handle
|
When given one or more command line arguments, \fIw3m\fP will handle
|
||||||
targets according to content type. For web, \fIw3m\fP gets this
|
targets according to content type.
|
||||||
|
For web, \fIw3m\fP gets this
|
||||||
information from HTTP headers; for relative or absolute file system
|
information from HTTP headers; for relative or absolute file system
|
||||||
paths, it relies on filenames.
|
paths, it relies on filenames.
|
||||||
|
|
||||||
@@ -60,18 +65,24 @@ deactivate mouse support
|
|||||||
display each line's number
|
display each line's number
|
||||||
.TP
|
.TP
|
||||||
\fB\-N\fP
|
\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
|
||||||
\fB\-ppc \fInum\fR
|
\fB\-ppc \fInum\fR
|
||||||
width of \fInum\fR pixels per character. Range of 4.0 to 32.0, default 8.0.
|
width of \fInum\fR pixels per character.
|
||||||
Larger values will make tables narrower. (Implementation not verified)
|
Range of 4.0 to 32.0, default 8.0.
|
||||||
|
Larger values will make tables narrower.
|
||||||
|
(Implementation not verified)
|
||||||
.TP
|
.TP
|
||||||
\fB\-ppl \fInum\fR
|
\fB\-ppl \fInum\fR
|
||||||
height of \fInum\fR pixels per line. Range of 4.0 to 64.0. (Implementation not verified)
|
height of \fInum\fR pixels per line.
|
||||||
|
Range of 4.0 to 64.0.
|
||||||
|
(Implementation not verified)
|
||||||
.TP
|
.TP
|
||||||
\fB\-title\fP, \fB\-title=TERM\fP
|
\fB\-title\fP, \fB\-title=TERM\fP
|
||||||
use the buffer name as terminal title string. With specified TERM,
|
use the buffer name as terminal title string.
|
||||||
|
With specified TERM,
|
||||||
this sets the title configuration style accordingly
|
this sets the title configuration style accordingly
|
||||||
.TP
|
.TP
|
||||||
\fB\-v\fP
|
\fB\-v\fP
|
||||||
@@ -84,7 +95,8 @@ toggle wrapping mode in searches
|
|||||||
do not initialize/deinitialize the terminal
|
do not initialize/deinitialize the terminal
|
||||||
.TP
|
.TP
|
||||||
\fB+\fInum\fR
|
\fB+\fInum\fR
|
||||||
go to line \fInum\fR; only effective for \fInum\fR larger than the number of lines in the terminal
|
go to line \fInum\fR;
|
||||||
|
only effective for \fInum\fR larger than the number of lines in the terminal
|
||||||
.SS Browser options
|
.SS Browser options
|
||||||
.TP
|
.TP
|
||||||
\fB\-cols \fInum\fR
|
\fB\-cols \fInum\fR
|
||||||
@@ -100,7 +112,8 @@ render frames
|
|||||||
use or do not use graphic characters for drawing HTML table and frame borders
|
use or do not use graphic characters for drawing HTML table and frame borders
|
||||||
.TP
|
.TP
|
||||||
\fB\-header \fIstring\fR
|
\fB\-header \fIstring\fR
|
||||||
append \fIstring\fR to the HTTP(S) request. Expected to match the header syntax \f(CWVariable: Value\fP
|
append \fIstring\fR to the HTTP(S) request.
|
||||||
|
Expected to match the header syntax \f(CWVariable: Value\fP
|
||||||
.TP
|
.TP
|
||||||
\fB\-m\fP
|
\fB\-m\fP
|
||||||
Render the body of Usenet messages according to the header \(lqContent-type\(rq
|
Render the body of Usenet messages according to the header \(lqContent-type\(rq
|
||||||
@@ -109,14 +122,17 @@ Render the body of Usenet messages according to the header \(lqContent-type\(rq
|
|||||||
do not use proxy
|
do not use proxy
|
||||||
.TP
|
.TP
|
||||||
\fB\-post \fIfile\fR
|
\fB\-post \fIfile\fR
|
||||||
use POST method to upload data defined in \fIfile\fR. The syntax to be used
|
use POST method to upload data defined in \fIfile\fR.
|
||||||
|
The syntax to be used
|
||||||
is \f(CWvar1=value1[&var2=value2]...\fP
|
is \f(CWvar1=value1[&var2=value2]...\fP
|
||||||
.TP
|
.TP
|
||||||
\fB\-4\fP
|
\fB\-4\fP
|
||||||
IPv4 only. Corresponds to dns_order=4 in configuration files
|
IPv4 only.
|
||||||
|
Corresponds to dns_order=4 in configuration files
|
||||||
.TP
|
.TP
|
||||||
\fB\-6\fP
|
\fB\-6\fP
|
||||||
IPv6 only. Corresponds to dns_order=6 in configuration files
|
IPv6 only.
|
||||||
|
Corresponds to dns_order=6 in configuration files
|
||||||
.SS Text pager options
|
.SS Text pager options
|
||||||
.TP
|
.TP
|
||||||
\fB\-l \fInum\fR
|
\fB\-l \fInum\fR
|
||||||
@@ -132,7 +148,8 @@ characters) instead of processing them
|
|||||||
squeeze multiple blank lines into one
|
squeeze multiple blank lines into one
|
||||||
.TP
|
.TP
|
||||||
\fB\-t\fP \fInum\fP
|
\fB\-t\fP \fInum\fP
|
||||||
set tab width to \fInum\fR columns. No effect on stdout
|
set tab width to \fInum\fR columns.
|
||||||
|
No effect on stdout
|
||||||
.SS Data type/encoding options
|
.SS Data type/encoding options
|
||||||
.TP
|
.TP
|
||||||
\fB\-I \fIcharset\fR
|
\fB\-I \fIcharset\fR
|
||||||
@@ -146,7 +163,8 @@ explicit characterization of input data by MIME type
|
|||||||
.SS Options for data output, followed by immediate exit
|
.SS Options for data output, followed by immediate exit
|
||||||
.TP
|
.TP
|
||||||
\fB\-dump\fP
|
\fB\-dump\fP
|
||||||
dump rendered page into stdout. Set implicitly when output is directed
|
dump rendered page into stdout.
|
||||||
|
Set implicitly when output is directed
|
||||||
to a file or pipe
|
to a file or pipe
|
||||||
.TP
|
.TP
|
||||||
\fB\-dump_source\fP
|
\fB\-dump_source\fP
|
||||||
@@ -181,7 +199,8 @@ use \fIfile\fR instead of the default configuration file
|
|||||||
DO NOT USE
|
DO NOT USE
|
||||||
.TP
|
.TP
|
||||||
\fB\-o \fIoption=value\fR
|
\fB\-o \fIoption=value\fR
|
||||||
modify one configuration item with an explicitly given value; without \fIoption=value\fR, equivalent to \fB-show-option\fR
|
modify one configuration item with an explicitly given value;
|
||||||
|
without \fIoption=value\fR, equivalent to \fB\-show-option\fR
|
||||||
.TP
|
.TP
|
||||||
\fB\-reqlog\fP
|
\fB\-reqlog\fP
|
||||||
log headers of HTTP communication in file \f(CW~/.w3m/request.log\fP
|
log headers of HTTP communication in file \f(CW~/.w3m/request.log\fP
|
||||||
@@ -190,55 +209,55 @@ log headers of HTTP communication in file \f(CW~/.w3m/request.log\fP
|
|||||||
.TP
|
.TP
|
||||||
Combine snippets of HTML code and preview the page
|
Combine snippets of HTML code and preview the page
|
||||||
.EX
|
.EX
|
||||||
$ cat header.html footer.html | w3m -T text/html
|
$ cat header.html footer.html | w3m \-T text/html
|
||||||
.EE
|
.EE
|
||||||
.TP
|
.TP
|
||||||
Compare two files using tabs
|
Compare two files using tabs
|
||||||
.EX
|
.EX
|
||||||
$ w3m -N config.old config
|
$ w3m \-N config.old config
|
||||||
.EE
|
.EE
|
||||||
.SS Browser-like usage
|
.SS Browser-like usage
|
||||||
.TP
|
.TP
|
||||||
Display web content in monochrome terminal
|
Display web content in monochrome terminal
|
||||||
.EX
|
.EX
|
||||||
$ w3m -M http://w3m.sourceforge.net
|
$ w3m \-M http://w3m.sourceforge.net
|
||||||
.EE
|
.EE
|
||||||
.TP
|
.TP
|
||||||
Display embedded graphics
|
Display embedded graphics
|
||||||
.EX
|
.EX
|
||||||
$ w3m -o auto_image=TRUE http://w3m.sourceforge.net
|
$ w3m \-o auto_image=TRUE http://w3m.sourceforge.net
|
||||||
.EE
|
.EE
|
||||||
.TP
|
.TP
|
||||||
Display content from Usenet
|
Display content from Usenet
|
||||||
.EX
|
.EX
|
||||||
$ w3m -m nntp://news.aioe.org/comp.os.linux.networking
|
$ w3m \-m nntp://news.aioe.org/comp.os.linux.networking
|
||||||
.EE
|
.EE
|
||||||
.TP
|
.TP
|
||||||
Upload data for a URL using the POST method
|
Upload data for a URL using the POST method
|
||||||
.EX
|
.EX
|
||||||
$ w3m -post - http://example.com/form.php <<<'a=0&b=1'
|
$ w3m \-post \- http://example.com/form.php <<<'a=0&b=1'
|
||||||
.EE
|
.EE
|
||||||
.SS Filter-like usage
|
.SS Filter-like usage
|
||||||
.TP
|
.TP
|
||||||
Convert an HTML file to plain text with a defined line length
|
Convert an HTML file to plain text with a defined line length
|
||||||
.EX
|
.EX
|
||||||
$ w3m -cols 40 foo.html > foo.txt
|
$ w3m \-cols 40 foo.html > foo.txt
|
||||||
.EE
|
.EE
|
||||||
.TP
|
.TP
|
||||||
Output the bookmarks page as text with an appended list of links
|
Output the bookmarks page as text with an appended list of links
|
||||||
.EX
|
.EX
|
||||||
$ w3m -B -o display_link_number=1 > out.txt
|
$ w3m \-B \-o display_link_number=1 > out.txt
|
||||||
.EE
|
.EE
|
||||||
.TP
|
.TP
|
||||||
Conversion of file format and character encoding
|
Conversion of file format and character encoding
|
||||||
.EX
|
.EX
|
||||||
$ w3m -T text/html -I EUC-JP -O UTF-8 < foo.html > foo.txt
|
$ w3m \-T text/html \-I EUC-JP \-O UTF-8 < foo.html > foo.txt
|
||||||
.EE
|
.EE
|
||||||
.SS Start with no input
|
.SS Start with no input
|
||||||
.TP
|
.TP
|
||||||
Welcome users with a built-in page
|
Welcome users with a built-in page
|
||||||
.EX
|
.EX
|
||||||
$ w3m -v
|
$ w3m \-v
|
||||||
.EE
|
.EE
|
||||||
.\".SH Errors
|
.\".SH Errors
|
||||||
.SH ENVIRONMENT
|
.SH ENVIRONMENT
|
||||||
@@ -282,7 +301,9 @@ contains predefined values to fill recurrent HTML forms
|
|||||||
.\" .I $~/.w3m/urimethodmap
|
.\" .I $~/.w3m/urimethodmap
|
||||||
.\" ???
|
.\" ???
|
||||||
.SH SEE ALSO
|
.SH SEE ALSO
|
||||||
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
|
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
|
||||||
.UR http://w3m.sourceforge.net
|
.UR http://w3m.sourceforge.net
|
||||||
the project's web pages at
|
the project's web pages at
|
||||||
.UE
|
.UE
|
||||||
@@ -290,7 +311,7 @@ the project's web pages at
|
|||||||
\fIw3m\fP has incorporated code from several sources.
|
\fIw3m\fP 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
|
||||||
.UR aito@fw.ipsj.or.jp
|
.MT aito@fw.ipsj.or.jp
|
||||||
Akinori ITO
|
Akinori ITO
|
||||||
.UE
|
.ME
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user