From f2462ca59e4a48b9f23e3c8f2acaa8bce60d588d Mon Sep 17 00:00:00 2001 From: "W. Trevor King" Date: Fri, 29 Jun 2018 10:53:33 -0700 Subject: docs: Follow man-pages(7) suggestions for SYNOPSIS man-pages(7) has [1]: > For commands, this shows the syntax of the command and its arguments > (including options); boldface is used for as-is text and italics are > used to indicate replaceable arguments. Brackets ([]) surround > optional arguments, vertical bars (|) separate choices, and ellipses > (...) can be repeated. I've adjusted our SYNOPSIS entries to match that formatting, and generally tried to make them more consistent with the precedent set by the man-pages project. Outside of the SYNOPSIS entry, I prefer using backticks for literals, although in some places I've left the ** bolding to keep things visually similar to a nearby SYNOPSIS entry. [1]: http://man7.org/linux/man-pages/man7/man-pages.7.html Signed-off-by: W. Trevor King Closes: #1027 Approved by: rhatdan --- docs/podman-export.1.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) (limited to 'docs/podman-export.1.md') diff --git a/docs/podman-export.1.md b/docs/podman-export.1.md index 92811b43e..6029beeb5 100644 --- a/docs/podman-export.1.md +++ b/docs/podman-export.1.md @@ -4,15 +4,12 @@ podman export - Export container's filesystem contents as a tar archive ## SYNOPSIS -**podman export** -**CONTAINER** -[**--output**|**-o**] -[**--help**|**-h**] +**podman export** [*options*] *container* ## DESCRIPTION **podman export** exports the filesystem of a container and saves it as a tarball on the local machine. **podman export** writes to STDOUT by default and can be -redirected to a file using the **output flag**. +redirected to a file using the `--output` flag. Note: `:` is a restricted character and cannot be part of the file name. **podman [GLOBAL OPTIONS]** @@ -27,6 +24,10 @@ Note: `:` is a restricted character and cannot be part of the file name. Write to a file, default is STDOUT +**--help**, **-h** + +Print usage statement + ## EXAMPLES ``` -- cgit v1.2.3-54-g00ecf