Cleanup man pages

Format md files to work properly when converted to man pages.
Add sed command to cleanup table in podman man page.

Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>

Closes: #842
Approved by: mheon
This commit is contained in:
Daniel J Walsh
2018-05-29 13:18:34 -04:00
committed by Atomic Bot
parent 8ee0f2bf91
commit 71487466fb
43 changed files with 44 additions and 124 deletions

View File

@ -165,7 +165,7 @@ MANPAGES_MD ?= $(wildcard docs/*.md pkg/*/docs/*.md)
MANPAGES ?= $(MANPAGES_MD:%.md=%) MANPAGES ?= $(MANPAGES_MD:%.md=%)
$(MANPAGES): %: %.md .gopathok $(MANPAGES): %: %.md .gopathok
$(GOMD2MAN) -in $< -out $@ @sed -e 's/\((podman.*\.md)\)//' -e 's/\[\(podman.*\)\]/\1/' $< | $(GOMD2MAN) -in /dev/stdin -out $@
docs: $(MANPAGES) docs: $(MANPAGES)

View File

@ -1,6 +1,4 @@
% libpod.conf(5) library for running OCI-based containers in Pods % libpod.conf "5"
% Nathan Williams
% APRIL 2018
# NAME # NAME
libpod.conf - libpod configuration file libpod.conf - libpod configuration file

View File

@ -1,6 +1,4 @@
% podman(1) podman-attach - See the output of pid 1 of a container or enter the container % podman-attach "1"
% Dan Walsh
# podman-attach "1" "December 2017" "podman"
## NAME ## NAME
podman\-attach - Attach to a running container podman\-attach - Attach to a running container

View File

@ -1,6 +1,4 @@
% podman(1) podman-build - Simple tool to build a container image % podman-build "1"
% Tom Sweeney
# podman-build "7" "December 2017" "podman"
## NAME ## NAME
podman\-build - Build a container image using a Dockerfile. podman\-build - Build a container image using a Dockerfile.

View File

@ -1,6 +1,4 @@
% podman(1) podman-commit - Tool to create new image based on the changed container % podman-commit "1"
% Urvashi Mohnani
# podman-commit "1" "December 2017" "podman"
## NAME ## NAME
podman\-commit - Create new image based on the changed container podman\-commit - Create new image based on the changed container

View File

@ -1,6 +1,4 @@
% podman(1) podman-cp - Copy content between container's file system and the host % podman-cp "1"
% Dan Walsh
# podman-cp "1" "August 2017" "podman"
## NAME ## 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

View File

@ -1,5 +1,4 @@
% podman(1) podman-create - Create a new container % podman-create "1"
% Dan Walsh
## NAME ## NAME
podman\-create - Create a new container podman\-create - Create a new container

View File

@ -1,6 +1,4 @@
% podman(1) podman-diff - Inspect changes on a container or image's filesystem % podman-diff "1"
% Dan Walsh
# podman-diff "1" "August 2017" "podman"
## NAME ## NAME
podman\-diff - Inspect changes on a container or image's filesystem podman\-diff - Inspect changes on a container or image's filesystem

View File

@ -1,6 +1,4 @@
% podman(1) podman-exec - Execute a command in a running container % podman-exec "1"
% Brent Baude
# podman-exec "1" "December 2017" "podman"
## NAME ## NAME
podman\-exec - Execute a command in a running container podman\-exec - Execute a command in a running container

View File

@ -1,6 +1,4 @@
% podman(1) podman-export - Simple tool to export a container's filesystem as a tarball % podman-export "1"
% Urvashi Mohnani
# podman-export "1" "July 2017" "podman"
## NAME ## NAME
podman export - Export container's filesystem contents as a tar archive podman export - Export container's filesystem contents as a tar archive

View File

@ -1,6 +1,4 @@
% podman(1) podman-history - Simple tool to view the history of an image % podman-history "1"
% Urvashi Mohnani
% podman-history "1" "JULY 2017" "podman"
## NAME ## NAME
podman\-history - Shows the history of an image podman\-history - Shows the history of an image

View File

@ -1,6 +1,4 @@
% podman(1) podman-images - List images in local storage % podman-images "1"
% Dan Walsh
# podman-images "1" "March 2017" "podman"
## NAME ## NAME
podman\-images - List images in local storage podman\-images - List images in local storage

View File

@ -1,6 +1,4 @@
% podman(1) podman-import - Simple tool to import a tarball as an image % podman-import "1"
% Urvashi Mohnani
# podman-import "1" "November 2017" "podman"
## NAME ## 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

View File

@ -1,6 +1,4 @@
% podman(1) podman-version - Simple tool to view version information % podman-version "1"
% Vincent Batts
% podman-version "1" "JULY 2017" "podman"
## NAME ## NAME
podman\-info - Display system information podman\-info - Display system information

View File

@ -1,6 +1,4 @@
% podman(1) podman-inspect - Display a container or image's configuration % podman-inspect "1"
% Dan Walsh
# podman-inspect "1" "July 2017" "podman"
## NAME ## NAME
podman\-inspect - Display a container or image's configuration podman\-inspect - Display a container or image's configuration

View File

@ -1,6 +1,4 @@
% podman(1) podman-kill- Kill one or more containers with a signal % podman-kill "1"
% Brent Baude
# podman-kill"1" "September 2017" "podman"
## NAME ## NAME
podman\-kill - Kills one or more containers with a signal podman\-kill - Kills one or more containers with a signal

View File

@ -1,6 +1,4 @@
% podman(1) podman-load - Simple tool to load an image from an archive to containers-storage % podman-load "1"
% Urvashi Mohnani
# podman-load "1" "July 2017" "podman"
## NAME ## NAME
podman\-load - Load an image from docker archive podman\-load - Load an image from docker archive

View File

@ -1,6 +1,4 @@
% podman(1) podman-login - Simple tool to login to a registry server % podman-login "1"
% Urvashi Mohnani
# podman-login "1" "August 2017" "podman"
## NAME ## NAME
podman\-login - Login to a container registry podman\-login - Login to a container registry

View File

@ -1,6 +1,4 @@
% podman(1) podman-logout - Simple tool to logout of a registry server % podman-logout "1"
% Urvashi Mohnani
# podman-logout "1" "August 2017" "podman"
## NAME ## NAME
podman\-logout - Logout of a container registry podman\-logout - Logout of a container registry

View File

@ -1,6 +1,4 @@
% podman(1) podman-logs - Fetch the logs of a container % podman-logs "1"
% Ryan Cole
# podman-logs "1" "March 2017" "podman"
## NAME ## NAME
podman\-logs - Fetch the logs of a container podman\-logs - Fetch the logs of a container

View File

@ -1,6 +1,4 @@
% podman(1) podman-mount - Mount a working container's root filesystem. % podman-mount "1"
% Dan Walsh
# podman-mount "1" "July 2017" "podman"
## NAME ## NAME
podman\-mount - Mount a working container's root filesystem podman\-mount - Mount a working container's root filesystem

View File

@ -1,6 +1,4 @@
% podman(1) podman-pause - Pause one or more containers % podman-pause "1"
% Dan Walsh
# podman-pause "1" "September 2017" "podman"
## NAME ## NAME
podman\-pause - Pause one or more containers podman\-pause - Pause one or more containers

View File

@ -1,6 +1,4 @@
% podman(1) podman-port - List port mappings for the CONTAINER, or lookup the public-facing port that is NAT-ed to the PRIVATE_PORT % podman-port "1"
% Brent Baude
# podman-port "1" "January 2018" "podman"
## NAME ## NAME
podman\-port - List port mappings for a container podman\-port - List port mappings for a container

View File

@ -1,6 +1,4 @@
% podman(1) podman-ps - Simple tool to list containers % podman-ps "1"
% Urvashi Mohnani
% podman-ps "1" "AUGUST 2017" "podman"
## NAME ## NAME
podman\-ps - Prints out information about containers podman\-ps - Prints out information about containers

View File

@ -1,6 +1,4 @@
% podman(1) podman-pull - Simple tool to pull an image from a registry % podman-pull "1"
% Urvashi Mohnani
# podman-pull "1" "July 2017" "podman"
## NAME ## NAME
podman\-pull - Pull an image from a registry podman\-pull - Pull an image from a registry

View File

@ -1,6 +1,4 @@
% podman(1) podman-push - Push an image from local storage to elsewhere % podman-push "1"
% Dan Walsh
# podman-push "1" "June 2017" "podman"
## NAME ## NAME
podman\-push - Push an image from local storage to elsewhere podman\-push - Push an image from local storage to elsewhere

View File

@ -1,6 +1,4 @@
% podman(1) podman-restart - Restart a container % podman-restart "1"
% Matt Heon
# podman-restart "1" "March 2017" "podman"
## NAME ## NAME
podman\-restart - Restart a container podman\-restart - Restart a container

View File

@ -1,6 +1,4 @@
% podman(1) podman-rm - Remove one or more containers % podman-rm "1"
% Ryan Cole
# podman-rm "1" "August 2017" "podman"
## NAME ## NAME
podman\-rm - Remove one or more containers podman\-rm - Remove one or more containers

View File

@ -1,6 +1,4 @@
% podman(1) podman-rmi - Removes one or more images % podman-rmi "1"
% Dan Walsh
# podman-rmi "1" "March 2017" "podman"
## NAME ## NAME
podman\-rmi - Removes one or more images podman\-rmi - Removes one or more images

View File

@ -1,5 +1,4 @@
% podman(1) podman-run - Run a command in a container % podman-run "1"
% Dan Walsh
## NAME ## NAME
podman\-run - Run a command in a new container podman\-run - Run a command in a new container

View File

@ -1,6 +1,4 @@
% podman(1) podman-save - Simple tool to save an image to an archive % podman-save "1"
% Urvashi Mohnani
# podman-save "1" "July 2017" "podman"
## NAME ## NAME
podman\-save - Save an image to docker-archive or oci-archive podman\-save - Save an image to docker-archive or oci-archive

View File

@ -1,6 +1,4 @@
% podman(1) podman-search - Tool to search registries for an image % podman-search "1"
% Urvashi Mohnani
# podman-search "1" "January 2018" "podman"
## NAME ## NAME
podman\-search - Search a registry for an image podman\-search - Search a registry for an image

View File

@ -1,6 +1,4 @@
% podman(1) podman-start - Stop one or more containers % podman-start "1"
% Brent Baude
# podman-start "1" "November 2017" "podman"
## NAME ## NAME
podman\-start - Start one or more containers podman\-start - Start one or more containers

View File

@ -1,6 +1,4 @@
% podman(1) podman-stats - Display a live stream of 1 or more containers' resource usage statistics % podman-stats "1"
% Ryan Cole
# podman-stats "1" "July 2017" "podman"
## NAME ## 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

View File

@ -1,6 +1,4 @@
% podman(1) podman-stop - Stop one or more containers % podman-stop "1"
% Brent Baude
# podman-stop "1" "September 2017" "podman"
## NAME ## NAME
podman\-stop - Stop one or more containers podman\-stop - Stop one or more containers

View File

@ -1,6 +1,4 @@
% podman(1) podman-tag - Add tags to an image % podman-tag "1"
% Ryan Cole
# podman-tag "1" "July 2017" "podman"
## NAME ## NAME
podman\-tag - Add an additional name to a local image podman\-tag - Add an additional name to a local image

View File

@ -1,5 +1,4 @@
% podman(1) podman-top - display the running processes of a container % podman-top "1"
% Brent Baude
## NAME ## NAME
podman\-top - Display the running processes of a container podman\-top - Display the running processes of a container

View File

@ -1,6 +1,4 @@
% podman(1) podman-umount - Unmount a working container's root filesystem. % podman-umount "1"
% Dan Walsh
# podman-umount "1" "July 2017" "podman"
## NAME ## NAME
podman\-umount - Unmount a working container's root file system podman\-umount - Unmount a working container's root file system

View File

@ -1,6 +1,4 @@
% podman(1) podman-unpause - Unpause one or more containers % podman-unpause "1"
% Dan Walsh
# podman-unpause "1" "September 2017" "podman"
## NAME ## NAME
podman\-unpause - Unpause one or more containers podman\-unpause - Unpause one or more containers

View File

@ -1,6 +1,4 @@
% podman(1) podman-varlink - Waits on a container % podman-varlink "1"
% Brent Baude
# podman-varlink "1" "April 2018" "podman"
## NAME ## NAME
podman\-varlink - Runs the varlink backend interface podman\-varlink - Runs the varlink backend interface

View File

@ -1,6 +1,4 @@
% podman(1) podman-version - Simple tool to view version information % podman-version "1"
% Urvashi Mohnani
# podman-version "1" "July 2017" "podman"
## NAME ## NAME
podman\-version - Display the PODMAN Version Information podman\-version - Display the PODMAN Version Information

View File

@ -1,6 +1,4 @@
% podman(1) podman-wait - Waits on a container % podman-wait "1"
% Brent Baude
# podman-wait "1" "September 2017" "podman"
## NAME ## NAME
podman\-wait - Waits on one or more containers to stop and prints exit code podman\-wait - Waits on one or more containers to stop and prints exit code

View File

@ -1,6 +1,5 @@
% podman(1) podman - Simple management tool for pods and images % podman "1"
% Dan Walsh
# podman "1" "September 2016" "podman"
## NAME ## NAME
podman - Simple management tool for containers and images podman - Simple management tool for containers and images