Intial commit
[profile/ivi/w3m.git] / scripts / w3mman / w3mman.1.in
1 .TH W3MMAN 1 "Nov 5, 2005"
2 .\" Please adjust this date whenever revising the manpage.
3 .\"
4 .\" Some roff macros, for reference:
5 .\" .nh        disable hyphenation
6 .\" .hy        enable hyphenation
7 .\" .ad l      left justify
8 .\" .ad b      justify to both left and right margins
9 .\" .nf        disable filling
10 .\" .fi        enable filling
11 .\" .br        insert line break
12 .\" .sp <n>    insert n+1 empty lines
13 .\" for manpage-specific macros, see man(7)
14 .SH NAME
15 w3mman \- an interface to the on-line reference manuals by w3m(1)
16 .SH SYNOPSIS
17 .B w3mman
18 .RI "[-M " path ] " " [ section ] " page"
19 .br
20 .B w3mman
21 .RI "[-M " path "] -k " keyword
22 .br
23 .B w3mman
24 .RI -l " file
25 .SH DESCRIPTION
26 .B w3mman
27 is the system's manual pager by 
28 .BR w3m (1).
29 .SH OPTIONS
30 A summary of options is included below.
31 .TP
32 .BI \-M " path"
33 Specify 
34 .I path
35 as MANPATH.
36 .TP
37 .BI \-k " keyword"
38 Specify 
39 .I keyword.
40 .TP
41 .BI \-l " file"
42 Specify a  
43 .I file.
44 .SH ENVIRONMENT
45 .TP
46 .B W3MMAN_W3M
47 If W3MMAN_W3M is set, its value is used instead of @W3M@.
48 .TP
49 .B W3MMAN_MAN
50 If W3MMAN_MAN is set, its value is used instead of @MAN@.
51 .SH FILES
52 .TP
53 .I @libexecdir@/@PACKAGE@/cgi-bin/w3mman2html.cgi
54 convert manual page to html.
55 .SH SEE ALSO
56 .BR man (1),
57 .BR w3m (1).
58 .SH AUTHOR
59 This manual page was written by Fumitoshi UKAI <ukai@debian.or.jp>,
60 for the Debian GNU/Linux system (but may be used by others).