summaryrefslogtreecommitdiffstats
path: root/usr.bin/catman/catman.1
diff options
context:
space:
mode:
authormarkm <markm@FreeBSD.org>2002-05-18 09:19:08 +0000
committermarkm <markm@FreeBSD.org>2002-05-18 09:19:08 +0000
commit7528001bd00aabf85cdf82b67961536208ea5c9f (patch)
tree13ad193e090d73a66e9cbb476cec92afc65d0279 /usr.bin/catman/catman.1
parent768f23ab17cc7b567acc41b7e4be3b92579b77f9 (diff)
downloadFreeBSD-src-7528001bd00aabf85cdf82b67961536208ea5c9f.zip
FreeBSD-src-7528001bd00aabf85cdf82b67961536208ea5c9f.tar.gz
Add C rewrites of catman and makewhatis. These aren't quite as
the submitter supplied them, as I did some WARNS=n fixups (mostly const-ification). Submitted by: John Rochester <john@jrochester.org>
Diffstat (limited to 'usr.bin/catman/catman.1')
-rw-r--r--usr.bin/catman/catman.1103
1 files changed, 103 insertions, 0 deletions
diff --git a/usr.bin/catman/catman.1 b/usr.bin/catman/catman.1
new file mode 100644
index 0000000..d019387
--- /dev/null
+++ b/usr.bin/catman/catman.1
@@ -0,0 +1,103 @@
+.\" Copyright (c) 2002 John Rochester
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" $FreeBSD$
+.\"
+.\" Note: The date here should be updated whenever a non-trivial
+.\" change is made to the manual page.
+.Dd May 11, 2002
+.Dt MAKEWHATIS 1
+.Os
+.Sh NAME
+.Nm catman
+.Nd "preformat man pages"
+.Sh SYNOPSIS
+.Nm
+.Op Fl fnrvL
+.Op Ar directories ...
+.Sh DESCRIPTION
+The
+.Nm
+utility preformats all the man pages in
+.Ar directories
+using the
+.Ic "nroff -man"
+command.
+Directories may be separated by colons instead of spaces.
+If no
+.Ar directories
+are specified, the contents of the
+.Ev MANPATH
+environment variable is used or if that is not set the default directory
+.Pa /usr/share/man
+is processed.
+.Pp
+The options are as follows:
+.Bl -tag -width ".Fl L"
+.It Fl f
+forces all man pages to be reformatted even if the corresponding cat page
+is newer.
+.It Fl L
+Process only localized subdirectories corresponding to the locale specified
+in the standard environment variables.
+.It Fl n
+prints out what would be done instead of performing any formatting.
+.It Fl r
+scans for and removes "junk" files that are neither man pages nor their
+corresponding formatted cat pages.
+.It Fl v
+makes
+.Nm
+more verbose about what it is doing.
+.El
+.Sh ENVIRONMENT
+.Bl -tag -width ".Ev MANPATH" -compact
+.It Ev LC_ALL , LC_CTYPE , LANG
+These variables control what subdirectories will be processed if the
+.Fl L
+option is used.
+.It Ev MANPATH
+Determines the set of directories to be processed if none are given on
+the command line.
+.El
+.Sh FILES
+.Bl -tag -width ".Pa /usr/share/man" -compact
+.It Pa /usr/share/man
+Default directory to process if the
+.Ev MANPATH
+environment variable is not set.
+.El
+.Sh DIAGNOSTICS
+.Ex -std
+.Sh SEE ALSO
+.Xr man 1 ,
+.Xr makewhatis 1 ,
+.Xr nroff 1
+.Sh HISTORY
+A previous version of the
+.Nm
+command appeared in
+.Fx 2.1 .
+.Sh AUTHORS
+.An John Rochester .
OpenPOWER on IntegriCloud