[Box Backup-dev] COMMIT r556 - in box/trunk/documentation/boxbackup: . html

boxbackup-dev at fluffy.co.uk boxbackup-dev at fluffy.co.uk
Sat Apr 15 08:44:46 BST 2006


Author: per
Date: 2006-04-15 07:44:41 +0000 (Sat, 15 Apr 2006)
New Revision: 556

Added:
   box/trunk/documentation/boxbackup/bb-man.xsl
   box/trunk/documentation/boxbackup/bb-nochunk-book.xsl
   box/trunk/documentation/boxbackup/bbstoreaccounts.xml
   box/trunk/documentation/boxbackup/html/bbdoc-man.css
Modified:
   box/trunk/documentation/boxbackup/Makefile
   box/trunk/documentation/boxbackup/bb-book.xsl
Log:
Added bbstoreaccounts man page.

Added man-page specific XSL stylesheets.

Rearranged the layout of the output directories. There are now
2 output directories: 

- box-hmtl, which gets tarred up into the dockit tarball for 
  installation on a web server.
- man-pages, which contains all the .1.gz files for installation
  somewhere in $MANPATH (/usr/share/man/manX?)




Modified: box/trunk/documentation/boxbackup/Makefile
===================================================================
--- box/trunk/documentation/boxbackup/Makefile	2006-04-10 14:39:00 UTC (rev 555)
+++ box/trunk/documentation/boxbackup/Makefile	2006-04-15 07:44:41 UTC (rev 556)
@@ -6,54 +6,57 @@
 BOOKXSL=bb-book.xsl
 NOCHUNKBOOKXSL=bb-nochunk-book.xsl
 MANXSL=bb-man.xsl
+HTMLPREFIX=box-html
 VPATH= adminguide
 .SUFFIXES: .html .xml
 
-all: adminguide instguide manpages
+all: adminguide instguide manpages 
 
-adminguide: adminguide/index.html 
+adminguide: $(HTMLPREFIX)/adminguide/index.html 
 
-adminguide/index.html: adminguide.xml ExceptionCodes.xml $(BOOKXSL)
+$(HTMLPREFIX)/adminguide/index.html: adminguide.xml ExceptionCodes.xml $(BOOKXSL)
 	# docname=`echo $@ | sed -e 's/\/index.html//'`
-	$(DBPROC) -o adminguide/ $(BOOKXSL) adminguide.xml
+	$(DBPROC) -o $(HTMLPREFIX)/adminguide/ $(BOOKXSL) adminguide.xml
 
-instguide: instguide/index.html 
+instguide: $(HTMLPREFIX)/instguide/index.html 
 
-instguide/index.html: instguide.xml $(BOOKXSL)
-	$(DBPROC) -o instguide/ $(BOOKXSL) instguide.xml
+$(HTMLPREFIX)/instguide/index.html: instguide.xml $(BOOKXSL)
+	$(DBPROC) -o $(HTMLPREFIX)/instguide/ $(BOOKXSL) instguide.xml
 
 ExceptionCodes.xml: ../../ExceptionCodes.txt
 	perl ./generate_except_xml.pl
 
 manpages: man-dirs man-nroff man-html
 
-man-dirs: man-pages/.there man-html/.there
+man-dirs: man-pages/.there $(HTMLPREFIX)/man-html/.there
 
-man-html/.there:
-	if [ ! -d man-html ]; then mkdir man-html; touch man-html/.there; fi
+$(HTMLPREFIX)/man-html/.there:
+	if [ ! -d man-html ]; then mkdir -p $(HTMLPREFIX)/man-html; touch $(HTMLPREFIX)/man-html/.there; fi
 
 man-pages/.there:
 	if [ ! -d man-pages ]; then mkdir man-pages; touch man-pages/.there; fi
 
-man-nroff: bbackupquery.1 bbackupctl.1
+man-nroff: bbackupquery.1 bbackupctl.1 bbstoreaccounts.1
 
-man-html: bbackupquery.html bbackupctl.html
+man-html: bbackupquery.html bbackupctl.html bbstoreaccounts.html
 
 %.html: %.xml
 	$(DBPROC) -o $@ $(NOCHUNKBOOKXSL) $<
-	mv $@ man-html/.
+	mv $@ $(HTMLPREFIX)/man-html/.
 
 %.1: %.xml
 	$(DBPROC) -o $@ $(MANXSL) $<
 	mv $@ man-pages/.
+	gzip -f -9 man-pages/$@
 
 dockit: instguide adminguide manpages
-	tar zcf documentation-kit-0.10.tar.gz html/ instguide/ adminguide/ man-html/ man-pages
+	mkdir $(HTMLPREFIX)/images
+	cp html/images/*.png $(HTMLPREFIX)/images/.
+	cp html/*.css $(HTMLPREFIX)/.
+	tar zcf documentation-kit-0.10.tar.gz $(HTMLPREFIX)/
 
 clean:
-	if [ -d ./instguide ]; then rm -rf ./instguide/; fi
-	if [ -d ./adminguide ]; then rm -rf ./adminguide/; fi
-	if [ -d ./man-html ]; then rm -rf ./man-html/; fi
+	if [ -d ./$(HTMLPREFIX) ]; then rm -rf $(HTMLPREFIX) ; fi
 	if [ -d ./man-pages ]; then  rm -rf ./man-pages/; fi
 	if [ -f ExceptionCodes.xml ]; then rm ExceptionCodes.xml; fi
 	if [ -f docuemtation-kit-0.10.tar.gz ]; then rm documentation-kit-0.10.tar.gz; fi

Modified: box/trunk/documentation/boxbackup/bb-book.xsl
===================================================================
--- box/trunk/documentation/boxbackup/bb-book.xsl	2006-04-10 14:39:00 UTC (rev 555)
+++ box/trunk/documentation/boxbackup/bb-book.xsl	2006-04-15 07:44:41 UTC (rev 556)
@@ -4,12 +4,12 @@
 
 <xsl:import href="http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl"/> 
 
-<xsl:param name="html.stylesheet" select="'../html/bbdoc.css'"/>
+<xsl:param name="html.stylesheet" select="'../bbdoc.css'"/>
 <xsl:param name="chunk.section.depth" select="'0'"/>
 <xsl:template name="user.header.navigation">
 <div id="header">
 <div id="logo">
-<img src="../html/images/bblogo.png" alt="logo" height="65" width="331" border="0" vspace="5" align="middle" /> <img src="../html/images/stepahead.png" alt="a step ahead in data security" width="182" height="11" hspace="10" vspace="20" border="0" align="middle" /></div>
+<img src="../images/bblogo.png" alt="logo" height="65" width="331" border="0" vspace="5" align="middle" /> <img src="../images/stepahead.png" alt="a step ahead in data security" width="182" height="11" hspace="10" vspace="20" border="0" align="middle" /></div>
 </div>
 </xsl:template>
 

Added: box/trunk/documentation/boxbackup/bb-man.xsl
===================================================================
--- box/trunk/documentation/boxbackup/bb-man.xsl	2006-04-10 14:39:00 UTC (rev 555)
+++ box/trunk/documentation/boxbackup/bb-man.xsl	2006-04-15 07:44:41 UTC (rev 556)
@@ -0,0 +1,9 @@
+<?xml version='1.0'?> 
+<xsl:stylesheet  
+    xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"> 
+
+<xsl:import href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"/> 
+
+<xsl:param name="chunk.section.depth" select="'0'"/>
+
+</xsl:stylesheet>

Added: box/trunk/documentation/boxbackup/bb-nochunk-book.xsl
===================================================================
--- box/trunk/documentation/boxbackup/bb-nochunk-book.xsl	2006-04-10 14:39:00 UTC (rev 555)
+++ box/trunk/documentation/boxbackup/bb-nochunk-book.xsl	2006-04-15 07:44:41 UTC (rev 556)
@@ -0,0 +1,17 @@
+<?xml version='1.0'?> 
+<xsl:stylesheet  
+    xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"> 
+
+<xsl:import href="http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl"/> 
+
+<xsl:param name="html.stylesheet" select="'../bbdoc-man.css'"/>
+<xsl:param name="chunk.section.depth" select="'0'"/>
+<xsl:template name="user.header.content">
+<div id="header">
+<div id="logo">
+<img src="../images/bblogo.png" alt="logo" height="65" width="331" border="0" vspace="5" align="middle" /> <img src="../images/stepahead.png" alt="a step ahead in data security" width="182" height="11" hspace="10" vspace="20" border="0" align="middle" /></div>
+</div>
+</xsl:template>
+
+
+</xsl:stylesheet>

Added: box/trunk/documentation/boxbackup/bbstoreaccounts.xml
===================================================================
--- box/trunk/documentation/boxbackup/bbstoreaccounts.xml	2006-04-10 14:39:00 UTC (rev 555)
+++ box/trunk/documentation/boxbackup/bbstoreaccounts.xml	2006-04-15 07:44:41 UTC (rev 556)
@@ -0,0 +1,290 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<refentry>
+  <refmeta>
+    <refentrytitle>bbstoreaccounts</refentrytitle>
+
+    <manvolnum>1</manvolnum>
+  </refmeta>
+
+  <refnamediv>
+    <refname>bbstoreaccounts</refname>
+
+    <refpurpose>View and change account information on the store
+    server</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      <command>bbstoreaccounts [-c configfile] command account_id
+      [command-specific arguments]</command>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsection>
+    <title>Description</title>
+
+    <para><literal>bbstoreaccounts</literal> is the tool for managing accounts
+    on the store server. It can be used to view information related to
+    accounts, as well as create, change and delete accounts on the store
+    server. </para>
+
+    <para><literal>bbstoreaccounts</literal> alwas takes at least 2
+    parameters: the command name and the account ID. Some commands require
+    additional parameters, and some commands have optional parameters.</para>
+
+    <refsection>
+      <title>Options</title>
+
+      <para><literal>-c <configfile></literal></para>
+
+      <para>The configfile to use for connecting to the store. Default is
+      <literal>/etc/box/bbstored.conf</literal>.</para>
+    </refsection>
+
+    <refsection>
+      <title>Commands</title>
+
+      <para>The commands tells bbstoreaccounts what action to perform.</para>
+
+      <itemizedlist>
+        <listitem>
+          <para><literal>check <account-id> [fix]</literal></para>
+
+          <para>The <literal>check</literal> command verifies the integrity of
+          the store account given, and optionally fixes any corruptions.
+          <emphasis role="bold">Note</emphasis>: It is recommended to run the
+          'simple' check command (without <literal>fix</literal>) before using
+          the <literal>fix</literal> option, This gives an overview of the
+          extent of any problems, before attempting to fix them.</para>
+        </listitem>
+
+        <listitem>
+          <para><literal>create <account-id> <discset>
+          <softlimit> <hardlimit></literal></para>
+
+          <para>Creates a new store account with the parameters given. The
+          parameters are as follows:</para>
+
+          <itemizedlist>
+            <listitem>
+              <para><literal>account-id</literal>: the ID of the new account
+              to be created. A 32-bit hexadecimal number. Cannot already exist
+              on the server.</para>
+            </listitem>
+
+            <listitem>
+              <para><literal>discset</literal>: the disc set from
+              raidfile.conf(5) where the backups for this client will be
+              stored.. A number. Each RAID-file set has a number in
+              raidfile.conf. This number is what's used.</para>
+            </listitem>
+
+            <listitem>
+              <para><literal>softlimit</literal>: The soft limit is the amount
+              of storage that the server will guarantee to be available for
+              storage.</para>
+            </listitem>
+
+            <listitem>
+              <para><literal>hardlimit</literal>: The amount of storage that
+              the the server will allow, before rejecting uploads, and
+              starting to eliminate old and deleted files to get back down to
+              <literal>softlimit</literal>. </para>
+            </listitem>
+          </itemizedlist>
+        </listitem>
+
+        <listitem>
+          <para><literal>delete <account-id> [yes]</literal></para>
+
+          <para>Deletes the account from the store server completely. Removes
+          all backups and deletes all references to the account in the config
+          files.</para>
+
+          <para><literal>delete</literal> will ask for confirmation from the
+          user, when called. Using the <literal>yes</literal> flag, eliminates
+          that need. This is useful when deleting accounts from within a
+          script or some other automated means.</para>
+        </listitem>
+
+        <listitem>
+          <para><literal>info <account-id></literal></para>
+
+          <para>Display information about the given account. Example:</para>
+
+          <programlisting> root]# bbstoreaccounts info 1
+                  Account ID: 00000001
+              Last object ID: 58757
+                 Blocks used: 9864063 (38531.50Mb)
+    Blocks used by old files: 62058 (242.41Mb)
+Blocks used by deleted files: 34025 (132.91Mb)
+  Blocks used by directories: 6679 (26.09Mb)
+            Block soft limit: 11796480 (46080.00Mb)
+            Block hard limit: 13107200 (51200.00Mb)
+         Client store marker: 1139559852000000 </programlisting>
+
+          <para>Explanation:</para>
+
+          <itemizedlist>
+            <listitem>
+              <para>Account ID: The account ID being displayed.</para>
+            </listitem>
+
+            <listitem>
+              <para>Last Object ID: A counter that keeps track of the objects
+              that have been backed up. This number refers to the last file
+              that was written to the store. The ID is displayed as a decimal
+              number, and the object ID can be converted to a path name to a
+              file as follows: convert the number to hex (e.g.: 58757 =>
+              0xE585); The last backed up file will be (relative from the
+              client's store root): <literal>e5/o85.rfw</literal>. Longer
+              numbers infer more directories in the structure, so as an
+              example 3952697264 as the last object ID gives 0xEB995FB0, which
+              translates to a backup pathname of
+              <literal>0e/b9/95/f0/b0.rfw.</literal></para>
+            </listitem>
+
+            <listitem>
+              <para>Blocks used: The number of blocks used by the store. The
+              size in Mb depends on the number of blocks, as well as the block
+              size for the disc set given in
+              <literal>raidfile.conf(5)</literal>. In this case the block size
+              is 4096.</para>
+            </listitem>
+
+            <listitem>
+              <para>Blocks used by old files: The number of blocks occupied by
+              files that have newer versions in the store. This data is at
+              risk for being removed during housekeeping.</para>
+            </listitem>
+
+            <listitem>
+              <para>Blocks used by deleted files: The number of blocks used by
+              files that have been deleted on the client. This data is at risk
+              for being removed during housekeeping.</para>
+            </listitem>
+
+            <listitem>
+              <para>Blocks used by directories: The number of blocks used by
+              directories in the store.</para>
+            </listitem>
+
+            <listitem>
+              <para>Block soft limit: The soft limit in blocks. The soft limit
+              is the maximum guaranteed storage space available to the
+              account. When housekeeping starts, and the old and deleted files
+              are removed, they are removed in chronological order (oldest
+              first), until the data used is less than the soft limit.</para>
+            </listitem>
+
+            <listitem>
+              <para>Block hard limit: The hard limit in blocks. The hard limit
+              is the most amount of storage the server will allow in an
+              account. Any data above this amount will be rejected.
+              Housekeeping will reduce the storage use, so more data can be
+              uploaded.</para>
+            </listitem>
+
+            <listitem>
+              <para>Client store marker: TODO What exactly is this? </para>
+            </listitem>
+          </itemizedlist>
+        </listitem>
+
+        <listitem>
+          <para><literal>setlimit <account-id> <softlimit>
+          <hardlimit></literal></para>
+
+          <para>Changes the storage space allocation for the given account. No
+          server restart is needed.</para>
+
+          <para>Parameters:</para>
+
+          <itemizedlist>
+            <listitem>
+              <para><literal>account-id</literal>: the ID of the new account
+              to be created. A 32-bit hexadecimal number. Cannot already exist
+              on the server.</para>
+            </listitem>
+
+            <listitem>
+              <para><literal>softlimit</literal>: The soft limit is the amount
+              of storage that the server will guarantee to be available for
+              storage.</para>
+            </listitem>
+
+            <listitem>
+              <para><literal>hardlimit</literal>: The amount of storage that
+              the the server will allow, before rejecting uploads, and
+              starting to eliminate old and deleted files to get back down to
+              <literal>softlimit</literal>.</para>
+            </listitem>
+          </itemizedlist>
+        </listitem>
+      </itemizedlist>
+    </refsection>
+  </refsection>
+
+  <refsection>
+    <title>Author</title>
+
+    <para>Ben Summers and contributors. For help, please go to the <ulink
+    url="http://boxbackup.hostworks.ca/">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.conf(5)</literal></para>
+
+    <para><literal>raidfile.conf(5)</literal></para>
+  </refsection>
+
+  <refsection>
+    <title>Files</title>
+
+    <para><literal>bbstoreaccounts</literal> uses the Box Backup server
+    configuration file, usually located in
+    <filename>/etc/box/bbstored.conf</filename>. </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>
\ No newline at end of file

Added: box/trunk/documentation/boxbackup/html/bbdoc-man.css
===================================================================
--- box/trunk/documentation/boxbackup/html/bbdoc-man.css	2006-04-10 14:39:00 UTC (rev 555)
+++ box/trunk/documentation/boxbackup/html/bbdoc-man.css	2006-04-15 07:44:41 UTC (rev 556)
@@ -0,0 +1,104 @@
+body {
+	font-family: Verdana, Geneva, Arial, sans-serif;
+	background-color: #edeef3;
+        font-size: .75em;
+        line-height: 180%;
+        text-align: left;
+        margin-top: 20px;
+        margin-right: 100px;
+        margin-left: 250px;
+        position: relative;
+        width: auto; }
+	
+table {
+	font-family: Verdana, Geneva, Arial, sans-serif;
+	background-color: #edeef3;
+        font-size: 10pt;
+        line-height: 100%; }
+
+
+code {
+	font-size: 11pt; }
+
+	
+
+div.navheader {
+	font-family: Verdana, Geneva, Arial, sans-serif;
+	background-color: #edeef3; 
+        line-height: 100%; }
+       
+#header {
+	background-color: #e4e6ed;
+	text-align: left;
+	padding-top: 10px;
+        margin-right: -100px;
+        margin-left: -250px;
+	top: 20px;
+	border-top: 1px solid #c4c4d5;
+	border-bottom: 1px solid white }
+	
+#logo {
+	position: relative; 
+	margin-left: 200px }
+	
+	
+#page {
+	font-size: .75em;
+	line-height: 180%;
+	text-align: left;
+	margin-top: 50px;
+	margin-right: 100px;
+	margin-left: 250px;
+	position: relative;
+	width: auto }
+
+#disc {    }
+	
+.informaltable td,tr {font-size: 1em;
+	line-height: 140%;
+	text-align: left;
+	background-color: #e4e6ed;
+	padding: 4px }
+	
+tr,td {font-size: 1em;
+	line-height: 100%;
+	background-color: #edeef3; }
+	
+pre, tt { font-size: 1.3em; 
+	color: #088;
+	letter-spacing: 1px;
+	word-spacing: 2px}
+	
+h1 {
+	color: #c00;
+	font-size: 16pt;
+	margin-bottom: 2em;
+	margin-left: -50px }
+	
+h2 {
+	color: #324e95;
+	font-size: 12pt;
+	margin-top: 2em;
+	margin-left: -50px }
+	
+h3 {
+	color: #324e95;
+	font-size: 10pt;
+	margin-top: 2em;
+	margin-left: -50px }
+	
+dt { font-weight: bold }
+	
+a:link {
+	color: #324e95;
+	text-decoration: none;
+	background-color: transparent }
+	
+a:visited {
+	color: #90c;
+	text-decoration: none }
+	
+a:hover {
+	color: #c00;
+	text-decoration: underline;
+	background-color: transparent }




More information about the Boxbackup-dev mailing list