-.\" $OpenBSD: man.1,v 1.55 2014/04/03 06:15:18 jmc Exp $
+.\" $Id: man.1,v 1.6 2014/10/25 01:03:52 schwarze Exp $
.\"
.\" Copyright (c) 1989, 1990, 1993
.\" The Regents of the University of California. All rights reserved.
+.\" Copyright (c) 2003, 2007, 2008, 2014 Jason McIntyre <jmc@openbsd.org>
+.\" Copyright (c) 2010, 2011 Ingo Schwarze <schwarze@openbsd.org>
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\"
.\" @(#)man.1 8.2 (Berkeley) 1/2/94
.\"
-.Dd $Mdocdate: August 21 2014 $
+.Dd $Mdocdate: October 25 2014 $
.Dt MAN 1
.Os
.Sh NAME
.Nd display manual pages
.Sh SYNOPSIS
.Nm man
-.Op Fl achw
+.Op Fl acfhklVw
.Op Fl C Ar file
.Op Fl M Ar path
.Op Fl m Ar path
.Op Fl s Ar section
.Op Ar section
.Ar name ...
-.Nm man
-.Fl f Ar command ...
-.Nm man
-.Fl k Ar keyword ...
.Sh DESCRIPTION
The
.Nm
utility
displays the
-.Bx
manual pages entitled
.Ar name .
Pages may be selected according to
.Xr more 1
to paginate it.
This is done by default if the standard output is not a terminal device.
-.It Fl f Ar command
+.It Fl f
A synonym for
.Xr whatis 1 .
-It looks up a given command and
-gives the header line from the manual page.
-.Ar command
-is case insensitive.
+It searches for
+.Ar name
+in manual page names and displays the header lines from all matching pages.
+The search is case insensitive and matches whole words only.
+This overrides any earlier
+.Fl k
+and
+.Fl l
+options.
.It Fl h
-Display only the
-.Dq SYNOPSIS
-lines of the requested manual pages.
-.It Fl k Ar keyword
+Display only the SYNOPSIS lines of the requested manual pages.
+Implies
+.Fl a .
+.It Fl k
A synonym for
.Xr apropos 1 .
-It shows which manual pages contain instances of any of the given
-keywords in their title line.
-.Ar keyword
-is case insensitive.
-.Pp
-For instance,
-to list all man pages which contain
-.Dq mount
-in the
-.Dq NAME
-line of the man page:
-.Pp
-.Dl $ man -k mount
-.Pp
-Which would produce a list much like this:
-.Bd -literal
-amd (8) \(en automatically mount file systems
-amq (8) \(en automounter query tool
-domountroothooks (9) \(en run all mountroot hooks
-exports (5) \(en define remote mount points for NFS mount requests
-getfsstat (2) \(en get list of all mounted file systems
-getmntinfo (3) \(en get information about mounted file systems
-mount (8) \(en mount file systems
-mount, unmount (2) \(en mount or dismount a filesystem
-mount_cd9660 (8) \(en mount an ISO-9660 filesystem
-mount_ext2fs (8) \(en mount an ext2fs file system
-mount_ffs (8) \(en mount a Berkeley Fast File System
-mount_msdos (8) \(en mount an MS-DOS file system
-mount_nfs (8) \(en mount NFS file systems
-mount_ntfs (8) \(en mount an NTFS file system
-mount_procfs (8) \(en mount the process file system
-mount_udf (8) \(en mount a UDF filesystem
-mount_vnd, vnconfig (8) \(en configure vnode disks
-mountd (8) \(en service remote NFS mount requests
-\&...
-.Ed
+Instead of
+.Ar name ,
+an expression can be provided using the syntax described in the
+.Xr apropos 1
+manual.
+By default, it displays the header lines of all matching pages.
+This overrides any earlier
+.Fl f
+and
+.Fl l
+options.
+.It Fl l
+A synonym for
+.Xr mandoc 1
+.Fl a .
+The
+.Ar name
+arguments are interpreted as filenames.
+No search is done and
+.Ar file ,
+.Ar path ,
+.Ar section ,
+and
+.Ar subsection
+are ignored.
+This overrides any earlier
+.Fl f ,
+.Fl k ,
+and
+.Fl w
+options.
.It Fl M Ar path
Override the list of standard directories which
.Nm
.Ar section
values, and their search order.
Additional sections may be specified.
+.It Fl V
+Print version and exit.
.It Fl w
List the pathnames of the manual pages which
.Nm
combination.
.El
.Pp
-Guidelines for
-.Ox
+The
+.Nm
+utility also supports the options
+.Fl IKOTW
+described in the
+.Xr mandoc 1
+manual.
+.Pp
+Guidelines for writing
man pages can be found in
.Xr mdoc 7 .
.Pp
git.ckatri.com / mandoc.git / blobdiff