xref: /openbsd/share/man/man1/pkg_check-manpages.1 (revision 4cfece93)
1.\"	$OpenBSD: pkg_check-manpages.1,v 1.1 2018/07/10 09:05:47 espie Exp $
2.\"
3.\" Copyright (c) 2010 Marc Espie <espie@openbsd.org>
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.Dd $Mdocdate: July 10 2018 $
18.Dt PKG_CHECK-MANPAGES 1
19.Os
20.Sh NAME
21.Nm pkg_check-manpages
22.Nd verify manpage subjects in packages
23.Sh SYNOPSIS
24.Nm
25.Op Fl p
26.Op Ar pkgname ...
27.Sh DESCRIPTION
28.Nm
29is used to check manpages in a collection of packages.
30It will extract all manpages from the
31.Ar pkgname
32arguments into a directory named
33.Pa manpages.XXXXXXXXXXXX
34.Po
35see
36.Xr mktemp 1
37.Pc
38and run them through
39.Xr makewhatis 8 .
40.Pp
41Note that this directory is not cleared on exit, so that the problematic
42manpages can be examined more precisely.
43.Pp
44If no
45.Ar pkgname
46argument is passed, it will process all
47.Pa *.tgz
48files in the current directory.
49.Pp
50Options are as follows:
51.Bl -tag -width packing-list
52.It Fl p
53Run
54.Xr makewhatis 8
55in picky mode.
56.El
57.Pp
58Errors reported in picky mode should usually be fixed, as it means the
59subject line stored in the whatis database will be useless to find out
60the corresponding manpage.
61