Proxmox/proxmox-backup
5
0
Fork 0
mirror of git://git.proxmox.com/git/proxmox-backup.git synced 2025-01-08 21:18:07 +03:00
Code Releases Activity
b1b6489233
proxmox-backup/docs/proxmox-file-restore/man1.rst

18 lines
210 B
ReStructuredText
Raw Normal View History

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 10:08:03 +03: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 17:41:43 +03:00
====================
file-restore: add binary and basic commands For now it only supports 'list' and 'extract' commands for 'pxar.didx' files. This should be the foundation for a general file-restore interface that is shared with block-level snapshots. This is packaged as a seperate .deb file, since for block level restore it will need to depend on pve-qemu-kvm, which we want to seperate from proxmox-backup-client. [original code for proxmox-file-restore.rs] Signed-off-by: Dominik Csapak <d.csapak@proxmox.com> [code cleanups/clippy, use helpers::list_dir_content/ArchiveEntry, no /block subdir for .fidx files, seperate binary and package] Signed-off-by: Stefan Reiter <s.reiter@proxmox.com>
2021-03-31 13:21:48 +03:00
proxmox-file-restore
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 17:41:43 +03:00
====================
file-restore: add binary and basic commands For now it only supports 'list' and 'extract' commands for 'pxar.didx' files. This should be the foundation for a general file-restore interface that is shared with block-level snapshots. This is packaged as a seperate .deb file, since for block level restore it will need to depend on pve-qemu-kvm, which we want to seperate from proxmox-backup-client. [original code for proxmox-file-restore.rs] Signed-off-by: Dominik Csapak <d.csapak@proxmox.com> [code cleanups/clippy, use helpers::list_dir_content/ArchiveEntry, no /block subdir for .fidx files, seperate binary and package] Signed-off-by: Stefan Reiter <s.reiter@proxmox.com>
2021-03-31 13:21:48 +03:00
Synopsis
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 17:41:43 +03:00
========
file-restore: add binary and basic commands For now it only supports 'list' and 'extract' commands for 'pxar.didx' files. This should be the foundation for a general file-restore interface that is shared with block-level snapshots. This is packaged as a seperate .deb file, since for block level restore it will need to depend on pve-qemu-kvm, which we want to seperate from proxmox-backup-client. [original code for proxmox-file-restore.rs] Signed-off-by: Dominik Csapak <d.csapak@proxmox.com> [code cleanups/clippy, use helpers::list_dir_content/ArchiveEntry, no /block subdir for .fidx files, seperate binary and package] Signed-off-by: Stefan Reiter <s.reiter@proxmox.com>
2021-03-31 13:21:48 +03:00
.. include:: synopsis.rst
Description
============
.. include:: description.rst
.. include:: ../pbs-copyright.rst
Copy Permalink