mirror of
https://github.com/borgbackup/borg.git
synced 2024-10-26 12:41:29 +03:00
a85b643866
One cannot "to not x", but one can "not to x". Avoiding split infinitives gives the added bonus that machine translation yields better results. setup (n/adj) vs set(v) up. We don't "I setup it" but "I set it up". Likewise for login(n/adj) and log(v) in, backup(n/adj) and back(v) up.
58 lines
1.7 KiB
ReStructuredText
58 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 data up.
|
|
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-rcreate(1)`, `borg-rdelete(1)`, `borg-rlist(1)`, `borg-rinfo(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)`
|
|
|
|
* 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
|