[pbs-devel] [PATCH proxmox-backup] docs: describe the intend for the statically linked pbs client

Christian Ebner c.ebner at proxmox.com
Thu Apr 10 11:30:59 CEST 2025


Discurage the use of the statically linked binary for systems where
the regular one is available.

Moves the previous note into it's own section and link to the
installation section.

Signed-off-by: Christian Ebner <c.ebner at proxmox.com>
---
Note: This was not properly tested because my current build system
(laptop) just takes ages to build but I didn't want to wait longer
before sending this. So please shout at me if this breaks something.

 docs/backup-client.rst | 20 +++++++++++++++-----
 1 file changed, 15 insertions(+), 5 deletions(-)

diff --git a/docs/backup-client.rst b/docs/backup-client.rst
index bb79c3ddb..40962f0e2 100644
--- a/docs/backup-client.rst
+++ b/docs/backup-client.rst
@@ -46,11 +46,21 @@ user\@pbs!token at host:store       ``user at pbs!token`` host:8007          store
 [ff80::51]:1234:mydatastore      ``root at pam``       [ff80::51]:1234    mydatastore
 ================================ ================== ================== ===========
 
-.. Note:: If you are using the statically linked binary of proxmox backup client
-   name resolution will not be performed via the mechanisms provided by libc,
-   but uses a resolver written purely in the Rust programming language.
-   Therefore, features and modules provided by Name Service Switch cannot be
-   used.
+.. _statically_linked_client:
+
+Statically Linked Backup Client
+-------------------------------
+
+A statically linked version of the Proxmox Backup client is available for Linux
+based systems where the regular client is not available. Please note that it is
+recommended to use the regular client when possible, as the statically linked
+client is not a full replacement. For example, name resolution will not be
+performed via the mechanisms provided by libc, but uses a resolver written
+purely in the Rust programming language. Therefore, features and modules
+provided by Name Service Switch cannot be used.
+
+The statically linked client is available via the ``pbs-client`` repository as
+described in the :ref:`installation <install_pbc>` section.
 
 .. _environment-variables:
 
-- 
2.39.5





More information about the pbs-devel mailing list