mirror of
https://github.com/borgbackup/borg.git
synced 2026-09-01 14:13:19 +02:00
df6f4201f8All command lines were executed against scratch repositories and all output samples regenerated from real runs (prettified, not invented): - recreate: the example used the removed --recompress; show borg repo-compress instead; refresh the borg info samples. - diff: default/text output has modified:/added:/removed: labels and mtime/ctime brackets now; the JSON-lines example used borg1 keys and lacked --json-lines on the command; add --content-only. - mount: example passed the repository as a positional (it would have been taken as the mountpoint); use -r. - tar: the archive-copy loop was a bash syntax error and used borg list with repo-list-only format keys; replaced with a working while-read loop over borg repo-list (verified end-to-end, identical archive contents in the destination repo). - key: regenerate repo-create/change-passphrase samples (hex-id named keyfiles, Key location line, no "Synchronizing index"); the import example silently did nothing without --key-location=keyfile; fix the Windows keys path (AppData\Local, not Roaming); explain why the keyfile name changes on passphrase change. - transfer: the borg1->borg2 upgrade steps were missing --from-borg1 and used a ssh:// destination URL (rejected for current repos); fix the Windows keys path. - notes: --noatime and --nobsdflags no longer exist (atime is opt-in via --atime); stray "|" removed. - compact: segments wording removed. - info/repo-info/repo-delete/list/find: output samples regenerated (new labels/order, UTC offsets, repo version line, prompt text; isomtime format and symlink size corrected in list). - general: fix broken inline markup (stray backtick). - serve: the authorized_keys forced command needs --rest (it is deliberately not client-suppliable); document the actual client argument allowlist including --backend. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
44 lines
1.5 KiB
ReStructuredText
44 lines
1.5 KiB
ReStructuredText
General
|
|
-------
|
|
|
|
Borg consists of a number of commands. Each command accepts
|
|
a number of arguments and options and interprets various environment variables.
|
|
The following sections will describe each command in detail.
|
|
|
|
Commands, options, parameters, paths, and similar elements are shown in ``fixed-width``.
|
|
Option values are underlined. Borg has a few options that accept a fixed set
|
|
of values (e.g., ``--encryption`` of :ref:`borg_repo-create`).
|
|
|
|
.. container:: experimental
|
|
|
|
Experimental features are marked with red stripes on the sides, like this paragraph.
|
|
|
|
Experimental features are not stable, which means that they may be changed in incompatible
|
|
ways or even removed entirely without prior notice in following releases.
|
|
|
|
.. include:: usage_general.rst.inc
|
|
|
|
If you are interested in more details (such as formulas), see
|
|
:ref:`internals`. For details on the available JSON output, refer to
|
|
:ref:`json_output`.
|
|
|
|
.. _common_options:
|
|
|
|
Common options
|
|
~~~~~~~~~~~~~~
|
|
|
|
All Borg commands share these options:
|
|
|
|
.. include:: common-options.rst.inc
|
|
|
|
Option ``--help`` when used as a command works as expected on subcommands (e.g., ``borg help compact``).
|
|
But it does not work when the help command is used on sub-sub-commands (e.g., ``borg help key export``).
|
|
The workaround for this is to use the help command as a flag (e.g., ``borg key export --help``).
|
|
|
|
Examples
|
|
~~~~~~~~
|
|
::
|
|
|
|
# Create an archive and log: borg version, files list, return code
|
|
$ borg -r /path/to/repo create --show-version --list --show-rc my-files files
|
|
|