man.desc(4)                         CLIX                         man.desc(4)



  NAME

    man.desc - Database for apropos and whatis commands

  DESCRIPTION

    The /usr/ip32/sysvdoc/man.desc file contains information on reference
    manual entries in the online reference product.  The information comprises
    a database that is searched by the apropos and whatis commands.  Each
    entry in the file represents a file in the online reference product, which
    contains information on one or more commands, files, or functions.

    Each line in the file has the following format:

    name[, name, ...] (section) = description

    The fields in each line are defined as follows:

    name          Name of a command, function, or file.  This is the naming
                  information shown in the NAME line of an online reference
                  manual entry.  If related commands, files, or functions are
                  documented in a single entry, multiple names may appear in
                  the entry's NAME line.  The first command, file, or function
                  listed in the NAME line is considered the primary subject of
                  the entry.

    section       Number of the reference manual section in which the
                  commands, functions, or files are located.

    description   Brief description of the command, function, or file.  This
                  is the description shown in the NAME line of an online
                  reference manual entry.  If related commands, files, or
                  functions are documented in a single entry, the description
                  applies to all of the documented commands, files, or
                  functions.

    A man.desc file is delivered with each release of the SYSVDOC product; the
    entries in the file apply to the online reference manual entries delivered
    in that release. To enable the apropos and whatis commands to search for
    information on locally created reference manual entries, add a line for
    each local entry to the man.desc file, making sure that the line matches
    the format of the other lines in the file.

  EXAMPLES

    The following example shows parts of the man.desc file:

    acct (0)  = Per-process accounting file format
    ar (0)    = Common archive file format
    ....
    ab (1)    = Runs the Ada program beautifier



  2/94 - Intergraph Corporation                                              1

  man.desc(4)                         CLIX                         man.desc(4)



    Ac (1)    = Runs the Ada compiler
    adb (1)   = Runs the absolute debugger
    ....
    accept (2)     = Accepts a connection on a socket
    access (2)     = Determines accessibility of a file
    acct (2)  = Enables or disables process accounting
    ....
    a64l, l64a (3) = Converts between long integer and base-64 ASCII string
    abort (3) = Generates an IOT fault
    abs, labs (3)  = Returns an integer absolute value
    ....


  CAUTIONS

    Any information in the man.desc file on local reference manual entries is
    lost upon redelivery of the SYSVDOC product.  Keep local reference manual
    entry information in a separate file and append that file to the man.desc
    file each time SYSVDOC is delivered to the system.

  RELATED INFORMATION

    Commands:  apropos(1), whatis(1)































  2                                              Intergraph Corporation - 2/94