r426 - branches/rewrite/debian

[Marco Presi]

Author: zufus
Date: Wed Dec 29 19:03:02 2004
New Revision: 426

Modified:
   branches/rewrite/debian/manpage.sgml
Log:
Modified manpage to add new all|update|upgrade commands.
A man page for debpartial-mirror.conf is coming soon.
Man page has some formatting error.. I taked suggestion from
a apt-get.8.sgml I found on the net.. tomorrow with more bandwidth I
will look for the latest one and fix sgml errors.


Modified: branches/rewrite/debian/manpage.sgml
==============================================================================
--- branches/rewrite/debian/manpage.sgml	(original)
+++ branches/rewrite/debian/manpage.sgml	Wed Dec 29 19:03:02 2004
@@ -57,15 +57,76 @@
   <refnamediv>
     <refname>&dhpackage;</refname>
 
-    <refpurpose>debpartial-mirror is a program to generate partial Debian mirrors.</refpurpose>
+    <refpurpose>debpartial-mirror is a program to generate partial
+  Debian packages archives mirrors.</refpurpose>
   </refnamediv>
+
+  <refsynopsisdiv>
+  <cmdsynopsis>
+    <command>&dhpackage;</>
+    <arg><option>-hv</></arg>
+    <arg><option>-c=<replaceable/file/</></arg>
+    <group choice=req>
+       <arg>all</>
+       <arg>update</>
+       <arg>upgrade</>
+    </group>
+  </cmdsynopsis>
+  </refsinopsysdiv>
+
+
   <refsect1>
     <title>DESCRIPTION</title>
+    <para>
+    <command>&dhpackage;</command> is a command-line tool to generate
+    partial Debian packages archives mirrors. It is designed to work (in
+    particular) in Custom Debian Distributions framework, as an aid to
+    create customization of debian systems.
+
+    Partial mirrors can be generated from different apt repositories
+    (local created or remote ones) and can contain binary as well as
+    sources packages.
+
+    Generated partial mirrors have the structure of standard apt
+    repositories: pls referr to APT documentation for explanation about this. 
+
+    <command>&dhpackage;</command> uses a configuration file to
+    determine which packages, are to be downloaded and monitored to
+    generate a local partial mirror. Packages can be specified by
+    regular expressions, by list or by mirrors sections.
+
+    Default configuration file is <filename>/etc/debpartial-mirror.conf</>
+
+    <command>&dhpackage;</command> accept commands in the same way
+    apt-get does, and unless the <command>-h</command> or
+    <command>--help</command> is given, one of the commands below must
+    be presented.  </para>
+
+    <VariableList>
+    <VarListEntry><Term>update</Term>
+    <ListItem>
+    <para>
+    <literal/update/ update is used to resynchronize the package index
+    files from specified sources.
+    </VarListEntry>
+
+    <VarListEntry><Term>upgrade</Term>
+    <ListItem>
+    <para>
+    <literal/upgrade/ upgrade is used to dowload selected binary and
+    source packages from specified mirrors. The first time this command
+    is ran the partial mirror is generated: after this, only newer or
+    updated packages will be downloaded into the mirror.
+    </VarListEntry>
 
-    <para>This manual page briefly documents the
-      <command>&dhpackage;</command> command.</para>
+    <VarListEntry><Term>all</Term>
+    <ListItem>
+    <para>
+    <literal/all/ all is used to perform both update and upgrade
+    commands.
+    </VarListEntry>
+    </VariableList>
 
-    <para><command>&dhpackage;</command> is a program to generate partial Debian mirrors</para>
 
   </refsect1>
   <refsect1>
@@ -105,7 +166,7 @@
           <option>--simulate</option>
         </term>
         <listitem>
-          <para>Do nothing, only simulate all</para>
+          <para>Do nothing, only simulate all. Actually it is not implemented</para>
         </listitem>
       </varlistentry>
       <varlistentry>
@@ -113,7 +174,7 @@
           <option>--skip-files</option>
         </term>
         <listitem>
-          <para>Skip downloading of files.</para>
+          <para>Skip downloading of files. Actually it is not implemented</para>
         </listitem>
       </varlistentry>
       <varlistentry>
@@ -121,7 +182,7 @@
           <option>--skip-packages</option>
         </term>
         <listitem>
-          <para>Skip downloading of packages.</para>
+          <para>Skip downloading of packages. Actually it is not implemented</para>
         </listitem>
       </varlistentry>
     </variablelist>