Print this page
manpage lint.
Split |
Close |
Expand all |
Collapse all |
--- old/usr/src/man/man1/man.1
+++ new/usr/src/man/man1/man.1
1 1 .\"
2 2 .\" This file and its contents are supplied under the terms of the
3 3 .\" Common Development and Distribution License ("CDDL"), version 1.0.
4 4 .\" You may only use this file in accordance with the terms of version
5 5 .\" 1.0 of the CDDL.
6 6 .\"
7 7 .\" A full copy of the text of the CDDL should have accompanied this
8 8 .\" source. A copy of the CDDL is also available via the Internet at
9 9 .\" http://www.illumos.org/license/CDDL.
10 10 .\"
11 11 .\"
12 12 .\" Copyright 2012 Nexenta Systems, Inc. All rights reserved.
13 13 .\" Copyright 2014 Garrett D'Amore <garrett@damore.org>
14 14 .\"
15 15 .Dd October 18, 2012
16 16 .Dt MAN 1
17 17 .Os
18 18 .Sh NAME
19 19 .Nm man
20 20 .Nd find and display reference manual pages
21 21 .Sh SYNOPSIS
22 22 .Nm
23 23 .Op Fl alptw
24 24 .Op Fl M Ar manpath
25 25 .Op Fl s Ar mansect
26 26 .Ar page ...
27 27 .Nm
28 28 .Op Fl s Ar mansect
29 29 .Fl f
30 30 .Ar keyword ...
31 31 .Nm
32 32 .Op Fl s Ar mansect
33 33 .Fl k
34 34 .Ar keyword ...
35 35 .Sh DESCRIPTION
36 36 The
37 37 .Nm
38 38 utility finds and displays reference manual pages.
39 39 .Pp
40 40 Options that
41 41 .Nm
42 42 understands:
43 43 .Bl -tag -width indent
44 44 .It Fl M Ar manpath
45 45 Forces a specific colon separated manual path instead of the default
46 46 search path.
47 47 Overrides the
48 48 .Ev MANPATH
49 49 environment variable.
50 50 .It Fl a
51 51 Display all manual pages instead of just the first found for each
52 52 .Ar page
53 53 argument.
54 54 .It Fl f
55 55 Emulate
56 56 .Xr whatis 1 .
57 57 .It Fl k
58 58 Emulate
59 59 .Xr apropos 1 .
60 60 .It Fl l
61 61 Display the location of the manual page instead of the contents of
62 62 the manual page.
63 63 .It Fl p
64 64 Output current path used for searching.
65 65 .It Fl s Ar mansect
66 66 Restrict manual sections searched to the specified colon delimited list.
67 67 .It Fl t
68 68 Send the content formatted as PostScript to the default printer.
69 69 .It Fl w
70 70 Create
71 71 .Nm whatis
72 72 databases used by
73 73 .Xr apropos 1
74 74 and
75 75 .Xr whatis 1 .
76 76 .El
77 77 .Sh ENVIRONMENT
78 78 The following environment variables affect the execution of
79 79 .Nm :
80 80 .Bl -tag -width ".Ev MANPATH"
81 81 .It Ev LC_ALL , LC_CTYPE , LANG
82 82 Used to find locale-specific manual pages.
83 83 .It Ev MANPATH
84 84 Used to find the location of the manual files.
85 85 Corresponds to the
86 86 .Fl M
87 87 option.
88 88 .It Ev MANWIDTH
89 89 Defines the width of output. If set to
90 90 .Dq Li tty ,
91 91 and output is to a terminal, full width of terminal is used.
92 92 .It Ev PAGER
93 93 Program used to display files. If unset,
94 94 .Dq Li "less -ins"
95 95 is used.
96 96 .It Ev PATH
97 97 Used to find location of manual files if
98 98 .Ev MANPATH
99 99 and
100 100 .Fl M
101 101 are not specified.
102 102 .El
103 103 .Sh FILES
104 104 .Bl -tag -width indent -compact
105 105 .It Pa man.cf
106 106 Per-manpath configuration settings. The file is formatted as follows:
107 107 .Bd -literal -offset indent
108 108 MANSECT=\fIsection\fR[,\fIsection\fR]...
109 109 .Ed
↓ open down ↓ |
109 lines elided |
↑ open up ↑ |
110 110 .Pp
111 111 Each section consists of a section in the reference manual. The file
112 112 may also contain comment blank lines or lines consisting of comments, where
113 113 the first character in the line is `#'. Both blank lines and comment lines are
114 114 ignored.
115 115 .El
116 116 .Sh CODE SET INDEPENDENCE
117 117 Enabled.
118 118 .Sh INTERFACE STABILITY
119 119 The
120 -.Nm
120 +.Nm
121 121 utility is
122 122 .Nm Standard ,
123 123 as is the
124 124 .Fl k
125 125 option. The other options are
126 126 .Nm Committed .
127 127 .Sh SEE ALSO
128 128 .Xr apropos 1 ,
129 129 .Xr intro 1 ,
130 130 .Xr mandoc 1 ,
131 131 .Xr whatis 1 ,
132 132 .Xr man 5 ,
133 133 .Xr mdoc 5 ,
134 134 .Xr standards 5
135 135 .Sh NOTES
136 136 Some pages may contain information which cannot be properly displayed on
137 137 all terminals. In such cases, some information may be lost.
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX