WEB-INF/lib/pear/PEAR/Command/Config.xml

   1 <commands version="1.0">
   2  <config-show>
   3   <summary>Show All Settings</summary>
   4   <function>doConfigShow</function>
   5   <shortcut>csh</shortcut>
   6   <options>
   7    <channel>
   8     <shortopt>c</shortopt>
   9     <doc>show configuration variables for another channel</doc>
  10     <arg>CHAN</arg>
  11    </channel>
  12   </options>
  13   <doc>[layer]
  14 Displays all configuration values.  An optional argument
  15 may be used to tell which configuration layer to display.  Valid
  16 configuration layers are &quot;user&quot;, &quot;system&quot; and &quot;default&quot;. To display
  17 configurations for different channels, set the default_channel
  18 configuration variable and run config-show again.
  19 </doc>
  20  </config-show>
  21  <config-get>
  22   <summary>Show One Setting</summary>
  23   <function>doConfigGet</function>
  24   <shortcut>cg</shortcut>
  25   <options>
  26    <channel>
  27     <shortopt>c</shortopt>
  28     <doc>show configuration variables for another channel</doc>
  29     <arg>CHAN</arg>
  30    </channel>
  31   </options>
  32   <doc>&lt;parameter&gt; [layer]
  33 Displays the value of one configuration parameter.  The
  34 first argument is the name of the parameter, an optional second argument
  35 may be used to tell which configuration layer to look in.  Valid configuration
  36 layers are &quot;user&quot;, &quot;system&quot; and &quot;default&quot;.  If no layer is specified, a value
  37 will be picked from the first layer that defines the parameter, in the order
  38 just specified.  The configuration value will be retrieved for the channel
  39 specified by the default_channel configuration variable.
  40 </doc>
  41  </config-get>
  42  <config-set>
  43   <summary>Change Setting</summary>
  44   <function>doConfigSet</function>
  45   <shortcut>cs</shortcut>
  46   <options>
  47    <channel>
  48     <shortopt>c</shortopt>
  49     <doc>show configuration variables for another channel</doc>
  50     <arg>CHAN</arg>
  51    </channel>
  52   </options>
  53   <doc>&lt;parameter&gt; &lt;value&gt; [layer]
  54 Sets the value of one configuration parameter.  The first argument is
  55 the name of the parameter, the second argument is the new value.  Some
  56 parameters are subject to validation, and the command will fail with
  57 an error message if the new value does not make sense.  An optional
  58 third argument may be used to specify in which layer to set the
  59 configuration parameter.  The default layer is &quot;user&quot;.  The
  60 configuration value will be set for the current channel, which
  61 is controlled by the default_channel configuration variable.
  62 </doc>
  63  </config-set>
  64  <config-help>
  65   <summary>Show Information About Setting</summary>
  66   <function>doConfigHelp</function>
  67   <shortcut>ch</shortcut>
  68   <options />
  69   <doc>[parameter]
  70 Displays help for a configuration parameter.  Without arguments it
  71 displays help for all configuration parameters.
  72 </doc>
  73  </config-help>
  74  <config-create>
  75   <summary>Create a Default configuration file</summary>
  76   <function>doConfigCreate</function>
  77   <shortcut>coc</shortcut>
  78   <options>
  79    <windows>
  80     <shortopt>w</shortopt>
  81     <doc>create a config file for a windows install</doc>
  82    </windows>
  83   </options>
  84   <doc>&lt;root path&gt; &lt;filename&gt;
  85 Create a default configuration file with all directory configuration
  86 variables set to subdirectories of &lt;root path&gt;, and save it as &lt;filename&gt;.
  87 This is useful especially for creating a configuration file for a remote
  88 PEAR installation (using the --remoteconfig option of install, upgrade,
  89 and uninstall).
  90 </doc>
  91  </config-create>
  92 </commands>