From 93f5feff0edd9a993b652b9fddeceb3eacae0955 Mon Sep 17 00:00:00 2001
From: Dietmar Maurer <dietmar@proxmox.com>
Date: Thu, 23 Feb 2017 10:41:04 +0100
Subject: [PATCH] pmgsh.adoc: new manual page

---
 Makefile                |  2 +-
 pmg-admin-guide.adoc    | 14 ++++----
 pmg-doc-generator.mk.in | 10 ++++++
 pmgsh.adoc              | 73 +++++++++++++++++++++++++++++++++++++++++
 4 files changed, 92 insertions(+), 7 deletions(-)
 create mode 100644 pmgsh.adoc

diff --git a/Makefile b/Makefile
index 37701e6..1ea3c4e 100644
--- a/Makefile
+++ b/Makefile
@@ -193,7 +193,7 @@ clean:
 	find . -name '*~' -exec rm {} ';'
 	rm -rf *.html *.pdf *.epub *.tmp *.1 *.5 *.8
 	rm -f *.deb *.changes *.buildinfo
-	rm -f api-viewer/apidoc.js chapter-*.html *-plain.html chapter-*.html pmg-admin-guide.chunked asciidoc-pmg link-refs.json .asciidoc-pmg-tmp_* pmg-smtp-filter.8-synopsis.adoc pmgpolicy.8-synopsis.adoc
+	rm -f api-viewer/apidoc.js chapter-*.html *-plain.html chapter-*.html pmg-admin-guide.chunked asciidoc-pmg link-refs.json .asciidoc-pmg-tmp_* pmg-smtp-filter.8-synopsis.adoc pmgpolicy.8-synopsis.adoc pmgsh.1-synopsis.adoc
 	rm -rf .pmg-doc-depends 
 	rm -f pmg-doc-generator.mk chapter-index-table.adoc man1-index-table.adoc man5-index-table.adoc man8-index-table.adoc pmg-admin-guide-docinfo.xml
 	rm -rf build-*
diff --git a/pmg-admin-guide.adoc b/pmg-admin-guide.adoc
index 87f68c7..a241875 100644
--- a/pmg-admin-guide.adoc
+++ b/pmg-admin-guide.adoc
@@ -27,8 +27,6 @@ include::pmg-planning-deployment.adoc[]
 
 include::pmgconfig.adoc[]
 
-include::pmgdb.adoc[]
-
 // Return to normal title levels.
 :leveloffset: 0
 
@@ -70,10 +68,10 @@ include::pmgpolicy.adoc[]
 Useful Command Line Tools
 -------------------------
 
-TODO
-
 :leveloffset: 2
-//include::pveceph.adoc[]
+include::pmgdb.adoc[]
+
+include::pmgsh.adoc[]
 
 :leveloffset: 0
 
@@ -84,7 +82,11 @@ Command Line Interface
 *pmgsh* - API Shell
 ~~~~~~~~~~~~~~~~~~~
 
-TODO
+:leveloffset: 1
+include::pmgsh.1-synopsis.adoc[]
+
+:leveloffset: 0
+
 
 *pmgconfig* - Configuration Management Toolkit
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/pmg-doc-generator.mk.in b/pmg-doc-generator.mk.in
index 28fd091..eef5d82 100644
--- a/pmg-doc-generator.mk.in
+++ b/pmg-doc-generator.mk.in
@@ -14,6 +14,16 @@ PMG_COMMON_DOC_SOURCES=                 \
 
 all:
 
+pmgsh.1-synopsis.adoc:
+	@echo 'Interactive session:' >$@.tmp
+	@echo '' >>$@.tmp
+	@echo '*pmgsh*' >>$@.tmp
+	@echo '' >>$@.tmp
+	@echo 'Directly call API functions:' >>$@.tmp
+	@echo '' >>$@.tmp
+	@echo '*pmgsh* `(get|set|create|help)` `<path>` `[OPTIONS]`' >>$@.tmp
+	mv $@.tmp $@
+
 pmg-smtp-filter.8-synopsis.adoc:
 	@echo 'Please use systemd tools to manage this service.' >$@.tmp
 	@echo '' >>$@.tmp
diff --git a/pmgsh.adoc b/pmgsh.adoc
new file mode 100644
index 0000000..4e44486
--- /dev/null
+++ b/pmgsh.adoc
@@ -0,0 +1,73 @@
+[[chapter_pmgsh]]
+ifdef::manvolnum[]
+pmgsh(1)
+========
+:pmg-toplevel:
+
+NAME
+----
+
+pmgsh - Proxmox Mail Gateway API Shell
+
+
+SYNOPSIS
+--------
+
+include::pmgsh.1-synopsis.adoc[]
+
+
+DESCRIPTION
+-----------
+endif::manvolnum[]
+ifndef::manvolnum[]
+API Shell
+=========
+:pmg-toplevel:
+endif::manvolnum[]
+
+Toolkit to access the Proxmox Mail Gateway API via the command line.
+
+Examples
+--------
+
+List entries:
+
+----
+# pmgsh ls /
+----
+
+Call method 'GET' on an specific API path:
+
+----
+# pmgsh get /version
+----
+
+View current mail configuration:
+
+----
+# pmgsh get /config/mail
+----
+
+Get help for a specific path:
+
+----
+# pmgsh help /config/mail  -v
+----
+
+Disable option 'spf' in '/config/mail'
+
+----
+# pmgsh set /config/mail  -spf 0
+----
+
+Delete spf setting from '/config/mail'
+
+----
+# pmgsh set /config/mail  -delete spf
+----
+
+
+ifdef::manvolnum[]
+include::pmg-copyright.adoc[]
+endif::manvolnum[]
+