proxmox-mirrors/pmg-docs
1
0
Fork 0
mirror of https://git.proxmox.com/git/pmg-docs synced 2025-05-30 00:57:55 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

pmgsh.adoc: new manual page

Browse Source
This commit is contained in:
Dietmar Maurer 2017-02-23 10:41:04 +01:00
parent 17f6628412
commit 93f5feff0e
4 changed files with 92 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile
View File

@ -193,7 +193,7 @@ clean:
find . -name '*~' -exec rm {} ';' find . -name '*~' -exec rm {} ';'
rm -rf *.html *.pdf *.epub *.tmp *.1 *.5 *.8 rm -rf *.html *.pdf *.epub *.tmp *.1 *.5 *.8
rm -f *.deb *.changes *.buildinfo 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 -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 -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-* rm -rf build-*

14
pmg-admin-guide.adoc
View File

@ -27,8 +27,6 @@ include::pmg-planning-deployment.adoc[]
include::pmgconfig.adoc[] include::pmgconfig.adoc[]
include::pmgdb.adoc[]
// Return to normal title levels. // Return to normal title levels.
:leveloffset: 0 :leveloffset: 0
@ -70,10 +68,10 @@ include::pmgpolicy.adoc[]
Useful Command Line Tools Useful Command Line Tools
------------------------- -------------------------
TODO
:leveloffset: 2 :leveloffset: 2
//include::pveceph.adoc[] include::pmgdb.adoc[]
include::pmgsh.adoc[]
:leveloffset: 0 :leveloffset: 0
@ -84,7 +82,11 @@ Command Line Interface
*pmgsh* - API Shell *pmgsh* - API Shell
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~
TODO :leveloffset: 1
include::pmgsh.1-synopsis.adoc[]
:leveloffset: 0
*pmgconfig* - Configuration Management Toolkit *pmgconfig* - Configuration Management Toolkit
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

10
pmg-doc-generator.mk.in
View File

@ -14,6 +14,16 @@ PMG_COMMON_DOC_SOURCES= \
all: 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: pmg-smtp-filter.8-synopsis.adoc:
@echo 'Please use systemd tools to manage this service.' >$@.tmp @echo 'Please use systemd tools to manage this service.' >$@.tmp
@echo '' >>$@.tmp @echo '' >>$@.tmp

73
pmgsh.adoc Normal file
View File

@ -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[]