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

Diff for /mandoc/man.1 between version 1.29 and 1.36

version 1.29, 2017/05/17 23:23:00 version 1.36, 2020/01/07 11:16:33
Line 3 
Line 3 
 .\" 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) 2003, 2007, 2008, 2014 Jason McIntyre <jmc@openbsd.org>
 .\" Copyright (c) 2010, 2011, 2014-2017 Ingo Schwarze <schwarze@openbsd.org>  .\" Copyright (c) 2010, 2011, 2014-2018 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 51  The
Line 51  The
 .Nm  .Nm
 utility  utility
 displays the  displays the
 manual pages entitled  manual page entitled
 .Ar name .  .Ar name .
 Pages may be selected according to  Pages may be selected according to
 a specific category  a specific category
Line 64  The options are as follows:
Line 64  The options are as follows:
 .Bl -tag -width Ds  .Bl -tag -width Ds
 .It Fl a  .It Fl a
 Display all matching manual pages.  Display all matching manual pages.
 Normally, only the first 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 78  Copy the manual page to the standard output instead of
Line 77  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.
   .Pp
   When using
   .Fl c ,
   most terminal devices are unable to show the markup.
   To print the output of
   .Nm
   to the terminal with markup but without using a pager, pipe it to
   .Xr ul 1 .
   To remove the markup, pipe the output to
   .Xr col 1
   .Fl b
   instead.
 .It Fl f  .It Fl f
 A synonym for  A synonym for
 .Xr whatis 1 .  .Xr whatis 1 .
Line 102  manual.
Line 113  manual.
 By default, it displays the header lines of all matching pages.  By default, it displays the header lines of all matching pages.
 .It Fl l  .It Fl l
 A synonym for  A synonym for
 .Xr mandoc 1  .Xr mandoc 1 .
 .Fl a .  
 The  The
 .Ar name  .Ar name
 arguments are interpreted as filenames.  arguments are interpreted as filenames.
Line 115  No search is done and
Line 125  No search is done and
 and  and
 .Fl w  .Fl w
 are ignored.  are ignored.
   This option implies
   .Fl a .
 .It Fl M Ar path  .It Fl M Ar path
 Override the list of standard directories which  Override the list of directories to search for manual pages.
 .Nm  
 searches for manual pages.  
 The supplied  The supplied
 .Ar path  .Ar path
 must be a colon  must be a colon
 .Pq Ql \&:  .Pq Ql \&:
 separated list of directories.  separated list of directories.
 This search path may also be set using the environment variable  This option also overrides the environment variable
 .Ev MANPATH .  .Ev MANPATH
   and any directories specified in the
   .Xr man.conf 5
   file.
 .It Fl m Ar path  .It Fl m Ar path
 Augment the list of standard directories which  Augment the list of directories to search for manual pages.
 .Nm  
 searches for manual pages.  
 The supplied  The supplied
 .Ar path  .Ar path
 must be a colon  must be a colon
 .Pq Ql \&:  .Pq Ql \&:
 separated list of directories.  separated list of directories.
 These directories will be searched before the standard directories or  These directories will be searched before those specified using the
 the directories specified using the  
 .Fl M  .Fl M
 option or the  option, the
 .Ev MANPATH  .Ev MANPATH
 environment variable.  environment variable, the
   .Xr man.conf 5
   file, or the default directories.
 .It Fl S Ar subsection  .It Fl S Ar subsection
 Only show pages for the specified  Only show pages for the specified
 .Xr machine 1  .Xr machine 1
Line 184  System maintenance and operation commands.
Line 196  System maintenance and operation commands.
 .It 9  .It 9
 Kernel internals.  Kernel internals.
 .El  .El
 .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 w  .It Fl w
 List the pathnames of all matching manual pages instead of displaying  List the pathnames of all matching manual pages instead of displaying
 any of them.  any of them.
Line 201  The options
Line 209  The options
 .Fl fkl  .Fl fkl
 are mutually exclusive and override each other.  are mutually exclusive and override each other.
 .Pp  .Pp
 Guidelines for writing  The search starts with the
 man pages can be found in  .Fl m
 .Xr mdoc 7 .  argument if provided, then continues with the
   .Fl M
   argument, the
   .Ev MANPATH
   variable, the
   .Ic manpath
   entries in the
   .Xr man.conf 5
   file, or with
   .Pa /usr/share/man : Ns Pa /usr/X11R6/man : Ns Pa /usr/local/man
   by default.
   Within each of these, directories are searched in the order provided.
   Within each directory, the search proceeds according to the following
   list of sections: 1, 8, 6, 2, 3, 5, 7, 4, 9, 3p.
   The first match found is shown.
 .Pp  .Pp
   The
   .Xr mandoc.db 5
   database is used for looking up manual page entries.
   In cases where the database is absent, outdated, or corrupt,
   .Nm
   falls back to looking for files called
   .Ar name . Ns Ar section .
 If both a formatted and an unformatted version of the same manual page,  If both a formatted and an unformatted version of the same manual page,
 for example  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, only the unformatted version is used.  exist in the same directory, only the unformatted version is used.
   The database is kept up to date with
   .Xr makewhatis 8 ,
   which is run by the
   .Xr weekly 8
   maintenance script.
   .Pp
   Guidelines for writing
   man pages can be found in
   .Xr mdoc 7 .
 .Sh ENVIRONMENT  .Sh ENVIRONMENT
 .Bl -tag -width MANPATHX  .Bl -tag -width MANPATHX
 .It Ev MACHINE  .It Ev MACHINE
Line 253  and
Line 291  and
 can be used to move to the next and to the previous place providing  can be used to move to the next and to the previous place providing
 information about the term last searched for with  information about the term last searched for with
 .Ic :t .  .Ic :t .
   The
   .Fl O Cm tag Ns Op = Ns Ar term
   option documented in the
   .Xr mandoc 1
   manual opens a manual page at the definition of a specific
   .Ar term
   rather than at the beginning.
 .It Ev MANPATH  .It Ev MANPATH
 The standard search path used by  Override the standard search path which is either specified in
 .Nm  .Xr man.conf 5
 may be changed by specifying a path in the  or the default path.
   The format of
 .Ev MANPATH  .Ev MANPATH
 environment variable.  is a colon
 The format of the path is a colon  
 .Pq Ql \&:  .Pq Ql \&:
 separated list of directories.  separated list of directories.
 Invalid paths are ignored.  Invalid directories are ignored.
 Overridden by  Overridden by
 .Fl M ,  .Fl M ,
 ignored if  ignored if
Line 271  is specified.
Line 316  is specified.
 .Pp  .Pp
 If  If
 .Ev MANPATH  .Ev MANPATH
 begins with a colon, it is appended to the default list;  begins with a colon, it is appended to the standard path;
 if it ends with a colon, it is prepended to the default list;  if it ends with a colon, it is prepended to the standard path;
 or if it contains two adjacent colons,  or if it contains two adjacent colons,
 the standard search path is inserted between the colons.  the standard 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
Line 285  If neither PAGER nor MANPAGER is defined,
Line 328  If neither PAGER nor MANPAGER is defined,
 .Xr more 1  .Xr more 1
 .Fl s  .Fl s
 is used.  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
 .It Pa /etc/man.conf  .It Pa /etc/man.conf
 default man configuration file  default
   .Nm
   configuration file
 .El  .El
 .Sh EXIT STATUS  .Sh EXIT STATUS
 .Ex -std man  .Ex -std man
 See  See
 .Xr mandoc 1  .Xr mandoc 1
 for details.  for details.
   .Sh EXAMPLES
   Format a page for pasting extracts into an email message \(em
   avoid printing any UTF-8 characters, reduce the width to ease
   quoting in replies, and remove markup:
   .Pp
   .Dl $ man -T ascii -O width=65 pledge | col -b
   .Pp
   Read a typeset page in a PDF viewer:
   .Pp
   .Dl $ MANPAGER=mupdf man -T pdf lpd
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr apropos 1 ,  .Xr apropos 1 ,
 .Xr intro 1 ,  .Xr col 1 ,
   .Xr mandoc 1 ,
   .Xr ul 1 ,
 .Xr whereis 1 ,  .Xr whereis 1 ,
 .Xr intro 2 ,  
 .Xr intro 3 ,  
 .Xr intro 4 ,  
 .Xr intro 5 ,  
 .Xr man.conf 5 ,  .Xr man.conf 5 ,
 .Xr intro 6 ,  .Xr mdoc 7
 .Xr intro 7 ,  
 .Xr mdoc 7 ,  
 .Xr intro 8 ,  
 .Xr intro 9  
 .Sh STANDARDS  .Sh STANDARDS
 The  The
 .Nm  .Nm

Legend:
Removed from v.1.29  
changed lines
  Added in v.1.36

CVSweb