home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / u_man / cat1 / man.z / man
Encoding:
Text File  |  2002-10-03  |  22.3 KB  |  397 lines
  1.  
  2.  
  3.  
  4. MMMMAAAANNNN((((1111))))                                                                  MMMMAAAANNNN((((1111))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      man - print entries from the on-line reference manuals; find manual
  10.      entries by keyword
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      mmmmaaaannnn [----ccccddddwwwwWWWWttttpppprrrr] [----MMMM _p_a_t_h] [----TTTT _m_a_c_r_o_p_a_c_k_a_g_e] [_s_e_c_t_i_o_n] _t_i_t_l_e ...
  14.      mmmmaaaannnn [----MMMM _p_a_t_h] ----kkkk _k_e_y_w_o_r_d ...
  15.      mmmmaaaannnn [----MMMM _p_a_t_h] ----ffff _f_i_l_e_n_a_m_e ...
  16.  
  17. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  18.      _m_a_n locates and prints the _t_i_t_l_ed entries from the on-line reference
  19.      manuals.  _m_a_n also prints summaries of manual entries selected by _k_e_y_w_o_r_d
  20.      or by associated _f_i_l_e_n_a_m_e.
  21.  
  22.      If a _s_e_c_t_i_o_n is given, only that particular section is searched for the
  23.      specified _t_i_t_l_e.  The current list of valid sections are any single digit
  24.      [0-9], the letter 'D', plus the sections llllooooccccaaaallll, ppppuuuubbbblllliiiicccc, nnnneeeewwww, and oooolllldddd,
  25.      corresponding to the sections llll, pppp, nnnn, and oooo, respectively.  When a
  26.      section name of this form is given, the first character is used to form
  27.      the directory, thus "local", will cause directories ending in "manl" to
  28.      be searched.  To find a man page with the name of one of these sections,
  29.      it is necessary to first give a dummy name, such as "man junk local",
  30.      which is unfortunate.
  31.  
  32.      If no _s_e_c_t_i_o_n is given, all sections of the on-line reference manuals are
  33.      searched and all occurrences of _t_i_t_l_e are printed.  The default sections
  34.      are searched in this order:  1111nnnnllll6666888822223333444455557777ppppooooDDDD
  35.  
  36.      Manual entries are retrieved in the following order:  for each root
  37.      directory in the search path, language specific directories are searched
  38.      first (see discussion of the LLLLAAAANNNNGGGG environment variable below), followed
  39.      by generic directories. Within each of those searches, local additions
  40.      are searched first, followed by the standard manual directories.  In each
  41.      leaf directory, there may be actual pages or subdirectories.  If the
  42.      subdirectory name has the format _c_a_t[_1-_8_l_n_o_p_D] then the pages in that
  43.      subdirectory are treated as pre-formatted "cat" manual entries.  If the
  44.      subdirectory name has the format _m_a_n[_1-_8_l_n_o_p_D] then the pages in that
  45.      subdirectory are treated as unformatted _n_r_o_f_f(1) source manual entries.
  46.      Unformatted manual entries will be processed by _n_e_q_n(1), _t_b_l(1),
  47.      _n_r_o_f_f(1), and _c_o_l(1).  (See the CCCCAAAAVVVVEEEEAAAATTTTSSSS section concerning formatting
  48.      unformatted manual pages.)  These must be installed with a standard
  49.      suffix, such as ._1_m, in order for the _m_a_n command to find them (i.e.,
  50.      name, period, suffix).  The "cat" manual entries are compressed to save
  51.      disk space using _p_a_c_k(1), _c_o_m_p_r_e_s_s(1), or _g_z_i_p(1); all pre-formatted man
  52.      pages must be compressed with one of the above in order for the man
  53.      command to find them.  _m_a_n will automatically uncompress compressed "cat"
  54.      manual entries using _p_c_a_t(1), _z_c_a_t(1), or _g_z_c_a_t(1) respectively.
  55.  
  56.      After the local additions are searched, the standard pre-formatted manual
  57.      entries in /_u_s_r/_s_h_a_r_e/_c_a_t_m_a_n/[_a_g_p_u]__m_a_n are searched.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. MMMMAAAANNNN((((1111))))                                                                  MMMMAAAANNNN((((1111))))
  71.  
  72.  
  73.  
  74.      After searching /_u_s_r/_s_h_a_r_e/_c_a_t_m_a_n, _m_a_n will search /_u_s_r/_s_h_a_r_e/_m_a_n ,
  75.      /_u_s_r/_c_a_t_m_a_n , then /_u_s_r/_m_a_n , for manual pages.  The user may override
  76.      these default root directories for manual entries with the environment
  77.      variable MMMMAAAANNNNPPPPAAAATTTTHHHH or with the command-line options ----MMMM and ----dddd.  (See
  78.      discussion below.)
  79.  
  80.      IIIIRRRRIIIIXXXX is derived from four main sources: AT&T, Berkeley, MIPS Computer
  81.      Systems, and Sun Microsystems.  Because development at these sources is
  82.      more or less independent, in several cases programs have been given the
  83.      same name but have vastly different functionality.  The manual entries
  84.      for such programs have been distinguished by giving them suffixes:  ____aaaatttttttt,
  85.      ____bbbbssssdddd, ____mmmmiiiippppssss, or ____ssssuuuunnnn.  You do not need to give the suffixes.  If _m_a_n is
  86.      given an un-suffixed title _t_i_t_l_e for which suffixed entries exist, it
  87.      will display all of them.
  88.  
  89.      Searches for _t_i_t_l_e_s, _k_e_y_w_o_r_d_s, and _f_i_l_e_n_a_m_e_s are case-insensitive.  For
  90.      example, the manual entry _R_G_B_c_o_l_o_r(3G) can be gotten by the command-line:
  91.  
  92.           man rgbcolor
  93.  
  94.      Also, _t_i_t_l_e_s, _k_e_y_w_o_r_d_s, and _f_i_l_e_n_a_m_e_s may contain special characters
  95.      allowing manual pages to looked up by only specifying partial names in
  96.      much the same way that _s_h(1) and _c_s_h(1) match file names.  For example,
  97.      the summaries of manual entries pertaining to RGB writemasks may be
  98.      searched by the command-line:
  99.  
  100.           man -k 'rgb*mask'
  101.  
  102.      The complete set of special characters is as follows:
  103.  
  104.  
  105.      ****      Match any sequence of characters, including none-at-all.
  106.  
  107.      ????      Match any single character.
  108.  
  109.      [[[[............]]]]  Matches any of the set of characters between the brackets.  A pair
  110.             of characters separated by ---- matches any one of the characters
  111.             which comes between the two characters, including the two
  112.             characters, based on ASCII character encoding (see _a_s_c_i_i(5)).
  113.  
  114.  
  115.      _m_a_n also supports a more sophisticated means for looking up manual pages
  116.      using regular expressions.  To use regular expressions to lookup manual
  117.      pages, you must use the ----rrrr option discussed below.
  118.  
  119. OOOOPPPPTTTTIIIIOOOONNNNSSSS
  120.      ----MMMM _p_a_t_h      Use _p_a_t_h as the search path for manual entries.  _p_a_t_h is a
  121.                   colon-separated list of directories where manual
  122.                   subdirectories may be found.  The default path is
  123.                   /_u_s_r/_s_h_a_r_e/_c_a_t_m_a_n:/_u_s_r/_s_h_a_r_e/_m_a_n:/_u_s_r/_c_a_t_m_a_n:/_u_s_r/_m_a_n.  ----MMMM
  124.                   is useful for searching locations other than the standard
  125.                   manual directories for manual entries.  These locations
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. MMMMAAAANNNN((((1111))))                                                                  MMMMAAAANNNN((((1111))))
  137.  
  138.  
  139.  
  140.                   could be personal manual page trees or NFS mounted BSD style
  141.                   manual page trees from another system.  For example, the
  142.                   standard manual directories could be augmented with personal
  143.                   manual pages by specifying the path:
  144.  
  145.                     /usr/share/catman:/usr/share/man:/usr/catman:/usr/man:$HOME/man
  146.  
  147.                   ----MMMM must be given before ----kkkk and ----ffff.  ----MMMM will override the
  148.                   environment variable MMMMAAAANNNNPPPPAAAATTTTHHHH.  ----MMMM and ----dddd are mutually
  149.                   exclusive.  At most 100 directories may be specified; if
  150.                   more are specified, the rest will be ignored.
  151.  
  152.      ----cccc           Copy the manual page to the standard output instead of using
  153.                   _m_o_r_e(1) or the user specified PPPPAAAAGGGGEEEERRRR or MMMMAAAANNNNPPPPAAAAGGGGEEEERRRR.
  154.  
  155.      ----dddd           Use the direct path specified for finding the manual page
  156.                   _t_i_t_l_e.  The ----dddd option uses the full path name of the
  157.                   specified _t_i_t_l_e as the manual page to print, formatting it
  158.                   if necessary.  Since ----dddd does no searching, any suffixes like
  159.                   ".1" must be specified otherwise the manual page will not be
  160.                   found.  If no leading path is specified, the current
  161.                   directory (.) is assumed.  ----dddd is useful for formatting
  162.                   manual page sources you are editing as part of your software
  163.                   development.  The ----tttt option may be used in conjunction with
  164.                   ----dddd to format a manual page source file and send it to the
  165.                   printer.  ----dddd will ignore the environment variable MMMMAAAANNNNPPPPAAAATTTTHHHH.
  166.                   ----dddd and ----MMMM are mutually exclusive.
  167.  
  168.      ----pppp           Print on standard output the commands that would be executed
  169.                   to format and display the specified manual pages instead of
  170.                   actually executing the commands.  The printed command
  171.                   reflects the environment variable settings described below.
  172.  
  173.      ----wwww           Print only the _p_a_t_h_n_a_m_e of each entry matching the given
  174.                   _t_i_t_l_e.  The actual matching entry will not be printed, only
  175.                   its path is given.
  176.  
  177.      ----tttt           Typeset each _t_i_t_l_ed manual entry and send the result to the
  178.                   printer.  In the case of the preformatted "cat" manual pages
  179.                   which come standard with IIIIRRRRIIIIXXXX, the entry is unpacked using
  180.                   _p_c_a_t(1) and then sent to the default printer using _l_p(1).
  181.                   If, however, the manual entry is a locally added,
  182.                   unformatted _n_r_o_f_f(1) source, the entry will be formatted
  183.                   using _p_s_r_o_f_f(1) and sent to the printer.  The environment
  184.                   variable TTTTRRRROOOOFFFFFFFF may be used to specify another formatting
  185.                   program other than _p_s_r_o_f_f (see the discussion on EEEENNNNVVVVIIIIRRRROOOONNNNMMMMEEEENNNNTTTT
  186.                   below.  If the BSD _l_p_r(1) printing facility is used, the
  187.                   TTTTCCCCAAAATTTT and NNNNCCCCAAAATTTT environment variables should be set to send
  188.                   the output to _l_p_r instead of _l_p.
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. MMMMAAAANNNN((((1111))))                                                                  MMMMAAAANNNN((((1111))))
  203.  
  204.  
  205.  
  206.      ----TTTT _m_a_c_r_o_p_a_c_k_a_g_e
  207.                   The given _n_r_o_f_f(1) macro package will be used for formatting
  208.                   unformatted manual entries.  By default,
  209.                   /_u_s_r/_l_i_b/_t_m_a_c/_t_m_a_c._a_n is used.
  210.  
  211.      ----kkkk _k_e_y_w_o_r_d   Print the manual entry summaries which contain the given
  212.                   _k_e_y_w_o_r_ds.  The summaries are gotten from the _w_h_a_t_i_s
  213.                   database.  (See also _a_p_r_o_p_o_s(1).)
  214.  
  215.      ----ffff _f_i_l_e_n_a_m_e  Print the manual entry summaries which might pertain to the
  216.                   given _f_i_l_e_n_a_m_es.  Any leading pathname components are
  217.                   stripped from the _f_i_l_e_n_a_m_e before the _f_i_l_e_n_a_m_e is matched
  218.                   against the summaries.  The summaries are gotten from the
  219.                   _w_h_a_t_i_s database.  (See also _w_h_a_t_i_s(1).)
  220.  
  221.      ----WWWW           is normally used only by the _m_a_k_e_w_h_a_t_i_s(1m) command to build
  222.                   the _w_h_a_t_i_s and _a_p_r_o_p_o_s databases.
  223.  
  224.      ----rrrr           Treat specified names as regular expressions for searches.
  225.                   The regular expressions handled are those supported by
  226.                   _r_e_g_e_x(3X).
  227.  
  228. EEEENNNNVVVVIIIIRRRROOOONNNNMMMMEEEENNNNTTTT
  229.      MMMMAAAANNNNPPPPAAAATTTTHHHH  If set, MMMMAAAANNNNPPPPAAAATTTTHHHH overrides the default manual entry search path.
  230.               MMMMAAAANNNNPPPPAAAATTTTHHHH is a colon-separated list of directories where manual
  231.               subdirectories may be found.  (See the discussion of ----MMMM.)  ----MMMM
  232.               and ----dddd will override MMMMAAAANNNNPPPPAAAATTTTHHHH.
  233.  
  234.      LLLLAAAANNNNGGGG     If set, then for each directory to be searched (as determined by
  235.               the ----MMMM option, the MMMMAAAANNNNPPPPAAAATTTTHHHH variable, or the default search
  236.               path), an additional directory is constructed and searched which
  237.               has the value of the LLLLCCCC____MMMMEEEESSSSSSSSAAAAGGGGEEEESSSS locale category appended to it.
  238.               These language specific directories are searched before the
  239.               corresponding generic directory.  LLLLCCCC____MMMMEEEESSSSSSSSAAAAGGGGEEEESSSS may be set either
  240.               in the environment or will automatically be set based on the
  241.               setting of the LLLLAAAANNNNGGGG variable (see _eeee_nnnn_vvvv_iiii_rrrr_oooo_nnnn(5)).
  242.  
  243.      PPPPAAAAGGGGEEEERRRR and MMMMAAAANNNNPPPPAAAAGGGGEEEERRRR
  244.               If set, PPPPAAAAGGGGEEEERRRR and MMMMAAAANNNNPPPPAAAAGGGGEEEERRRR specify a program for interactively
  245.               displaying the output from _m_a_n.  MMMMAAAANNNNPPPPAAAAGGGGEEEERRRR will override PPPPAAAAGGGGEEEERRRR so
  246.               a program other than the user's standard paging program may be
  247.               used for displaying _m_a_n output.  If neither PPPPAAAAGGGGEEEERRRR or MMMMAAAANNNNPPPPAAAAGGGGEEEERRRR
  248.               are set, the command "ul -b | more -s -f" is used.  See _u_l(1)
  249.               and _m_o_r_e(1) for details on these options.
  250.  
  251.      MMMMAAAANNNNFFFFMMMMTTTTCCCCMMMMDDDD
  252.               may be used to specify the full command to format unformatted
  253.               man pages.  If set, the other formatter environment variables
  254.               are ignored, as is the -_T option.  The command will be given a
  255.               single argument, which is the full pathname of the man page that
  256.               is to be formatted.
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. MMMMAAAANNNN((((1111))))                                                                  MMMMAAAANNNN((((1111))))
  269.  
  270.  
  271.  
  272.      TTTTCCCCAAAATTTT     may be used to specify the command for printing or displaying
  273.               unformatted (nroff/troff source) manual pages when the ----tttt option
  274.               is selected.  If TTTTCCCCAAAATTTT is not set, the command "lp" is used.  For
  275.               systems using the BSD _l_p_r(1) printing facility, TTTTCCCCAAAATTTT should be
  276.               set to "lpr".  If a troff formatting program which does not
  277.               output PostScript is used, TTTTCCCCAAAATTTT should be set to "lpr <option>"
  278.               where <option> specifies the proper printing for the troff
  279.               output.
  280.  
  281.      NNNNCCCCAAAATTTT     may be used to specify the command for printing or displaying
  282.               preformatted manual pages when the ----tttt option is selected.  If
  283.               NNNNCCCCAAAATTTT is not set, the command specified by TTTTCCCCAAAATTTT is used.  It is
  284.               only necessary to set NNNNCCCCAAAATTTT if TTTTCCCCAAAATTTT is set to "lpr <option>"
  285.               where <option> specifies printing of some special (non-ASCII)
  286.               format.
  287.  
  288.      TTTTRRRROOOOFFFFFFFF    may be used to specify a formatter to use when the ----tttt option is
  289.               selected, and unformatted man pages are processed.  The command
  290.               specified by TTTTRRRROOOOFFFFFFFF must output its results to the standard
  291.               output for TTTTCCCCAAAATTTT to work.  If TTTTRRRROOOOFFFFFFFF is not set, the command
  292.               "psroff -t" is used.
  293.  
  294.      NNNNRRRROOOOFFFFFFFF    Similar to TTTTRRRROOOOFFFFFFFF above, used when the ----tttt option is not
  295.               specified.
  296.  
  297. FFFFIIIILLLLEEEESSSS
  298.      /usr/share/catman                   root directory of on-line reference
  299.                                          manual entry tree
  300.      /usr/share/catman/whatis            table of contents and keyword
  301.                                          database
  302.      /usr/share/catman/u_man/cat[1,6]/*  user manual pages
  303.      /usr/share/catman/a_man/cat[1,4,7]/*
  304.                                          system administrator manual pages
  305.      /usr/share/catman/p_man/cat[2-5]/*  programmer manual pages
  306.      /usr/share/catman/g_man/cat3/*      Graphics Library manual pages
  307.      /usr/share/catman/local/cat[1-8lnop]/*
  308.                                          local pre-formatted manual entries
  309.      /usr/catman/local/man[1-8lnop]/*    local unformatted _n_r_o_f_f(1) source
  310.                                          manual entries
  311.      /usr/share/man/*                    additional unformatted manual pages
  312.      /usr/lib/tmac/tmac.an               default macro package used for
  313.                                          formatting manual entries (contained
  314.                                          in the _D_o_c_u_m_e_n_t_o_r'_s _W_o_r_k _B_e_n_c_h
  315.                                          software option)
  316.  
  317. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  318.      apropos(1), col(1), compress(1), csh(1), eqn(1), grep(1), gzip(1), lp(1),
  319.      lpr(1), makewhatis(1M), more(1), neqn(1), nroff(1), pack(1), pcat(1),
  320.      psroff(1), sh(1), tbl(1), troff(1), ul(1), whatis(1), zcat(1), regex(3X),
  321.      ascii(5), environ(5), man(5), term(5).
  322.  
  323.  
  324.  
  325.  
  326.  
  327.                                                                         PPPPaaaaggggeeee 5555
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334. MMMMAAAANNNN((((1111))))                                                                  MMMMAAAANNNN((((1111))))
  335.  
  336.  
  337.  
  338. CCCCAAAAVVVVEEEEAAAATTTTSSSS
  339.      _a_p_r_o_p_o_s (_m_a_n -_k) and _w_h_a_t_i_s (_m_a_n -_f) require that the _w_h_a_t_i_s database be
  340.      kept up to date by running _m_a_k_e_w_h_a_t_i_s(1M) after installing or removing
  341.      software from the system.  This command is run by default on system
  342.      reboot when software is installed or removed by the _i_n_s_t(1m) command.  If
  343.      the _w_h_a_t_i_s database is not kept up to date, _a_p_r_o_p_o_s (_m_a_n -_k) and _w_h_a_t_i_s
  344.      (_m_a_n -_f) will not find entries for new manual pages and will erroneously
  345.      refer to manual pages which no longer exist on the system.
  346.  
  347.      The /_u_s_r/_s_h_a_r_e/_c_a_t_m_a_n directories have all been processed by _n_r_o_f_f(1).
  348.  
  349.      To format locally added, unformatted manual pages, _m_a_n requires _n_r_o_f_f(1),
  350.      _t_b_l(1), and _n_e_q_n(1) or _e_q_n(1) and _p_s_r_o_f_f(1) with the ----tttt option; these are
  351.      contained in the _D_o_c_u_m_e_n_t_o_r'_s _W_o_r_k _B_e_n_c_h software option, except
  352.      _p_s_r_o_f_f(1), which is part of the _I_m_p_r_e_s_s_a_r_i_o product.  If they are not
  353.      found in the search path, a message to this effect will be printed once
  354.      per invocation of _m_a_n.  The _a_w_f(1) command is then searched for, and if
  355.      found, it will be used instead.  It does not understand all the
  356.      formatting commands, but is usually good enough (the -_T option is ignored
  357.      in this case).  If _a_w_f isn't found either, then any unformatted man pages
  358.      will be skipped.
  359.  
  360.      _p_s_r_o_f_f and _n_r_o_f_f may be overridden with environment variables (see
  361.      above), but the others may not; they must exist somewhere in the search
  362.      path, unless the MMMMAAAANNNNFFFFMMMMTTTTCCCCMMMMDDDD variable is set.  If none of these can be
  363.      used, it may be possible to format the man pages on a system that does
  364.      have the formatting commands available.  The resulting formatted versions
  365.      may be installed on IRISes which do not have the _D_o_c_u_m_e_n_t_o_r'_s _W_o_r_k _B_e_n_c_h.
  366.      To create pre-formatted manual pages, use the commands:
  367.  
  368.  
  369.           neqn mymanpage.1 | tbl | nroff -man > mymanpage
  370.           pack -f mymanpage
  371.  
  372.      The resulting _m_y_m_a_n_p_a_g_e._z file may be copied into the appropriate
  373.      /_u_s_r/_l_o_c_a_l/_m_a_n/_c_a_t[_1-_8] directory.
  374.  
  375.      _m_a_n will not locate manual pages in directories with names containing a
  376.      period (.).
  377.  
  378.      _m_a_n may produce some extra matches if man page names have a period (.) in
  379.      them, as it matches up to a period, assuming the rest is a suffix.
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.                                                                         PPPPaaaaggggeeee 6666
  394.  
  395.  
  396.  
  397.