1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-12-24 16:55:36 +00:00
borg/docs/usage/init.rst.inc
Antoine Beaupré 8e36075fe9 commit usage files directly into git
the generation of those files was causing us way too much pain to
justify automatically generating them all the time.

those will have to be re-generated with `build_api` or `build_usage`
as appropriate, for example when function signatures or commandline
flags change.

see #384
2015-11-13 10:42:52 -05:00

34 lines
1.3 KiB
HTML

.. _borg_init:
borg init
---------
::
usage: borg init [-h] [-v] [--show-rc] [--no-files-cache] [--umask M]
[--remote-path PATH] [-e {none,keyfile,repokey,passphrase}]
[REPOSITORY]
Initialize an empty repository
positional arguments:
REPOSITORY repository to create
optional arguments:
-h, --help show this help message and exit
-v, --verbose verbose output
--show-rc show/log the return code (rc)
--no-files-cache do not load/update the file metadata cache used to
detect unchanged files
--umask M set umask to M (local and remote, default: 63)
--remote-path PATH set remote path to executable (default: "borg")
-e {none,keyfile,repokey,passphrase}, --encryption {none,keyfile,repokey,passphrase}
select encryption key mode
Description
~~~~~~~~~~~
This command initializes an empty repository. A repository is a filesystem
directory containing the deduplicated data from zero or more archives.
Encryption can be enabled at repository init time.
Please note that the 'passphrase' encryption mode is DEPRECATED (instead of it,
consider using 'repokey').