home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / u_man / cat1 / intro.z / intro
Encoding:
Text File  |  1998-10-20  |  7.3 KB  |  199 lines
  1.  
  2.  
  3.  
  4. IIIINNNNTTTTRRRROOOO((((1111))))                                                              IIIINNNNTTTTRRRROOOO((((1111))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      intro - introduction to commands, application programs, and programming
  10.      commands.
  11.  
  12. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  13.      This section describes, in alphabetical order, publicly-accessible
  14.      commands.  Certain distinctions of purpose are made in the headings:
  15.  
  16.        (1)  Commands of general utility.
  17.        (1C) Commands for communication with other systems.
  18.        (1G) Graphics utilities.
  19.  
  20.    MMMMaaaannnnuuuuaaaallll PPPPaaaaggggeeee CCCCoooommmmmmmmaaaannnndddd SSSSyyyynnnnttttaaaaxxxx
  21.      Unless otherwise noted, commands described in the SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS section of a
  22.      manual page accept options and other arguments according to the following
  23.      syntax and should be interpreted as explained below.
  24.  
  25.      _n_a_m_e [ ----_o_p_t_i_o_n ... ] [ _c_m_d_a_r_g ... ]
  26.      where:
  27.  
  28.      [ ]          Surround an _o_p_t_i_o_n or _c_m_d_a_r_g that is not required.
  29.  
  30.      ...          Indicates multiple occurrences of the _o_p_t_i_o_n or _c_m_d_a_r_g.
  31.  
  32.      _n_a_m_e         The name of an executable file.
  33.  
  34.      _o_p_t_i_o_n       This is either
  35.                   _n_o_a_r_g_l_e_t_t_e_r...
  36.                   or
  37.                   _a_r_g_l_e_t_t_e_r _o_p_t_a_r_g[,,,,...]
  38.                   It is always preceded by a ``-''.
  39.  
  40.           _n_o_a_r_g_l_e_t_t_e_r
  41.                   A single letter representing an option without an option-
  42.                   argument.  Note that more than one _n_o_a_r_g_l_e_t_t_e_r option can be
  43.                   grouped after one ``----'' (Rule 5, below).
  44.  
  45.           _a_r_g_l_e_t_t_e_r
  46.                   A single letter representing an option requiring an option-
  47.                   argument.
  48.  
  49.           _o_p_t_a_r_g  An option-argument (character string) satisfying a preceding
  50.                   _a_r_g_l_e_t_t_e_r.  Note that groups of _o_p_t_a_r_g_s following an
  51.                   _a_r_g_l_e_t_t_e_r must be separated by commas, or separated by white
  52.                   space and quoted (Rule 8, below).
  53.  
  54.           _c_m_d_a_r_g  Path name (or other command argument) _n_o_t beginning with
  55.                   ``----'', or ``----'' by itself indicating the standard input.
  56.  
  57.    CCCCoooommmmmmmmaaaannnndddd SSSSyyyynnnnttttaaaaxxxx SSSSttttaaaannnnddddaaaarrrrdddd::::  RRRRuuuulllleeeessss
  58.      These command syntax rules are not followed by all current commands, but
  59.      all new commands will obey them.  _g_e_t_o_p_t_s(1) should be used by all shell
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. IIIINNNNTTTTRRRROOOO((((1111))))                                                              IIIINNNNTTTTRRRROOOO((((1111))))
  71.  
  72.  
  73.  
  74.      procedures to parse positional parameters and to check for legal options.
  75.      It supports Rules 3-10 below.  The enforcement of the other rules must be
  76.      done by the command itself.
  77.  
  78.      Since almost all commands are run via the shells ( _b_s_h(1),_s_h(1),_c_s_h(1),
  79.      _k_s_h(1),_a_n_d _t_c_s_h(_1)) diagnostic messages may be issued by the shells,
  80.      prior to, or even instead of, the command itself being executed.  A
  81.      common case is too many arguments to the command.  See the manual page
  82.      for your shell for details.
  83.  
  84.           1.   Command names (_n_a_m_e above) must be between two and nine
  85.                characters long.
  86.  
  87.           2.   Command names must include only lower-case letters and digits.
  88.  
  89.           3.   Option names (_o_p_t_i_o_n above) must be one character long.
  90.  
  91.           4.   All options must be preceded by ``----''.
  92.  
  93.           5.   Options with no arguments may be grouped after a single ``----''.
  94.  
  95.           6.   The first option-argument (_o_p_t_a_r_g above) following an option
  96.                must be preceded by white space.
  97.  
  98.           7.   Option-arguments cannot be optional.
  99.  
  100.           8.   Groups of option-arguments following an option must either be
  101.                separated by commas or separated by white space and quoted
  102.                (e.g., -o xxx,z,yy or  -o "xxx z yy").
  103.  
  104.           9.   All options must precede operands (_c_m_d_a_r_g above) on the command
  105.                line.
  106.  
  107.           10.  ``--------'' may be used to indicate the end of the options.
  108.  
  109.           11.  The order of the options relative to one another should not
  110.                matter.
  111.  
  112.           12.  The relative order of the operands (_c_m_d_a_r_g above) may affect
  113.                their significance in ways determined by the command with which
  114.                they appear.
  115.  
  116.           13.  ``----'' preceded and followed by white space should only be used
  117.                to mean standard input.
  118.  
  119.           Throughout the manual pages there are references to _T_M_P_D_I_R, _B_I_N_D_I_R,
  120.           _I_N_C_D_I_R, _L_I_B_D_I_R, and _L_L_I_B_D_I_R.  These represent directory names whose
  121.           value is specified on each manual page as necessary.  For example,
  122.           _T_M_P_D_I_R might refer to /tmp or /usr/tmp.  These are not environment
  123.           variables and cannot be set.  (There is also an environment variable
  124.           called TTTTMMMMPPPPDDDDIIIIRRRR which can be set.  See _t_m_p_n_a_m(3S).)
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. IIIINNNNTTTTRRRROOOO((((1111))))                                                              IIIINNNNTTTTRRRROOOO((((1111))))
  137.  
  138.  
  139.  
  140. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  141.      getopts(1), exec(2), exit(2), wait(2), getopt(3C).
  142. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  143.      Upon termination, each command returns two bytes of status, one supplied
  144.      by the system and giving the cause for termination, and (in the case of
  145.      ``normal'' termination) one supplied by the program (see _w_a_i_t(2) and
  146.      _e_x_i_t(2)).  The former byte is 0 for normal termination; the latter is
  147.      customarily 0 for successful execution and non-zero to indicate troubles
  148.      such as erroneous parameters, or bad or inaccessible data.  It is called
  149.      variously ``exit code'', ``exit status'', or ``return code'', and is
  150.      described only where special conventions are involved.
  151. WWWWAAAARRRRNNNNIIIINNNNGGGGSSSS
  152.      Some commands produce unexpected results when processing files containing
  153.      null characters.  These commands often treat text input lines as strings
  154.      and therefore become confused upon encountering a null character (the
  155.      string terminator) within a line.
  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.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.