X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=pmgsh.adoc;h=0424f14590ebb6542e60453b82e3d8b05b800792;hb=c901e5bde89ef1965c90b6fce27844d57f453a27;hp=4e444868b436b24189add93acead4cea6b99a753;hpb=93f5feff0edd9a993b652b9fddeceb3eacae0955;p=pmg-docs.git diff --git a/pmgsh.adoc b/pmgsh.adoc index 4e44486..0424f14 100644 --- a/pmgsh.adoc +++ b/pmgsh.adoc @@ -20,15 +20,14 @@ DESCRIPTION ----------- endif::manvolnum[] ifndef::manvolnum[] -API Shell -========= +pmgsh - API Shell +================= :pmg-toplevel: endif::manvolnum[] -Toolkit to access the Proxmox Mail Gateway API via the command line. +The `pmgsh` tool can be used to access the {pmg} API via the command line. -Examples --------- +.Examples List entries: @@ -60,7 +59,7 @@ Disable option 'spf' in '/config/mail' # pmgsh set /config/mail -spf 0 ---- -Delete spf setting from '/config/mail' +Delete 'spf' setting from '/config/mail' ---- # pmgsh set /config/mail -delete spf