diff options
Diffstat (limited to 'documentation/bbstored-certs.xml')
| -rw-r--r-- | documentation/bbstored-certs.xml | 147 |
1 files changed, 99 insertions, 48 deletions
diff --git a/documentation/bbstored-certs.xml b/documentation/bbstored-certs.xml index 2da25053..5f7fb92b 100644 --- a/documentation/bbstored-certs.xml +++ b/documentation/bbstored-certs.xml @@ -1,9 +1,17 @@ <?xml version="1.0" encoding="UTF-8"?> -<refentry> +<refentry version="5.0" xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:m="http://www.w3.org/1998/Math/MathML" + xmlns:html="http://www.w3.org/1999/xhtml" + xmlns:db="http://docbook.org/ns/docbook"> <refmeta> <refentrytitle>bbstored-certs</refentrytitle> <manvolnum>8</manvolnum> + + <refmiscinfo>Box Backup 0.11</refmiscinfo> </refmeta> <refnamediv> @@ -14,19 +22,24 @@ <refsynopsisdiv> <cmdsynopsis> - <command>bbstored-certs <certs-dir> <command> - [<arguments>]</command> + <command>bbstored-certs</command> + + <arg choice="plain">certs-dir</arg> + + <arg choice="plain">command</arg> + + <arg>arguments</arg> </cmdsynopsis> </refsynopsisdiv> <refsection> <title>Description</title> - <para><literal>bbstored-certs</literal> creates and signs certificates for + <para><command>bbstored-certs</command> creates and signs certificates for use in Box Backup. It allows the user to create and sign the server keys, as well as signing client keys.</para> - <para>All commands must be followed by the <literal>certs-dir</literal>, + <para>All commands must be followed by the <varname>certs-dir</varname>, which is the directory in which the certificates are stored.</para> <refsection> @@ -34,56 +47,60 @@ <para>There are 3 commands:</para> - <itemizedlist> - <listitem> - <para><literal>init</literal>: Create the - <literal>certs-dir</literal>, and generate the server keys for - bbstored. <literal>certs-dir</literal> cannot exist before running - the command.</para> - </listitem> - - <listitem> - <para><literal>sign-server <servercsrfile></literal>: Sign the - server certificate. The <literal>servercsrfile</literal> is the file - generated by the <literal>init</literal> command.</para> - </listitem> - - <listitem> - <para><literal>sign <clientcsrfile></literal>: Sign a client - certificate. The <literal>clientcsrfile</literal> is generated - during client setup. See <literal>bbackupd-config(8)</literal>. Send - the signed certificate back to the client, and install according to - the instructions given by <literal>bbackupd-config</literal>.</para> - </listitem> - </itemizedlist> + <variablelist> + <varlistentry> + <term><command>init</command></term> + + <listitem> + <para>Create the <varname>certs-dir</varname>, and generate the + server keys for bbstored. <varname>certs-dir</varname> cannot + exist before running the command.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>sign-server</command> + <varname>servercsrfile</varname></term> + + <listitem> + <para>Sign the server certificate. The + <varname>servercsrfile</varname> is the file generated by the + <command>init</command> command.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>sign</command> + <varname>clientcsrfile</varname></term> + + <listitem> + <para>Sign a client certificate. The + <varname>clientcsrfile</varname> is generated during client setup. + See <citerefentry> + <refentrytitle>bbackupd-config</refentrytitle> + + <manvolnum>8</manvolnum> + </citerefentry>. Send the signed certificate back to the client, + and install according to the instructions given by + <command>bbackupd-config</command>.</para> + </listitem> + </varlistentry> + </variablelist> </refsection> </refsection> <refsection> - <title>Author</title> - - <para>Ben Summers and contributors. For help, please go to the <ulink - url="http://www.boxbackup.org/trac/">Wiki</ulink>, or subscribe to the Box - Backup <ulink - url="http://lists.warhead.org.uk/mailman/listinfo/boxbackup">mailing - list.</ulink></para> - </refsection> - - <refsection> - <title>See Also</title> - - <para><literal>bbstored-config(8)</literal></para> - - <para><literal>bbstored.conf(5)</literal></para> + <title>Files</title> - <para><literal>bbstoreaccounts(8)</literal></para> - </refsection> + <para><citerefentry> + <refentrytitle>raidfile-config</refentrytitle> - <refsection> - <title>Files</title> + <manvolnum>8</manvolnum> + </citerefentry> generates the <citerefentry> + <refentrytitle>raidfile.conf</refentrytitle> - <para><literal>raidfile-config</literal> generates the raidfile.conf(5) - file.</para> + <manvolnum>5</manvolnum> + </citerefentry> file.</para> </refsection> <refsection> @@ -122,4 +139,38 @@ </listitem> </itemizedlist> </refsection> + + <refsection> + <title>See Also</title> + + <para><citerefentry> + <refentrytitle>bbstored-config</refentrytitle> + + <manvolnum>8</manvolnum> + </citerefentry>, <citerefentry> + <refentrytitle>bbstored.conf</refentrytitle> + + <manvolnum>5</manvolnum> + </citerefentry>, <citerefentry> + <refentrytitle>bbstoreaccounts</refentrytitle> + + <manvolnum>8</manvolnum> + </citerefentry></para> + </refsection> + + <refsection> + <title>Authors</title> + + <para><author> + <personname>Ben Summers</personname> + </author></para> + + <para><author> + <personname>Per Thomsen</personname> + </author></para> + + <para><author> + <personname>James O'Gorman</personname> + </author></para> + </refsection> </refentry> |