5025 import and use mandoc
Reviewed by: Hans Rosenfeld <hans.rosenfeld@nexenta.com>
Reviewed by: Igor Kozhukhov <ikozhukhov@gmail.com>
Reviewed by: Robert Mustacchi <rm@joyent.com>
Reviewed by: Albert Lee <trisk@nexenta.com>
Approved by: TBD

*** 1,142 ****
! '\" te
! .\"  Copyright (c) 1996, Sun Microsystems, Inc.  All Rights Reserved
! .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
! .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
! .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
! .TH APROPOS 1 "Dec 20, 1996"
! .SH NAME
! apropos \- locate commands by keyword lookup
! .SH SYNOPSIS
! .LP
! .nf
! \fBapropos\fR \fIkeyword\fR...
! .fi
! 
! .SH DESCRIPTION
! .sp
! .LP
! The \fBapropos\fR utility displays the man page name, section number, and a
! short description for each man page whose \fBNAME\fR line contains
! \fIkeyword\fR. This information is contained in the \fB/usr/share/man/windex\fR
! database created by \fBcatman\fR(1M). If \fBcatman\fR(1M) was not run, or was
! run with the \fB-n\fR option, \fBapropos\fR fails. Each word is considered
! separately and the case of letters is ignored. Words which are part of other
! words are considered; for example, when looking for `compile', \fBapropos\fR
! finds all instances of `compiler' also.
! .sp
! .LP
! \fBapropos\fR is actually just the \fB-k\fR option to the \fBman\fR(1) command.
! .SH EXAMPLES
! .LP
! \fBExample 1 \fRTo find a man page whose NAME line contains a keyword
! .sp
! .LP
! Try
! 
! .sp
! .in +2
! .nf
! example% \fBapropos password\fR
! .fi
! .in -2
! .sp
! 
! .sp
! .LP
! and
! 
! .sp
! .in +2
! .nf
! example% \fBapropos editor\fR
! .fi
! .in -2
! .sp
! 
! .sp
! .LP
! If the line starts `\fIfilename\fR(\fIsection\fR) .\|.\|.' you can run
! 
! .sp
! .in +2
! .nf
! man -s \fIsection filename\fR
! .fi
! .in -2
! .sp
! 
! .sp
! .LP
! to display the man page for \fIfilename\fR.
! 
! .LP
! \fBExample 2 \fRTo find the man page for the subroutine \fBprintf()\fR
! .sp
! .LP
! Try
! 
! .sp
! .in +2
! .nf
! example% \fBapropos format\fR
! .fi
! .in -2
! .sp
! 
! .sp
! .LP
! and then
! 
! .sp
! .in +2
! .nf
! example% \fBman -s 3s printf\fR
! .fi
! .in -2
! .sp
! 
! .sp
! .LP
! to get the manual page on the subroutine \fBprintf()\fR.
! 
! .SH FILES
! .sp
! .ne 2
! .na
! \fB\fB/usr/share/man/windex\fR \fR
! .ad
! .RS 26n
! table of contents and keyword database
! .RE
! 
! .SH ATTRIBUTES
! .sp
! .LP
! See \fBattributes\fR(5) for descriptions of the following attributes:
! .sp
! 
! .sp
! .TS
! box;
! c | c
! l | l .
! ATTRIBUTE TYPE  ATTRIBUTE VALUE
! _
! CSI     Enabled
! .TE
! 
! .SH SEE ALSO
! .sp
! .LP
! \fBman\fR(1), \fBwhatis\fR(1), \fBcatman\fR(1M), \fBattributes\fR(5)
! .SH DIAGNOSTICS
! .sp
! .ne 2
! .na
! \fB\f(CW/usr/share/man/windex: No such file or directory\fR\fR
! .ad
! .sp .6
! .RS 4n
! This database does not exist. \fBcatman\fR(1M) must be run to create it.
! .RE
! 
--- 1,79 ----
! .\"
! .\" This file and its contents are supplied under the terms of the
! .\" Common Development and Distribution License ("CDDL"), version 1.0.
! .\" You may only use this file in accordance with the terms of version
! .\" 1.0 of the CDDL.
! .\"
! .\" A full copy of the text of the CDDL should have accompanied this
! .\" source.  A copy of the CDDL is also available via the Internet at
! .\" http://www.illumos.org/license/CDDL.
! .\"
! .\"
! .\" Copyright 2012 Nexenta Systems, Inc. All rights reserved.
! .\" Copyright 2014 Garrett D'Amore <garrett@damore.org>
! .\"
! .Dd Jul 18, 2014
! .Dt APROPOS 1
! .Os
! .Sh NAME
! .Nm apropos ,
! .Nm whatis
! .Nd keyword search in
! .Nm whatis
! database files
! .Sh SYNOPSIS
! .Nm
! .Op Fl M Ar path
! .Op Fl s Ar section
! .Ar keyword ...
! .Nm whatis
! .Op Fl M Ar path
! .Op Fl s Ar section
! .Ar keyword ...
! .Sh DESCRIPTION
! The
! .Nm
! utility searches a set of
! .Nm whatis
! database files matching each
! .Ar keyword .
! The
! .Nm whatis
! utility does the same search but only on complete words. The
! .Nm whatis
! database files are created using the
! .Xr man 1
! command.
! .Sh OPTIONS
! .Bl -tag -width ".Fl d"
! .It Fl M Ar path
! Force a specific colon separated manual path instead of the default search path.
! Overrides the
! .Ev MANPATH
! environment variable.
! .It Fl s Ar section
! Restrict search to specified
! .Ar section .
! .El
! .Sh ENVIRONMENT
! The following environment variables affect the execution of
! .Nm :
! .Bl -tag -width ".Ev MANPATH , PATH"
! .It Ev MANPATH , PATH
! Used to find the location of the
! .Nm whatis
! database files.
! .El
! .Sh DIAGNOSTICS
! The
! .Nm
! utility exits 0 if a keyword matched and 1 if no keywords are matched or no
! .Nm whatis
! databases are found.
! .Sh INTERFACE STABILITY
! .Nm Committed .
! .Sh CODE SET INDEPENDENCE
! Enabled.
! .Sh SEE ALSO
! .Xr man 1 ,
! .Xr mandoc 1