<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

<!-- Process this file with docbook-to-man to generate an nroff manual
     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
     less'.  A typical entry in a Makefile or Makefile.am is:

manpage.1: manpage.sgml
	docbook-to-man $< > $@

    
	The docbook-to-man binary is found in the docbook-to-man package.
	Please remember that if you create the nroff version in one of the
	debian/rules file targets (such as build), you will need to include
	docbook-to-man in your Build-Depends control field.

  -->

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>Otavio</firstname>">
  <!ENTITY dhsurname   "<surname>Salvador</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>março 26, 2004</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>otavio@debian.org</email>">
  <!ENTITY dhusername  "Otavio Salvador">
  <!ENTITY dhucpackage "<refentrytitle>DEBPARTIAL-MIRROR</refentrytitle>">
  <!ENTITY dhpackage   "debpartial-mirror">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2003</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>

    <refpurpose>debpartial-mirror is a program to generate partial
  Debian packages archives mirrors.</refpurpose>
  </refnamediv>

 <!-- Arguments -->
 <refsynopsisdiv>
   <cmdsynopsis>
      <command>apt-get</command>
      <arg><option>-hvs</option></arg>
      <arg><option>-o=<replaceable>config string</replaceable></option></arg>
      <arg><option>-c=<replaceable>file</replaceable></option></arg>
      <group choice="req">
         <arg>update</arg>
         <arg>upgrade</arg>
         <arg>dselect-upgrade</arg>
         <arg>install <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg>
         <arg>remove <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg>
         <arg>source <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg>
         <arg>build-dep <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg>
         <arg>check</arg>
         <arg>clean</arg>
         <arg>autoclean</arg>
      </group>   
   </cmdsynopsis>
 </refsynopsisdiv>


  <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: please 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.
    </para>
    </ListItem>
    </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.
    </para>
    </ListItem>
    </VarListEntry>

    <VarListEntry><Term>all</Term>
    <ListItem>
    <para>
    <literal/all/ all is used to perform both update and upgrade
    commands.
    </para>
    </ListItem>
    </VarListEntry>
    </VariableList>


  </refsect1>
  <refsect1>
    <title>OPTIONS</title>

    <para>This program follows the usual &gnu; command line syntax,
      with long options starting with two dashes (`-').  A summary of
      options is included below.</para>

    <variablelist>
      <varlistentry>
        <term><option>-h</option>
          <option>--help</option>
        </term>
        <listitem>
          <para>Show summary of options.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-v</option>
          <option>--version</option>
        </term>
        <listitem>
          <para>Show version of program.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-cCONFIGFILE</option>
          <option>--configfile=CONFIGFILE</option>
        </term>
        <listitem>
          <para>Select the confiruration file.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-s</option>
          <option>--simulate</option>
        </term>
        <listitem>
          <para>Do nothing, only simulate all. Actually it is not implemented</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-sf</option>
          <option>--skip-files</option>
        </term>
        <listitem>
          <para>Skip downloading of files. Actually it is not implemented</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-sp</option>
          <option>--skip-packages</option>
        </term>
        <listitem>
          <para>Skip downloading of packages. Actually it is not implemented</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>AUTHOR</title>
    <para>This manual page was written by &dhusername; (&dhemail;). 
      Permission is granted to copy, distribute and/or modify this
      document under the terms of the &gnu; General Public License,
      Version 2 any later version published by the Free Software
      Foundation.
    </para>
    <para>
       On Debian systems, the complete text of the GNU General Public
       License can be found in /usr/share/common-licenses/GPL.
    </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:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->
