.\" Copyright (c) 1995 Wolfram Schneider, Berlin. 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.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"    This product includes software developed by Wolfram Schneider
.\" 4. The name of the author may not be used to endorse or promote products
.\"    derived from this software without specific prior written permission
.\"
.\" 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.
.\"
.\" $Id: manck.1,v 1.2 1996/05/30 16:22:06 wosch Exp $
.\"
.\" manck - check manual pages
.Dd July 25, 1995
.Os FreeBSD 2.2
.Dt MANCK 1
.Sh NAME
.Nm manck
.Nd check manual pages
.Sh SYNOPSIS
.Nm manck
.Op Fl d
.Op Fl h \&| Ns Fl \&?
.Op Fl help
.Op Fl bin Ar path
.Op Fl exclude_files Ar file
.Op Fl exclude_pages Ar file
.Op Fl u=section
.Op Fl i \&| Ns Fl include Ar includepath
.Op Fl xref
.Op Fl files
.Op Fl M Ar manpath
.Op Ar manpages ...
.Sh DESCRIPTION
.Nm Manck
check manual pages. Currently supported section FILES, NAME, SEE ALSO, and
SYNOPSIS.
.Nm Manck
checks all man pages in the directory
.Ar /usr/share/man
if no
.Ar manpages
defined. See option
.Fl M

.Pp
The options are as follows:

.Bl -tag -width 10n -offset indent
.It Fl d \&| Ns Fl debug
Be more verbose about what will be done.  For a single
.Fl d
option, print more errors and warnings. If the option
.Fl d
has been specified at least twice, print verbose errors and warnings.
One
.Fl d
is recommend for a thorough review.

.It Fl h \&| Ns Fl \&?
.It Fl help
Give a help on the command usage and exit.

.It Fl bin Ar path
Look for binaries in
.Ar path
without a corresponding manpage. Colons in
.Ar path
are allowed. Default /bin:/sbin:/usr/bin:/usr/sbin

.It Fl exclude_files Ar file
.Ar file
contains a list of missing files that are ``ok'' to be missing
in the FILES section.

.It Fl exclude_pages Ar file
.Ar file
contains a list of missing manpages that are ``ok'' to be missing.

.It Fl files
Scan entire man page for file names that have been specified with the
``.Pa'' or ``.It Pa'' macros. This option is independent
from section FILES, so it is possible that
.Nm manck
may report errors twice.

.It Fl i \&| Ns Fl include Ar includepath
Path where include files located.
Colons in
.Ar includepath
are allowed. Default /usr/include:/usr/local/include:/usr/X11/include.

.It Fl u=section
Don't check section
.Ar section.

.It Fl xref
Scan entire man page for references to other man pages that have been
referenced with the ``.Xr'' or ``.Fn'' macros. This option is independent
from the SEE ALSO section, so it is possible that
.Nm manck
may report errors twice.

.It Fl M Ar manpath
Use
.Ar manpath
as the directory where manpages are located. Colons in
.Ar manpath
are allowed. Default /usr/share/man

.Sh EXAMPLES
.Pp
.Dl $ manck -bin
.Pp
Test if all binaries in /bin:/sbin:/usr/bin:/usr/sbin have their own
manpages

.Pp
.Dl $ manck /usr/share/man/man1/z*
.Pp
Check all manpages with leading 'z' in /usr/share/man/man1.

.Pp
.Dl $ manck
.Pp
Recursively check all manpages in /usr/share/man.

.Sh FILES
.Bl -tag -width /usr/share/manxxxx -compact
.It Pa /usr/share/man
directory for manual pages.
.El

.Sh ENVIRONMENT
.Bl -tag -width /usr/share/manxxxx -compact
.It $MANPATH
directories for searching cross references.
.El

.Sh SEE ALSO
.Xr man 1 ,
.Xr hier 7 .

.Sh HISTORY
.Nm manck
appeared in late July 1995.

.Sh AUTHOR
Wolfram Schneider, Berlin