pmg-docs/pmg-admin-guide.adoc
Noel Ullreich db96e7429f Fix spelling of command line/command-line
Commandline/command line/command-line where being used interchangeably,
which is not correct
(see: https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/c/command-line).
use command-line when it is an adjective (e.g. "command-line interface")
and use command line when it is a noun (e.g. "change the setting from
the command line")

Signed-off-by: Noel Ullreich <n.ullreich@proxmox.com>
[S.I.: fix a stray ' ' introduced with this commit]
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2024-01-22 18:40:37 +01:00

211 lines
3.4 KiB
Plaintext

ifdef::pmglogo[]
image:./images/proxmox-logo.svg[] pass:[<br>] Proxmox Mail Gateway Administration Guide
=======================================================================================
endif::pmglogo[]
ifndef::pmglogo[]
Proxmox Mail Gateway Administration Guide
=========================================
endif::pmglogo[]
:doctype: book
:title: Proxmox Mail Gateway Administration Guide
:toc2:
:numbered:
:data-uri:
:icons:
ifndef::wiki[]
ifndef::manvolnum[]
:pmg-toplevel:
// Push titles down one level.
:leveloffset: 1
include::pmg-intro.adoc[]
include::pmg-planning-deployment.adoc[]
include::pmg-installation.adoc[]
include::pmgconfig.adoc[]
include::pmg-mail-filter.adoc[]
include::pmg-administration.adoc[]
include::pmg-statistic.adoc[]
include::pmgbackup.adoc[]
include::pmgcm.adoc[]
// Return to normal title levels.
:leveloffset: 0
Important Service Daemons
-------------------------
:leveloffset: 2
include::pmgdaemon.adoc[]
include::pmgproxy.adoc[]
include::pmg-smtp-filter.adoc[]
include::pmgpolicy.adoc[]
include::pmgtunnel.adoc[]
include::pmgmirror.adoc[]
:leveloffset: 0
Useful Command-line Tools
-------------------------
:leveloffset: 2
include::pmgdb.adoc[]
include::pmgsh.adoc[]
include::pmgversion.adoc[]
include::pmgsubscription.adoc[]
include::pmgperf.adoc[]
include::pmgqm.adoc[]
include::pmgreport.adoc[]
include::pmgupgrade.adoc[]
include::pmg-log-tracker.adoc[]
:leveloffset: 1
include::nmap.adoc[]
:leveloffset: 0
:leveloffset: 1
include::pmg-faq.adoc[]
include::pmg-bibliography.adoc[]
:leveloffset: 0
[appendix]
Command-line Interface
----------------------
*pmgbackup* - Proxmox Mail Gateway Backup and Restore Utility
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
include::pmgbackup.1-synopsis.adoc[]
*pmgcm* - Proxmox Mail Gateway Cluster Management Toolkit
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
include::pmgcm.1-synopsis.adoc[]
*pmgsh* - API Shell
~~~~~~~~~~~~~~~~~~~
include::pmgsh.1-synopsis.adoc[]
*pmgperf* - Proxmox Simple Performance Benchmark
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
include::pmgperf.1-synopsis.adoc[]
*pmgconfig* - Configuration Management Toolkit
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
include::pmgconfig.1-synopsis.adoc[]
*pmgdb* - Database Management Toolkit
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
include::pmgdb.1-synopsis.adoc[]
[appendix]
Service Daemons
---------------
*pmgdaemon* - {pmg} API Daemon
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
include::pmgdaemon.8-synopsis.adoc[]
*pmgproxy* - {pmg} API Proxy Daemon
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
include::pmgproxy.8-synopsis.adoc[]
*pmg-smtp-filter* - Proxmox SMTP Filter Daemon
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
include::pmg-smtp-filter.8-synopsis.adoc[]
*pmgpolicy* - {pmg} Policy Daemon
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
include::pmgpolicy.8-synopsis.adoc[]
*pmgtunnel* - Cluster Tunnel Daemon
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
include::pmgtunnel.8-synopsis.adoc[]
*pmgmirror* - Database Mirror Daemon
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
include::pmgmirror.8-synopsis.adoc[]
[appendix]
include::pmg-rule-macros.adoc[]
[appendix]
Configuration Files
-------------------
:leveloffset: 2
include::pmg.conf.adoc[]
include::cluster.conf.adoc[]
include::user.conf.adoc[]
include::ldap.conf.adoc[]
:leveloffset: 0
:leveloffset: 1
[appendix]
include::GFDL.adoc[]
:leveloffset: 0
endif::manvolnum[]
endif::wiki[]