| man.1 (275432) | man.1 (279527) |
|---|---|
| 1.\" $Id: man.1,v 1.7 2014/11/11 02:43:41 schwarze Exp $ | 1.\" $Id: man.1,v 1.13 2015/02/16 16:23:54 schwarze Exp $ |
| 2.\" 3.\" Copyright (c) 1989, 1990, 1993 4.\" The Regents of the University of California. All rights reserved. 5.\" Copyright (c) 2003, 2007, 2008, 2014 Jason McIntyre <jmc@openbsd.org> | 2.\" 3.\" Copyright (c) 1989, 1990, 1993 4.\" The Regents of the University of California. All rights reserved. 5.\" Copyright (c) 2003, 2007, 2008, 2014 Jason McIntyre <jmc@openbsd.org> |
| 6.\" Copyright (c) 2010, 2011 Ingo Schwarze | 6.\" Copyright (c) 2010, 2011, 2014, 2015 Ingo Schwarze <schwarze@openbsd.org> |
| 7.\" 8.\" Redistribution and use in source and binary forms, with or without 9.\" modification, are permitted provided that the following conditions 10.\" are met: 11.\" 1. Redistributions of source code must retain the above copyright 12.\" notice, this list of conditions and the following disclaimer. 13.\" 2. Redistributions in binary form must reproduce the above copyright 14.\" notice, this list of conditions and the following disclaimer in the --- 11 unchanged lines hidden (view full) --- 26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30.\" SUCH DAMAGE. 31.\" 32.\" @(#)man.1 8.2 (Berkeley) 1/2/94 33.\" | 7.\" 8.\" Redistribution and use in source and binary forms, with or without 9.\" modification, are permitted provided that the following conditions 10.\" are met: 11.\" 1. Redistributions of source code must retain the above copyright 12.\" notice, this list of conditions and the following disclaimer. 13.\" 2. Redistributions in binary form must reproduce the above copyright 14.\" notice, this list of conditions and the following disclaimer in the --- 11 unchanged lines hidden (view full) --- 26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30.\" SUCH DAMAGE. 31.\" 32.\" @(#)man.1 8.2 (Berkeley) 1/2/94 33.\" |
| 34.Dd $Mdocdate: November 11 2014 $ | 34.Dd $Mdocdate: February 16 2015 $ |
| 35.Dt MAN 1 36.Os 37.Sh NAME 38.Nm man 39.Nd display manual pages 40.Sh SYNOPSIS 41.Nm man | 35.Dt MAN 1 36.Os 37.Sh NAME 38.Nm man 39.Nd display manual pages 40.Sh SYNOPSIS 41.Nm man |
| 42.Op Fl acfhklVw | 42.Op Fl acfhklw |
| 43.Op Fl C Ar file | 43.Op Fl C Ar file |
| 44.Op Fl I Cm os Ns = Ns Ar name 45.Op Fl K Ar encoding |
|
| 44.Op Fl M Ar path 45.Op Fl m Ar path | 46.Op Fl M Ar path 47.Op Fl m Ar path |
| 48.Op Fl O Ar option Ns = Ns Ar value |
|
| 46.Op Fl S Ar subsection 47.Op Fl s Ar section | 49.Op Fl S Ar subsection 50.Op Fl s Ar section |
| 51.Op Fl T Ar output 52.Op Fl W Ar level |
|
| 48.Op Ar section 49.Ar name ... 50.Sh DESCRIPTION 51The 52.Nm 53utility 54displays the 55manual pages entitled --- 34 unchanged lines hidden (view full) --- 90.Ar name 91in manual page names and displays the header lines from all matching pages. 92The search is case insensitive and matches whole words only. 93This overrides any earlier 94.Fl k 95and 96.Fl l 97options. | 53.Op Ar section 54.Ar name ... 55.Sh DESCRIPTION 56The 57.Nm 58utility 59displays the 60manual pages entitled --- 34 unchanged lines hidden (view full) --- 95.Ar name 96in manual page names and displays the header lines from all matching pages. 97The search is case insensitive and matches whole words only. 98This overrides any earlier 99.Fl k 100and 101.Fl l 102options. |
| 103.It Fl I Cm os Ns = Ns Ar name 104Override the default operating system 105.Ar name 106for the 107.Xr mdoc 7 108.Ic \&Os 109and for the 110.Xr man 7 111.Ic \&TH 112macro. |
|
| 98.It Fl h 99Display only the SYNOPSIS lines of the requested manual pages. 100Implies 101.Fl a 102and 103.Fl c . | 113.It Fl h 114Display only the SYNOPSIS lines of the requested manual pages. 115Implies 116.Fl a 117and 118.Fl c . |
| 119.It Fl K Ar encoding 120Specify the input encoding. 121The supported 122.Ar encoding 123arguments are 124.Cm us-ascii , 125.Cm iso-8859-1 , 126and 127.Cm utf-8 . 128By default, the encoding is automatically detected as described in the 129.Xr mandoc 1 130manual. |
|
| 104.It Fl k 105A synonym for 106.Xr apropos 1 . 107Instead of 108.Ar name , 109an expression can be provided using the syntax described in the 110.Xr apropos 1 111manual. --- 56 unchanged lines hidden (view full) --- 168.Ev MANPATH 169environment variable. 170The subdirectories to be searched, and their search order, 171are specified by the 172.Dq _subdir 173line in the 174.Nm 175configuration file. | 131.It Fl k 132A synonym for 133.Xr apropos 1 . 134Instead of 135.Ar name , 136an expression can be provided using the syntax described in the 137.Xr apropos 1 138manual. --- 56 unchanged lines hidden (view full) --- 195.Ev MANPATH 196environment variable. 197The subdirectories to be searched, and their search order, 198are specified by the 199.Dq _subdir 200line in the 201.Nm 202configuration file. |
| 203.It Fl O Ar option Ns = Ns Ar value 204Comma-separated output options. 205For each output format, the available options are described in the 206.Xr mandoc 1 207manual. |
|
| 176.It Fl S Ar subsection 177Restricts the directories that 178.Nm 179will search to those of a specific 180.Xr machine 1 181architecture. 182.Ar subsection 183is case insensitive. --- 53 unchanged lines hidden (view full) --- 237The 238.Nm 239configuration file, 240.Xr man.conf 5 , 241specifies the possible 242.Ar section 243values, and their search order. 244Additional sections may be specified. | 208.It Fl S Ar subsection 209Restricts the directories that 210.Nm 211will search to those of a specific 212.Xr machine 1 213architecture. 214.Ar subsection 215is case insensitive. --- 53 unchanged lines hidden (view full) --- 269The 270.Nm 271configuration file, 272.Xr man.conf 5 , 273specifies the possible 274.Ar section 275values, and their search order. 276Additional sections may be specified. |
| 245.It Fl V 246Print version and exit. | 277.It Fl T Ar output 278Select the output format. 279The default is 280.Cm locale . 281The other output modes 282.Cm ascii , 283.Cm html , 284.Cm lint , 285.Cm man , 286.Cm pdf , 287.Cm ps , 288.Cm tree , 289and 290.Cm utf8 291are described in the 292.Xr mandoc 1 293manual. 294.It Fl W Ar level 295Specify the minimum message 296.Ar level 297to be reported on the standard error output and to affect the exit status. 298The 299.Ar level 300can be 301.Cm warning , 302.Cm error , 303or 304.Cm unsupp ; 305.Cm all 306is an alias for 307.Cm warning . 308By default, 309.Nm 310is silent. 311See the 312.Xr mandoc 1 313manual for details. |
| 247.It Fl w 248List the pathnames of the manual pages which 249.Nm 250would display for the specified 251.Ar section 252and 253.Ar name 254combination. 255.El 256.Pp | 314.It Fl w 315List the pathnames of the manual pages which 316.Nm 317would display for the specified 318.Ar section 319and 320.Ar name 321combination. 322.El 323.Pp |
| 257The 258.Nm 259utility also supports the options 260.Fl IKOTW 261described in the 262.Xr mandoc 1 263manual. 264.Pp | |
| 265Guidelines for writing 266man pages can be found in 267.Xr mdoc 7 . 268.Pp 269If both a formatted and an unformatted version of the same manual page, 270for example 271.Pa cat1/foo.0 272and --- 77 unchanged lines hidden (view full) --- 350.Sh STANDARDS 351The 352.Nm 353utility is compliant with the 354.St -p1003.1-2008 355specification. 356.Pp 357The flags | 324Guidelines for writing 325man pages can be found in 326.Xr mdoc 7 . 327.Pp 328If both a formatted and an unformatted version of the same manual page, 329for example 330.Pa cat1/foo.0 331and --- 77 unchanged lines hidden (view full) --- 409.Sh STANDARDS 410The 411.Nm 412utility is compliant with the 413.St -p1003.1-2008 414specification. 415.Pp 416The flags |
| 358.Op Fl aCcfhMmSsw , | 417.Op Fl aCcfhIKlMmOSsTWw , |
| 359as well as the environment variables 360.Ev MACHINE , 361.Ev MANPAGER , 362and 363.Ev MANPATH , 364are extensions to that specification. 365.Sh HISTORY 366A --- 36 unchanged lines hidden --- | 418as well as the environment variables 419.Ev MACHINE , 420.Ev MANPAGER , 421and 422.Ev MANPATH , 423are extensions to that specification. 424.Sh HISTORY 425A --- 36 unchanged lines hidden --- |