From f2462ca59e4a48b9f23e3c8f2acaa8bce60d588d Mon Sep 17 00:00:00 2001
From: "W. Trevor King" <wking@tremily.us>
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 <wking@tremily.us>

Closes: #1027
Approved by: rhatdan
---
 docs/podman-import.1.md | 21 +++++++++------------
 1 file changed, 9 insertions(+), 12 deletions(-)

(limited to 'docs/podman-import.1.md')

diff --git a/docs/podman-import.1.md b/docs/podman-import.1.md
index 053a41538..70b382a63 100644
--- a/docs/podman-import.1.md
+++ b/docs/podman-import.1.md
@@ -4,12 +4,7 @@
 podman\-import - Import a tarball and save it as a filesystem image
 
 ## SYNOPSIS
-**podman import**
-**TARBALL**
-[**--change**|**-c**]
-[**--message**|**-m**]
-[**--help**|**-h**]
-[**-verbose**]
+**podman import** [*options*] *path*
 
 ## DESCRIPTION
 **podman import** imports a tarball (.tar, .tar.gz, .tgz, .bzip, .tar.xz, .txz)
@@ -18,12 +13,6 @@ Various image instructions can be configured with the **--change** flag and
 a commit message can be set using the **--message** flag.
 Note: `:` is a restricted character and cannot be part of the file name.
 
-**podman [GLOBAL OPTIONS]**
-
-**podman import [GLOBAL OPTIONS]**
-
-**podman import [OPTIONS] CONTAINER**
-
 ## OPTIONS
 
 **--change, -c**
@@ -40,6 +29,14 @@ Set commit message for imported image
 
 Shows progress on the import
 
+**-verbose**
+
+Print additional debugging information
+
+**--help**, **-h**
+
+Print usage statement
+
 ## EXAMPLES
 
 ```
-- 
cgit v1.2.3-54-g00ecf