plan9port

fork of plan9port with libvec, libstr and libsdb
Log | Files | Refs | README | LICENSE

man.1 (2023B)


      1 .TH MAN 1
      2 .SH NAME
      3 man, lookman, sig \- print or find pages of this manual
      4 .SH SYNOPSIS
      5 .B man
      6 [
      7 .B -hnpPtw
      8 ]
      9 [
     10 .I section ...
     11 ]
     12 [
     13 .B --
     14 ]
     15 .I title ...
     16 .PP
     17 .B lookman
     18 .I key ...
     19 .PP
     20 .B sig
     21 .I function ...
     22 .SH DESCRIPTION
     23 .I Man
     24 locates and prints pages of this manual named
     25 .I title
     26 in the specified
     27 .IR sections .
     28 .I Title
     29 is given in lower case.
     30 Each
     31 .I section
     32 is a number;
     33 pages marked (2S), for example,
     34 belong to chapter 2.
     35 If no
     36 .I section
     37 is specified, pages 
     38 in all sections are printed.
     39 Any name from the
     40 .SM NAME
     41 section at the top of the page will serve as a
     42 .IR title .
     43 .PP
     44 The options are:
     45 .TP
     46 .B -h
     47 Print the pages to HTML and send to a web browser with
     48 .MR web (1) .
     49 .TP
     50 .B -n
     51 (Default)
     52 Print the pages on the standard output using
     53 .IR nroff .
     54 .TP
     55 .B -p
     56 Run
     57 .MR proof (1)
     58 on the specified man pages.
     59 .TP
     60 .B -P
     61 Run
     62 .MR page (1)
     63 on the specified man pages.
     64 .TP
     65 .B -t
     66 Run
     67 .MR troff (1)
     68 and send its output
     69 to standard output.
     70 .TP
     71 .B -w
     72 Print the file names for the pages.
     73 .PD
     74 .PP
     75 .B Lookman
     76 prints the names of all manual sections that contain
     77 all of the
     78 .I key
     79 words given on the command line.
     80 .PP
     81 .B Sig
     82 prints the signature (i.e. C definition) of the
     83 .IR function 's
     84 given on the command line.
     85 .SH FILES
     86 .TP
     87 .B \*9/man?/*.[0-9]*
     88 .I troff
     89 source for manual; this page is
     90 .B \*9/man/man1/man.1
     91 .TP
     92 .B \*9/man?/*.html
     93 HTML version of the manual
     94 .TP
     95 .B \*9/man/man?/INDEX
     96 indices searched to find pages corresponding to titles
     97 .TP
     98 .B \*9/man/secindex
     99 command to make an index for a given section
    100 .TP
    101 .B \*9/man/lookman.index
    102 index for
    103 .I lookman
    104 .SH SOURCE
    105 .B \*9/bin/man
    106 .br
    107 .B \*9/bin/lookman
    108 .SH "SEE ALSO"
    109 .MR page (1) ,
    110 .MR proof (1)
    111 .SH BUGS
    112 The manual was intended to be typeset; some detail is sacrificed on text terminals.
    113 .PP
    114 There is no automatic mechanism to keep the indices up to date.
    115 .PP
    116 Except for special cases,
    117 .I man
    118 doesn't recognize things that should be run through
    119 .I tbl
    120 and/or
    121 .IR eqn .
    122 .PP
    123 The HTML manual is not maintained automatically.
    124 To update it:
    125 .IP
    126 .EX
    127 cd \*9/dist
    128 mk man
    129 .EE