home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 8 / FreshFishVol8-CD1.bin / gnu / man / cat5 / man.conf.0 < prev   
Text File  |  1993-12-07  |  4KB  |  133 lines
  1.  
  2. MAN.CONF(5)                UNIX Programmer's Manual                MAN.CONF(5)
  3.  
  4. NNAAMMEE
  5.      mmaann..ccoonnff - configuration file for man(1)
  6.  
  7. DDEESSCCRRIIPPTTIIOONN
  8.      The man(1),  apropos(1),  and whatis(1) commands search for manual pages
  9.      or their database files as specified by the mmaann..ccoonnff file.  Manual pages
  10.      are expected to be preformatted (see nroff(1))  and named with a trailing
  11.      ``.0''.
  12.  
  13.      The mmaann..ccoonnff file contains two types of lines.
  14.  
  15.      The first type of line is a ``section'' line, which contains a section
  16.      name followed by a directory path.  Lines in this format specify that
  17.      manual pages for the section may be found in the directory.
  18.  
  19.      Directories named with a trailing slash character (``/'') are expected to
  20.      contain subdirectories (see the keyword ``_subdir'' below) instead of
  21.      manual pages.  These subdirectories are searched instead of the directo­
  22.      ry.
  23.  
  24.      All directories (either explicitly specified or named with a trailing
  25.      slash) may contain subdirectories.  The man(1) command automatically
  26.      searches any subdirectory with the same name as the current machine type
  27.      before the directory is searched.  No specification of these subdirecto­
  28.      ries is necessary in the mmaann..ccoonnff file.
  29.  
  30.      Section names are unrestricted except for the reserved words specified
  31.      below; in general, however, it is best to avoid anything beginning with
  32.      an underscore (``_'') in order to avoid future incompatibilities.
  33.  
  34.      The section named ``_default'' is the list of directories to be searched
  35.      if no section is specified.
  36.  
  37.      The second type of line is preceded with a ``keyword''.  The possible
  38.      keywords and their meanings are as follows:
  39.  
  40.      _subdir
  41.              The list (in search order) of subdirectories which will be
  42.              searched in any directory named with a trailing slash (``/'')
  43.              character.  This list is also used when a path is specified by
  44.              the MANPATH environment variable or the --MM option.
  45.  
  46.      _version
  47.              The version of the configuration file.
  48.  
  49.      _whatdb
  50.              The full pathname (not just a directory path) for a database to
  51.              be used by the apropos(1) and whatis(1) commands.
  52.  
  53.      Multiple specifications for all types of lines (except for ``_version'')
  54.      are cumulative and the entries are used in the order listed in the file;
  55.      multiple entries may be listed per line, as well.
  56.  
  57.      Empty lines or lines whose first non­whitespace character is a hash mark
  58.      (``#'') are ignored.
  59.  
  60. EEXXAAMMPPLLEESS
  61.      Given the following mmaann..ccoonnff file:
  62.  
  63.            _version        BSD.1
  64.            _subdir         cat1 cat2 cat3
  65.            _default        /usr/share/man/
  66.            sect3           /usr/share/man/cat3
  67.  
  68.      The default mktemp(3) manual page should be stored in
  69.      ``_/_u_s_r_/_s_h_a_r_e_/_m_a_n_/_c_a_t_3_/_m_k_t_e_m_p_._0''. Any VAX architecture specific version
  70.      of it should be stored in ``_c_a_t_3_/_v_a_x_/_m_k_t_e_m_p_._0''.
  71.  
  72.      The command ``man mktemp'' would search the subdirectories ``_c_a_t_1''
  73.      ``_c_a_t_2'', and ``_c_a_t_3'', in ``_/_u_s_r_/_s_h_a_r_e_/_m_a_n'', in that order, for
  74.      ``_m_k_t_e_m_p_._0_'_'_.'' If a subdirectory with the same name as the current ma­
  75.      chine type existed in any of them, it would be searched as well.
  76.  
  77.      The command ``man sect3 mktemp'' would only search
  78.      ``/usr/share/man/cat3'' and any possible per machine subdirectory.
  79.  
  80. FFIILLEESS
  81.      /etc/man.conf  Standard manual directory search path.
  82.  
  83. SSEEEE AALLSSOO
  84.      apropos(1),  machine(1),  man(1),  whatis(1),  whereis(1)
  85.  
  86. HHIISSTTOORRYY
  87.      The mmaann..ccoonnff file format currently under development.
  88.  
  89.                                  May 10, 1991                                2
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.