.if n .pH m_index.permuse @(#)permuse	40.9
.\" Copyright 1989 AT&T
.tr ~
.BK "Product Overview and Master Index"
.CH "Permuted Index" "3"
.H 1 "Using the Permuted Index"
The comprehensive permuted index directs you to
manual pages located throughout the
UNIX\(rg System Documentation Set.
Manual pages are concise reference pages that assume
some familiarity with the information.
Detailed discussions and procedures on select topics are covered in the guide
volumes and can be found using the subject index.
.H 2 "How the Permuted Index Is Created"
Many users find that understanding a few things about how the
permuted index is created helps them to read it more
effectively and clarifies what kind of information can and cannot
be obtained from it.
.P
The basic building block for the index is the one-line
description given in the
.SM NAME
line on the top of each manual page.
For example, this is what the top of
the \f4mountall\f1(1M) manual
page looks like:
.TS
center expand ;
l c r .
_
.SP
\s-2\f(HBmountall(1M)	(Essential Utilities)	mountall(1M)\fP\s0
.TE
.DS
\s-1\f(HBNAME\fP
	\f4mountall, umountall\f1 \-  mount, unmount multiple file systems\s0
.DE
.TS
center expand ;
l r.
_
 	 
.TE
Each
.SM NAME
line includes:
.BL
.LI
the command, file format, system call
or other utility for which the manual page
is named (this is the primary utility; \f4mountall\fP
is the primary utility in the example)
.LI
secondary utilities, which are also described on that
manual page and do not have a separate manual page of
their own (\f4umountall\fP is a secondary utility in the example)
.LI
a brief description of the utility function(s)
.LE
.P
For each manual page \s-2NAME\s+2 line, the indexing software
generates several index entries, generally one entry for each
keyword in the phrase.
The middle column of the index is alphabetized on these keywords.
.P
For:
.DS I
\s-1\f(HBNAME\fP
	\f4mountall, umountall\f1 \-  mount, unmount multiple file systems\s0
.DE
.P
This is generated:
.DS
.Px
.xx "" "mount, unmount multiple" "file systems." "/umountall:" mountall(1M)\0\s-1\fHSARM\fP\s0
.xx "systems." "mountall, umountall:" "mount, unmount multiple file" "" mountall(1M)\0\s-1\fHSARM\fP\s0
.xx "unmount multiple file systems." "" "mountall, umountall: mount," "" mountall(1M)\0\s-1\fHSARM\fP\s0
.xx "" "/umountall: mount, unmount" "multiple file systems." "" mountall(1M)\0\s-1\fHSARM\fP\s0
.xx "" "mount, unmount multiple file" "systems." "mountall, umountall:" mountall(1M)\0\s-1\fHSARM\fP\s0
.xx "multiple file/" "mountall," "umountall: mount, unmount" "" mountall(1M)\0\s-1\fHSARM\fP\s0
.xx "" "mountall, umountall: mount," "unmount multiple file systems." "" mountall(1M)\0\s-1\fHSARM\fP\s0
.DE
.H 2 "How to Use the Index"
Look in the middle column of the index for the word of interest.
Then read the complete phrase by starting with the utility
name, which may appear in the left or middle column.
Utility names are followed by a colon.
A period marks the end of the description from the
.SM NAME
line.
(See page 3-3 for information about what the section numbers mean.)
.sp0.5
The
.SM NAME
line phrase is contained in the two columns, with
long phrases wrapping around to the beginning of the left column.
The right column of the index provides the manual page name, section number,
and acronym for the book where it is located.
.SP
Although not illustrated in the example, a slash (\f4/\fP) sometimes
appears in the index entry to indicate that space limitations were
exceeded and one or more words from the phrase were deleted.
.H 2 "Book Acronyms Used in the Permuted Index"
.TS
center;
l l.
BSD	BSD\/XENIX Compatibility Guide \- Part 1
.sp0.25
CHAR	Programmer's Guide: Character User Interface (FMLI and ETI)
.sp0.25
DDRM	Device Driver Interface\/Driver\-Kernel Interface Reference Manual
.sp0.25
NI	Programmer's Guide: Networking Interfaces
.sp0.25
NUA	Network User's and Administrator's Guide
.sp0.25
PRM	Programmer's Reference Manual
.sp0.25
SARM	System Administrator's Reference Manual
.sp0.25
SS	Programmer's Guide: System Services and Application Packaging Tools
.sp0.25
STRM	Programmer's Guide: STREAMS
.sp0.25
URM	User's Reference Manual
.sp0.25
XNX	BSD\/XENIX Compatibility Guide \- Part 2
.TE
.H 2 "Quick Reference to Manual Page Section Numbers"
.sp
.TS
center;
lw(1.25i) lw(2.0i).
.sp0.5
T{
.ce
\f3Section Number\fP
T}	T{
\f3Type of Utility\fP
T}
.sp
T{
.ce 2
(1)
T}	T{
User Commands
T}
.sp
T{
.ce
(1C)
T}	T{
Basic Networking Commands
T}
.sp
T{
.ce
(1F)
T}	T{
FMLI Commands
T}
.sp
T{
.ce
(1M)
T}	T{
Administration Commands
T}
.sp
T{
.ce
(2)
T}	T{
System Calls
T}
.sp
T{
.ce
(3)
T}	T{
BSD Routines
T}
.sp
T{
.ce
(3C)
T}	T{
C Library Functions
T}
.TE
.SK
.TS
center;
cw(1.25i) lw(2.25i).
.sp0.5
T{
.ce
\f3Section Number\fP
T}	T{
\f3Type of Utility\fP
T}
.sp
T{
.ce
(3E)
T}	T{
\f4libelf\fP Functions
T}
.sp
T{
.ce
(3G)
T}	T{
\f4libgen\fP Functions
T}
.sp
T{
.ce
(3M)
T}	T{
Math Library Functions
T}
.sp
T{
.ce
(3N)
T}	T{
Network Services Functions
T}
.sp
T{
.ce
(3S)
T}	T{
Standard I\/O Functions
T}
.sp
T{
.ce
(3X)
T}	T{
Specialized Libraries
T}
.sp
T{
.ce
(4)
T}	T{
File Formats
T}
.sp
T{
.ce
(5)
T}	T{
Miscellaneous
T}
.sp
T{
.ce
(7)
T}	T{
Special Files
T}
.sp
T{
.ce
(8)
T}	T{
System Maintenance Procedures
T}
.sp
T{
.ce
(D2D)
T}	T{
DDI Driver Entry Points
T}
.sp
T{
.ce
(D2DK)
T}	T{
DDI\/DKI Driver Entry Points
T}
.sp
T{
.ce
(D3D)
.br
T}	T{
DDI Kernel Functions
T}
.sp
T{
.ce
(D3DK)
T}	T{
DDI\/DKI Kernel Functions
T}
.sp
T{
.ce
(D4D)
T}	T{
DDI Data Structures
T}
.sp
T{
.ce
(D4DK)
T}	T{
DDI\/DKI Data Structures
T}
.TE
