[svnbook commit] r2850 - trunk/src/en/book

[cmpilato]

Author: cmpilato
Date: Tue Aug 14 20:12:57 2007
New Revision: 2850

Log:
Add skeletal svnsync reference matter.

Modified:
   trunk/src/en/book/ch09-reference.xml

Modified: trunk/src/en/book/ch09-reference.xml
==============================================================================
--- trunk/src/en/book/ch09-reference.xml	(original)
+++ trunk/src/en/book/ch09-reference.xml	Tue Aug 14 20:12:57 2007
@@ -6330,6 +6330,243 @@
   <!-- ================================================================= -->
   <!-- ================================================================= -->
   <!-- ================================================================= -->
+  <sect1 id="svn.ref.svnsync">
+
+    <title><command>svnsync</command></title>
+    
+    <para><command>svnsync</command> is the Subversion remote
+      repository mirroring tool.</para>
+
+    <para>### TODO ###</para>
+
+    <!-- =============================================================== -->
+    <sect2 id="svn.ref.svnsync.sw">
+      <title><command>svnsync</command> Options</title>
+
+      <variablelist>
+
+        <varlistentry>
+          <term><option>--config-dir</option>
+            <replaceable>DIR</replaceable></term>
+          <listitem>
+            <para>Instructs Subversion to read configuration
+              information from the specified directory instead of the
+              default location (<filename>.subversion</filename> in
+              the user's home directory).</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><option>--no-auth-cache</option></term>
+          <listitem>
+            <para>Prevents caching of authentication information
+              (e.g. username and password) in the Subversion
+              administrative directories.</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><option>--non-interactive</option></term>
+          <listitem>
+            <para>In the case of an authentication failure, or
+              insufficient credentials, prevents prompting for
+              credentials (e.g. username or password).  This is useful
+              if you're running Subversion inside of an automated
+              script and it's more appropriate to have Subversion fail
+              than to prompt for more information.</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><option>--password</option>
+            <replaceable>PASS</replaceable></term>
+          <listitem>
+            <para>Indicates that you are providing your password for
+              authentication on the command line—otherwise, if
+              it is needed, Subversion will prompt you for
+              it.</para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><option>--username</option>
+            <replaceable>NAME</replaceable></term>
+          <listitem>
+            <para>Indicates that you are providing your username for
+              authentication on the command line—otherwise, if
+              it is needed, Subversion will prompt you for
+              it.</para>
+          </listitem>
+        </varlistentry>
+
+      </variablelist>
+
+    </sect2>
+
+    <!-- =============================================================== -->
+    <sect2 id="svn.ref.svnsync.c">
+      <title><command>svnsync</command> Subcommands</title>
+
+      <para>Here are the various subcommands:</para>
+
+      <refentry id="svn.ref.svnsync.c.init">
+
+        <indexterm>
+          <primary>svnsync</primary>
+          <secondary>subcommands</secondary>
+          <tertiary>initialize</tertiary>
+        </indexterm>
+
+        <refnamediv>
+          <refname>svnsync initialize</refname>
+          <refpurpose>Initialize a destination repository for
+            synchronization from another repository.</refpurpose>
+        </refnamediv>
+        <refsect1>
+          <title>Synopsis</title>
+          <programlisting>svnsync initialize DEST_URL SOURCE_URL</programlisting>
+        </refsect1>
+        <refsect1>
+          <title>Description</title>
+
+          <para>The destination URL must point to the root of a
+            repository with no committed revisions.  The destination
+            repository must allow revision property changes.</para>
+
+          <para>You should not commit to, or make revision property
+            changes in, the destination repository by any method other
+            than 'svnsync'.  In other words, the destination
+            repository should be a read-only mirror of the source
+            repository.</para>
+        </refsect1>
+
+        <refsect1>
+          <title>Alternate Names</title>
+          <para>init</para>
+        </refsect1>
+
+        <refsect1>
+          <title>Options</title>
+
+          <screen>
+--non-interactive
+--no-auth-cache
+--username NAME
+--password PASS
+--config-dir DIR
+</screen>
+        </refsect1>
+
+        <refsect1>
+          <title>Examples</title>
+
+          <para>### TODO ###</para>
+        </refsect1>
+
+      </refentry>
+
+      <refentry id="svn.ref.svnsync.c.sync">
+
+        <indexterm>
+          <primary>svnsync</primary>
+          <secondary>subcommands</secondary>
+          <tertiary>synchronize</tertiary>
+        </indexterm>
+
+        <refnamediv>
+          <refname>svnsync synchronize</refname>
+          <refpurpose>Transfer all pending revisions from source to
+            destination.</refpurpose>
+        </refnamediv>
+        <refsect1>
+          <title>Synopsis</title>
+          <programlisting>svnsync synchronize DEST_URL</programlisting>
+        </refsect1>
+        <refsect1>
+          <title>Description</title>
+
+          <para>### TODO ###</para>
+        </refsect1>
+
+        <refsect1>
+          <title>Alternate Names</title>
+          <para>sync</para>
+        </refsect1>
+
+        <refsect1>
+          <title>Options</title>
+
+          <screen>
+--non-interactive
+--no-auth-cache
+--username NAME
+--password PASS
+--config-dir DIR
+</screen>
+        </refsect1>
+
+        <refsect1>
+          <title>Examples</title>
+
+          <para>### TODO ###</para>
+        </refsect1>
+
+      </refentry>
+
+      <refentry id="svn.ref.svnsync.c.copy-revprops">
+
+        <indexterm>
+          <primary>svnsync</primary>
+          <secondary>subcommands</secondary>
+          <tertiary>copy-revprops</tertiary>
+        </indexterm>
+
+        <refnamediv>
+          <refname>svnsync copy-revprops</refname>
+          <refpurpose>Copy all revision properties for revision REV
+            from source to destination.</refpurpose>
+        </refnamediv>
+        <refsect1>
+          <title>Synopsis</title>
+          <programlisting>svnsync initialize DEST_URL SOURCE_URL</programlisting>
+        </refsect1>
+        <refsect1>
+          <title>Description</title>
+
+          <para>### TODO ###</para>
+        </refsect1>
+
+        <refsect1>
+          <title>Alternate Names</title>
+          <para>None</para>
+        </refsect1>
+
+        <refsect1>
+          <title>Options</title>
+
+          <screen>
+--non-interactive
+--no-auth-cache
+--username NAME
+--password PASS
+--config-dir DIR
+</screen>
+        </refsect1>
+
+        <refsect1>
+          <title>Examples</title>
+
+          <para>### TODO ###</para>
+        </refsect1>
+
+      </refentry>
+    </sect2>
+
+  </sect1>
+
+  <!-- ================================================================= -->
+  <!-- ================================================================= -->
+  <!-- ================================================================= -->
   <sect1 id="svn.ref.svnserve">
 
     <title><command>svnserve</command></title>