aboutsummaryrefslogtreecommitdiffstats
path: root/scripts/w3mman/w3mman.1.in
diff options
context:
space:
mode:
Diffstat (limited to 'scripts/w3mman/w3mman.1.in')
-rw-r--r--scripts/w3mman/w3mman.1.in46
1 files changed, 32 insertions, 14 deletions
diff --git a/scripts/w3mman/w3mman.1.in b/scripts/w3mman/w3mman.1.in
index 1c0361d..68e3afc 100644
--- a/scripts/w3mman/w3mman.1.in
+++ b/scripts/w3mman/w3mman.1.in
@@ -1,4 +1,4 @@
-.TH W3MMAN 1 "Nov 5, 2005"
+.TH W3MMAN 1 "2016-07-13"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
@@ -12,36 +12,54 @@
.\" .sp <n> insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
-w3mman \- an interface to the on-line reference manuals by w3m(1)
+w3mman \- an interface to the on-line reference manuals via w3m(1)
.SH SYNOPSIS
+.\" mh 2016-07-04: "page" is an optional argument.
+.\" Started without it, w3mman displays a form that allows selection
+.\" of a manual page according to section, name and keyword.
+.\" Therefore square brackets introduced
.B w3mman
-.RI "[-M " path ] " " [ section ] " page"
+[
+.BI \-M " path"
+] [ [
+.I section
+]
+.I page
+]
.br
.B w3mman
-.RI "[-M " path "] -k " keyword
+[
+.BI \-M " path"
+] [
+.I section
+]
+.BI \-k " keyword"
.br
.B w3mman
-.RI -l " file
+.BI \-l " file"
+.br
.SH DESCRIPTION
+.\" mh 2016-07-04 text edited. This section shall deliver
+.\" more information than section NAME
.B w3mman
-is the system's manual pager by
-.BR w3m (1).
+is a Perl script that uses
+.BR w3m (1)
+to serve as a pager for on-line reference manuals.
.SH OPTIONS
A summary of options is included below.
.TP
.BI \-M " path"
-Specify
+Specify
.I path
-as MANPATH.
+as alternative MANPATH to use.
.TP
.BI \-k " keyword"
-Specify
-.I keyword.
+Specify \fIkeyword\fP.
.TP
.BI \-l " file"
-Specify a
-.I file.
+Specify a \fIfile\fP.
.SH ENVIRONMENT
+Two variables are available for debugging.
.TP
.B W3MMAN_W3M
If W3MMAN_W3M is set, its value is used instead of @W3M@.
@@ -51,7 +69,7 @@ If W3MMAN_MAN is set, its value is used instead of @MAN@.
.SH FILES
.TP
.I @libexecdir@/@PACKAGE@/cgi-bin/w3mman2html.cgi
-convert manual page to html.
+manual page to HTML converter.
.SH SEE ALSO
.BR man (1),
.BR w3m (1).