tsarevvv/proxmox-backup
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
proxmox-backup/docs/command-syntax.rst

68 lines
1.2 KiB
ReStructuredText
Raw Normal View History

build doc with sphinx
2019-02-27 17:42:31 +01:00
Command Syntax
==============
fix spelling of command line/command-line "Commandline", "command line" & "command-line" were being used interchangeably, which is not correct use command-line when it is an adjective (e.g. "command-line interface") and use command line when it is a noun (e.g. "change the setting from the command line") Signed-off-by: Noel Ullreich <n.ullreich@proxmox.com> [T: fix typos in commit message and reflow ] Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-06-27 14:40:08 +02:00
.. NOTE:: Logging verbosity for the command-line tools can be controlled with the
docs: add note for setting verbosity level Signed-off-by: Hannes Laimer <h.laimer@proxmox.com> Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
2022-06-15 08:19:56 +00:00
``PBS_LOG`` (for ``pxar``: ``PXAR_LOG``) environment variable. Possible values are `off`,
`error`, `warn`, `info`, `debug` and `trace` with `info` being the default.
build doc with sphinx
2019-02-27 17:42:31 +01:00
``proxmox-backup-client``
docs/command-syntax.rst: include catalog-shell-synopsis.rst
2019-12-06 13:46:02 +01:00
-------------------------
build doc with sphinx
2019-02-27 17:42:31 +01:00
.. include:: proxmox-backup-client/synopsis.rst
docs/command-syntax.rst: include catalog-shell-synopsis.rst
2019-12-06 13:46:02 +01:00
Catalog Shell Commands
~~~~~~~~~~~~~~~~~~~~~~
docs: language fixup: faq and appendix minor formatting and language fixes to the faq section and the appendix Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
2021-10-27 16:19:27 +02:00
The following commands are available in an interactive restore shell:
docs/command-syntax.rst: include catalog-shell-synopsis.rst
2019-12-06 13:46:02 +01:00
.. code-block:: console
proxmox-backup-client shell <snapshot> <name.pxar>
.. include:: proxmox-backup-client/catalog-shell-synopsis.rst
add manual page for proxmox-backup-manager
2019-11-11 09:14:18 +01:00
``proxmox-backup-manager``
docs/command-syntax.rst: include catalog-shell-synopsis.rst
2019-12-06 13:46:02 +01:00
--------------------------
add manual page for proxmox-backup-manager
2019-11-11 09:14:18 +01:00
.. include:: proxmox-backup-manager/synopsis.rst
docs/command-syntax.rst: include catalog-shell-synopsis.rst
2019-12-06 13:46:02 +01:00
docs: move tape config/syntax to appendix
2021-04-14 14:14:30 +02:00
``proxmox-tape``
----------------
.. include:: proxmox-tape/synopsis.rst
``pmt``
-------
.. include:: pmt/options.rst
....
.. include:: pmt/synopsis.rst
``pmtx``
--------
.. include:: pmtx/synopsis.rst
docs: add backup reader protocol
2019-11-22 06:59:37 +01:00
``pxar``
docs/command-syntax.rst: include catalog-shell-synopsis.rst
2019-12-06 13:46:02 +01:00
--------
docs: add backup reader protocol
2019-11-22 06:59:37 +01:00
.. include:: pxar/synopsis.rst
docs: cleanup and readd command-line-tools the collection of descriptions of our cli tools was dropped in 04e24b14f0c51f01a1f8afe2d0eff124c1095758 I'll readd it to the sysadmin.rst, since the (related) service daemons also got moved here. additionally add the newly added cli-tools to both command-line-tools.rst and command-syntax.rst, and put both in the same order Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2022-05-16 16:27:29 +00:00
``proxmox-file-restore``
------------------------
.. include:: proxmox-file-restore/synopsis.rst
``proxmox-backup-debug``
------------------------
.. include:: proxmox-backup-debug/synopsis.rst
Reference in New Issue Copy Permalink