summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-generate-systemd.1.md
diff options
context:
space:
mode:
authorEd Santiago <santiago@redhat.com>2022-03-23 12:29:08 -0600
committerEd Santiago <santiago@redhat.com>2022-03-23 13:49:42 -0600
commit9b0c8d23bddd0fccd6a1faa3fa7f5b7e0373f541 (patch)
tree37dad6631948e2cfa28165a423c6bf22f9ab4d1e /docs/source/markdown/podman-generate-systemd.1.md
parent73713062806aa4c2db25dc62e2fff47406085dc8 (diff)
downloadpodman-9b0c8d23bddd0fccd6a1faa3fa7f5b7e0373f541.tar.gz
podman-9b0c8d23bddd0fccd6a1faa3fa7f5b7e0373f541.tar.bz2
podman-9b0c8d23bddd0fccd6a1faa3fa7f5b7e0373f541.zip
man pages: sort flags, and keep them that way
Command flags (OPTIONS) in man pages have to date been in haphazard order. Sometimes that order is sensible, e.g., most-important options first, but more often they're just in arbitrary places. This makes life hard for users. Here, I update the man-page-check Makefile script so it checks and enforces alphabetical order in OPTIONS sections. Then -- the hard part -- update all existing man pages to conform to this requirement. Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'docs/source/markdown/podman-generate-systemd.1.md')
-rw-r--r--docs/source/markdown/podman-generate-systemd.1.md48
1 files changed, 24 insertions, 24 deletions
diff --git a/docs/source/markdown/podman-generate-systemd.1.md b/docs/source/markdown/podman-generate-systemd.1.md
index b2b5ee2ca..32d5d2bc4 100644
--- a/docs/source/markdown/podman-generate-systemd.1.md
+++ b/docs/source/markdown/podman-generate-systemd.1.md
@@ -16,6 +16,16 @@ _Note: If you use this command with the remote client, including Mac and Windows
## OPTIONS
+#### **--after**=*dependency_name*
+
+Add the systemd unit after (`After=`) option, that ordering dependencies between the list of dependencies and this service. This option may be specified more than once.
+
+User-defined dependencies will be appended to the generated unit file, but any existing options such as needed or defined by default (e.g. `online.target`) will **not** be removed or overridden.
+
+#### **--container-prefix**=*prefix*
+
+Set the systemd unit name prefix for containers. The default is *container*.
+
#### **--files**, **-f**
Generate files instead of printing to stdout. The generated files are named {container,pod}-{ID,name}.service and will be placed in the current working directory.
@@ -40,13 +50,13 @@ Note that `--new` only works on containers and pods created directly via Podman
Do not generate the header including meta data such as the Podman version and the timestamp.
-#### **--start-timeout** =*value*
+#### **--pod-prefix**=*prefix*
-Override the default start timeout for the container with the given value in seconds.
+Set the systemd unit name prefix for pods. The default is *pod*.
-#### **--stop-timeout** =*value*
+#### **--requires**=*dependency_name*
-Override the default stop timeout for the container with the given value in seconds.
+Set the systemd unit requires (`Requires=`) option. Similar to wants, but declares a stronger requirement dependency.
#### **--restart-policy**=*policy*
@@ -58,33 +68,17 @@ Set the systemd restart policy. The restart-policy must be one of: "no", "on-su
Set the systemd service restartsec value. Configures the time to sleep before restarting a service (as configured with restart-policy).
Takes a value in seconds.
-#### **--container-prefix**=*prefix*
-
-Set the systemd unit name prefix for containers. The default is *container*.
-
-#### **--pod-prefix**=*prefix*
-
-Set the systemd unit name prefix for pods. The default is *pod*.
-
#### **--separator**=*separator*
Set the systemd unit name separator between the name/id of a container/pod and the prefix. The default is *-*.
-#### **--wants**=*dependency_name*
-
-Add the systemd unit wants (`Wants=`) option, that this service is (weak) dependent on. This option may be specified more than once. This option does not influence the order in which services are started or stopped.
-
-User-defined dependencies will be appended to the generated unit file, but any existing options such as needed or defined by default (e.g. `online.target`) will **not** be removed or overridden.
-
-#### **--after**=*dependency_name*
-
-Add the systemd unit after (`After=`) option, that ordering dependencies between the list of dependencies and this service. This option may be specified more than once.
+#### **--start-timeout** =*value*
-User-defined dependencies will be appended to the generated unit file, but any existing options such as needed or defined by default (e.g. `online.target`) will **not** be removed or overridden.
+Override the default start timeout for the container with the given value in seconds.
-#### **--requires**=*dependency_name*
+#### **--stop-timeout** =*value*
-Set the systemd unit requires (`Requires=`) option. Similar to wants, but declares a stronger requirement dependency.
+Override the default stop timeout for the container with the given value in seconds.
#### **--template**
@@ -92,6 +86,12 @@ Add template specifiers to run multiple services from the systemd unit file.
Note that if `--new` was not set to true, it is set to true by default. However, if `--new` is set to `false` explicitly the command will fail.
+#### **--wants**=*dependency_name*
+
+Add the systemd unit wants (`Wants=`) option, that this service is (weak) dependent on. This option may be specified more than once. This option does not influence the order in which services are started or stopped.
+
+User-defined dependencies will be appended to the generated unit file, but any existing options such as needed or defined by default (e.g. `online.target`) will **not** be removed or overridden.
+
## EXAMPLES
### Generate and print a systemd unit file for a container