]> git.proxmox.com Git - proxmox-backup.git/blob - docs/command-syntax.rst
docs: add documentation about the 'sync-level' tuning
[proxmox-backup.git] / docs / command-syntax.rst
1 Command Syntax
2 ==============
3
4 .. NOTE:: Logging verbosity for the command line tools can be controlled with the
5 ``PBS_LOG`` (for ``pxar``: ``PXAR_LOG``) environment variable. Possible values are `off`,
6 `error`, `warn`, `info`, `debug` and `trace` with `info` being the default.
7
8 ``proxmox-backup-client``
9 -------------------------
10
11 .. include:: proxmox-backup-client/synopsis.rst
12
13
14 Catalog Shell Commands
15 ~~~~~~~~~~~~~~~~~~~~~~
16
17 The following commands are available in an interactive restore shell:
18
19 .. code-block:: console
20
21 proxmox-backup-client shell <snapshot> <name.pxar>
22
23
24 .. include:: proxmox-backup-client/catalog-shell-synopsis.rst
25
26
27 ``proxmox-backup-manager``
28 --------------------------
29
30 .. include:: proxmox-backup-manager/synopsis.rst
31
32
33 ``proxmox-tape``
34 ----------------
35
36 .. include:: proxmox-tape/synopsis.rst
37
38 ``pmt``
39 -------
40
41 .. include:: pmt/options.rst
42
43 ....
44
45 .. include:: pmt/synopsis.rst
46
47
48 ``pmtx``
49 --------
50
51 .. include:: pmtx/synopsis.rst
52
53
54 ``pxar``
55 --------
56
57 .. include:: pxar/synopsis.rst
58
59
60 ``proxmox-file-restore``
61 ------------------------
62 .. include:: proxmox-file-restore/synopsis.rst
63
64
65 ``proxmox-backup-debug``
66 ------------------------
67 .. include:: proxmox-backup-debug/synopsis.rst