summaryrefslogtreecommitdiff
path: root/docs/source/man/podman-start.1.md
diff options
context:
space:
mode:
authorbaude <bbaude@redhat.com>2019-10-24 14:54:57 -0500
committerbaude <bbaude@redhat.com>2019-10-31 12:31:39 -0500
commit52b92023edeba3a5e2c466d92d742e54b14a85cb (patch)
tree44e6193d49afd1277b7d07b0df41fc80d31b3adb /docs/source/man/podman-start.1.md
parent5af166ff513265b17aee92a9ce3a1522090d7dec (diff)
downloadpodman-52b92023edeba3a5e2c466d92d742e54b14a85cb.tar.gz
podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.tar.bz2
podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.zip
Restructure documentation dir
Restructuring the docs dir to make integration with sphinx easier. man pages now exist in docs/source/man and the sphinx make files exists in docs. Signed-off-by: baude <bbaude@redhat.com>
Diffstat (limited to 'docs/source/man/podman-start.1.md')
-rw-r--r--docs/source/man/podman-start.1.md59
1 files changed, 59 insertions, 0 deletions
diff --git a/docs/source/man/podman-start.1.md b/docs/source/man/podman-start.1.md
new file mode 100644
index 000000000..4c81d17bd
--- /dev/null
+++ b/docs/source/man/podman-start.1.md
@@ -0,0 +1,59 @@
+% podman-start(1)
+
+## NAME
+podman\-start - Start one or more containers
+
+## SYNOPSIS
+**podman start** [*options*] *container* ...
+
+**podman container start** [*options*] *container* ...
+
+## DESCRIPTION
+Start one or more containers. You may use container IDs or names as input. The *attach* and *interactive*
+options cannot be used to override the *--tty* and *--interactive* options from when the container
+was created. If you attempt to start a running container with the *--attach* option, podman will simply
+attach to the container.
+
+## OPTIONS
+
+**--attach**, **-a**
+
+Attach container's STDOUT and STDERR. The default is false. This option cannot be used when
+starting multiple containers.
+
+**--detach-keys**=*sequence*
+
+Override the key sequence for detaching a container. Format is a single character `[a-Z]` or
+a comma separated sequence of `ctrl-<value>`, where `<value>` is one of:
+`a-z`, `@`, `^`, `[`, `\\`, `]`, `^` or `_`.
+
+**--interactive**, **-i**
+
+Attach container's STDIN. The default is false.
+
+**--latest**, **-l**
+
+Instead of providing the container name or ID, use the last created container. If you use methods other than Podman
+to run containers such as CRI-O, the last started container could be from either of those methods.
+
+The latest option is not supported on the remote client.
+
+**--sig-proxy**=*true|false*
+
+Proxy received signals to the process (non-TTY mode only). SIGCHLD, SIGSTOP, and SIGKILL are not proxied. The default is *true* when attaching, *false* otherwise.
+
+## EXAMPLE
+
+podman start mywebserver
+
+podman start 860a4b231279 5421ab43b45
+
+podman start --interactive --attach 860a4b231279
+
+podman start -i -l
+
+## SEE ALSO
+podman(1), podman-create(1)
+
+## HISTORY
+November 2018, Originally compiled by Brent Baude <bbaude@redhat.com>