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

<refentry lang="en">
  <refentryinfo>
    <address>jigdo atterer.net</address>
    <author>
      <firstname>Richard</firstname><surname>Atterer</surname>
    </author>
    <copyright>
      <year>2001-2002</year><holder>Richard Atterer</holder>
    </copyright>
    <date>May 04, 2002</date>
  </refentryinfo>
  <refmeta>
    <refentrytitle>jigdo-mirror</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>
  <refnamediv>
    <refname>jigdo-mirror</refname>
    <refpurpose>Maintain a mirror of images offered with jigdo</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>jigdo-mirror</command>
      <arg>config-file</arg>
    </cmdsynopsis>
  </refsynopsisdiv>
  <!-- ============================================================= -->
  <refsect1 id="description">
    <title>DESCRIPTION</title>

    <para>See <citerefentry><refentrytitle>jigdo-file</refentrytitle
    ><manvolnum>1</manvolnum></citerefentry> for an introduction to
    Jigsaw Download.</para>

    <para><command>jigdo-mirror</command> is a script intended for
    people who want to offer direct HTTP or FTP downloads of files for
    which only the jigdo and template files are available.</para>

    <para>As the first step of using <command>jigdo-mirror</command>,
    you need to set up normal HTTP/FTP/rsync mirroring both of the
    `<filename>.jigdo</filename>'/`<filename>.template</filename>'
    files and of the parts that are needed for the reconstruction of
    the images. For example, in the case that you want to mirror
    Debian CD images with <command>jigdo-mirror</command>, you need a
    mirror of the
    `<filename>.jigdo</filename>'/`<filename>.template</filename>'
    files and a Debian mirror on the local machine.</para>

    <para>At regular intervals (preferably immediately after the
    normal mirroring has finished), schedule a run of
    <command>jigdo-mirror</command>. It will search through a given
    directory for any `<filename>.jigdo</filename>' files and attempt
    to create all images offered by each file.</para>

    <para>The script requires you to set a number of variables -
    please refer to the start of
    <filename>/usr/bin/jigdo-mirror</filename> for a description of
    each of them. Since <filename>/usr/bin/jigdo-mirror</filename>
    will be overwritten whenever you upgrade
    <command>jigdo-mirror</command>, it is highly recommended
    <emphasis>not</emphasis> to change the settings directly in this
    script. Instead, personal settings should be saved in a file
    called <filename>.jigdo-mirror</filename> in your home directory,
    or in a different file whose name is then passed to the script as
    its first (and only) command line argument.</para>

  </refsect1>
  <!-- ============================================================= -->
  <refsect1 id="seealso">
    <title>SEE ALSO</title>

    <para>
      <citerefentry>
        <refentrytitle>jigdo-file</refentrytitle><manvolnum>1</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>jigdo-lite</refentrytitle><manvolnum>1</manvolnum>
      </citerefentry>
    </para>

    <para>CD images for Debian Linux can be <ulink
    url="http://www.debian.org/CD/jigdo-cd/">downloaded with
    jigdo</ulink>.</para>

  </refsect1>
  <!-- ============================================================= -->
  <refsect1 id="author">
    <title>AUTHOR</title>

    <para><ulink url="http://atterer.net/jigdo/">Jigsaw
    Download</ulink> was written by Richard Atterer
    <email>jigdo atterer.net</email>, to make downloading of CD ROM
    images for the Debian Linux distribution more convenient.</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:
-->
