Skip to content

Commit

Permalink
Refine the documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
Ken Kundert authored and Ken Kundert committed Oct 4, 2019
1 parent 0746359 commit 8b63dbb
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 21 deletions.
14 changes: 13 additions & 1 deletion doc/commands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,19 @@
Commands
========

Here are the available commands:
You invoke *Emborg* from your shell by entering a line of the form::

emborg [global-options] <command> [command-options]

Details about the options and commands can be accessed with::

emborg help

or::

emborg help <command>

The available commands are:

:borg: :ref:`run a raw borg command. <borg>`
:breaklock: :ref:`breaks the repository and cache locks. <breaklock>`
Expand Down
6 changes: 3 additions & 3 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ for your day-to-day activities.
Use of *Emborg* does not preclude the use of Borg directly on the same
repository. The philosophy of *Emborg* is to provide commands that you would
use often and in an interactive manner with the expectation that you would use
*Borg* directly for the remaining commands.
*Borg* directly for more unusual or esoteric situations.

An alternative to *Emborg* is
`borgmatic <https://github.com/witten/borgmatic>`_. It seems largely focused on
Expand Down Expand Up @@ -155,8 +155,8 @@ extracts a file or directory from the most recent archive.
emborg mount restore

creates a directory 'restore' and then mounts the repository on this directory.
This allows you to move into the repository, navigating and retrieve files as if
it were a file system.
This allows you to move into the repository, navigating, examining, and
retrieving files as if it were a file system.

::

Expand Down
43 changes: 26 additions & 17 deletions doc/installing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,23 +40,24 @@ are backing up your home directory, and start from *root* if you are backing up
the root file system. Delete the one you do not need.

Normally people have just two files, the shared settings file and one
configuration file, perhaps named 'home' because it used to back up your home
directory. However, you may wish to have a second configuration dedicated to
creating snapshots of your files every 15 minutes or so. These snapshots may be
kept locally and only for a day or so while your primary backups are kept
remotely and kept long term.
configuration file, but you may have as many configurations as you want.
For example, in addition to your primary backup configuration, you may wish to
have a second configuration dedicated to creating snapshots of your files every
15 minutes or so. These snapshots may be kept locally and only for a day or so
while your primary backups are kept remotely and kept long term.

Settings may be placed in either the shared settings file or the configuration
specific file. The ones placed in the configuration specific file dominate.
The shared settings file must contain at least one setting, *configurations*,
which is a list of the available configurations.
specific file. The ones placed in the configuration specific file dominate for
that configuration. The shared settings file must contain at least one setting,
*configurations*, which is a list of the available configurations.

You can find descriptions of all available settings with::

emborg settings -a

There are certain settings that are worth highlighting.


**repository**

The destination for the backups. A typical value might be::
Expand All @@ -71,10 +72,18 @@ repository. For a local repository you would use something like this::
repository = '/mnt/backups/{host_name}-{user_name}-{config_name}'

These examples assume that */mnt/backups* contains many independent
repositories. Borg allows you to make a single repository the target of
multiple backup configurations, and in this way you can further benefit from its
repositories, and that each repository contains the files associated with
a single backup configuration. Borg allows you to make a repository the target
of many backup configurations, and in this way you can further benefit from its
ability to de-duplicate files. In this case you might want to use a less
granular name for you repository.
granular name for your repository. For example, a particular user could use
a single repository for all their configurations on all their hosts using::

repository = '/mnt/backups/{user_name}'

In this case you should specify the *prefix* setting, described next, to allow
the archives created by each backup configuration to be distinguished.


**archive** and **prefix**

Expand Down Expand Up @@ -111,7 +120,7 @@ If you do not specify either *archive* or *prefix*, then you get the following
defaults::

prefix = '{host_name}-{user_name}-{config_name}-'
archive = '{prefix}-{{now}}'
archive = '{prefix}{{now}}'

If you specify only *prefix*, then *archive* becomes::

Expand All @@ -123,8 +132,8 @@ suitable when there is only one backup configuration using a repository.
If you want *prefix* and want to customize *now*, you should give both *prefix*
and *archive*. For example, you can reduce the length of the timestamp using::

archive = '{host_name}-{{now:%Y%m%d}}'
prefix = '{host_name}-'
archive = '{prefix}{{now:%Y%m%d}}'

In this example the host name was used as the prefix rather than the
configuration name. When specifying both the *prefix* and the *archive*, the
Expand All @@ -150,9 +159,8 @@ a copy in a safe place along with the passphrase.

**passphrase**

The passphrase used when encrypting the encryption key. This is used as an
alternative to *avendesora_account*. Be sure to make the file that contains it
unreadable by others.
The passphrase used when encrypting the encryption key. Be sure to make the
file that contains it is unreadable by others.


**passcommand**
Expand Down Expand Up @@ -181,7 +189,8 @@ In general, the source directories should be given as absolute paths.

**excludes**

A list of files to exclude from the backups. Typical value might be::
A list of files or directories to exclude from the backups. Typical value might
be::

excludes = '''
~/tmp
Expand Down

0 comments on commit 8b63dbb

Please sign in to comment.