cvs: peardoc /en/pyrus/configuration/user autodiscover.xml cachedir.xml cachettl.xml defaultchannel.xml downloaddir.xml handle.xml httpproxy.xml mypearpath.xml opensslcert.xml password.xml pluginsdir.xml preferredmirror.xml preferredstate.xml tempdir.xml umask.xml username.xml verbose.xml

http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/configuration/user/autodiscover.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/pyrus/configuration/user/autodiscover.xml
diff -u peardoc/en/pyrus/configuration/user/autodiscover.xml:1.1 peardoc/en/pyrus/configuration/user/autodiscover.xml:1.2
--- peardoc/en/pyrus/configuration/user/autodiscover.xml:1.1	Sat Jun 27 19:00:15 2009
+++ peardoc/en/pyrus/configuration/user/autodiscover.xml	Sun Jun 28 05:11:39 2009
@@ -4,6 +4,26 @@
 
  <section xml:id="pyrus.configuration.user.autodiscover.intro">
   <info><title>Introduction</title></info>
-  <para>This is a work in progress.</para>
+  <para>
+   <literal>auto_discover</literal> is a flag (boolean), defaulting to
+   <literal>0</literal> or off.  If on, this flag instructs Pyrus
+   to automatically discover channels of dependencies (see
+   <link linkend="pyrus.commands.channeldiscover">channel-discover</link> for
+   a more in-depth description of what channel discovery means).
+  </para>
+  <para>
+   For example, let's say we are installing Package <literal>foo</literal> from channel
+   <literal>pear2.php.net</literal>, and that <literal>foo</literal> depends on package
+   <literal>bar</literal> from channel <literal>pear.example.com</literal>.
+   If Pyrus does not know the <literal>pear.example.com</literal> channel, and
+   <literal>auto_discover</literal> is set to <literal>1</literal>, it will
+   attempt to discover information on the channel, and after successfully
+   adding its information to the registry, will then successfully download
+   and install the dependency <literal>bar</literal>.  However, if
+   <literal>auto_discover</literal> is disabled, Pyrus will simply fail
+   with an error explaining that nothing is known about the
+   <literal>pear.example.com</literal> channel, and that it must be
+   added prior to installation.
+  </para>
  </section>
 </section>
http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/configuration/user/cachedir.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/pyrus/configuration/user/cachedir.xml
diff -u peardoc/en/pyrus/configuration/user/cachedir.xml:1.1 peardoc/en/pyrus/configuration/user/cachedir.xml:1.2
--- peardoc/en/pyrus/configuration/user/cachedir.xml:1.1	Sat Jun 27 19:00:15 2009
+++ peardoc/en/pyrus/configuration/user/cachedir.xml	Sun Jun 28 05:11:39 2009
@@ -4,6 +4,9 @@
 
  <section xml:id="pyrus.configuration.user.cachedir.intro">
   <info><title>Introduction</title></info>
-  <para>This is a work in progress.</para>
+  <para>
+   <literal>cache_dir</literal> is the location where HTTP caching of
+   PEAR channel <link linkend="core.rest">REST</link> files is cached.
+  </para>
  </section>
 </section>
http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/configuration/user/cachettl.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/pyrus/configuration/user/cachettl.xml
diff -u peardoc/en/pyrus/configuration/user/cachettl.xml:1.1 peardoc/en/pyrus/configuration/user/cachettl.xml:1.2
--- peardoc/en/pyrus/configuration/user/cachettl.xml:1.1	Sat Jun 27 19:00:15 2009
+++ peardoc/en/pyrus/configuration/user/cachettl.xml	Sun Jun 28 05:11:39 2009
@@ -4,6 +4,11 @@
 
  <section xml:id="pyrus.configuration.user.cachettl.intro">
   <info><title>Introduction</title></info>
-  <para>This is a work in progress.</para>
+  <para>
+   the <literal>cache_ttl</literal> configuration variable is used to determine
+   when to consider the PEAR Channel <link linkend="core.rest">REST</link>
+   cache to have been invalidated.  It is measured in seconds, and by default
+   is <literal>3600</literal>, or 1 hour.
+  </para>
  </section>
 </section>
http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/configuration/user/defaultchannel.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/pyrus/configuration/user/defaultchannel.xml
diff -u peardoc/en/pyrus/configuration/user/defaultchannel.xml:1.1 peardoc/en/pyrus/configuration/user/defaultchannel.xml:1.2
--- peardoc/en/pyrus/configuration/user/defaultchannel.xml:1.1	Sat Jun 27 19:00:15 2009
+++ peardoc/en/pyrus/configuration/user/defaultchannel.xml	Sun Jun 28 05:11:39 2009
@@ -4,6 +4,25 @@
 
  <section xml:id="pyrus.configuration.user.defaultchannel.intro">
   <info><title>Introduction</title></info>
-  <para>This is a work in progress.</para>
+  <para>
+   The default channel is the channel that should be implied when an
+   <link linkend="guide.users.concepts.abstractpackage">Abstract Package</link>
+   is ambiguous.  By default, it is <literal>pear2.php.net</literal>.
+  </para>
+  <para>
+   As an example, when executing:
+  </para>
+  <screen>php pyrus.phar install PEAR2_HTTP_Request</screen>
+  <para>
+   The abstract package <literal>PEAR2_HTTP_Request</literal> is ambiguous - it
+   does not specify a channel.  Pyrus assumes, therefore, that the requested
+   package is from the default channel, and acts as if the user had in fact
+   typed:
+  </para>
+  <screen>php pyrus.phar install pear2.php.net/PEAR2_HTTP_Request</screen>
+  <para>
+   The <literal>default_channel</literal> value is also used for all
+   channel-specific configuration values.
+  </para>
  </section>
 </section>
http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/configuration/user/downloaddir.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/pyrus/configuration/user/downloaddir.xml
diff -u peardoc/en/pyrus/configuration/user/downloaddir.xml:1.1 peardoc/en/pyrus/configuration/user/downloaddir.xml:1.2
--- peardoc/en/pyrus/configuration/user/downloaddir.xml:1.1	Sat Jun 27 19:00:15 2009
+++ peardoc/en/pyrus/configuration/user/downloaddir.xml	Sun Jun 28 05:11:39 2009
@@ -4,6 +4,12 @@
 
  <section xml:id="pyrus.configuration.user.downloaddir.intro">
   <info><title>Introduction</title></info>
-  <para>This is a work in progress.</para>
+  <note><simpara>This is a channel-specific configuration value</simpara></note>
+  <para>
+   The <literal>download_dir</literal> is where downloaded packages are kept.
+   This can allow later repairing or easy cloning of an installation.  There is
+   no penalty if the files are removed, and they may be easily removed to
+   conserve space.
+  </para>
  </section>
 </section>
http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/configuration/user/handle.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/pyrus/configuration/user/handle.xml
diff -u peardoc/en/pyrus/configuration/user/handle.xml:1.1 peardoc/en/pyrus/configuration/user/handle.xml:1.2
--- peardoc/en/pyrus/configuration/user/handle.xml:1.1	Sat Jun 27 19:00:15 2009
+++ peardoc/en/pyrus/configuration/user/handle.xml	Sun Jun 28 05:11:39 2009
@@ -4,6 +4,35 @@
 
  <section xml:id="pyrus.configuration.user.handle.intro">
   <info><title>Introduction</title></info>
-  <para>This is a work in progress.</para>
+  <note><simpara>This is a channel-specific configuration value</simpara></note>
+  <para>
+   The <literal>handle</literal> variable should be set to the handle you use
+   to identify yourself in the <literal>&lt;maintainers&gt;</literal> section
+   of package.xml for packages in a specific channel.
+  </para>
+  <para>
+   For example, if your <literal>&lt;maintainer&gt;</literal> entry in package.xml
+   is:
+  </para>
+  <para>
+   <programlisting role="xml">
+    <![CDATA[
+ <lead>
+  <name>Greg Beaver</name>
+  <user>cellog</user>
+  <email>[email protected]</email>
+  <active>no</active>
+ </lead>
+    ]]>
+   </programlisting>
+  </para>
+  <para>
+   Your handle is <literal>cellog</literal>.
+  </para>
+  <para>
+   This configuration variable is used in conjunction with the
+   <link linkend="pyrus.configuration.user.opensslcert">openssl_cert</link>
+   configuration variable to implement package signing.
+  </para>
  </section>
 </section>
http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/configuration/user/httpproxy.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/pyrus/configuration/user/httpproxy.xml
diff -u peardoc/en/pyrus/configuration/user/httpproxy.xml:1.1 peardoc/en/pyrus/configuration/user/httpproxy.xml:1.2
--- peardoc/en/pyrus/configuration/user/httpproxy.xml:1.1	Sat Jun 27 19:00:15 2009
+++ peardoc/en/pyrus/configuration/user/httpproxy.xml	Sun Jun 28 05:11:39 2009
@@ -4,6 +4,9 @@
 
  <section xml:id="pyrus.configuration.user.httpproxy.intro">
   <info><title>Introduction</title></info>
-  <para>This is a work in progress.</para>
+  <para>
+   The <literal>http_proxy</literal> configuration variable should be set to the
+   full URI of your local HTTP proxy, or left blank for none.
+  </para>
  </section>
 </section>
http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/configuration/user/mypearpath.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/pyrus/configuration/user/mypearpath.xml
diff -u peardoc/en/pyrus/configuration/user/mypearpath.xml:1.1 peardoc/en/pyrus/configuration/user/mypearpath.xml:1.2
--- peardoc/en/pyrus/configuration/user/mypearpath.xml:1.1	Sat Jun 27 19:00:15 2009
+++ peardoc/en/pyrus/configuration/user/mypearpath.xml	Sun Jun 28 05:11:39 2009
@@ -4,6 +4,29 @@
 
  <section xml:id="pyrus.configuration.user.mypearpath.intro">
   <info><title>Introduction</title></info>
-  <para>This is a work in progress.</para>
+  <para>
+   The <literal>my_pear_path</literal> configuration value controls the order
+   in which Pyrus cascades PEAR installations.  The path should have the same
+   syntax as <literal>include_path</literal>, a
+   <constant>PATH_SEPARATOR</constant>-separated list of full paths to PEAR
+   installations.  The <literal>my_pear_path</literal> configuration variable
+   can be easily set with the <link linkend="pyrus.commands.mypear">mypear</link>
+   command.
+  </para>
+  <para>
+   Only the first path is considered to be read/write, the others are only used
+   to validate package dependencies on download.
+  </para>
+  <para>
+   For instance, the <literal>my_pear_path</literal>
+   <literal>/home/user/testpear:/usr/local/lib/php</literal> instructs Pyrus
+   to install all packages into the PEAR installation at
+   <literal>/home/user/testpear</literal>, and to also use the PEAR installation
+   in <literal>/usr/local/lib/php</literal> to validate dependencies.
+  </para>
+  <para>
+   On Windows, an example <literal>my_pear_path</literal> is
+   <literal>D:\customPear;C:\php5</literal>.
+  </para>
  </section>
 </section>
http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/configuration/user/opensslcert.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/pyrus/configuration/user/opensslcert.xml
diff -u peardoc/en/pyrus/configuration/user/opensslcert.xml:1.1 peardoc/en/pyrus/configuration/user/opensslcert.xml:1.2
--- peardoc/en/pyrus/configuration/user/opensslcert.xml:1.1	Sat Jun 27 19:00:15 2009
+++ peardoc/en/pyrus/configuration/user/opensslcert.xml	Sun Jun 28 05:11:39 2009
@@ -1,9 +1,25 @@
 <?xml version="1.0" encoding="utf-8"?>
-<section xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="pyrus.configuration.user.opensslcert">
+<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="lillet" xml:id="pyrus.configuration.user.opensslcert">
  <info><title>openssl_cert</title></info>
 
  <section xml:id="pyrus.configuration.user.opensslcert.intro">
   <info><title>Introduction</title></info>
-  <para>This is a work in progress.</para>
+  <note><simpara>This is a channel-specific configuration value</simpara></note>
+  <para>
+   The <literal>openssl_cert</literal> configuration variable should be set to
+   the full path to your personal PKCS#12 certificate, as signed by a recognized
+   certificate authority such as <link xlink:href="http://www.cacert.org">CACert</link>.
+   Pyrus uses this certificate along with your
+   <link linkend="pyrus.configuration.user.handle">handle</link> to implement
+   package signing.
+  </para>
+  <para>
+   Your certificate must have the email address you use in package.xml as its
+   alternate name, otherwise Pyrus will refuse to use it.  Pyrus uses the
+   email address as stated in package.xml of the releasing maintainer of a
+   package to verify that the package was actually created by the maintainer.
+   This makes a man-in-the-middle attack far more difficult to execute, as well
+   as verifying package integrity.
+  </para>
  </section>
 </section>
http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/configuration/user/password.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/pyrus/configuration/user/password.xml
diff -u peardoc/en/pyrus/configuration/user/password.xml:1.1 peardoc/en/pyrus/configuration/user/password.xml:1.2
--- peardoc/en/pyrus/configuration/user/password.xml:1.1	Sat Jun 27 19:00:15 2009
+++ peardoc/en/pyrus/configuration/user/password.xml	Sun Jun 28 05:11:39 2009
@@ -4,6 +4,10 @@
 
  <section xml:id="pyrus.configuration.user.password.intro">
   <info><title>Introduction</title></info>
-  <para>This is a work in progress.</para>
+  <note><simpara>This is a channel-specific configuration value</simpara></note>
+  <para>
+   This configuration variable is a legacy variable from PEAR, is not yet
+   used in Pyrus, and may be removed before the stable release.
+  </para>
  </section>
 </section>
http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/configuration/user/pluginsdir.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/pyrus/configuration/user/pluginsdir.xml
diff -u peardoc/en/pyrus/configuration/user/pluginsdir.xml:1.1 peardoc/en/pyrus/configuration/user/pluginsdir.xml:1.2
--- peardoc/en/pyrus/configuration/user/pluginsdir.xml:1.1	Sat Jun 27 19:00:15 2009
+++ peardoc/en/pyrus/configuration/user/pluginsdir.xml	Sun Jun 28 05:11:39 2009
@@ -4,6 +4,10 @@
 
  <section xml:id="pyrus.configuration.user.pluginsdir.intro">
   <info><title>Introduction</title></info>
-  <para>This is a work in progress.</para>
+  <para>
+   The <literal>plugins_dir</literal> directory is where all Pyrus plugins are
+   installed.  By default, it is the directory in which the user configuration
+   file is stored.
+  </para>
  </section>
 </section>
http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/configuration/user/preferredmirror.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/pyrus/configuration/user/preferredmirror.xml
diff -u peardoc/en/pyrus/configuration/user/preferredmirror.xml:1.1 peardoc/en/pyrus/configuration/user/preferredmirror.xml:1.2
--- peardoc/en/pyrus/configuration/user/preferredmirror.xml:1.1	Sat Jun 27 19:00:15 2009
+++ peardoc/en/pyrus/configuration/user/preferredmirror.xml	Sun Jun 28 05:11:39 2009
@@ -4,6 +4,12 @@
 
  <section xml:id="pyrus.configuration.user.preferredmirror.intro">
   <info><title>Introduction</title></info>
-  <para>This is a work in progress.</para>
+  <note><simpara>This is a channel-specific configuration value</simpara></note>
+  <para>
+   This variable controls which mirror of a channel should be used
+   to retrieve package releases and PEAR Channel
+   <link linkend="core.rest">REST</link> information.  By default, it is
+   set to the main channel path.
+  </para>
  </section>
 </section>
http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/configuration/user/preferredstate.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/pyrus/configuration/user/preferredstate.xml
diff -u peardoc/en/pyrus/configuration/user/preferredstate.xml:1.1 peardoc/en/pyrus/configuration/user/preferredstate.xml:1.2
--- peardoc/en/pyrus/configuration/user/preferredstate.xml:1.1	Sat Jun 27 19:00:15 2009
+++ peardoc/en/pyrus/configuration/user/preferredstate.xml	Sun Jun 28 05:11:39 2009
@@ -4,6 +4,16 @@
 
  <section xml:id="pyrus.configuration.user.preferredstate.intro">
   <info><title>Introduction</title></info>
-  <para>This is a work in progress.</para>
+  <para>
+   The <literal>preferred_state</literal> configuration variable controls the
+   release stability level of packages that will be installed.  By default it
+   is <literal>stable</literal>, which instructs Pyrus to ignore any releases
+   with lesser stabilities <literal>beta</literal>, <literal>alpha</literal>
+   or <literal>devel</literal> unless explicitly requested by the user.
+  </para>
+  <para>
+   This can be changed to allow riskier installation of newer, less-tested
+   releases that are on the cutting edge of development.
+  </para>
  </section>
 </section>
http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/configuration/user/tempdir.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/pyrus/configuration/user/tempdir.xml
diff -u peardoc/en/pyrus/configuration/user/tempdir.xml:1.1 peardoc/en/pyrus/configuration/user/tempdir.xml:1.2
--- peardoc/en/pyrus/configuration/user/tempdir.xml:1.1	Sat Jun 27 19:00:15 2009
+++ peardoc/en/pyrus/configuration/user/tempdir.xml	Sun Jun 28 05:11:39 2009
@@ -4,6 +4,9 @@
 
  <section xml:id="pyrus.configuration.user.tempdir.intro">
   <info><title>Introduction</title></info>
-  <para>This is a work in progress.</para>
+  <para>
+   The <literal>temp_dir</literal> configuration directive is where all
+   temporary files are extracted by Pyrus.
+  </para>
  </section>
 </section>
http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/configuration/user/umask.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/pyrus/configuration/user/umask.xml
diff -u peardoc/en/pyrus/configuration/user/umask.xml:1.1 peardoc/en/pyrus/configuration/user/umask.xml:1.2
--- peardoc/en/pyrus/configuration/user/umask.xml:1.1	Sat Jun 27 19:00:15 2009
+++ peardoc/en/pyrus/configuration/user/umask.xml	Sun Jun 28 05:11:39 2009
@@ -4,6 +4,14 @@
 
  <section xml:id="pyrus.configuration.user.umask.intro">
   <info><title>Introduction</title></info>
-  <para>This is a work in progress.</para>
+  <para>
+   The <literal>umask</literal> configuration value is used to control the
+   default file mask used when setting file permissions.  By default it is
+   octal value <literal>0022</literal>.  The value is a bitmask that is used
+   to clear any bits.  Thus, a <literal>umask</literal> of <literal>0000</literal>
+   will cause files to be installed with <literal>0666</literal> permissions.  A
+   <literal>umask</literal> of <literal>0022</literal> causes files to be installed
+   with <literal>0644</literal> permissions.
+  </para>
  </section>
 </section>
http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/configuration/user/username.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/pyrus/configuration/user/username.xml
diff -u peardoc/en/pyrus/configuration/user/username.xml:1.1 peardoc/en/pyrus/configuration/user/username.xml:1.2
--- peardoc/en/pyrus/configuration/user/username.xml:1.1	Sat Jun 27 19:00:15 2009
+++ peardoc/en/pyrus/configuration/user/username.xml	Sun Jun 28 05:11:39 2009
@@ -4,6 +4,10 @@
 
  <section xml:id="pyrus.configuration.user.username.intro">
   <info><title>Introduction</title></info>
-  <para>This is a work in progress.</para>
+  <note><simpara>This is a channel-specific configuration value</simpara></note>
+  <para>
+   This configuration variable is a legacy variable from PEAR, is not yet
+   used in Pyrus, and may be removed before the stable release.
+  </para>
  </section>
 </section>
http://cvs.php.net/viewvc.cgi/peardoc/en/pyrus/configuration/user/verbose.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/en/pyrus/configuration/user/verbose.xml
diff -u peardoc/en/pyrus/configuration/user/verbose.xml:1.1 peardoc/en/pyrus/configuration/user/verbose.xml:1.2
--- peardoc/en/pyrus/configuration/user/verbose.xml:1.1	Sat Jun 27 19:00:15 2009
+++ peardoc/en/pyrus/configuration/user/verbose.xml	Sun Jun 28 05:11:39 2009
@@ -4,6 +4,10 @@
 
  <section xml:id="pyrus.configuration.user.verbose.intro">
   <info><title>Introduction</title></info>
-  <para>This is a work in progress.</para>
+  <para>
+   The <literal>verbose</literal> setting controls how much information Pyrus
+   echoes as it performs its task.  The higher the setting, the more information
+   Pyrus will spew.  By default, it is set to <literal>1</literal>.
+  </para>
  </section>
 </section>