From 4bf0cc3b41a62e19a9934732783ff058c57293e7 Mon Sep 17 00:00:00 2001
From: Dietmar Maurer <dietmar@proxmox.com>
Date: Fri, 6 Dec 2019 10:08:11 +0100
Subject: [PATCH] proxmox-backup-client/man1.rst: include catalog shell
 commands

---
 docs/Makefile                       | 15 ++++++++++-----
 docs/proxmox-backup-client/man1.rst | 14 +++++++++++++-
 2 files changed, 23 insertions(+), 6 deletions(-)

diff --git a/docs/Makefile b/docs/Makefile
index e290b5e4..e7493987 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -6,10 +6,12 @@ else
 COMPILEDIR := ../target/debug
 endif
 
-GENERATED_SYNOPSIS := 				\
-	proxmox-backup-client/synopsis.rst	\
-	proxmox-backup-manager/synopsis.rst	\
-	backup-protocol-api.rst			\
+GENERATED_SYNOPSIS := 						\
+	proxmox-backup-client/synopsis.rst			\
+	proxmox-backup-client/catalog-shell-synopsis.rst 	\
+	proxmox-backup-manager/synopsis.rst			\
+	pxar/synopsis.rst					\
+	backup-protocol-api.rst					\
 	reader-protocol-api.rst
 
 MANUAL_PAGES := 			\
@@ -48,7 +50,10 @@ pxar.1: pxar/man1.rst  pxar/description.rst pxar/synopsis.rst
 proxmox-backup-client/synopsis.rst: ${COMPILEDIR}/proxmox-backup-client
 	${COMPILEDIR}/proxmox-backup-client printdoc > proxmox-backup-client/synopsis.rst
 
-proxmox-backup-client.1: proxmox-backup-client/man1.rst  proxmox-backup-client/description.rst proxmox-backup-client/synopsis.rst
+proxmox-backup-client/catalog-shell-synopsis.rst: ${COMPILEDIR}/dump-catalog-shell-cli
+	${COMPILEDIR}/dump-catalog-shell-cli > proxmox-backup-client/catalog-shell-synopsis.rst
+
+proxmox-backup-client.1: proxmox-backup-client/man1.rst  proxmox-backup-client/description.rst proxmox-backup-client/synopsis.rst  proxmox-backup-client/catalog-shell-synopsis.rst
 	rst2man $< >$@
 
 proxmox-backup-manager/synopsis.rst: ${COMPILEDIR}/proxmox-backup-manager
diff --git a/docs/proxmox-backup-client/man1.rst b/docs/proxmox-backup-client/man1.rst
index e2120e9a..f303d0b3 100644
--- a/docs/proxmox-backup-client/man1.rst
+++ b/docs/proxmox-backup-client/man1.rst
@@ -18,6 +18,19 @@ 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
+
+
 Description
 ============
 
@@ -25,4 +38,3 @@ Description
 
 
 .. include:: ../pbs-copyright.rst
-