summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-start.1.md
diff options
context:
space:
mode:
authorJhon Honce <jhonce@redhat.com>2019-10-29 17:27:12 -0700
committerMatthew Heon <mheon@redhat.com>2019-10-31 16:34:29 -0400
commit28ad43940f3bfca3870a5450342c4b79c6a2f60f (patch)
treee09c845896ba74942de8ec13e4404df393f374a5 /docs/source/markdown/podman-start.1.md
parent27e79f55407b9e46cee06c97ba53bc3a485f5c03 (diff)
downloadpodman-28ad43940f3bfca3870a5450342c4b79c6a2f60f.tar.gz
podman-28ad43940f3bfca3870a5450342c4b79c6a2f60f.tar.bz2
podman-28ad43940f3bfca3870a5450342c4b79c6a2f60f.zip
Update document formatting and packaging code
* Refactored code and Makefile to support new docs layout * Removed some old code packaging code * Add Readme.md to document what we're doing Signed-off-by: Jhon Honce <jhonce@redhat.com> Signed-off-by: baude <bbaude@redhat.com>
Diffstat (limited to 'docs/source/markdown/podman-start.1.md')
-rw-r--r--docs/source/markdown/podman-start.1.md59
1 files changed, 59 insertions, 0 deletions
diff --git a/docs/source/markdown/podman-start.1.md b/docs/source/markdown/podman-start.1.md
new file mode 100644
index 000000000..4c81d17bd
--- /dev/null
+++ b/docs/source/markdown/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>