mirror/borg
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-12-23 00:07:38 +00:00
Code Issues Releases Wiki Activity

docs: explain formatting

Browse source
This commit is contained in:
Marian Beermann 2017-06-17 14:29:14 +02:00
parent 02ada03486
commit 0288fff6b7
2 changed files with 17 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/usage/general.rst
View file

@ -5,6 +5,10 @@ Borg consists of a number of commands. Each command accepts
a number of arguments and options and interprets various environment variables. a number of arguments and options and interprets various environment variables.
The following sections will describe each command in detail. The following sections will describe each command in detail.
Commands, options, parameters, paths and such are ``set in fixed-width``.
Option values are `underlined`. Borg has few options accepting a fixed set
of values (e.g. ``--encryption`` of :ref:`borg_init`).
.. container:: experimental .. container:: experimental
Experimental features are marked with red stripes on the sides, like this paragraph. Experimental features are marked with red stripes on the sides, like this paragraph.

24
docs/usage_general.rst.inc
View file

@ -105,14 +105,16 @@ Return codes
Borg can exit with the following return codes (rc): Borg can exit with the following return codes (rc):
:: =========== =======
Return code Meaning
0 = success (logged as INFO) =========== =======
1 = warning (operation reached its normal end, but there were warnings - 0 success (logged as INFO)
you should check the log, logged as WARNING) 1 warning (operation reached its normal end, but there were warnings --
2 = error (like a fatal error, a local or remote exception, the operation you should check the log, logged as WARNING)
did not reach its normal end, logged as ERROR) 2 error (like a fatal error, a local or remote exception, the operation
128+N = killed by signal N (e.g. 137 == kill -9) did not reach its normal end, logged as ERROR)
128+N killed by signal N (e.g. 137 == kill -9)
=========== =======
If you use ``--show-rc``, the return code is also logged at the indicated If you use ``--show-rc``, the return code is also logged at the indicated
level as the last log entry. level as the last log entry.
@ -127,8 +129,8 @@ Borg uses some environment variables for automation:
General: General:
BORG_REPO BORG_REPO
When set, use the value to give the default repository location. If a command needs an archive When set, use the value to give the default repository location. If a command needs an archive
parameter, you can abbreviate as `::archive`. If a command needs a repository parameter, you parameter, you can abbreviate as ``::archive``. If a command needs a repository parameter, you
can either leave it away or abbreviate as `::`, if a positional parameter is required. can either leave it away or abbreviate as ``::``, if a positional parameter is required.
BORG_PASSPHRASE BORG_PASSPHRASE
When set, use the value to answer the passphrase question for encrypted repositories. When set, use the value to answer the passphrase question for encrypted repositories.
It is used when a passphrase is needed to access an encrypted repo as well as when a new It is used when a passphrase is needed to access an encrypted repo as well as when a new
@ -337,7 +339,7 @@ Cache files (client only):
Network (only for client/server operation): Network (only for client/server operation):
If your repository is remote, all deduplicated (and optionally compressed/ If your repository is remote, all deduplicated (and optionally compressed/
encrypted) data of course has to go over the connection (ssh: repo url). encrypted) data of course has to go over the connection (``ssh://`` repo url).
If you use a locally mounted network filesystem, additionally some copy If you use a locally mounted network filesystem, additionally some copy
operations used for transaction support also go over the connection. If operations used for transaction support also go over the connection. If
you backup multiple sources to one target repository, additional traffic you backup multiple sources to one target repository, additional traffic