upstream/borgbackup
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2026-06-09 08:51:54 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Merge pull request #1271 from ThomasWaldmann/autogenerated-hint

Browse source 
auto-generated hint, fixes #1250
This commit is contained in:
TW 2016-07-06 00:22:32 +02:00 committed by GitHub
commit e825f170f2
21 changed files with 87 additions and 43 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/usage/break-lock.rst.inc
View file

@ -1,3 +1,5 @@
.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
.. _borg_break-lock:
borg break-lock

2
docs/usage/change-passphrase.rst.inc
View file

@ -1,3 +1,5 @@
.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
.. _borg_change-passphrase:
borg change-passphrase

2
docs/usage/check.rst.inc
View file

@ -1,3 +1,5 @@
.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
.. _borg_check:
borg check

10
docs/usage/create.rst.inc
View file

@ -1,3 +1,5 @@
.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
.. _borg_create:
borg create
@ -70,10 +72,10 @@ borg create
compression (default), lz4 == lz4, zlib == zlib
(default level 6), zlib,0 .. zlib,9 == zlib (with
level 0..9), lzma == lzma (default level 6), lzma,0 ..
lzma,6 == lzma (with level 0..6. levels above 6 do not
improve compression and only waste many cpu cycles)
--read-special open and read special files as if they were regular
files
lzma,9 == lzma (with level 0..9).
--read-special open and read block and char device files as well as
FIFOs as if they were regular files. Also follows
symlinks pointing to these kinds of files.
-n, --dry-run do not create a backup archive
Description

2
docs/usage/debug-delete-obj.rst.inc
View file

@ -1,3 +1,5 @@
.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
.. _borg_debug-delete-obj:
borg debug-delete-obj

2
docs/usage/debug-dump-archive-items.rst.inc
View file

@ -1,3 +1,5 @@
.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
.. _borg_debug-dump-archive-items:
borg debug-dump-archive-items

2
docs/usage/debug-get-obj.rst.inc
View file

@ -1,3 +1,5 @@
.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
.. _borg_debug-get-obj:
borg debug-get-obj

2
docs/usage/debug-put-obj.rst.inc
View file

@ -1,3 +1,5 @@
.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
.. _borg_debug-put-obj:
borg debug-put-obj

6
docs/usage/delete.rst.inc
View file

@ -1,3 +1,5 @@
.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
.. _borg_delete:
borg delete
@ -6,7 +8,8 @@ borg delete
usage: borg delete [-h] [--critical] [--error] [--warning] [--info] [--debug]
[--lock-wait N] [--show-rc] [--no-files-cache] [--umask M]
[--remote-path PATH] [-p] [-s] [-c] [--save-space]
[--remote-path PATH] [-p] [-s] [-c] [--force]
[--save-space]
[TARGET]
Delete an existing repository or archive
@ -31,6 +34,7 @@ borg delete
-p, --progress show progress display while deleting a single archive
-s, --stats print statistics for the deleted archive
-c, --cache-only delete only the local cache for the given repository
--force force deletion of corrupted archives
--save-space work slower, but using less space
Description

2
docs/usage/extract.rst.inc
View file

@ -1,3 +1,5 @@
.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
.. _borg_extract:
borg extract

76
docs/usage/help.rst.inc
View file

@ -1,41 +1,5 @@
.. _borg_placeholders:
.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
borg help placeholders
~~~~~~~~~~~~~~~~~~~~~~
::
Repository (or Archive) URLs and --prefix values support these placeholders:
{hostname}
The (short) hostname of the machine.
{fqdn}
The full name of the machine.
{now}
The current local date and time.
{utcnow}
The current UTC date and time.
{user}
The user name (or UID, if no name is available) of the user running borg.
{pid}
The current process ID.
Examples::
borg create /path/to/repo::{hostname}-{user}-{utcnow} ...
borg create /path/to/repo::{hostname}-{now:%Y-%m-%d_%H:%M:%S} ...
borg prune --prefix '{hostname}-' ...
.. _borg_patterns:
borg help patterns
@ -129,3 +93,41 @@ Examples::
sh:/home/*/.thumbnails
EOF
$ borg create --exclude-from exclude.txt backup /
.. _borg_placeholders:
borg help placeholders
~~~~~~~~~~~~~~~~~~~~~~
::
Repository (or Archive) URLs and --prefix values support these placeholders:
{hostname}
The (short) hostname of the machine.
{fqdn}
The full name of the machine.
{now}
The current local date and time.
{utcnow}
The current UTC date and time.
{user}
The user name (or UID, if no name is available) of the user running borg.
{pid}
The current process ID.
Examples::
borg create /path/to/repo::{hostname}-{user}-{utcnow} ...
borg create /path/to/repo::{hostname}-{now:%Y-%m-%d_%H:%M:%S} ...
borg prune --prefix '{hostname}-' ...

2
docs/usage/info.rst.inc
View file

@ -1,3 +1,5 @@
.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
.. _borg_info:
borg info

2
docs/usage/init.rst.inc
View file

@ -1,3 +1,5 @@
.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
.. _borg_init:
borg init

2
docs/usage/list.rst.inc
View file

@ -1,3 +1,5 @@
.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
.. _borg_list:
borg list

2
docs/usage/migrate-to-repokey.rst.inc
View file

@ -1,3 +1,5 @@
.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
.. _borg_migrate-to-repokey:
borg migrate-to-repokey

2
docs/usage/mount.rst.inc
View file

@ -1,3 +1,5 @@
.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
.. _borg_mount:
borg mount

5
docs/usage/prune.rst.inc
View file

@ -1,3 +1,5 @@
.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
.. _borg_prune:
borg prune
@ -6,7 +8,7 @@ borg prune
usage: borg prune [-h] [--critical] [--error] [--warning] [--info] [--debug]
[--lock-wait N] [--show-rc] [--no-files-cache] [--umask M]
[--remote-path PATH] [-n] [-s] [--list]
[--remote-path PATH] [-n] [--force] [-s] [--list]
[--keep-within WITHIN] [-H HOURLY] [-d DAILY] [-w WEEKLY]
[-m MONTHLY] [-y YEARLY] [-P PREFIX] [--save-space]
[REPOSITORY]
@ -31,6 +33,7 @@ borg prune
--umask M set umask to M (local and remote, default: 0077)
--remote-path PATH set remote path to executable (default: "borg")
-n, --dry-run do not change repository
--force force pruning of corrupted archives
-s, --stats print statistics for the deleted archive
--list output verbose list of archives it keeps/prunes
--keep-within WITHIN keep all archives within this time interval

2
docs/usage/rename.rst.inc
View file

@ -1,3 +1,5 @@
.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
.. _borg_rename:
borg rename

2
docs/usage/serve.rst.inc
View file

@ -1,3 +1,5 @@
.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
.. _borg_serve:
borg serve

2
docs/usage/upgrade.rst.inc
View file

@ -1,3 +1,5 @@
.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
.. _borg_upgrade:
borg upgrade

1
setup.py
View file

@ -163,6 +163,7 @@ class build_usage(Command):
for command, parser in choices.items():
print('generating help for %s' % command)
with open('docs/usage/%s.rst.inc' % command, 'w') as doc:
doc.write(".. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!\n\n")
if command == 'help':
for topic in Archiver.helptext:
params = {"topic": topic,