Ignore:
Timestamp:
01/10/2008 00:28:57 (4 years ago)
Author:
jamesog
Message:

Documentation!

Add new documents for:

  • bbackupd
  • bbstored
  • bbackupd-config
  • bbackupd.conf
  • bbstored.conf
  • raidfile.conf

Update all other existing docs with a little more info.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • box/trunk/documentation/bbstored-certs.xml

    r2127 r2305  
    11<?xml version="1.0" encoding="UTF-8"?> 
    2 <refentry> 
     2<refentry version="5.0" xmlns="http://docbook.org/ns/docbook" 
     3          xmlns:xlink="http://www.w3.org/1999/xlink" 
     4          xmlns:xi="http://www.w3.org/2001/XInclude" 
     5          xmlns:svg="http://www.w3.org/2000/svg" 
     6          xmlns:m="http://www.w3.org/1998/Math/MathML" 
     7          xmlns:html="http://www.w3.org/1999/xhtml" 
     8          xmlns:db="http://docbook.org/ns/docbook"> 
    39  <refmeta> 
    410    <refentrytitle>bbstored-certs</refentrytitle> 
    511 
    612    <manvolnum>8</manvolnum> 
     13 
     14    <refmiscinfo>Box Backup 0.11</refmiscinfo> 
    715  </refmeta> 
    816 
    … …  
    1523  <refsynopsisdiv> 
    1624    <cmdsynopsis> 
    17       <command>bbstored-certs &lt;certs-dir&gt; &lt;command&gt; 
    18       [&lt;arguments&gt;]</command> 
     25      <command>bbstored-certs</command> 
     26 
     27      <arg choice="plain">certs-dir</arg> 
     28 
     29      <arg choice="plain">command</arg> 
     30 
     31      <arg>arguments</arg> 
    1932    </cmdsynopsis> 
    2033  </refsynopsisdiv> 
    … …  
    2336    <title>Description</title> 
    2437 
    25     <para><literal>bbstored-certs</literal> creates and signs certificates for 
     38    <para><command>bbstored-certs</command> creates and signs certificates for 
    2639    use in Box Backup. It allows the user to create and sign the server keys, 
    2740    as well as signing client keys.</para> 
    2841 
    29     <para>All commands must be followed by the <literal>certs-dir</literal>, 
     42    <para>All commands must be followed by the <varname>certs-dir</varname>, 
    3043    which is the directory in which the certificates are stored.</para> 
    3144 
    … …  
    3548      <para>There are 3 commands:</para> 
    3649 
    37       <itemizedlist> 
    38         <listitem> 
    39           <para><literal>init</literal>: Create the 
    40           <literal>certs-dir</literal>, and generate the server keys for 
    41           bbstored. <literal>certs-dir</literal> cannot exist before running 
    42           the command.</para> 
    43         </listitem> 
     50      <variablelist> 
     51        <varlistentry> 
     52          <term><command>init</command></term> 
    4453 
    45         <listitem> 
    46           <para><literal>sign-server &lt;servercsrfile&gt;</literal>: Sign the 
    47           server certificate. The <literal>servercsrfile</literal> is the file 
    48           generated by the <literal>init</literal> command.</para> 
    49         </listitem> 
     54          <listitem> 
     55            <para>Create the <varname>certs-dir</varname>, and generate the 
     56            server keys for bbstored. <varname>certs-dir</varname> cannot 
     57            exist before running the command.</para> 
     58          </listitem> 
     59        </varlistentry> 
    5060 
    51         <listitem> 
    52           <para><literal>sign &lt;clientcsrfile&gt;</literal>: Sign a client 
    53           certificate. The <literal>clientcsrfile</literal> is generated 
    54           during client setup. See <literal>bbackupd-config(8)</literal>. Send 
    55           the signed certificate back to the client, and install according to 
    56           the instructions given by <literal>bbackupd-config</literal>.</para> 
    57         </listitem> 
    58       </itemizedlist> 
     61        <varlistentry> 
     62          <term><command>sign-server</command> 
     63          <varname>servercsrfile</varname></term> 
     64 
     65          <listitem> 
     66            <para>Sign the server certificate. The 
     67            <varname>servercsrfile</varname> is the file generated by the 
     68            <command>init</command> command.</para> 
     69          </listitem> 
     70        </varlistentry> 
     71 
     72        <varlistentry> 
     73          <term><command>sign</command> 
     74          <varname>clientcsrfile</varname></term> 
     75 
     76          <listitem> 
     77            <para>Sign a client certificate. The 
     78            <varname>clientcsrfile</varname> is generated during client setup. 
     79            See <citerefentry> 
     80                <refentrytitle>bbackupd-config</refentrytitle> 
     81 
     82                <manvolnum>8</manvolnum> 
     83              </citerefentry>. Send the signed certificate back to the client, 
     84            and install according to the instructions given by 
     85            <command>bbackupd-config</command>.</para> 
     86          </listitem> 
     87        </varlistentry> 
     88      </variablelist> 
    5989    </refsection> 
    60   </refsection> 
    61  
    62   <refsection> 
    63     <title>Author</title> 
    64  
    65     <para>Ben Summers and contributors. For help, please go to the <ulink 
    66     url="http://www.boxbackup.org/trac/">Wiki</ulink>, or subscribe to the Box 
    67     Backup <ulink 
    68     url="http://lists.warhead.org.uk/mailman/listinfo/boxbackup">mailing 
    69     list.</ulink></para> 
    70   </refsection> 
    71  
    72   <refsection> 
    73     <title>See Also</title> 
    74  
    75     <para><literal>bbstored-config(8)</literal></para> 
    76  
    77     <para><literal>bbstored.conf(5)</literal></para> 
    78  
    79     <para><literal>bbstoreaccounts(8)</literal></para> 
    8090  </refsection> 
    8191 
    … …  
    8393    <title>Files</title> 
    8494 
    85     <para><literal>raidfile-config</literal> generates the raidfile.conf(5) 
    86     file.</para> 
     95    <para><citerefentry> 
     96        <refentrytitle>raidfile-config</refentrytitle> 
     97 
     98        <manvolnum>8</manvolnum> 
     99      </citerefentry> generates the <citerefentry> 
     100        <refentrytitle>raidfile.conf</refentrytitle> 
     101 
     102        <manvolnum>5</manvolnum> 
     103      </citerefentry> file.</para> 
    87104  </refsection> 
    88105 
    … …  
    123140    </itemizedlist> 
    124141  </refsection> 
     142 
     143  <refsection> 
     144    <title>See Also</title> 
     145 
     146    <para><citerefentry> 
     147        <refentrytitle>bbstored-config</refentrytitle> 
     148 
     149        <manvolnum>8</manvolnum> 
     150      </citerefentry>, <citerefentry> 
     151        <refentrytitle>bbstored.conf</refentrytitle> 
     152 
     153        <manvolnum>5</manvolnum> 
     154      </citerefentry>, <citerefentry> 
     155        <refentrytitle>bbstoreaccounts</refentrytitle> 
     156 
     157        <manvolnum>8</manvolnum> 
     158      </citerefentry></para> 
     159  </refsection> 
     160 
     161  <refsection> 
     162    <title>Authors</title> 
     163 
     164    <para><author> 
     165        <personname>Ben Summers</personname> 
     166      </author></para> 
     167 
     168    <para><author> 
     169        <personname>Per Thomsen</personname> 
     170      </author></para> 
     171 
     172    <para><author> 
     173        <personname>James O'Gorman</personname> 
     174      </author></para> 
     175  </refsection> 
    125176</refentry> 
Note: See TracChangeset for help on using the changeset viewer.