proxmox-backup/docs/proxmox-backup-client/man1.rst

:orphan:

=====================
proxmox-backup-client
=====================

Synopsis
==========

.. include:: synopsis.rst

Catalog Shell Commands
======================

Those command are available when you start an intercative restore shell:

::

    proxmox-backup-client shell <snapshot> <name.pxar>


.. include:: catalog-shell-synopsis.rst


Common Options
==============

.. include:: ../output-format.rst


Description
============

.. include:: description.rst


.. include:: ../pbs-copyright.rst
docs: avoid orphan warnings for man-page skeletons Use the `:orphan:` special metadata field [0] to tell Sphinx that this file is expected to not be included in any TOC-tree. [0]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/field-lists.html#special-metadata-fields Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com> 2024-03-08 08:08:03 +01:00			`:orphan:`

docs: let sphinx build man pages for better integration and less cruft rst2man is only good for use in projects that don't use sphinx already, as there it can help to avoid bringing in the full sphinx dependencies and be easier to manage (as long as it stay small). But we already use sphinx, so there's no point in managing the manual pages in a separate, semi-related way that is quite restricted as we have no access to sphinx infrastructure like conf.py defined variables and helpers for things like the current version. Besides that, we're rather big, so the complexity of sphinx can shine, e.g., see the diffstat report from switching out rst2man for sphinx: 22 files changed, 74 insertions(+), 347 deletions(-) so 273 lines less in total is rather nice. Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com> 2022-07-14 16:41:43 +02:00			`=====================`
start generating manual pages Depend on docutils-doc 2019-02-24 09:51:10 +01:00			`proxmox-backup-client`
docs: let sphinx build man pages for better integration and less cruft rst2man is only good for use in projects that don't use sphinx already, as there it can help to avoid bringing in the full sphinx dependencies and be easier to manage (as long as it stay small). But we already use sphinx, so there's no point in managing the manual pages in a separate, semi-related way that is quite restricted as we have no access to sphinx infrastructure like conf.py defined variables and helpers for things like the current version. Besides that, we're rather big, so the complexity of sphinx can shine, e.g., see the diffstat report from switching out rst2man for sphinx: 22 files changed, 74 insertions(+), 347 deletions(-) so 273 lines less in total is rather nice. Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com> 2022-07-14 16:41:43 +02:00			`=====================`
start generating manual pages Depend on docutils-doc 2019-02-24 09:51:10 +01:00
			`Synopsis`
			`==========`

			`.. include:: synopsis.rst`

proxmox-backup-client/man1.rst: include catalog shell commands 2019-12-06 10:08:11 +01:00			`Catalog Shell Commands`
			`======================`

			`Those command are available when you start an intercative restore shell:`

			`::`

			`proxmox-backup-client shell <snapshot> <name.pxar>`


			`.. include:: catalog-shell-synopsis.rst`


docs: split out output-format.rst 2021-02-13 08:54:23 +01:00			`Common Options`
			`==============`

			`.. include:: ../output-format.rst`


start generating manual pages Depend on docutils-doc 2019-02-24 09:51:10 +01:00			`Description`
			`============`

			`.. include:: description.rst`


			`.. include:: ../pbs-copyright.rst`