opensource/podman
1
0
Fork 0
mirror of https://github.com/containers/podman.git synced 2025-06-25 20:26:51 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: Follow man-pages(7) suggestions for SYNOPSIS

Browse Source 
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
This commit is contained in:
W. Trevor King
2018-06-29 10:53:33 -07:00
committed by Atomic Bot
parent 6d8fac87ed
commit f2462ca59e
43 changed files with 111 additions and 147 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/podman-run.1.md
View File

@ -4,7 +4,7 @@
podman\-run - Run a command in a new container
## SYNOPSIS
**podman run** [*options* [...]] IMAGE [COMMAND] [ARG...]
**podman run** [*options*] *image* [*command* [*arg* ...]]
## DESCRIPTION