Module Name: src
Committed By: lukem
Date: Fri Nov 29 07:55:10 UTC 2024
Modified Files:
src/usr.bin/man: man.1
Log Message:
man(1): document arguments in the list
For options that have an argument, add that argument to
the entry in the list.
To generate a diff of this commit:
cvs rdiff -u -r1.30 -r1.31 src/usr.bin/man/man.1
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/usr.bin/man/man.1
diff -u src/usr.bin/man/man.1:1.30 src/usr.bin/man/man.1:1.31
--- src/usr.bin/man/man.1:1.30 Sat Jun 18 02:14:39 2022
+++ src/usr.bin/man/man.1 Fri Nov 29 07:55:10 2024
@@ -1,4 +1,4 @@
-.\" $NetBSD: man.1,v 1.30 2022/06/18 02:14:39 gutteridge Exp $
+.\" $NetBSD: man.1,v 1.31 2024/11/29 07:55:10 lukem Exp $
.\"
.\" Copyright (c) 1989, 1990, 1993
.\" The Regents of the University of California. All rights reserved.
@@ -29,7 +29,7 @@
.\"
.\" @(#)man.1 8.2 (Berkeley) 1/2/94
.\"
-.Dd June 18, 2022
+.Dd November 29, 2024
.Dt MAN 1
.Os
.Sh NAME
@@ -47,15 +47,15 @@
.Op Fl s
.Ar section
.Oc
-.Ar name Ar ...
+.Ar name Ar \&...
.Nm
.Op Fl C Ar file
-.Fl f
-.Ar command Ar ...
+.Fl f Ar command
+.Ar \&...
.Nm
.Op Fl C Ar file
-.Fl k
-.Ar keyword Ar ...
+.Fl k Ar keyword
+.Ar \&...
.Nm
.Fl p
.Sh DESCRIPTION
@@ -63,7 +63,7 @@ The
.Nm
utility displays the manual pages named on the command line.
Its options are as follows:
-.Bl -tag -width indent
+.Bl -tag -width Fl
.It Fl a
Display all of the man pages for a specified
.Ar section
@@ -71,7 +71,7 @@ and
.Ar name
combination.
(Normally, only the first man page found is displayed.)
-.It Fl C
+.It Fl C Ar file
Use the specified
.Ar file
instead of the default configuration file.
@@ -84,7 +84,7 @@ Copy the man page to the standard output
.Xr more 1
to paginate it.
This is done by default if the standard output is not a terminal device.
-.It Fl f
+.It Fl f Ar command
Synonym for
.Xr whatis 1 .
It searches man pages for
@@ -97,12 +97,12 @@ lines of the requested man pages.
For commands, this is typically the command line usage information.
For library functions, this usually contains the required include
files and function prototypes.
-.It Fl k
+.It Fl k Ar keyword
Search man pages for
.Ar keyword Ns Pq s ,
in the same manner as
.Xr apropos 1 .
-.It Fl M
+.It Fl M Ar path
Override the list of standard directories which
.Nm
searches for man pages.
@@ -119,7 +119,7 @@ is specified by the
line in the
.Nm
configuration file.
-.It Fl m
+.It Fl m Ar path
Augment the list of standard directories which
.Nm
searches for man pages.
@@ -142,10 +142,11 @@ line in the
configuration file.
.It Fl p
Print the search path for the manual pages.
-.It Fl s
+.It Fl s Ar section
Restrict the directories that
.Nm
-will search to the specified section.
+will search to the specified
+.Ar section .
The
.Nm
configuration file (see
@@ -153,9 +154,10 @@ configuration file (see
specifies the possible
.Ar section
values that are currently available.
-.It Fl S
-Display only man pages that have the specified string in the directory
-part of their filenames.
+.It Fl S Ar srch
+Display only man pages that have the specified string
+.Ar srch
+in the directory part of their filenames.
This allows the man page search process criteria to be
narrowed without having to change the MANPATH or
.Dq _default
