More documentation improvements.

docs/_themes/attic/static/attic.css_t

@@ -3,7 +3,7 @@
 body {
   font-family: Arial, Sans-Serif;
   background-color: white;
-  margin: 0;
+  margin: 0 0 4em;
   padding: 0;
 }
 div.related {
@@ -40,9 +40,15 @@ h1, h2, h3 {
   font-style: italic;
   color: #333;
 }
-h1 { font-size: 200%;}
-h2 { font-size: 140%;}
-h3 { font-size: 100%;}
+h1 {
+  margin: .8em 0 .5em;
+}
+h2, h3 {
+  margin: 1.2em 0 .6em;
+}
+h1 { font-size: 260%;}
+h2 { font-size: 180%;}
+h3 { font-size: 130%;}
 ul {
   padding-left: 1.2em;
   margin-bottom: .3em;
@@ -85,12 +91,6 @@ pre a:visited {
   color: #00B0E4;
 }
 
-div.note {
-  background-color: #eee;
-  border: 1px solid #ccc;
-  border-radius: .4em;
-  box-shadow: 2px 2px #ddd;
-}
 div.sidebarlogo .title {
   font-family: "DejaVu Serif";
   font-style: italic;
@@ -107,3 +107,33 @@ dt {
   font-style: italic;
   font-size: 95%;
 }
+
+div.admonition p.admonition-title + p {
+    display: inline;
+}
+
+div.admonition p {
+    margin-bottom: 5px;
+}
+
+p.admonition-title {
+    display: inline;
+}
+
+p.admonition-title:after {
+    content: ":";
+}
+
+div.note {
+  background-color: #eee;
+  border: 1px solid #ccc;
+  border-radius: .4em;
+  box-shadow: 2px 2px #ddd;
+}
+
+div.seealso {
+  background-color: #ffe;
+  border: 1px solid #ff6;
+  border-radius: .4em;
+  box-shadow: 2px 2px #dd6;
+}

docs/conf.py

@@ -212,7 +212,7 @@ latex_documents = [
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    ('index', 'attic', 'Attic Documentation',
-     ['Jonas Borgström'], 1)
-]
+#man_pages = [
+#    ('man', 'attic', 'Attic',
+#     ['Jonas Borgström'], 1)
+#]

docs/foreword.rst

@@ -1,9 +1,13 @@
 .. include:: global.rst.inc
-.. _foreward:
+.. _foreword:
 
 Foreword
 ========
 
+|project_name| is a secure backup program for Linux, FreeBSD and Mac OS X. 
+|project_name| is designed for efficient data storage where only new or
+modified data is stored.
+
 Features
 --------
 
@@ -22,12 +26,12 @@ Off-site backups
     long as |project_name| is installed.
 
 Backups mountable as filesystems
-    Backup archives are :ref:`mountable <usage_attic_mount>` as
+    Backup archives are :ref:`mountable <attic_mount>` as
     `userspace filesystems`_ for easy backup verification and restores.
 
 
-Terminology
------------
+Glossary
+--------
 
 .. _deduplication_def:
 

docs/index.rst

@@ -16,7 +16,7 @@ first backup :ref:`archive <archive_def>` in two lines::
     $ attic init /usbdrive/my-backup.attic
     $ attic create -v /usbdrive/my-backup.attic::documents ~/Documents
 
-See the :ref:`generalusage` section for a more detailed example.
+See the :ref:`quickstart` chapter for a more detailed example.
 
 Easy installation
 -----------------

docs/quickstart.rst

@@ -5,13 +5,13 @@ Quick Start
 ===========
 
 This chapter will get you started with |project_name|. The first section
-presents a simple example that uses |project_name| to backup data.
+presents a simple step by step example that uses |project_name| to backup data.
 The next section continues by showing how backups can be automated.
 
 A step by step example
 ----------------------
 
-1. Before any backup can be made a repository has to be initialized::
+1. Before any backup can be taken a repository has to be initialized::
 
     $ attic init /somewhere/my-backup.attic
 
@@ -51,7 +51,7 @@ Automating backups
 
 The following example script backups up ``/home`` and
 ``/var/www`` to a remote server. The script also uses the
-:ref:`usage_attic_prune` subcommand to maintain a certain number
+:ref:`attic_prune` subcommand to maintain a certain number
 of old archives::
 
     #!/bin/sh

docs/terminology.rst

@@ -1,31 +0,0 @@
-.. _terminology:
-.. include:: global.rst.inc
-
-Terminology
-===========
-
-.. _deduplication_def:
-
-Deduplication
-    Deduplication is a technique for improving storage utilization by
-    eliminating redundant data. 
-
-.. _archive_def:
-
-Archive
-    An archive is a collection of files along with metadata that include file
-    permissions, directory structure and various file attributes.
-    Since each archive in a repository must have a unique name a good naming
-    convention is ``hostname-YYYY-MM-DD``.
-
-.. _repository_def:
-
-Repository
-    A repository is a filesystem directory storing data from zero or more
-    archives. The data in a repository is both deduplicated and encrypted
-    making it both efficient and safe.
-
-Key file
-    When a repository is initialized a key file containing a password
-    protected encryption key is created. It is vital to keep this file safe
-    since the repository data is totally inaccessible without it.

docs/update_usage.sh

@@ -5,7 +5,8 @@ fi
 for cmd in change-passphrase create delete extract info init list mount prune verify; do
   FILENAME="usage/$cmd.rst.inc"
   LINE=`echo -n attic $cmd | tr 'a-z- ' '-'`
-  echo -e "attic $cmd\n$LINE\n::\n\n" > $FILENAME
+  echo -e ".. _attic_$cmd:\n" > $FILENAME
+  echo -e "attic $cmd\n$LINE\n::\n\n" >> $FILENAME
   attic $cmd -h | sed -e 's/^/    /' >> $FILENAME
   echo -e "\nDescription\n~~~~~~~~~~~\n\n" >> $FILENAME
 done

docs/usage.rst

@@ -15,8 +15,6 @@ Like most UNIX commands |project_name| is quiet by default but the ``-v`` or
 ``--verbose`` option can be used to get the program to output more status
 messages as it is processing.
 
-.. _attic_init:
-
 .. include:: usage/init.rst.inc
 
 This command initializes an empty :ref:`repository <repository_def>`.
@@ -62,8 +60,6 @@ Examples
     NAME="root-`date +%Y-%m-%d`"
     $ attic create /data/myrepo.attic::$NAME / --do-not-cross-mountpoints
 
-.. _attic_extract:
-
 
 .. include:: usage/extract.rst.inc
 
@@ -103,9 +99,6 @@ This command deletes an archive from the repository. Any disk space not
 shared with any other existing archive is also reclaimed.
 
 
-.. _attic_list:
-
-
 .. include:: usage/list.rst.inc
 
 This command lists the contents of a repository or an archive.

docs/usage/change-passphrase.rst.inc

@@ -1,3 +1,5 @@
+.. _attic_change-passphrase:
+
 attic change-passphrase
 -----------------------
 ::

docs/usage/create.rst.inc

@@ -1,3 +1,5 @@
+.. _attic_create:
+
 attic create
 ------------
 ::

docs/usage/delete.rst.inc

@@ -1,3 +1,5 @@
+.. _attic_delete:
+
 attic delete
 ------------
 ::

docs/usage/extract.rst.inc

@@ -1,3 +1,5 @@
+.. _attic_extract:
+
 attic extract
 -------------
 ::

docs/usage/info.rst.inc

@@ -1,3 +1,5 @@
+.. _attic_info:
+
 attic info
 ----------
 ::

docs/usage/init.rst.inc

@@ -1,3 +1,5 @@
+.. _attic_init:
+
 attic init
 ----------
 ::

docs/usage/list.rst.inc

@@ -1,3 +1,5 @@
+.. _attic_list:
+
 attic list
 ----------
 ::

docs/usage/mount.rst.inc

@@ -1,3 +1,5 @@
+.. _attic_mount:
+
 attic mount
 -----------
 ::

docs/usage/prune.rst.inc

@@ -1,3 +1,5 @@
+.. _attic_prune:
+
 attic prune
 -----------
 ::

docs/usage/verify.rst.inc

@@ -1,3 +1,5 @@
+.. _attic_verify:
+
 attic verify
 ------------
 ::