mirror of
https://github.com/borgbackup/borg.git
synced 2026-09-01 14:13:19 +02:00
39d0e27f56Add an "environment" help topic (alias: "env") showing the documentation about the environment variables borg supports, like borg help already does for patterns, placeholders, compression and match-archives. The help topic is now the single source of that documentation: scripts/make.py build_usage generates docs/usage/general/environment.rst.inc from it (and skips it on the misc. help docs page, where it would duplicate the "General" chapter's section), and build_man already generates a borg-environment(1) man page from any help topic. The text was adapted a bit so that it renders well both via sphinx and via nanorst on the terminal: the list-table, note directive and hyperlink targets were replaced by constructs nanorst understands. nanorst: end a code block when a following line is less indented than the code block's contents (instead of the hardcoded "less than 4 spaces" rule), so code blocks nested inside definition lists do not swallow the text following them any more. Also, borg help <topic> now resolves :ref: references like the command epilogs already did. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
57 lines
1.7 KiB
ReStructuredText
57 lines
1.7 KiB
ReStructuredText
:orphan:
|
|
|
|
SYNOPSIS
|
|
--------
|
|
|
|
borg [common options] <command> [options] [arguments]
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
|
|
.. we don't include the README.rst here since we want to keep this terse.
|
|
|
|
BorgBackup (short: Borg) is a deduplicating backup program.
|
|
Optionally, it supports compression and authenticated encryption.
|
|
|
|
The main goal of Borg is to provide an efficient and secure way to back up data.
|
|
The data deduplication technique used makes Borg suitable for daily backups
|
|
since only changes are stored.
|
|
The authenticated encryption technique makes it suitable for backups to targets not
|
|
fully trusted.
|
|
|
|
Borg stores a set of files in an *archive*. A *repository* is a collection
|
|
of *archives*. The format of repositories is Borg-specific. Borg does not
|
|
distinguish archives from each other in any way other than their name,
|
|
it does not matter when or where archives were created (e.g., different hosts).
|
|
|
|
EXAMPLES
|
|
--------
|
|
|
|
A step-by-step example
|
|
~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. include:: quickstart_example.rst.inc
|
|
|
|
NOTES
|
|
-----
|
|
|
|
.. include:: usage_general.rst.inc
|
|
|
|
SEE ALSO
|
|
--------
|
|
|
|
`borg-common(1)` for common command line options
|
|
|
|
`borg-repo-create(1)`, `borg-repo-delete(1)`, `borg-repo-list(1)`, `borg-repo-info(1)`,
|
|
`borg-create(1)`, `borg-mount(1)`, `borg-extract(1)`,
|
|
`borg-list(1)`, `borg-info(1)`,
|
|
`borg-delete(1)`, `borg-prune(1)`, `borg-compact(1)`,
|
|
`borg-recreate(1)`
|
|
|
|
`borg-compression(1)`, `borg-patterns(1)`, `borg-placeholders(1)`, `borg-environment(1)`
|
|
|
|
* Main web site https://www.borgbackup.org/
|
|
* Releases https://github.com/borgbackup/borg/releases
|
|
* Changelog https://github.com/borgbackup/borg/blob/master/docs/changes.rst
|
|
* GitHub https://github.com/borgbackup/borg
|
|
* Security contact https://borgbackup.readthedocs.io/en/latest/support.html#security-contact
|