home *** CD-ROM | disk | FTP | other *** search
/ Fish 'n' More 2 / fishmore-publicdomainlibraryvol.ii1991xetec.iso / fish / programming / mkid / doc / mkid.man < prev   
Text File  |  1991-02-01  |  7KB  |  199 lines
  1.  
  2.  
  3.  
  4. MKID(1)                  USER COMMANDS                    MKID(1)
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      mkid - make an id database
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      mmmmkkkkiiiidddd   [----vvvv]   [----ffffout-file]    [----ssssdirectory]    [----rrrrdirectory]
  13.      [----SSSSscanarg] [----aaaaarg-file] [----] [----uuuu] [ffffiiiilllleeeessss............]
  14.  
  15. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  16.      _M_k_i_d builds a database that stores  numbers  and  identifier
  17.      names,  as  well  as  the  names  of the files in which they
  18.      occur.  _M_k_i_d is  particularly  useful  with  large  programs
  19.      spread  out  across  multiple source files.  It serves as an
  20.      aid for program maintenance and as a _g_u_i_d_e  for  perusing  a
  21.      program.
  22.  
  23.      The following options are recognized:
  24.  
  25.      ----vvvv        Verbose.  Report _m_k_i_d's progress in  building  the
  26.                database.  The output comes on standard error.
  27.  
  28.      ----ffff_o_u_t-_f_i_l_e
  29.                Write the finished database into _o_u_t-_f_i_l_e.  IIIIDDDD  is
  30.                the default.
  31.  
  32.      ----ssss_d_i_r_e_c_t_o_r_y
  33.  
  34.      ----rrrr_d_i_r_e_c_t_o_r_y
  35.                If _m_k_i_d's attempt to open a source-file fails,  it
  36.                will try to checkout the corresponding SCCS or RCS
  37.                file if present.  The ----ssss option tells  _m_k_i_d  which
  38.                directory  holds the SCCS file.  Similarly, the ----rrrr
  39.                option tells _m_k_i_d which directory  holds  the  RCS
  40.                file.   If neither the RCS or SCCS directories are
  41.                specified, _m_k_i_d will first look for an  SCCS  file
  42.                in  the  current  directory,  then  in  ssssccccccccssss,  and
  43.                finally in SSSSCCCCCCCCSSSS.  It will then  look  for  an  RCS
  44.                file in the current directory, and finally in RRRRCCCCSSSS.
  45.  
  46.      ----aaaa_a_r_g-_f_i_l_e
  47.                Open and read _a_r_g-_f_i_l_e in order to obtain  a  list
  48.                of  source file arguments.  Source file names must
  49.                appear one to a line.  ----SSSS, ----rrrr,  and  ----ssss  arguments
  50.                may also be placed one per line in _f_i_l_e.  They are
  51.                distinguished from  source  file  names  by  their
  52.                leading  `-'.   If a file name begins with `-', it
  53.                can be distinguished from an  argument  by  expli-
  54.                citly  prepending  the  current  directory string:
  55.                `./'.
  56.  
  57.      ----         This operates in the same manner as the ----aaaa  option
  58.                described above, but reads from the standard input
  59.                instead of a file.
  60.  
  61.  
  62.  
  63. Sun Microsystems          Last change:                          1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. MKID(1)                  USER COMMANDS                    MKID(1)
  71.  
  72.  
  73.  
  74.      ----uuuu        Update an existing  database.   Only  those  files
  75.                that  have  been  modified  since the database was
  76.                built will be rescanned.  This  is  a  significant
  77.                time-saver  for updating large databases where few
  78.                sources have changed.
  79.  
  80.      ffffiiiilllleeeessss............  If neither the ----aaaa, ----, nor ----uuuu, arguments have  been
  81.                specified, take file names from the command line.
  82.  
  83.      ----SSSS_s_c_a_n_a_r_g _M_k_i_d scans source files in order to obtain numbers
  84.                and  identifier names.  Since the lexical rules of
  85.                languages differ, _m_k_i_d applies a  different  scan-
  86.                ning function to each language in order to conform
  87.                to that language's lexical rules.  _M_k_i_d determines
  88.                the   source  file's  language  by  examining  its
  89.                filename suffix which commonly occurs after a  dot
  90.                (`.').   The  ----SSSS  argument  is  a  way  of passing
  91.                language specific arguments  to  the  scanner  for
  92.                that  language.   This  argument takes a number of
  93.                forms:
  94.                -S<suffix>=<language>
  95.                -S<language>-<arg>
  96.                +S-<arg>
  97.                The  first  form  associates  a  suffix   with   a
  98.                language.   You  may  find  out which suffixes are
  99.                defined for which  languages  with  the  following
  100.                options:  `-S<suffix>=?'  tells  which language is
  101.                bound to <_s_u_f_f_i_x>,  `-S?=<language>'  tells  which
  102.                suffixes  are  bound  to  <_l_a_n_g_u_a_g_e>,  and `-S?=?'
  103.                reports  all   bindings   between   suffixes   and
  104.                languages.
  105.  
  106.      The second form passes an argument  for  processing  by  the
  107.      scanner  for  a specific language.  The third form passes an
  108.      argument to all scanners.
  109.  
  110.      You may get a brief summary of the scanner-specific  options
  111.      for  a  language  by  supplying  the  following  option:  `-
  112.      S<language>?'.
  113.  
  114.      Here is a brief summary of the options for the `_a_s_m' (assem-
  115.      bler) language.
  116.  
  117.      The ----uuuu option controls whether or not the assembler  scanner
  118.      should  strip  off a leading _u_n_d_e_r_s_c_o_r_e (`_') character.  If
  119.      your assembler prepends an _u_n_d_e_r_s_c_o_r_e to  external  symbols,
  120.      then  you  should  tell the scanner to strip it off, so that
  121.      references to the same  symbol  from  assembly  and  from  a
  122.      high-level language will look the same.
  123.  
  124.      The ----cccc<<<<cccccccc>>>> option supplies the character(s) used to begin  a
  125.      comment that extends to the end of the line.
  126.  
  127.  
  128.  
  129. Sun Microsystems          Last change:                          2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. MKID(1)                  USER COMMANDS                    MKID(1)
  137.  
  138.  
  139.  
  140.      The ----aaaa<<<<cccccccc>>>> option indicates character(s) that are  legal  in
  141.      names,  in addition to the alpha-numeric characters.  If the
  142.      option appears as `-a', names that contain these  characters
  143.      are  ignored.   If it appears as `+a', these names are added
  144.      to the database.
  145.  
  146. BBBBUUUUGGGGSSSS
  147.      This manual  page  needs  to  be  more  complete  about  the
  148.      scanner-specific arguments.
  149.  
  150.      At the moment, the only scanners implemented are for  C  and
  151.      assembly language.  There ought to be scanners for Ada, Pas-
  152.      cal, Fortran, Lisp, nroff/troff, and TeX.
  153.  
  154. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  155.      lid(1).
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195. Sun Microsystems          Last change:                          3
  196.  
  197.  
  198.  
  199.