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/bbackupctl.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>bbackupctl</refentrytitle> 
    … …  
    1016    <refname>bbackupctl</refname> 
    1117 
    12     <refpurpose>Control the bbackupd daemon </refpurpose> 
     18    <refpurpose>Contol the Box Backup client daemon</refpurpose> 
    1319  </refnamediv> 
    1420 
    1521  <refsynopsisdiv> 
    1622    <cmdsynopsis> 
    17       <command>bbackupctl [-q] [-c config-file] command</command> 
     23      <command>bbackupctl</command> 
     24 
     25      <arg>-q</arg> 
     26 
     27      <arg>-c config-file</arg> 
     28 
     29      <arg choice="plain">command</arg> 
    1830    </cmdsynopsis> 
    1931  </refsynopsisdiv> 
    … …  
    2234    <title>Description</title> 
    2335 
    24     <para><literal>bbackupctl</literal> lets the user control the bbackupd 
    25     daemon on a client machine. The main use is to force a sync with the store 
    26     server. This is especially important if bbackupd(8) is configured to do 
    27     snapshot backups. In that case <literal>bbackupctl</literal> is the only 
    28     way to effect a backup.</para> 
     36    <para><command>bbackupctl</command> sends commands to a running 
     37    <command>bbackupd</command> daemon on a client machine. It can be used to 
     38    force an immediate backup, tell the daemon to reload its configuration 
     39    files or stop the daemon. If <command>bbackupd</command> is configured in 
     40    snapshot mode, it will not back up automatically, and the 
     41    <command>bbackupctl</command> must be used to tell it when to start a 
     42    backup.</para> 
    2943 
    3044    <para>Communication with the bbackupd daemon takes place over a local 
    31     socket. Some platforms (notably Windows) can't determine if the user 
    32     connecting on this socket has the correct credentials to execute the 
    33     commands, leaving a rather sizeable security hole open. To avoid this, 
    34     unset the CommandSocket parameter in <literal>bbackupd.conf</literal>(5). 
    35     That disables the command socket, so bbackupd is secure. This does, 
    36     however, render bbackupctl unusable.</para> 
     45    socket (not over the network). Some platforms (notably Windows) can't 
     46    determine if the user connecting on this socket has the correct 
     47    credentials to execute the commands. On these platforms, ANY local user 
     48    can interfere with bbackupd. To avoid this, remove the CommandSocket 
     49    option from bbackupd.conf, which will also disable bbackupctl. See the 
     50    Client Configuration page for more information.</para> 
    3751 
    38     <refsection> 
    39       <title>Options</title> 
     52    <para><command>bbackupctl</command> needs to read the 
     53    <command>bbackupd</command> configuration file to find out the name of the 
     54    CommandSocket. If you have to tell <command>bbackupd</command> where to 
     55    find the configuration file, you will have to tell 
     56    <command>bbackupctl</command> as well. The default on Unix systems is 
     57    usually <filename>/etc/box/bbackupd.conf</filename>. On Windows systems, 
     58    it is <filename>bbackupd.conf</filename> in the same directory where 
     59    <command>bbackupd.exe</command> is located. If 
     60    <command>bbackupctl</command> cannot find or read the configuration file, 
     61    it will log an error message and exit.</para> 
    4062 
    41       <itemizedlist> 
    42         <listitem> 
    43           <para>-q -- quiet. Do not output status messages.</para> 
    44         </listitem> 
     63    <para><command>bbackupctl</command> usually writes error messages to the 
     64    console and the system logs. If it is not doing what you expect, please 
     65    check these outputs first of all.</para> 
     66 
     67    <variablelist> 
     68      <varlistentry> 
     69        <term><option>-q</option></term> 
    4570 
    4671        <listitem> 
    47           <para>-c config_file -- Use a different config file from the default 
    48           one. Can be a full or a relative path.</para> 
     72          <para>Run in quiet mode.</para> 
    4973        </listitem> 
    50       </itemizedlist> 
    51     </refsection> 
     74      </varlistentry> 
     75 
     76      <varlistentry> 
     77        <term><option>-c</option> config-file</term> 
     78 
     79        <listitem> 
     80          <para>Specify configuration file.</para> 
     81        </listitem> 
     82      </varlistentry> 
     83    </variablelist> 
    5284 
    5385    <refsection> 
    … …  
    5688      <para>The following commands are available in bbackupctl:</para> 
    5789 
    58       <itemizedlist> 
    59         <listitem> 
    60           <para><literal>terminate</literal></para> 
     90      <variablelist> 
     91        <varlistentry> 
     92          <term><command>terminate</command></term> 
    6193 
    62           <para>This command stops the bbackupd server. This is the equivalent 
    63           of killing (kill -KILL) the bbackupd process.</para> 
    64         </listitem> 
     94          <listitem> 
     95            <para>This command cleanly shuts down <command>bbackupd</command>. 
     96            This is better than killing or terminating it any other 
     97            way.</para> 
     98          </listitem> 
     99        </varlistentry> 
    65100 
    66         <listitem> 
    67           <para><literal>reload</literal></para> 
     101        <varlistentry> 
     102          <term><command>reload</command></term> 
    68103 
    69           <para>Causes the bbackupd daemon to re-read all its configuration 
    70           files. Equivalent to kill -HUP.</para> 
    71         </listitem> 
     104          <listitem> 
     105            <para>Causes the <command>bbackupd</command> daemon to re-read all 
     106            its configuration files. Equivalent to <command>kill 
     107            -HUP</command>.</para> 
     108          </listitem> 
     109        </varlistentry> 
    72110 
    73         <listitem> 
    74           <para><literal>sync</literal></para> 
     111        <varlistentry> 
     112          <term><command>sync</command></term> 
    75113 
    76           <para>Initiates a backup to the store of whatever needs to be backed 
    77           up.</para> 
    78         </listitem> 
    79       </itemizedlist> 
     114          <listitem> 
     115            <para>Initiates a backup. If no files need to be backed up, no 
     116            connection will be made to the server.</para> 
     117          </listitem> 
     118        </varlistentry> 
     119 
     120        <varlistentry> 
     121          <term><command>force-sync</command></term> 
     122 
     123          <listitem> 
     124            <para>Initiates a backup, even if the 
     125            <varname>SyncAllowScript</varname> says that no backup should run 
     126            now.</para> 
     127          </listitem> 
     128        </varlistentry> 
     129 
     130        <varlistentry> 
     131          <term><command>wait-for-sync</command></term> 
     132 
     133          <listitem> 
     134            <para>Passively waits until the next backup starts of its own 
     135            accord, and then terminates.</para> 
     136          </listitem> 
     137        </varlistentry> 
     138 
     139        <varlistentry> 
     140          <term><command>wait-for-end</command></term> 
     141 
     142          <listitem> 
     143            <para>Passively waits until the next backup starts of its own 
     144            accord and finishes, and then terminates.</para> 
     145          </listitem> 
     146        </varlistentry> 
     147 
     148        <varlistentry> 
     149          <term><command>sync-and-wait</command></term> 
     150 
     151          <listitem> 
     152            <para>Initiates a backup, waits for it to finish, and then 
     153            terminates.</para> 
     154          </listitem> 
     155        </varlistentry> 
     156      </variablelist> 
    80157    </refsection> 
    81158  </refsection> 
    82159 
    83160  <refsection> 
    84     <title>Author</title> 
     161    <title>Files</title> 
    85162 
    86     <para>Ben Summers and contributors. For help, please go to the <ulink 
    87     url="http://www.boxbackup.org/trac/">Wiki</ulink>, or subscribe to the Box 
    88     Backup <ulink 
    89     url="http://lists.warhead.org.uk/mailman/listinfo/boxbackup">mailing 
    90     list.</ulink></para> 
     163    <para><filename>/etc/box/bbackupd.conf</filename></para> 
    91164  </refsection> 
    92165 
    … …  
    94167    <title>See Also</title> 
    95168 
    96     <para><literal>bbackupd.conf(5)</literal></para> 
     169    <para><citerefentry> 
     170        <refentrytitle>bbackupd.conf</refentrytitle> 
    97171 
    98     <para><literal>bbackupd(8)</literal></para> 
    99   </refsection> 
     172        <manvolnum>5</manvolnum> 
     173      </citerefentry>, <citerefentry> 
     174        <refentrytitle>bbackupd-config</refentrytitle> 
    100175 
    101   <refsection> 
    102     <title>Files</title> 
     176        <manvolnum>8</manvolnum> 
     177      </citerefentry>, <citerefentry> 
     178        <refentrytitle>bbackupctl</refentrytitle> 
    103179 
    104     <para><literal>bbackupctl</literal> uses the Box Backup client 
    105     configuration file, usually located in 
    106     <filename>/etc/box/bbackupd.conf</filename>. On Windows this file is 
    107     usually located in the installation directory, and is named 
    108     <filename>bbackupd.conf</filename> as well.</para> 
    109   </refsection> 
    110  
    111   <refsection> 
    112     <title>Bugs</title> 
    113  
    114     <para>If you find a bug in Box Backup, and you want to let us know about 
    115     it, join the <ulink 
    116     url="http://lists.warhead.org.uk/mailman/listinfo/boxbackup">mailing 
    117     list</ulink>, and send a description of the problem there.</para> 
    118  
    119     <para>To report a bug, give us at least the following information:</para> 
    120  
    121     <itemizedlist> 
    122       <listitem> 
    123         <para>The version of Box Backup you are running</para> 
    124       </listitem> 
    125  
    126       <listitem> 
    127         <para>The platform you are running on (Hardware and OS), for both 
    128         client and server.</para> 
    129       </listitem> 
    130  
    131       <listitem> 
    132         <para>If possible attach your config files (bbstored.conf, 
    133         bbackupd.conf) to the bug report.</para> 
    134       </listitem> 
    135  
    136       <listitem> 
    137         <para>Also attach any log file output that helps shed light on the 
    138         problem you are seeing.</para> 
    139       </listitem> 
    140  
    141       <listitem> 
    142         <para>And last but certainly not least, a description of what you are 
    143         seeing, in as much detail as possible.</para> 
    144       </listitem> 
    145     </itemizedlist> 
     180        <manvolnum>8</manvolnum> 
     181      </citerefentry></para> 
    146182  </refsection> 
    147183</refentry> 
Note: See TracChangeset for help on using the changeset viewer.