pbs2to3: add manual page

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

diff --git a/debian/proxmox-backup-server.install b/debian/proxmox-backup-server.install
index 58d5ba1b8fcb29a3d40f3d9c8163b19f8f285d6c..61920f4e856c6aa670d0ddaf4e48b908c476896d 100644 (file)
--- a/debian/proxmox-backup-server.install
+++ b/debian/proxmox-backup-server.install
@@ -25,6 +25,7 @@ usr/share/man/man1/proxmox-backup-proxy.1
 usr/share/man/man1/proxmox-tape.1
 usr/share/man/man1/pmtx.1
 usr/share/man/man1/pmt.1
+usr/share/man/man1/pbs2to3.1
 usr/share/man/man5/acl.cfg.5
 usr/share/man/man5/datastore.cfg.5
 usr/share/man/man5/domains.cfg.5

diff --git a/docs/Makefile b/docs/Makefile
index b06badffd6724d7c16aa9435590009c90e7d6458..0d0963f3b4213d9baa601f4c5de2ca51407437c0 100644 (file)
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -30,7 +30,8 @@ MAN1_PAGES :=                                 \
        proxmox-backup-client.1         \
        proxmox-backup-manager.1        \
        proxmox-file-restore.1          \
-       proxmox-backup-debug.1
+       proxmox-backup-debug.1          \
+       pbs2to3.1                       \
 
 MAN5_PAGES :=                          \
        media-pool.cfg.5                \

diff --git a/docs/conf.py b/docs/conf.py
index 8944926e2ac66efacc2805a8afb5a8b0935180a5..f7e7c54de8c73d2836e190dc9fb4dfc51950f885 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -102,6 +102,7 @@ man_pages = [
     ('pxar/man1', 'pxar', 'Proxmox File Archive CLI Tool', [author], 1),
     ('pmt/man1', 'pmt', 'Control Linux Tape Devices', [author], 1),
     ('pmtx/man1', 'pmtx', 'Control SCSI media changer devices (tape autoloaders)', [author], 1),
+    ('pbs2to3/man1', 'pbs2to3', 'Proxmox Backup Server upgrade checker script for 2.4+ to current 3.x major upgrades', [author], 1),
     # configs
     ('config/acl/man5', 'acl.cfg', 'Access Control Configuration', [author], 5),
     ('config/datastore/man5', 'datastore.cfg', 'Datastore Configuration', [author], 5),

diff --git a/docs/pbs2to3/man1.rst b/docs/pbs2to3/man1.rst
new file mode 100644 (file)
index 0000000..d6a14b9
--- /dev/null
+++ b/docs/pbs2to3/man1.rst
@@ -0,0 +1,14 @@
+
+=======
+pbs2to3
+=======
+
+Description
+===========
+
+This tool will help you to detect common pitfalls and misconfguration before,
+and during the upgrade of a Proxmox VE system Any failure must be addressed
+before the upgrade, and any waring must be addressed, or at least carefully
+evaluated, if a false-positive is suspected
+
+.. include:: ../pbs-copyright.rst