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

Diff for /mandoc/man.1 between version 1.25 and 1.35

version 1.25, 2017/03/22 13:31:49 version 1.35, 2019/03/09 15:55:01
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 41 
Line 41 
 .Nm man  .Nm man
 .Op Fl acfhklw  .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 Oo Fl s Oc Ar section
 .Op Fl T Ar output  
 .Op Fl W Ar level  
 .Op Ar section  
 .Ar name ...  .Ar name ...
 .Sh DESCRIPTION  .Sh DESCRIPTION
 The  The
Line 84  Copy the manual page to the standard output instead of
Line 78  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 91  It searches for
Line 97  It searches for
 .Ar name  .Ar name
 in manual page names and displays the header lines from all matching pages.  in manual page names and displays the header lines from all matching pages.
 The search is case insensitive and matches whole words only.  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 SYNOPSIS lines of the requested manual pages.  Display only the SYNOPSIS lines of the requested manual pages.
 Implies  Implies
 .Fl a  .Fl a
 and  and
 .Fl c .  .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  .It Fl k
 A synonym for  A synonym for
 .Xr apropos 1 .  .Xr apropos 1 .
Line 133  an expression can be provided using the syntax describ
Line 112  an expression can be provided using the syntax describ
 .Xr apropos 1  .Xr apropos 1
 manual.  manual.
 By default, it displays the header lines of all matching pages.  By default, it displays the header lines of all matching pages.
 This overrides any earlier  
 .Fl f  
 and  
 .Fl l  
 options.  
 .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 149  No search is done and
Line 122  No search is done and
 .Ar file ,  .Ar file ,
 .Ar path ,  .Ar path ,
 .Ar section ,  .Ar section ,
   .Ar subsection ,
 and  and
 .Ar subsection  
 are ignored.  
 This overrides any earlier  
 .Fl f ,  
 .Fl k ,  
 and  
 .Fl w  .Fl w
 options.  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 standard directories which
 .Nm  .Nm
Line 184  the directories specified using the
Line 154  the directories specified using the
 option or the  option or the
 .Ev MANPATH  .Ev MANPATH
 environment variable.  environment variable.
 .It Fl O Ar option Ns = Ns Ar value  
 Comma-separated output options.  
 For each output format, the available options are described in the  
 .Xr mandoc 1  
 manual.  
 .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 236  Kernel internals.
Line 201  Kernel internals.
 If not specified and a match is found in more than one section,  If not specified and a match is found in more than one section,
 the first match is selected from the following list:  the first match is selected from the following list:
 1, 8, 6, 2, 3, 5, 7, 4, 9, 3p.  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  
 .Ar level  
 can be  
 .Cm warning ,  
 .Cm error ,  
 or  
 .Cm unsupp ;  
 .Cm all  
 is an alias for  
 .Cm warning .  
 By default,  
 .Nm  
 is silent.  
 See the  
 .Xr mandoc 1  
 manual for details.  
 .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.
 .El  .El
 .Pp  .Pp
   The options
   .Fl IKOTW
   are also supported and are documented in
   .Xr mandoc 1 .
   The options
   .Fl fkl
   are mutually exclusive and override each other.
   .Pp
 Guidelines for writing  Guidelines for writing
 man pages can be found in  man pages can be found in
 .Xr mdoc 7 .  .Xr mdoc 7 .
 .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.
 .Sh ENVIRONMENT  .Sh ENVIRONMENT
 .Bl -tag -width MANPATHX  .Bl -tag -width MANPATHX
 .It Ev MACHINE  .It Ev MACHINE
Line 330  and
Line 278  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  The standard search path used by
 .Nm  .Nm
Line 339  environment variable.
Line 294  environment 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.
 Invalid paths, or paths without manual databases, are ignored.  Invalid paths are ignored.
 Overridden by  Overridden by
 .Fl M ,  .Fl M ,
 ignored if  ignored if
Line 362  If neither PAGER nor MANPAGER is defined,
Line 317  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
Line 378  default man configuration file
Line 328  default man configuration file
 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.25  
changed lines
  Added in v.1.35

CVSweb