cvs: peardoc /en/package system.xml /en/package/system mount.xml /en/package/system/mount intro.xml

saltybeagle		Mon Dec  3 03:52:07 2007 UTC

  Added files:                 
    /peardoc/en/package/system/mount	intro.xml 
    /peardoc/en/package/system	mount.xml 

  Modified files:              
    /peardoc/en/package	system.xml 
  Log:
  Doc Bug #2540  	Missing end user docs 3 years is too long. Added basics of use.. this package is so small and the target audience should have an idea after this simple example.
  
http://cvs.php.net/viewvc.cgi/peardoc/en/package/system.xml?r1=1.9&r2=1.10&diff_format=u
Index: peardoc/en/package/system.xml
diff -u peardoc/en/package/system.xml:1.9 peardoc/en/package/system.xml:1.10
--- peardoc/en/package/system.xml:1.9	Sat Mar 18 11:22:44 2006
+++ peardoc/en/package/system.xml	Mon Dec  3 03:52:07 2007
@@ -1,4 +1,4 @@
-<!-- $Revision: 1.9 $ -->
+<!-- $Revision: 1.10 $ -->
 
 <chapter id="package.System">
   <title>System</title>
@@ -9,6 +9,7 @@
   &blankpagehack;
 
   &package.system.folders;
+  &package.system.mount;
   &package.system.system-procwatch;
   &package.system.windrives;
 </chapter>

http://cvs.php.net/viewvc.cgi/peardoc/en/package/system/mount/intro.xml?view=markup&rev=1.1
Index: peardoc/en/package/system/mount/intro.xml
+++ peardoc/en/package/system/mount/intro.xml
<?xml version="1.0" encoding="iso-8859-1" ?>
<!-- $Revision$ -->

<refentry id="package.system.mount.intro">
 <refnamediv>
  <refname>Introduction</refname>
  <refpurpose>
   Mount and Unmount filesystems
  </refpurpose>
 </refnamediv>

 <refsect1 id="package.system.mount.intro.contrib">
  <title>Contributors</title>
  <para>
   <itemizedlist>
    <listitem><simpara>Brett Bieber</simpara></listitem>
   </itemizedlist>
  </para>
 </refsect1>

 <refsect1 id="package.system.mount.intro.desc">
  <title>Description</title>
  <para>
   <classname>System_Mount</classname> provides methods to mount and unmount
   filesystems and partitions listed in a system's
   <filename>/etc/fstab</filename>. The fstab file is common on Unix/Linux
   based systems and is used to list the available filesystems and partitions
   which users can mount into the filesystem hierarchy. Common entries include
   root partitions, boot partitions, as well as cdrom drives and other
   removable media. 
  </para>

  <para>
   The System_Mount command utilizes File_Fstab to discover entries in the 
   <filename>/etc/fstab</filename> file, and allow easy mount/unmount operations.
  </para>
 </refsect1>

 <refsect1>
  <title>Using System_Mount</title>
  <example>
   <title>General usage</title>
   <programlisting role="php">
    <![CDATA[
<?php
require_once 'System/Mount.php';

// Create the mount class
$m = new System_Mount();

// Get an object representing the CD-ROM entry
$cdrom = $m->getEntryForPath('/media/cdrom0');

if (PEAR::isError($cdrom)) {
    die($cdrom->message."\n");
}

// Mount it
$res = $cdrom->mount();
if (PEAR::isError($res)) {
    die($res->getMessage()."\n");
}

// List it's contents
print `ls {$cdrom->mountPoint}`;

// Unmount it
$cdrom->unmount();
if (PEAR::isError($res)) {
    die($res->getMessage()."\n");
}
?>
]]></programlisting>
  </example>
  <para>
   At first, you need to instantitiate a new
   <classname>System_Mount</classname> object.
  </para>
  <para>
   Use the mount point for the corresponding entry in your
   <filename>/etc/fstab</filename> to obtain an object to mount,
   then check if there are any errors. If there are no errors mount the cdrom.
  </para>

 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

http://cvs.php.net/viewvc.cgi/peardoc/en/package/system/mount.xml?view=markup&rev=1.1
Index: peardoc/en/package/system/mount.xml
+++ peardoc/en/package/system/mount.xml
<?xml version="1.0" encoding="iso-8859-1" ?>
<!-- $Revision$ -->

<sect1 id="package.system.mount">
 <title>System_Mount</title>

 <para>
  This package allows you to mount and unmount disks and partitions listed in your
  file systems table (<filename>/etc/fstab</filename>), which is found on Unix/Linux
  based systems.
 </para>
 <para>You can install this package by using 
  <command>pear install System_Mount</command>. Once you have the package installed
  it is very easy to use.
 </para>

 &package.system.mount.intro;
</sect1>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->