Qubes/core-admin-client
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
e64bd839a5
core-admin-client/doc/manpages/qvm-backup.rst

82 lines
2.0 KiB
ReStructuredText
Raw Normal View History

doc: import man pages Most of them are moved from core-admin repository, even if tool is not implemented yet. Some are generated using skel-manpage.py script. This way we have complete man pages list, and sphinx will properly warn/error about inconsistencies.
2017-05-11 20:20:55 +02:00
.. program:: qvm-backup
:program:`qvm-backup` -- Create a backup of Qubes
=================================================
Synopsis
--------
tools: add qvm-backup tool New qvm-backup tool can either use pre-existing backup profile (--profile), or - when running in dom0 - can create new one based on used options (--save-profile). This commit add a tool itself, update its man page, and add tests for it. Fixes QubesOS/qubes-issues#2931
2017-07-21 03:05:49 +02:00
:command:`qvm-backup` [-h] [--verbose] [--quiet] [--profile *PROFILE*] [--exclude EXCLUDE_LIST] [--dest-vm *APPVM*] [--encrypt] [--passphrase-file PASSPHRASE_FILE] [--compress] [--compress-filter *COMPRESSION*] [--save-profile SAVE_PROFILE] backup_location [vms [vms ...]]
doc: import man pages Most of them are moved from core-admin repository, even if tool is not implemented yet. Some are generated using skel-manpage.py script. This way we have complete man pages list, and sphinx will properly warn/error about inconsistencies.
2017-05-11 20:20:55 +02:00
Options
-------
tools: add qvm-backup tool New qvm-backup tool can either use pre-existing backup profile (--profile), or - when running in dom0 - can create new one based on used options (--save-profile). This commit add a tool itself, update its man page, and add tests for it. Fixes QubesOS/qubes-issues#2931
2017-07-21 03:05:49 +02:00
.. option:: --profile
Specify backup profile to use. This option is mutually exclusive with all
other options. This is also the only working mode when running from non-dom0.
.. option:: --save-profile
Save backup profile based on given options. This is possible only when
running in dom0. Otherwise, prepared profile is printed on standard output
and user needs to manually place it into /etc/qubes/backup in dom0.
doc: import man pages Most of them are moved from core-admin repository, even if tool is not implemented yet. Some are generated using skel-manpage.py script. This way we have complete man pages list, and sphinx will properly warn/error about inconsistencies.
2017-05-11 20:20:55 +02:00
.. option:: --help, -h
tools: add qvm-backup tool New qvm-backup tool can either use pre-existing backup profile (--profile), or - when running in dom0 - can create new one based on used options (--save-profile). This commit add a tool itself, update its man page, and add tests for it. Fixes QubesOS/qubes-issues#2931
2017-07-21 03:05:49 +02:00
show help message and exit
doc: import man pages Most of them are moved from core-admin repository, even if tool is not implemented yet. Some are generated using skel-manpage.py script. This way we have complete man pages list, and sphinx will properly warn/error about inconsistencies.
2017-05-11 20:20:55 +02:00
.. option:: --verbose, -v
increase verbosity
.. option:: --quiet, -q
decrease verbosity
.. option:: --exclude, -x
Exclude the specified VM from the backup (may be repeated)
.. option:: --dest-vm, -d
Specify the destination VM to which the backup will be sent (implies -e)
.. option:: --encrypt, -e
tools: add qvm-backup tool New qvm-backup tool can either use pre-existing backup profile (--profile), or - when running in dom0 - can create new one based on used options (--save-profile). This commit add a tool itself, update its man page, and add tests for it. Fixes QubesOS/qubes-issues#2931
2017-07-21 03:05:49 +02:00
Ignored, backup is always encrypted
doc: import man pages Most of them are moved from core-admin repository, even if tool is not implemented yet. Some are generated using skel-manpage.py script. This way we have complete man pages list, and sphinx will properly warn/error about inconsistencies.
2017-05-11 20:20:55 +02:00
.. option:: --passphrase-file, -p
Read passphrase from a file, or use '-' to read from stdin
.. option:: --compress, -z
Compress the backup
.. option:: --compress-filter, -Z
Specify a non-default compression filter program (default: gzip)
doc: update qvm-backup man page
2017-07-29 00:17:07 +02:00
.. option:: --yes, -y
Do not ask for confirmation
doc: import man pages Most of them are moved from core-admin repository, even if tool is not implemented yet. Some are generated using skel-manpage.py script. This way we have complete man pages list, and sphinx will properly warn/error about inconsistencies.
2017-05-11 20:20:55 +02:00
Arguments
---------
The first positional parameter is the backup location (directory path, or
command to pipe backup to). After that you may specify the qubes you'd like to
tools: add qvm-backup tool New qvm-backup tool can either use pre-existing backup profile (--profile), or - when running in dom0 - can create new one based on used options (--save-profile). This commit add a tool itself, update its man page, and add tests for it. Fixes QubesOS/qubes-issues#2931
2017-07-21 03:05:49 +02:00
backup. If not specified, all qubes are included.
doc: import man pages Most of them are moved from core-admin repository, even if tool is not implemented yet. Some are generated using skel-manpage.py script. This way we have complete man pages list, and sphinx will properly warn/error about inconsistencies.
2017-05-11 20:20:55 +02:00
Authors
-------
| Joanna Rutkowska <joanna at invisiblethingslab dot com>
| Rafal Wojtczuk <rafal at invisiblethingslab dot com>
| Marek Marczykowski <marmarek at invisiblethingslab dot com>
| Wojtek Porczyk <woju at invisiblethingslab dot com>
.. vim: ts=3 sw=3 et tw=80
Reference in New Issue Copy Permalink