[BACK]Return to man.1 CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/man.1 between version 1.1 and 1.24

version 1.1, 2014/08/21 00:42:38 version 1.24, 2017/03/21 18:06:12
Line 1 
Line 1 
 .\"     $OpenBSD$  .\"     $Id$
 .\"  .\"
 .\" Copyright (c) 1989, 1990, 1993  .\" Copyright (c) 1989, 1990, 1993
 .\"     The Regents of the University of California.  All rights reserved.  .\"     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, 2014-2017 Ingo Schwarze <schwarze@openbsd.org>
 .\"  .\"
 .\" Redistribution and use in source and binary forms, with or without  .\" Redistribution and use in source and binary forms, with or without
 .\" modification, are permitted provided that the following conditions  .\" modification, are permitted provided that the following conditions
Line 37 
Line 39 
 .Nd display manual pages  .Nd display manual pages
 .Sh SYNOPSIS  .Sh SYNOPSIS
 .Nm man  .Nm man
 .Op Fl achw  .Op Fl acfhklw
 .Op Fl C Ar file  .Op Fl C Ar file
   .Op Fl I Cm os Ns = Ns Ar name
   .Op Fl K Ar encoding
 .Op Fl M Ar path  .Op Fl M Ar path
 .Op Fl m Ar path  .Op Fl m Ar path
   .Op Fl O Ar option Ns = Ns Ar value
 .Op Fl S Ar subsection  .Op Fl S Ar subsection
 .Op Fl s Ar section  .Op Fl s Ar section
   .Op Fl T Ar output
   .Op Fl W Ar level
 .Op Ar section  .Op Ar section
 .Ar name ...  .Ar name ...
 .Nm man  
 .Fl f Ar command ...  
 .Nm man  
 .Fl k Ar keyword ...  
 .Sh DESCRIPTION  .Sh DESCRIPTION
 The  The
 .Nm  .Nm
 utility  utility
 displays the  displays the
 .Bx  
 manual pages entitled  manual pages entitled
 .Ar name .  .Ar name .
 Pages may be selected according to  Pages may be selected according to
Line 67  machine architecture
Line 69  machine architecture
 The options are as follows:  The options are as follows:
 .Bl -tag -width Ds  .Bl -tag -width Ds
 .It Fl a  .It Fl a
 Display all of the manual pages for a specified  Display all matching manual pages.
 .Ar section  Normally, only the first page found is displayed.
 and  
 .Ar name  
 combination.  
 Normally, only the first manual page found is displayed.  
 .It Fl C Ar file  .It Fl C Ar file
 Use the specified  Use the specified
 .Ar file  .Ar file
Line 86  Copy the manual page to the standard output instead of
Line 84  Copy the manual page to the standard output instead of
 .Xr more 1  .Xr more 1
 to paginate it.  to paginate it.
 This is done by default if the standard output is not a terminal device.  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  A synonym for
 .Xr whatis 1 .  .Xr whatis 1 .
 It looks up a given command and  It searches for
 gives the header line from the manual page.  .Ar name
 .Ar command  in manual page names and displays the header lines from all matching pages.
 is case insensitive.  The search is case insensitive and matches whole words only.
   This overrides any earlier
   .Fl k
   and
   .Fl l
   options.
 .It Fl h  .It Fl h
 Display only the  Display only the SYNOPSIS lines of the requested manual pages.
 .Dq SYNOPSIS  Implies
 lines of the requested manual pages.  .Fl a
 .It Fl k Ar keyword  and
   .Fl c .
   .It Fl I Cm os Ns = Ns Ar name
   Override the default operating system
   .Ar name
   for the
   .Xr mdoc 7
   .Ic \&Os
   and for the
   .Xr man 7
   .Ic \&TH
   macro.
   .It Fl K Ar encoding
   Specify the input encoding.
   The supported
   .Ar encoding
   arguments are
   .Cm us-ascii ,
   .Cm iso-8859-1 ,
   and
   .Cm utf-8 .
   By default, the encoding is automatically detected as described in the
   .Xr mandoc 1
   manual.
   .It Fl k
 A synonym for  A synonym for
 .Xr apropos 1 .  .Xr apropos 1 .
 It shows which manual pages contain instances of any of the given  Instead of
 keywords in their title line.  .Ar name ,
 .Ar keyword  an expression can be provided using the syntax described in the
 is case insensitive.  .Xr apropos 1
 .Pp  manual.
 For instance,  By default, it displays the header lines of all matching pages.
 to list all man pages which contain  This overrides any earlier
 .Dq mount  .Fl f
 in the  and
 .Dq NAME  .Fl l
 line of the man page:  options.
 .Pp  .It Fl l
 .Dl $ man -k mount  A synonym for
 .Pp  .Xr mandoc 1
 Which would produce a list much like this:  .Fl a .
 .Bd -literal  The
 amd (8) \(en automatically mount file systems  .Ar name
 amq (8) \(en automounter query tool  arguments are interpreted as filenames.
 domountroothooks (9) \(en run all mountroot hooks  No search is done and
 exports (5) \(en define remote mount points for NFS mount requests  .Ar file ,
 getfsstat (2) \(en get list of all mounted file systems  .Ar path ,
 getmntinfo (3) \(en get information about mounted file systems  .Ar section ,
 mount (8) \(en mount file systems  and
 mount, unmount (2) \(en mount or dismount a filesystem  .Ar subsection
 mount_cd9660 (8) \(en mount an ISO-9660 filesystem  are ignored.
 mount_ext2fs (8) \(en mount an ext2fs file system  This overrides any earlier
 mount_ffs (8) \(en mount a Berkeley Fast File System  .Fl f ,
 mount_msdos (8) \(en mount an MS-DOS file system  .Fl k ,
 mount_nfs (8) \(en mount NFS file systems  and
 mount_ntfs (8) \(en mount an NTFS file system  .Fl w
 mount_procfs (8) \(en mount the process file system  options.
 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  
 .It Fl M Ar path  .It Fl M Ar path
 Override the list of standard directories which  Override the list of standard directories which
 .Nm  .Nm
Line 147  must be a colon
Line 169  must be a colon
 separated list of directories.  separated list of directories.
 This search path may also be set using the environment variable  This search path may also be set using the environment variable
 .Ev MANPATH .  .Ev MANPATH .
 The subdirectories to be searched, and their search order,  
 are specified by the  
 .Dq _subdir  
 line in the  
 .Nm  
 configuration file.  
 .It Fl m Ar path  .It Fl m Ar path
 Augment the list of standard directories which  Augment the list of standard directories which
 .Nm  .Nm
Line 168  the directories specified using the
Line 184  the directories specified using the
 option or the  option or the
 .Ev MANPATH  .Ev MANPATH
 environment variable.  environment variable.
 The subdirectories to be searched, and their search order,  .It Fl O Ar option Ns = Ns Ar value
 are specified by the  Comma-separated output options.
 .Dq _subdir  For each output format, the available options are described in the
 line in the  .Xr mandoc 1
 .Nm  manual.
 configuration file.  
 .It Fl S Ar subsection  .It Fl S Ar subsection
 Restricts the directories that  Restricts the directories that
 .Nm  .Nm
Line 190  architecture whilst using another.
Line 205  architecture whilst using another.
 This option overrides the  This option overrides the
 .Ev MACHINE  .Ev MACHINE
 environment variable.  environment variable.
 .It Xo  .It Oo Fl s Oc Ar section
 .Op Fl s  Only select manuals from the specified
 .Ar section  .Ar section .
 .Xc  
 Restricts the directories that  
 .Nm  
 will search to a specific section.  
 The currently available sections are:  The currently available sections are:
 .Pp  .Pp
 .Bl -tag -width "localXXX" -offset indent -compact  .Bl -tag -width "localXXX" -offset indent -compact
Line 206  General commands
Line 217  General commands
 .It 2  .It 2
 System calls and error numbers.  System calls and error numbers.
 .It 3  .It 3
 Libraries.  Library functions.
 .It 3f  
 Fortran programmer's reference guide.  
 .It 3p  .It 3p
 .Xr perl 1  .Xr perl 1
 programmer's reference guide.  programmer's reference guide.
Line 219  File formats.
Line 228  File formats.
 .It 6  .It 6
 Games.  Games.
 .It 7  .It 7
 Miscellaneous.  Miscellaneous information.
 .It 8  .It 8
 System maintenance and operation commands.  System maintenance and operation commands.
 .It 9  .It 9
 Kernel internals.  Kernel internals.
 .It X11  
 An alias for X11R6.  
 .It X11R6  
 X Window System.  
 .It local  
 Pages located in  
 .Pa /usr/local .  
 .It n  
 Tcl/Tk commands.  
 .El  .El
 .Pp  .Pp
   If not specified and a match is found in more than one section,
   the first match is selected from the following list:
   1, 8, 6, 2, 3, 5, 7, 4, 9, 3p.
   .It Fl T Ar output
   Select the output format.
   The default is
   .Cm locale .
   The other output modes
   .Cm ascii ,
   .Cm html ,
   .Cm lint ,
   .Cm man ,
   .Cm pdf ,
   .Cm ps ,
   .Cm tree ,
   and
   .Cm utf8
   are described in the
   .Xr mandoc 1
   manual.
   .It Fl W Ar level
   Specify the minimum message
   .Ar level
   to be reported on the standard error output and to affect the exit status.
 The  The
   .Ar level
   can be
   .Cm warning ,
   .Cm error ,
   or
   .Cm unsupp ;
   .Cm all
   is an alias for
   .Cm warning .
   By default,
 .Nm  .Nm
 configuration file,  is silent.
 .Xr man.conf 5 ,  See the
 specifies the possible  .Xr mandoc 1
 .Ar section  manual for details.
 values, and their search order.  
 Additional sections may be specified.  
 .It Fl w  .It Fl w
 List the pathnames of the manual pages which  List the pathnames of the manual pages which
 .Nm  .Nm
Line 253  and
Line 285  and
 combination.  combination.
 .El  .El
 .Pp  .Pp
 Guidelines for  Guidelines for writing
 .Ox  
 man pages can be found in  man pages can be found in
 .Xr mdoc 7 .  .Xr mdoc 7 .
 .Pp  .Pp
Line 263  for example
Line 294  for example
 .Pa cat1/foo.0  .Pa cat1/foo.0
 and  and
 .Pa man1/foo.1 ,  .Pa man1/foo.1 ,
 exist in the same directory, and at least one of them is selected,  exist in the same directory, only the unformatted version is used.
 only the newer one is used.  
 However, if both the  
 .Fl a  
 and the  
 .Fl w  
 options are specified, both file names are printed.  
 .Sh ENVIRONMENT  .Sh ENVIRONMENT
 .Bl -tag -width MANPATHX  .Bl -tag -width MANPATHX
 .It Ev MACHINE  .It Ev MACHINE
Line 291  is case insensitive.
Line 316  is case insensitive.
 .It Ev MANPAGER  .It Ev MANPAGER
 Any non-empty value of the environment variable  Any non-empty value of the environment variable
 .Ev MANPAGER  .Ev MANPAGER
 will be used instead of the standard pagination program,  is used instead of the standard pagination program,
 .Xr more 1 .  .Xr more 1 .
   If
   .Xr less 1
   is used, the interactive
   .Ic :t
   command can be used to go to the definitions of various terms, for
   example command line options, command modifiers, internal commands,
   environment variables, function names, preprocessor macros,
   .Xr errno 2
   values, and some other emphasized words.
   Some terms may have defining text at more than one place.
   In that case, the
   .Xr less 1
   interactive commands
   .Ic t
   and
   .Ic T
   can be used to move to the next and to the previous place providing
   information about the term last searched for with
   .Ic :t .
 .It Ev MANPATH  .It Ev MANPATH
 The standard search path used by  The standard search path used by
 .Nm  .Nm
 may be overridden by specifying a path in the  may be changed by specifying a path in the
 .Ev MANPATH  .Ev MANPATH
 environment  environment variable.
 variable.  
 The format of the path is a colon  The format of the path is a colon
 .Pq Ql \&:  .Pq Ql \&:
 separated list of directories.  separated list of directories.
 The subdirectories to be searched, as well as their search order,  Invalid paths, or paths without manual databases, are ignored.
 are specified by the  Overridden by
 .Dq _subdir  .Fl M ,
 line in the  ignored if
 .Nm  .Fl l
 configuration file.  is specified.
   .Pp
   If
   .Ev MANPATH
   begins with a colon, it is appended to the default list;
   if it ends with a colon, it is prepended to the default list;
   or if it contains two adjacent colons,
   the standard search path is inserted between the colons.
   If none of these conditions are met, it overrides the
   standard search path.
 .It Ev PAGER  .It Ev PAGER
 Specifies the pagination program to use when  Specifies the pagination program to use when
 .Ev MANPAGER  .Ev MANPAGER
 is not defined.  is not defined.
 If neither PAGER nor MANPAGER is defined,  If neither PAGER nor MANPAGER is defined,
 .Pa /usr/bin/more Fl s  .Xr more 1
 will be used.  .Fl s
   is used.
   Only used if
   .Fl a
   or
   .Fl l
   is specified.
 .El  .El
 .Sh FILES  .Sh FILES
 .Bl -tag -width /etc/man.conf -compact  .Bl -tag -width /etc/man.conf -compact
Line 347  utility is compliant with the
Line 405  utility is compliant with the
 specification.  specification.
 .Pp  .Pp
 The flags  The flags
 .Op Fl aCcfhMmSsw ,  .Op Fl aCcfhIKlMmOSsTWw ,
 as well as the environment variables  as well as the environment variables
 .Ev MACHINE ,  .Ev MACHINE ,
 .Ev MANPAGER ,  .Ev MANPAGER ,
Line 386  in
Line 444  in
 .Fl C  .Fl C
 in  in
 .Nx 1.0 ;  .Nx 1.0 ;
 and  
 .Fl s  .Fl s
 and  and
 .Fl S  .Fl S
 in  in
 .Ox 2.3 .  .Ox 2.3 ;
   and
   .Fl I ,
   .Fl K ,
   .Fl l ,
   .Fl O ,
   and
   .Fl W
   in
   .Ox 5.7 .
   The
   .Fl T
   option first appeared in
   .At III
   and was also added in
   .Ox 5.7 .

Legend:
Removed from v.1.1  
changed lines
  Added in v.1.24

CVSweb