From 6065f18da6fa847ee67ff1e86e0a04ccb90dc587 Mon Sep 17 00:00:00 2001 From: Daniel J Walsh Date: Wed, 20 Dec 2017 05:35:51 -0500 Subject: Cleanup Documentation and bash completions Signed-off-by: Daniel J Walsh Closes: #159 Approved by: TomSweeneyRedHat --- docs/podman-attach.1.md | 2 +- docs/podman-commit.1.md | 2 +- docs/podman-cp.1.md | 2 +- docs/podman-create.1.md | 14 ++++++++------ docs/podman-exec.1.md | 2 +- docs/podman-export.1.md | 2 +- docs/podman-history.1.md | 2 +- docs/podman-import.1.md | 2 +- docs/podman-info.1.md | 2 +- docs/podman-load.1.md | 2 +- docs/podman-login.1.md | 2 +- docs/podman-logout.1.md | 2 +- docs/podman-ps.1.md | 2 +- docs/podman-pull.1.md | 2 +- docs/podman-run.1.md | 30 ++++++++++++++++-------------- docs/podman-save.1.md | 2 +- docs/podman-stats.1.md | 2 +- docs/podman-version.1.md | 2 +- docs/podman.1.md | 6 +++--- 19 files changed, 43 insertions(+), 39 deletions(-) (limited to 'docs') diff --git a/docs/podman-attach.1.md b/docs/podman-attach.1.md index ddb59e553..4d8b803c8 100644 --- a/docs/podman-attach.1.md +++ b/docs/podman-attach.1.md @@ -3,7 +3,7 @@ # podman-attach "1" "December 2017" "podman" ## NAME -podman-attach - Attach to a running container +podman attach - Attach to a running container ## SYNOPSIS **podman attach [OPTIONS] CONTAINER** diff --git a/docs/podman-commit.1.md b/docs/podman-commit.1.md index 10680fcb8..001c37daf 100644 --- a/docs/podman-commit.1.md +++ b/docs/podman-commit.1.md @@ -3,7 +3,7 @@ # podman-commit "1" "December 2017" "podman" ## NAME -podman-commit - Create new image based on the changed container +podman commit - Create new image based on the changed container ## SYNOPSIS **podman commit** diff --git a/docs/podman-cp.1.md b/docs/podman-cp.1.md index 0c23d6f10..440a88866 100644 --- a/docs/podman-cp.1.md +++ b/docs/podman-cp.1.md @@ -3,7 +3,7 @@ # podman-cp "1" "August 2017" "podman" ## NAME -podman-cp - Copy files/folders between a container and the local filesystem. +podman cp - Copy files/folders between a container and the local filesystem ## Description We chose not to implement the `cp` feature in `podman` even though the upstream Docker diff --git a/docs/podman-create.1.md b/docs/podman-create.1.md index 117a076a6..bf2f8b4c2 100644 --- a/docs/podman-create.1.md +++ b/docs/podman-create.1.md @@ -1,11 +1,13 @@ % podman(1) podman-create - Create a new container % Dan Walsh -podman-create - Create a new container -# SYNOPSIS +## NAME +podman create - Create a new container + +## SYNOPSIS **podman create** [*options* [...]] IMAGE [COMMAND] [ARG...] -# DESCRIPTION +## DESCRIPTION Creates a writeable container layer over the specified image and prepares it for running the specified command. The container ID is then printed to STDOUT. This @@ -15,7 +17,7 @@ any point. The initial status of the container created with **podman create** is 'created'. -# OPTIONS +## OPTIONS **--add-host**=[] Add a custom host-to-IP mapping (host:ip) @@ -561,9 +563,9 @@ the `nocopy` flag. The `nocopy` flag can be set on bind mounts and named volumes The image developer can set a different default with the WORKDIR instruction. The operator can override the working directory by using the **-w** option. -# EXAMPLES +## EXAMPLES -# HISTORY +## HISTORY August 2014, updated by Sven Dowideit September 2014, updated by Sven Dowideit November 2014, updated by Sven Dowideit diff --git a/docs/podman-exec.1.md b/docs/podman-exec.1.md index aa8d36a96..a9795002e 100644 --- a/docs/podman-exec.1.md +++ b/docs/podman-exec.1.md @@ -3,7 +3,7 @@ # podman-exec "1" "December 2017" "podman" ## NAME -podman-exec - Execute a command in a running container +podman exec - Execute a command in a running container ## SYNOPSIS **podman exec** diff --git a/docs/podman-export.1.md b/docs/podman-export.1.md index 5652c245b..ae6e6024c 100644 --- a/docs/podman-export.1.md +++ b/docs/podman-export.1.md @@ -3,7 +3,7 @@ # podman-export "1" "July 2017" "podman" ## NAME -podman-export - Export container's filesystem contents as a tar archive +podman export - Export container's filesystem contents as a tar archive ## SYNOPSIS **podman export** diff --git a/docs/podman-history.1.md b/docs/podman-history.1.md index f4a089b3c..0a07be699 100644 --- a/docs/podman-history.1.md +++ b/docs/podman-history.1.md @@ -3,7 +3,7 @@ % podman-history "1" "JULY 2017" "podman" ## NAME -podman-history - Shows the history of an image +podman history - Shows the history of an image ## SYNOPSIS **podman history** diff --git a/docs/podman-import.1.md b/docs/podman-import.1.md index f90b82a89..a789bdbfc 100644 --- a/docs/podman-import.1.md +++ b/docs/podman-import.1.md @@ -3,7 +3,7 @@ # podman-import "1" "November 2017" "podman" ## NAME -podman-import - import a tarball and save it as a filesystem image +podman import - Import a tarball and save it as a filesystem image ## SYNOPSIS **podman import** diff --git a/docs/podman-info.1.md b/docs/podman-info.1.md index 09c46d7f9..f3e3bc63f 100644 --- a/docs/podman-info.1.md +++ b/docs/podman-info.1.md @@ -3,7 +3,7 @@ % podman-version "1" "JULY 2017" "podman" ## NAME -podman-info - Display system information +podman info - Display system information ## SYNOPSIS diff --git a/docs/podman-load.1.md b/docs/podman-load.1.md index 80210d547..4b0cf4017 100644 --- a/docs/podman-load.1.md +++ b/docs/podman-load.1.md @@ -3,7 +3,7 @@ # podman-load "1" "July 2017" "podman" ## NAME -podman-load - Load an image from docker archive +podman load - Load an image from docker archive ## SYNOPSIS **podman load** diff --git a/docs/podman-login.1.md b/docs/podman-login.1.md index 2b136789e..180cdd45e 100644 --- a/docs/podman-login.1.md +++ b/docs/podman-login.1.md @@ -3,7 +3,7 @@ # podman-login "1" "August 2017" "podman" ## NAME -podman-login - Login to a container registry +podman login - Login to a container registry ## SYNOPSIS **podman login** diff --git a/docs/podman-logout.1.md b/docs/podman-logout.1.md index 7fa6c728d..d6281500b 100644 --- a/docs/podman-logout.1.md +++ b/docs/podman-logout.1.md @@ -3,7 +3,7 @@ # podman-logout "1" "August 2017" "podman" ## NAME -podman-logout - Logout of a container registry +podman logout - Logout of a container registry ## SYNOPSIS **podman logout** diff --git a/docs/podman-ps.1.md b/docs/podman-ps.1.md index 493a11465..11c3aabaf 100644 --- a/docs/podman-ps.1.md +++ b/docs/podman-ps.1.md @@ -3,7 +3,7 @@ % podman-ps "1" "AUGUST 2017" "podman" ## NAME -podman-ps - Prints out information about containers +podman ps - Prints out information about containers ## SYNOPSIS **podman ps** diff --git a/docs/podman-pull.1.md b/docs/podman-pull.1.md index ccb2248fb..b1212ee6b 100644 --- a/docs/podman-pull.1.md +++ b/docs/podman-pull.1.md @@ -3,7 +3,7 @@ # podman-pull "1" "July 2017" "podman" ## NAME -podman-pull - Pull an image from a registry +podman pull - Pull an image from a registry ## SYNOPSIS **podman pull** diff --git a/docs/podman-run.1.md b/docs/podman-run.1.md index 19e73aea2..0431478e4 100644 --- a/docs/podman-run.1.md +++ b/docs/podman-run.1.md @@ -1,11 +1,13 @@ % podman(1) podman-run - Run a command in a container % Dan Walsh -podman-run - Run a command in a new container -# SYNOPSIS +## NAME +podman run - Run a command in a new container + +## SYNOPSIS **podman run** [*options* [...]] IMAGE [COMMAND] [ARG...] -# DESCRIPTION +## DESCRIPTION Run a process in a new container. **podman run** starts a process with its own file system, its own networking, and its own isolated process tree. The IMAGE @@ -19,7 +21,7 @@ If the IMAGE is not already loaded then **podman run** will pull the IMAGE, and all image dependencies, from the repository in the same way running **podman pull** IMAGE, before it starts the container from that image. -# OPTIONS +## OPTIONS **--add-host**=[] Add a custom host-to-IP mapping (host:ip) @@ -598,9 +600,9 @@ the exit codes follow the `chroot` standard, see below: $ podman run busybox /bin/sh -c 'exit 3' # 3 -# EXAMPLES +## EXAMPLES -## Running container in read-only mode +### Running container in read-only mode During container image development, containers often need to write to the image content. Installing packages into /usr, for example. In production, @@ -613,7 +615,7 @@ tmpfs directories on /run and /tmp. # podman run --read-only --tmpfs /run --tmpfs /tmp -i -t fedora /bin/bash -## Exposing log messages from the container to the host's log +### Exposing log messages from the container to the host's log If you want messages that are logged in your container to show up in the host's syslog/journal then you should bind mount the /dev/log directory as follows. @@ -632,7 +634,7 @@ Then exit and check the journal. This should list the message sent to logger. -## Attaching to one or more from STDIN, STDOUT, STDERR +### Attaching to one or more from STDIN, STDOUT, STDERR If you do not specify -a then podman will attach everything (stdin,stdout,stderr) . You can specify to which of the three standard streams (stdin, stdout, stderr) @@ -705,7 +707,7 @@ Create a 3rd container using the new --ipc=container:CONTAINERID option, now it 0x0000162e 0 root 666 27 1 ``` -## Mapping Ports for External Usage +### Mapping Ports for External Usage The exposed port of an application can be mapped to a host port using the **-p** flag. For example, an httpd port 80 can be mapped to the host port 8080 using the @@ -713,7 +715,7 @@ following: # podman run -p 8080:80 -d -i -t fedora/httpd -## Mounting External Volumes +### Mounting External Volumes To mount a host directory as a container volume, specify the absolute path to the directory and the absolute path for the container directory separated by a @@ -737,7 +739,7 @@ to the host directory: Now, writing to the /data1 volume in the container will be allowed and the changes will also be reflected on the host in /var/db. -## Using alternative security labeling +### Using alternative security labeling You can override the default labeling scheme for each container by specifying the `--security-opt` flag. For example, you can specify the MCS/MLS level, a @@ -766,7 +768,7 @@ Note: You would have to write policy defining a `svirt_apache_t` type. -## Setting device weight +### Setting device weight If you want to set `/dev/sda` device weight to `200`, you can specify the device weight by `--blkio-weight-device` flag. Use the following command: @@ -777,7 +779,7 @@ weight by `--blkio-weight-device` flag. Use the following command: $ podman run -d busybox top ``` -## Setting Namespaced Kernel Parameters (Sysctls) +### Setting Namespaced Kernel Parameters (Sysctls) The `--sysctl` sets namespaced kernel parameters (sysctls) in the container. For example, to turn on IP forwarding in the containers @@ -794,7 +796,7 @@ evolves we expect to see more sysctls become namespaced. See the definition of the `--sysctl` option above for the current list of supported sysctls. -# HISTORY +## HISTORY April 2014, Originally compiled by William Henry (whenry at redhat dot com) based on docker.com source material and internal work. June 2014, updated by Sven Dowideit diff --git a/docs/podman-save.1.md b/docs/podman-save.1.md index e55ea1c9b..280073e74 100644 --- a/docs/podman-save.1.md +++ b/docs/podman-save.1.md @@ -3,7 +3,7 @@ # podman-save "1" "July 2017" "podman" ## NAME -podman-save - Save an image to docker-archive or oci-archive +podman save - Save an image to docker-archive or oci-archive ## SYNOPSIS **podman save** diff --git a/docs/podman-stats.1.md b/docs/podman-stats.1.md index 80d061cb2..6d050b485 100644 --- a/docs/podman-stats.1.md +++ b/docs/podman-stats.1.md @@ -3,7 +3,7 @@ # podman-stats "1" "July 2017" "podman" ## NAME -podman-stats - Display a live stream of 1 or more containers' resource usage statistics +podman stats - Display a live stream of 1 or more containers' resource usage statistics ## SYNOPSIS **podman** **stats** [*options* [...]] [container] diff --git a/docs/podman-version.1.md b/docs/podman-version.1.md index e6dba33fc..8978da630 100644 --- a/docs/podman-version.1.md +++ b/docs/podman-version.1.md @@ -3,7 +3,7 @@ # podman-version "1" "July 2017" "podman" ## NAME -podman-version - Display the PODMAN Version Information +podman version - Display the PODMAN Version Information ## SYNOPSIS **podman version** diff --git a/docs/podman.1.md b/docs/podman.1.md index be35c506d..ad9138a1d 100644 --- a/docs/podman.1.md +++ b/docs/podman.1.md @@ -55,6 +55,9 @@ has the capability to debug pods/images created by crio. ### attach Attach to a running container +### commit +Create new image based on the changed container + ### create create a new container @@ -109,9 +112,6 @@ Pull an image from a registry ### push Push an image from local storage to elsewhere -### rename -Rename a container - ### rm Remove one or more containers -- cgit v1.2.3-54-g00ecf