Changeset 2094 for box/trunk/documentation/adminguide.xml

Timestamp:

27/02/2008 18:50:44 (4 years ago)

Author:

jamesog

Message:

• Move all commands from bin to sbin on Unix platforms
• Update all associated docs and contributed distribution files

File:

• box/trunk/documentation/adminguide.xml (modified) (21 diffs)

box/trunk/documentation/adminguide.xml

@@ -97 +97 @@
 chown _bbstored /tmp/boxbackupRepository/             # Change the owner to the new boxbackup daemon user
 
-/usr/local/bin/raidfile-config /etc/box/  1024 /tmp/boxbackupRepository
+/usr/local/sbin/raidfile-config /etc/box/  1024 /tmp/boxbackupRepository
 
 #substitute 1024 with the desired blocksize
 #substitute /tmp/boxbackupRepository with a directory that exists where you want the backup store located
-#/usr/local/bin/raidfile-config --help shows you the options</programlisting>
+#/usr/local/sbin/raidfile-config --help shows you the options</programlisting>
 
         <para>Then create the configuration file /etc/box/bbstored.conf The
@@ -112 +112 @@
         <filename>/etc/box/bbstored.conf</filename> file.</para>
 
-        <programlisting>/usr/local/bin/bbstored-config /etc/box hostname _bbstored</programlisting>
+        <programlisting>/usr/local/sbin/bbstored-config /etc/box hostname _bbstored</programlisting>
 
         <para>This last step outputs 5 instructions that you must execute to
@@ -165 +165 @@
           <para>To setup the basic key structure, do the following:</para>
 
-          <programlisting>/usr/local/bin/bbstored-certs ca init</programlisting>
+          <programlisting>/usr/local/sbin/bbstored-certs ca init</programlisting>
 
           <para>(See <ulink url="instguide.xml">OpenSSL notes</ulink> if you
@@ -182 +182 @@
           do:</para>
 
-          <programlisting>/usr/local/bin/bbstored-certs ca sign-server hostname-csr.pem</programlisting>
+          <programlisting>/usr/local/sbin/bbstored-certs ca sign-server hostname-csr.pem</programlisting>
 
           <para>This signs the certificate for the server. Follow the
@@ -200 +200 @@
           create the account with:</para>
 
-          <programlisting>/usr/local/bin/bbstoreaccounts create 75AB23C 0 4096M 4505M</programlisting>
+          <programlisting>/usr/local/sbin/bbstoreaccounts create 75AB23C 0 4096M 4505M</programlisting>
 
           <para>This looks complicated. The numbers are, in order:</para>
@@ -262 +262 @@
           <para>Sign this CSR with this command:</para>
 
-          <programlisting>/usr/local/bin/bbstored-certs ca sign 75AB23C-csr.pem</programlisting>
+          <programlisting>/usr/local/sbin/bbstored-certs ca sign 75AB23C-csr.pem</programlisting>
 
           <para>Don't forget to check that the embedded account number is
@@ -346 +346 @@
           request.</para>
 
-          <programlisting>/usr/local/bin/bbackupd-config /etc/box lazy <emphasis
+          <programlisting>/usr/local/sbin/bbackupd-config /etc/box lazy <emphasis
               role="bold">999 hostname</emphasis> /var/bbackupd <emphasis
               role="bold">/home</emphasis></programlisting>
@@ -408 +408 @@
 
           <para>You can then run the daemon (as root) by running
-          <command>/usr/local/bin/bbackupd</command>, and of course, adding it
+          <command>/usr/local/sbin/bbackupd</command>, and of course, adding it
           to your system's startup scripts. The first time it's run it will
           upload everything. Interrupting it and restarting it will only
@@ -518 +518 @@
           </important>
 
-          <programlisting>/usr/local/bin/bbackupd-config /etc/box lazy 51 server.example.com /var/bbackupd /home /etc/samba
+          <programlisting>/usr/local/sbin/bbackupd-config /etc/box lazy 51 server.example.com /var/bbackupd /home /etc/samba
 
 Setup bbackupd config utility.
@@ -580 +580 @@
 
 6) Start the backup daemon with the command
-      /usr/local/bin/bbackupd
+      /usr/local/sbin/bbackupd
    in /etc/rc.local, or your local equivalent.
    Note that bbackupd must run as root.
@@ -1305 +1305 @@
         <para>The command line syntax is:</para>
 
-        <programlisting>/usr/local/bin/bbackupctl [-q] [-c config-file] command</programlisting>
+        <programlisting>/usr/local/sbin/bbackupctl [-q] [-c config-file] command</programlisting>
 
         <para>The -q option reduces the amount of output the program emits,
@@ -1359 +1359 @@
         mode, and then run the following command as a cron job.</para>
 
-        <programlisting>/usr/local/bin/bbackupctl -q sync</programlisting>
+        <programlisting>/usr/local/sbin/bbackupctl -q sync</programlisting>
 
         <para>This will cause the backup daemon to upload all changed files
@@ -1377 +1377 @@
           or type:</para>
 
-          <programlisting>/usr/local/bin/bbackupquery -q usage quit</programlisting>
+          <programlisting>/usr/local/sbin/bbackupquery -q usage quit</programlisting>
 
           <para>to show the space used as a single command.</para>
@@ -1389 +1389 @@
           use:</para>
 
-          <programlisting>/usr/local/bin/bbstoreaccounts info 75AB23C</programlisting>
+          <programlisting>/usr/local/sbin/bbstoreaccounts info 75AB23C</programlisting>
 
           <para>To adjust the soft and hard limits on an account, use:</para>
 
-          <programlisting>/usr/local/bin/bbstoreaccounts setlimit 75AB23C new-soft-limit new-hard-limit</programlisting>
+          <programlisting>/usr/local/sbin/bbstoreaccounts setlimit 75AB23C new-soft-limit new-hard-limit</programlisting>
 
           <para>You do not need to restart the server.</para>
@@ -1539 +1539 @@
           follows:</para>
 
-          <programlisting>/usr/local/bin/bbackupquery "compare -a" quit</programlisting>
+          <programlisting>/usr/local/sbin/bbackupquery "compare -a" quit</programlisting>
 
           <para>This command will report all the differences found between the
@@ -1562 +1562 @@
           file checksums and compares against that, then run:</para>
 
-          <programlisting>/usr/local/bin/bbackupquery "compare -aq" quit</programlisting>
+          <programlisting>/usr/local/sbin/bbackupquery "compare -aq" quit</programlisting>
 
           <para>However, this does not check that the file attributes are
@@ -1596 +1596 @@
           <para>Type:</para>
 
-          <programlisting>/usr/local/bin/bbackupquery</programlisting>
+          <programlisting>/usr/local/sbin/bbackupquery</programlisting>
 
           <para>to run it in interactive mode.</para>
@@ -1629 +1629 @@
           similar manner to a command line sftp client.</para>
 
-          <programlisting>/usr/local/bin/bbackupquery</programlisting>
+          <programlisting>/usr/local/sbin/bbackupquery</programlisting>
 
           <para>Then navigate to the directory containing the file you want,
@@ -1745 +1745 @@
         reports.</para>
 
-        <programlisting>/usr/local/bin/bbstoreaccounts check 1234</programlisting>
+        <programlisting>/usr/local/sbin/bbstoreaccounts check 1234</programlisting>
 
         <para>This will take some time, and use a fair bit of memory (about 16
@@ -1752 +1752 @@
         flag:</para>
 
-        <programlisting>/usr/local/bin/bbstoreaccounts check 1234 fix</programlisting>
+        <programlisting>/usr/local/sbin/bbstoreaccounts check 1234 fix</programlisting>
 
         <para>This will fix any errors, and remove unrecoverable files.
@@ -1842 +1842 @@
         example</para>
 
-        <programlisting>/usr/local/bin/bbstored /some/other/dir/bbstored.config /usr/local/bin/bbackupquery -c /some/other/dir/bbackupd.config</programlisting>
+        <programlisting>/usr/local/sbin/bbstored /some/other/dir/bbstored.config /usr/local/sbin/bbackupquery -c /some/other/dir/bbackupd.config</programlisting>
 
         <para>(daemons specify the name as the first argument, utility