proxmox-backup/docs/proxmox-backup-proxy/description.rst
Thomas Lamprecht ed873dc6a4 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:54:56 +02:00

5 lines
240 B
ReStructuredText

This daemon exposes the whole Proxmox Backup Server API on TCP port 8007 using
HTTPS. It runs as user ``backup`` and has very limited permissions. Operations
requiring more permissions are forwarded to the local ``proxmox-backup``
service.