home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3n / doconfig.z / doconfig
Encoding:
Text File  |  1998-10-20  |  8.7 KB  |  130 lines
  1.  
  2.  
  3.  
  4. ddddooooccccoooonnnnffffiiiigggg((((3333NNNN))))                                                      ddddooooccccoooonnnnffffiiiigggg((((3333NNNN))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      _dddd_oooo_cccc_oooo_nnnn_ffff_iiii_gggg - execute a configuration script
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      _#### _iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_ssss_aaaa_cccc_...._hhhh_>>>>
  13.  
  14.      _iiii_nnnn_tttt _dddd_oooo_cccc_oooo_nnnn_ffff_iiii_gggg_((((_iiii_nnnn_tttt _ffff_dddd_,,,, _cccc_hhhh_aaaa_rrrr _****_ssss_cccc_rrrr_iiii_pppp_tttt_,,,, _llll_oooo_nnnn_gggg _rrrr_ffff_llll_aaaa_gggg_))))_;;;;
  15.  
  16. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  17.      _dddd_oooo_cccc_oooo_nnnn_ffff_iiii_gggg is a Service Access Facility library function that interprets
  18.      the configuration scripts contained in the files _////_eeee_tttt_cccc_////_ssss_aaaa_ffff_////_p_m_t_a_g_////______cccc_oooo_nnnn_ffff_iiii_gggg,
  19.      _////_eeee_tttt_cccc_////_ssss_aaaa_ffff_////______ssss_yyyy_ssss_cccc_oooo_nnnn_ffff_iiii_gggg, and _////_eeee_tttt_cccc_////_ssss_aaaa_ffff_////_p_m_t_a_g/_s_v_c_t_a_g.
  20.  
  21.      _ssss_cccc_rrrr_iiii_pppp_tttt is the name of the configuration script; _f_d is a file descriptor
  22.      that designates the stream to which stream manipulation operations are to
  23.      be applied; _r_f_l_a_g is a bitmask that indicates the mode in which _ssss_cccc_rrrr_iiii_pppp_tttt is
  24.      to be interpreted.  _r_f_l_a_g may take two values, _NNNN_OOOO_RRRR_UUUU_NNNN and _NNNN_OOOO_AAAA_SSSS_SSSS_IIII_GGGG_NNNN, which
  25.      may be or'd.  If _r_f_l_a_g is zero, all commands in the configuration script
  26.      are eligible to be interpreted.  If _r_f_l_a_g has the _NNNN_OOOO_AAAA_SSSS_SSSS_IIII_GGGG_NNNN bit set, the
  27.      _aaaa_ssss_ssss_iiii_gggg_nnnn command is considered illegal and will generate an error return.
  28.      If _r_f_l_a_g has the _NNNN_OOOO_RRRR_UUUU_NNNN bit set, the _rrrr_uuuu_nnnn and _rrrr_uuuu_nnnn_wwww_aaaa_iiii_tttt commands are
  29.      considered illegal and will generate error returns.
  30.  
  31.      The configuration language in which _ssss_cccc_rrrr_iiii_pppp_tttt is written consists of a
  32.      sequence of commands, each of which is interpreted separately.  The
  33.      following reserved keywords are defined:  _aaaa_ssss_ssss_iiii_gggg_nnnn, _pppp_uuuu_ssss_hhhh, _pppp_oooo_pppp, _rrrr_uuuu_nnnn_wwww_aaaa_iiii_tttt, and
  34.      _rrrr_uuuu_nnnn.  The comment character is _####; when a _#### occurs on a line, everything
  35.      from that point to the end of the line is ignored.  Blank lines are not
  36.      significant.  No line in a command script may exceed 1024 characters.
  37.  
  38.      _aaaa_ssss_ssss_iiii_gggg_nnnn _v_a_r_i_a_b_l_e=_v_a_l_u_e
  39.           Used to define environment variables.  _v_a_r_i_a_b_l_e is the name of the
  40.           environment variable and _v_a_l_u_e is the value to be assigned to it.
  41.           The value assigned must be a string constant; no form of parameter
  42.           substitution is available.  _v_a_l_u_e may be quoted.  The quoting rules
  43.           are those used by the shell for defining environment variables.
  44.           _aaaa_ssss_ssss_iiii_gggg_nnnn will fail if space cannot be allocated for the new variable
  45.           or if any part of the specification is invalid.
  46.      _pppp_uuuu_ssss_hhhh _m_o_d_u_l_e_1[, _m_o_d_u_l_e_2, _m_o_d_u_l_e_3, . . .]
  47.           Used to push STREAMS modules onto the stream designated by _f_d.
  48.           _m_o_d_u_l_e_1 is the name of the first module to be pushed, _m_o_d_u_l_e_2 is the
  49.           name of the second module to be pushed, etc.  The command will fail
  50.           if any of the named modules cannot be pushed.  If a module cannot be
  51.           pushed, the subsequent modules on the same command line will be
  52.           ignored and modules that have already been pushed will be popped.
  53.      _pppp_oooo_pppp [_m_o_d_u_l_e]
  54.           Used to pop STREAMS modules off the designated stream.  If _pppp_oooo_pppp is
  55.           invoked with no arguments, the top module on the stream is popped.
  56.           If an argument is given, modules will be popped one at a time until
  57.           the named module is at the top of the stream.  If the named module
  58.           is not on the designated stream, the stream is left as it was and
  59.  
  60.  
  61.  
  62.                                                                         PPPPaaaaggggeeee 1111
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69. ddddooooccccoooonnnnffffiiiigggg((((3333NNNN))))                                                      ddddooooccccoooonnnnffffiiiigggg((((3333NNNN))))
  70.  
  71.  
  72.  
  73.           the command fails.  If _m_o_d_u_l_e is the special keyword ALL, then all
  74.           modules on the
  75.           stream will be popped.  Note that only modules above the topmost
  76.           driver are affected.
  77.      _rrrr_uuuu_nnnn_wwww_aaaa_iiii_tttt _c_o_m_m_a_n_d
  78.           The _rrrr_uuuu_nnnn_wwww_aaaa_iiii_tttt command runs a command and waits for it to complete.
  79.           _c_o_m_m_a_n_d is the pathname of the command to be run.  The command is
  80.           run with _////_uuuu_ssss_rrrr_////_bbbb_iiii_nnnn_////_ssss_hhhh _----_cccc prepended to it; shell scripts may thus be
  81.           executed from configuration scripts.  The _rrrr_uuuu_nnnn_wwww_aaaa_iiii_tttt command will fail
  82.           if _c_o_m_m_a_n_d cannot be found or cannot be executed, or if _c_o_m_m_a_n_d
  83.           exits with a non-zero status.
  84.      _rrrr_uuuu_nnnn _c_o_m_m_a_n_d
  85.           The _rrrr_uuuu_nnnn command is identical to _rrrr_uuuu_nnnn_wwww_aaaa_iiii_tttt except that it does not wait
  86.           for _c_o_m_m_a_n_d to complete.  _c_o_m_m_a_n_d is the pathname of the command to
  87.           be run.  _rrrr_uuuu_nnnn will not fail unless it is unable to create a child
  88.           process to execute the command.
  89.  
  90.      Although they are syntactically indistinguishable, some of the commands
  91.      available to _rrrr_uuuu_nnnn and _rrrr_uuuu_nnnn_wwww_aaaa_iiii_tttt are interpreter built-in commands.
  92.      Interpreter built-ins are used when it is necessary to alter the state of
  93.      a process within the context of that process.  The _dddd_oooo_cccc_oooo_nnnn_ffff_iiii_gggg interpreter
  94.      built-in commands are similar to the shell special commands and, like
  95.      these, they do not spawn another process for execution.  See _ssss_hhhh(1).  The
  96.      initial set of built-in commands is:
  97.                _cccc_dddd
  98.                _uuuu_llll_iiii_mmmm_iiii_tttt
  99.                _uuuu_mmmm_aaaa_ssss_kkkk
  100.  
  101. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  102.      _dddd_oooo_cccc_oooo_nnnn_ffff_iiii_gggg returns _0000 if the script was interpreted successfully.  If a
  103.      command in the script fails, the interpretation of the script ceases at
  104.      that point and a positive number is returned; this number indicates which
  105.      line in the script failed.  If a system error occurs, a value of _----_1111 is
  106.      returned.  When a script fails, the process whose environment was being
  107.      established should _n_o_t be started.
  108.  
  109. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  110.      _ssss_hhhh(1), _pppp_mmmm_aaaa_dddd_mmmm(1M), _ssss_aaaa_cccc_aaaa_dddd_mmmm(1M)
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  124.  
  125.  
  126.                                                                         PPPPaaaaggggeeee 2222
  127.  
  128.  
  129.  
  130.