MKID(1) USER COMMANDS MKID(1) NNNNAAAAMMMMEEEE mkid - make an id database SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS mmmmkkkkiiiidddd [----vvvv] [----ffffout-file] [----ssssdirectory] [----rrrrdirectory] [----SSSSscanarg] [----aaaaarg-file] [----] [----uuuu] [ffffiiiilllleeeessss............] DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN _M_k_i_d builds a database that stores numbers and identifier names, as well as the names of the files in which they occur. _M_k_i_d is particularly useful with large programs spread out across multiple source files. It serves as an aid for program maintenance and as a _g_u_i_d_e for perusing a program. The following options are recognized: ----vvvv Verbose. Report _m_k_i_d's progress in building the database. The output comes on standard error. ----ffff_o_u_t-_f_i_l_e Write the finished database into _o_u_t-_f_i_l_e. IIIIDDDD is the default. ----ssss_d_i_r_e_c_t_o_r_y ----rrrr_d_i_r_e_c_t_o_r_y If _m_k_i_d's attempt to open a source-file fails, it will try to checkout the corresponding SCCS or RCS file if present. The ----ssss option tells _m_k_i_d which directory holds the SCCS file. Similarly, the ----rrrr option tells _m_k_i_d which directory holds the RCS file. If neither the RCS or SCCS directories are specified, _m_k_i_d will first look for an SCCS file in the current directory, then in ssssccccccccssss, and finally in SSSSCCCCCCCCSSSS. It will then look for an RCS file in the current directory, and finally in RRRRCCCCSSSS. ----aaaa_a_r_g-_f_i_l_e Open and read _a_r_g-_f_i_l_e in order to obtain a list of source file arguments. Source file names must appear one to a line. ----SSSS, ----rrrr, and ----ssss arguments may also be placed one per line in _f_i_l_e. They are distinguished from source file names by their leading `-'. If a file name begins with `-', it can be distinguished from an argument by expli- citly prepending the current directory string: `./'. ---- This operates in the same manner as the ----aaaa option described above, but reads from the standard input instead of a file. Sun Microsystems Last change: 1 MKID(1) USER COMMANDS MKID(1) ----uuuu Update an existing database. Only those files that have been modified since the database was built will be rescanned. This is a significant time-saver for updating large databases where few sources have changed. ffffiiiilllleeeessss............ If neither the ----aaaa, ----, nor ----uuuu, arguments have been specified, take file names from the command line. ----SSSS_s_c_a_n_a_r_g _M_k_i_d scans source files in order to obtain numbers and identifier names. Since the lexical rules of languages differ, _m_k_i_d applies a different scan- ning function to each language in order to conform to that language's lexical rules. _M_k_i_d determines the source file's language by examining its filename suffix which commonly occurs after a dot (`.'). The ----SSSS argument is a way of passing language specific arguments to the scanner for that language. This argument takes a number of forms: -S= -S- +S- The first form associates a suffix with a language. You may find out which suffixes are defined for which languages with the following options: `-S=?' tells which language is bound to <_s_u_f_f_i_x>, `-S?=' tells which suffixes are bound to <_l_a_n_g_u_a_g_e>, and `-S?=?' reports all bindings between suffixes and languages. The second form passes an argument for processing by the scanner for a specific language. The third form passes an argument to all scanners. You may get a brief summary of the scanner-specific options for a language by supplying the following option: `- S?'. Here is a brief summary of the options for the `_a_s_m' (assem- bler) language. The ----uuuu option controls whether or not the assembler scanner should strip off a leading _u_n_d_e_r_s_c_o_r_e (`_') character. If your assembler prepends an _u_n_d_e_r_s_c_o_r_e to external symbols, then you should tell the scanner to strip it off, so that references to the same symbol from assembly and from a high-level language will look the same. The ----cccc<<<>>> option supplies the character(s) used to begin a comment that extends to the end of the line. Sun Microsystems Last change: 2 MKID(1) USER COMMANDS MKID(1) The ----aaaa<<<>>> option indicates character(s) that are legal in names, in addition to the alpha-numeric characters. If the option appears as `-a', names that contain these characters are ignored. If it appears as `+a', these names are added to the database. BBBBUUUUGGGGSSSS This manual page needs to be more complete about the scanner-specific arguments. At the moment, the only scanners implemented are for C and assembly language. There ought to be scanners for Ada, Pas- cal, Fortran, Lisp, nroff/troff, and TeX. SSSSEEEEEEEE AAAALLLLSSSSOOOO lid(1). Sun Microsystems Last change: 3