summaryrefslogtreecommitdiff
path: root/documentation/bbackupctl.xml
blob: 09085be81cab7ab4aa0c5ef6c6d7ad35de11ba54 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
<?xml version="1.0" encoding="UTF-8"?>
<refentry>
  <refmeta>
    <refentrytitle>bbackupctl</refentrytitle>

    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>bbackupctl</refname>

    <refpurpose>Control the bbackupd daemon </refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>bbackupctl [-q] [-c config-file] command</command>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsection>
    <title>Description</title>

    <para><literal>bbackupctl</literal> lets the user control the bbackupd
    daemon on a client machine. The main use is to force a sync with the store
    server. This is especially important if bbackupd(1) is configured to do
    snapshot backups. In that case <literal>bbackupctl</literal> is the only
    way to effect a backup.</para>

    <para>Communication with the bbackupd daemon takes place over a local
    socket. Some platforms (notably Windows) can't determine if the user
    connecting on this socket has the correct credentials to execute the
    commands, leaving a rather sizeable security hole open. To avoid this,
    unset the CommandSocket parameter in <literal>bbackupd.conf</literal>(8).
    That disables the command socket, so bbackupd is secure. This does,
    however, render bbackupctl unusable.</para>

    <refsection>
      <title>Options</title>

      <itemizedlist>
        <listitem>
          <para>-q -- quiet. Do not output status messages.</para>
        </listitem>

        <listitem>
          <para>-c config_file -- Use a different config file from the default
          one. Can be a full or a relative path.</para>
        </listitem>
      </itemizedlist>
    </refsection>

    <refsection>
      <title>Commands</title>

      <para>The following commands are available in bbackupctl:</para>

      <itemizedlist>
        <listitem>
          <para><literal>terminate</literal></para>

          <para>This command stops the bbackupd server. This is the equivalent
          of killing (kill -KILL) the bbackupd process.</para>
        </listitem>

        <listitem>
          <para><literal>reload</literal></para>

          <para>Causes the bbackupd daemon to re-read all its configuration
          files. Equivalent to kill -HUP.</para>
        </listitem>

        <listitem>
          <para><literal>sync</literal></para>

          <para>Initiates a backup to the store of whatever needs to be backed
          up.</para>
        </listitem>
      </itemizedlist>
    </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>bbackupd.conf(8)</literal></para>

    <para>bbackupd(1)</para>
  </refsection>

  <refsection>
    <title>Files</title>

    <para><literal>bbackupctl</literal> uses the Box Backup client
    configuration file, usually located in
    <filename>/etc/box/bbackupd.conf</filename>. On Windows this file is
    usually located in the installation directory, and is named
    <filename>bbackupd.conf</filename> as well.</para>
  </refsection>

  <refsection>
    <title>Bugs</title>

    <para>If you find a bug in Box Backup, and you want to let us know about
    it, join the <ulink
    url="http://lists.warhead.org.uk/mailman/listinfo/boxbackup">mailing
    list</ulink>, and send a description of the problem there.</para>

    <para>To report a bug, give us at least the following information:</para>

    <itemizedlist>
      <listitem>
        <para>The version of Box Backup you are running</para>
      </listitem>

      <listitem>
        <para>The platform you are running on (Hardware and OS), for both
        client and server.</para>
      </listitem>

      <listitem>
        <para>If possible attach your config files (bbstored.conf,
        bbackupd.conf) to the bug report.</para>
      </listitem>

      <listitem>
        <para>Also attach any log file output that helps shed light on the
        problem you are seeing.</para>
      </listitem>

      <listitem>
        <para>And last but certainly not least, a description of what you are
        seeing, in as much detail as possible.</para>
      </listitem>
    </itemizedlist>
  </refsection>
</refentry>