[type/__postgres_conf] Update man.rst

This commit is contained in:
Dennis Camera 2021-04-15 15:55:52 +02:00
parent 686e4f0f2d
commit 19bf37be1a
1 changed files with 22 additions and 17 deletions

View File

@ -1,29 +1,27 @@
cdist-type__postgres_conf(7)
============================
Configure a PostgreSQL server.
NOTE: This type might need to be run multiple times to apply all bits of the
configuration due to ordering requirements.
SSRQ <cdist--@--ssrq-sds-fds.ch>
NAME
----
cdist-type__postgres_conf - Alter PostgreSQL configuration
DESCRIPTION
-----------
Configure a PostgreSQL server using ALTER SYSTEM.
Configure a running PostgreSQL server using ``ALTER SYSTEM``.
REQUIRED PARAMETERS
-------------------
value
The value to setup (can be omitted when state is set to "absent").
The value to set (can be omitted if ``--state`` is set to ``absent``).
OPTIONAL PARAMETERS
-------------------
state
"present" or "absent". Defaults to "present".
``present`` or ``absent``.
Defaults to ``present``.
BOOLEAN PARAMETERS
@ -36,20 +34,27 @@ EXAMPLES
.. code-block:: sh
# set timezone
__postgres_conf timezone --value Europe/Zurich
# set timezone
__postgres_conf timezone --value Europe/Zurich
# reset maximum number of concurrent connections to default (normally 100)
__postgres_conf max_connections --state absent
# reset maximum number of concurrent connections to default (normally 100)
__postgres_conf max_connections --state absent
SEE ALSO
--------
- `cdist-type(7) <cdist-type.html>`_
None.
AUTHORS
-------
Beni Ruef (bernhard.ruef--@--ssrq-sds-fds.ch)
Dennis Camera (dennis.camera--@--ssrq-sds-fds.ch)
COPYING
-------
Copyright \(C) 2020 SSRQ (www.ssrq-sds-fds.ch).
Free use of this software is granted under the terms
of the GNU General Public License version 3 (GPLv3).
Copyright \(C) 2019-2021 SSRQ (www.ssrq-sds-fds.ch).
You can redistribute it and/or modify it under the terms of the GNU General
Public License as published by the Free Software Foundation, either version 3 of
the License, or (at your option) any later version.