aboutsummaryrefslogtreecommitdiff
path: root/docs/podman-generate-systemd.1.md
diff options
context:
space:
mode:
authorAshley Cui <ashleycui16@gmail.com>2019-05-31 15:21:47 -0400
committerAshley Cui <ashleycui16@gmail.com>2019-06-10 11:48:02 -0400
commit19e0928037e2d9c6fb0941e2ac40b8cea731e22d (patch)
tree1b5b10718e2c27c690ae789392fe1d46535a4401 /docs/podman-generate-systemd.1.md
parent7b0d6fcf0e3ce59f842273f670d742aaf597bf2f (diff)
downloadpodman-19e0928037e2d9c6fb0941e2ac40b8cea731e22d.tar.gz
podman-19e0928037e2d9c6fb0941e2ac40b8cea731e22d.tar.bz2
podman-19e0928037e2d9c6fb0941e2ac40b8cea731e22d.zip
standardize documentation formatting
Signed-off-by: Ashley Cui <ashleycui16@gmail.com>
Diffstat (limited to 'docs/podman-generate-systemd.1.md')
-rw-r--r--docs/podman-generate-systemd.1.md26
1 files changed, 12 insertions, 14 deletions
diff --git a/docs/podman-generate-systemd.1.md b/docs/podman-generate-systemd.1.md
index cc3f098a6..09752480d 100644
--- a/docs/podman-generate-systemd.1.md
+++ b/docs/podman-generate-systemd.1.md
@@ -1,34 +1,32 @@
-% podman-generate Podman Man Pages
-% Brent Baude
-% April 2019
-# NAME
+% podman-generate-systemd(1)
+
+## NAME
podman-generate-systemd- Generate Systemd Unit file
-# SYNOPSIS
-**podman generate systemd** [*-n*|*--name*] [*-t*|*--timeout*] [*--restart-policy*] *container*
+## SYNOPSIS
+**podman generate systemd** [*options*] *container*
-# DESCRIPTION
+## DESCRIPTION
**podman generate systemd** will create a Systemd unit file that can be used to control a container. The
command will dynamically create the unit file and output it to stdout where it can be piped by the user
to a file. The options can be used to influence the results of the output as well.
-# OPTIONS:
+## OPTIONS:
-**--name** **-n**
+**--name**, **-n**
Use the name of the container for the start, stop, and description in the unit file
-**--timeout** **-t**
+**--timeout**, **-t**=*value*
Override the default stop timeout for the container with the given value.
-**--restart-policy**
+**--restart-policy**=*policy*
Set the SystemD restart policy. The restart-policy must be one of: "no", "on-success", "on-failure", "on-abnormal",
"on-watchdog", "on-abort", or "always". The default policy is *on-failure*.
-## Examples ##
-
+## Examples
Create a systemd unit file for a container running nginx:
```
@@ -65,5 +63,5 @@ WantedBy=multi-user.target
## SEE ALSO
podman(1), podman-container(1)
-# HISTORY
+## HISTORY
April 2019, Originally compiled by Brent Baude (bbaude at redhat dot com)