type <code>ls</code> you should see your tag listed, and within that
tag, you'll find a list of snapshots, in descending date order, with a
special entry <code>current</code> for the most recent
snapshot. Within a snapshot, you'll find the root directory of your
snapshot under "contents", and will be able to <code>cd</code> into
subdirectories, and so on:

FIXME: Make this reflect an actual localhost-etc snapshot.

      > ls
      Test <tag>
      > cd Test
      /Test> ls
      2009-01-24 10:28:16 <snapshot>
      2009-01-24 10:28:16 <snapshot>
      current <snapshot>

Given the sample vault from the previous example, it would be possible
to extract the <code>README.txt</code> file with the following
command:

      ugarit extract ugarit.conf /Test/current/contents/README.txt

<h2>Forking tags</h2>

As mentioned above, you can fork a tag, creating two tags that
refer to the same snapshot and its history but that can then have
their own subsequent history of snapshots applied to each
independently, with the following command:

      $ ugarit fork <ugarit.conf> <existing tag> <new tag>

<h2>Merging tags</h2>

FIXME: Document this.

<h2>Archive operations</h2>

<h3>Importing</h3>

FIXME: Document this.

<h3>Exploring</h3>

FIXME: Document this.

<h3>Searching</h3>

FIXME: Document this.

<h3>Extracting</h3>

FIXME: Document this.

<h2>Storage administration</h2>

Each backend offers a number of administrative commands for
administering the storage underlying vaults. These are accessible via
the <code>ugarit-storage-admin</code> command line interface.

To use it, run it with the following command:

      $ ugarit-storage-admin '<vault identifier>'

The available commands differ between backends, but all backends
support the <code>info</code> and <code>help</code> commands, which give basic information
about the vault, and list all available commands, respectively. Some
offer a <code>stats</code> command that examines the vault state to give
interesting statistics, but which may be a time-consuming operation.

<h3>Administering <code>splitlog</code> storages</h3>

The splitlog backend offers a wide selection of administrative
commands. See the <code>help</code> command on a splitlog vault for
details. The following facilities are available:

   *  Configuring the block size of the storage (this will affect new
   blocks written to the storage, and leave existing blocks untouched,
   even if they are larger than the new block size)

   *  Configuring the size at which a log file is finished and a new one
   started (likewise, existing log files will be untouched; this will
   only affect new log files)

   * Configuring the frequency of automatic synching of the storage
   state to disk. Lowering this harms performance when writing to the
   storage, but decreases the number of in-progress block writes that
   can fail in a crash.

   * Enable or disable write protection of the storage

   * Reindex the storage, rebuilding the block and tag state from the
   contents of the log. If the metadata file is damaged or lost,
   reindexing can rebuild it (although any configuration changes made
   via other admin commands will need manually repeating as they are
   not logged).

<h3>Administering <code>sqlite</code> storages</h3>

FIXME: Document this.

<h2><code>.ugarit</code> files</h2>

By default, Ugarit will vault everything it finds in the filesystem
tree you tell it to snapshot. However, this might not always be
desired; so we provide the facility to override this with <code>.ugarit</code>
files, or global rules in your <code>.conf</code> file.