zvault/docs/man/zvault-init.1.md

97 lines
2.1 KiB
Markdown
Raw Normal View History

2017-04-05 14:02:16 +00:00
zvault-init(1) -- Initialize a new repository
=============================================
## SYNOPSIS
2017-04-07 16:57:49 +00:00
`zvault init [OPTIONS] --remote <REMOTE> <REPO>`
2017-04-05 14:02:16 +00:00
## DESCRIPTION
2017-04-07 16:57:49 +00:00
This subcommand initializes a new repository at the location `REPO`. It is
important that the path given as `REPO` does not yet exist, so that it can be
created.
2017-04-05 14:02:16 +00:00
The remote storage path `REMOTE` must be an existing empty folder. ZVault
supports mounted remote filesystems, so it is a good idea to use such a folder
to keep the backups on a remote location.
This subcommand should **NOT** be used to import existing remote backup
locations. Please use _zvault-import(1)_ for this purpose.
The rest of the options sets configuration options for the new repository. The
configuration can be changed by _zvault-config(1)_ later.
## OPTIONS
* `--bundle-size <SIZE>`:
2017-04-05 14:02:16 +00:00
Set the target bundle size in MiB (default: 25).
Please see zvault(1) for more information on *bundle size*.
2017-04-05 14:02:16 +00:00
* `--chunker <CHUNKER>`:
2017-04-05 14:02:16 +00:00
Set the chunker algorithm and target chunk size (default: fastcdc/16).
Please see _zvault(1)_ for more information on *chunkers* and possible
values.
2017-04-05 14:02:16 +00:00
* `-c`, `--compression <COMPRESSION>`:
2017-04-05 14:02:16 +00:00
Set the compression method and level (default: brotli/3).
Please see _zvault(1)_ for more information on *compression* and possible
values.
2017-04-05 14:02:16 +00:00
* `-e`, `--encrypt`:
2017-04-05 14:02:16 +00:00
Generate a keypair and enable encryption.
Please see _zvault(1)_ for more information on *encryption*.
2017-04-05 14:02:16 +00:00
* `--hash <HASH>`:
2017-04-05 14:02:16 +00:00
Set the hash method (default: blake2).
Please see _zvault(1)_ for more information on *hash methods* and possible
values.
2017-04-05 14:02:16 +00:00
* `-h`, `--help`:
2017-04-05 14:02:16 +00:00
Prints help information
2017-04-05 14:02:16 +00:00
* `-r`, `--remote <REMOTE>`:
Set the path to the mounted remote storage. There should be an empty folder
at this location.
* `-q`, `--quiet`:
Print less information
* `-v`, `--verbose`:
Print more information
* `-h`, `--help`:
Prints help information
* `-V`, `--version`:
Prints version information
2017-04-05 14:02:16 +00:00
## COPYRIGHT
Copyright (C) 2017 Dennis Schwerdel
This software is licensed under GPL-3 or newer (see LICENSE.md)