diff options
| -rw-r--r-- | CONTRIBUTING.md | 4 | ||||
| -rw-r--r-- | docs/MANPAGE_SYNTAX.md | 102 | ||||
| -rw-r--r-- | docs/README.md | 4 |
3 files changed, 110 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cb8bce9ed..cbe0fcfab 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -126,6 +126,10 @@ Well, you can now create your own branch, apply changes on it, and then submitti For further reading about branching [you can read this document](https://herve.beraud.io/containers/linux/podman/isolate/environment/2019/02/06/how-to-hack-on-podman.html). +## Documentation + +Make sure to update the documentation if needed. You can find the man pages under `docs/source/markdown`. The syntax for the formatting of all man pages can be found [here](docs/MANPAGE_SYNTAX.md). + ## Submitting Pull Requests No Pull Request (PR) is too small! Typos, additional comments in the code, diff --git a/docs/MANPAGE_SYNTAX.md b/docs/MANPAGE_SYNTAX.md new file mode 100644 index 000000000..436ec5e8d --- /dev/null +++ b/docs/MANPAGE_SYNTAX.md @@ -0,0 +1,102 @@ +% podman-command(1) + +## NAME +podman\-command - short description + +## SYNOPSIS +(Shows the command structure.) + +**podman command** [*optional*] *mandatory value* + +**podman subcommand command** [*optional*] *mandatory value* + +(If there is the possibility to chose between 2 (two) or more mandatory command values. There should also always be a space before and after a vertical bar to ensure better readability.) + +**podman command** [*optional*] *value1* | *value2* + +**podman subcommand command** [*optional*] *value1* | *value2* + +(If an optinal value follows a mandatory one.) + +**podman command** [*optional*] *value1* | *value2* [*optional*] + +**podman subcommand command** [*optional*] *value1* | *value2* [*optional*] + +(If the command accepts an infinite number of values.) + +**podman command** [*optional*] *value* [*value* ...] + +**podman subcommand command** [*optional*] *value* [*value* ...] + +## DESCRIPTION +**podman command** is always the beginning of the DESCRIPTION section. Putting the command as the first part of the DESCRIPTION ensures uniformity. All commands mentioned in a text retain their appearance and form.\ +Example sentence: The command **podman command** is an example command.\ +It should also be specified if the command can only be run as root. In addition, it should be described when a command or OPTION cannot be executed with the remote client. For a command, this should be done in the DESCRIPTION part. For the OPTIONS, it should be done in the DESCRIPTION of the specified OPTION. Do not use pronouns in the man pages, especially the word `you`. + +## OPTIONS +All flags are referred to as OPTIONS. The term flags should not be used. All OPTIONS are listed in this section. OPTIONS that appear in descriptions of other OPTIONS and sections retain their appearance, for example: **--exit**. Each OPTION should be explained to the fullest extend below the OPTION itself. Each OPTION is behind an H4-header (`####`). + +#### **--option**, **-o** + +OPTIONS can be put after the command in two different ways. Eather the long version with **--option** or as the short version **-o**. If there are two ways to write an OPTION they are separated by a comma. If there are 2 (two) versions of one command the long version is always shown in front. + +#### **--exit** + +An example of an OPTION that has only one possible structure. Thus, it cannot be executed by the extension **-e**. + +#### **--answer**=, **-a**=**_active_** | *disable* + +OPTIONS that accept 2 possible arguments as inputs are shown above. If there is a default argument that is selected when no special input is made, it is shown in **_bold italics_**. It must always be ensured that the standard argument is in the first place after the OPTION. In this example, there are 2 (two) different versions to execute the command. Both versions of the OPTION have to be shown with the arguments behind them. + +#### **--status**=**good** | *better* | *best* + +This is an example for 3 (three) arguments behind an OPTION. If the number of arguments is higher than 3 (three), the arguments are **not** listed after the equal sign. The arguments have to be explained in a table like in **--test**=**_test_** regardless of the number of arguments. + +#### **--test**=**_test_** + +OPTIONS that are followed by an equal sign include an argument after the equal sign in *italic*. If there is a default argument, that is used if the OPTION is not specified in the **command**, the argument after the eqaul sign is displayed in **bold**. All arguments must be listed and explained in the text below the OPTION. + +| Argument | Description | +| - | - | +| **_example one_** | This argument is the standard argument if the OPTION is not specified. | +| *example two* | If one refers to a command, one should use **bold** marks. | +| *example three* | Example: In combination with **podman command** highly effective. | +| *example four* | Example: Can be combined with **--exit**. | +| *example five* | The fifth description | + +The table shows an example for a listing of arguments. The contents in the table should be aligned left. If the content in the table conflicts with this, it can be aligned in a way that supports the understanding of the content. If there is a standard argument, it **must** listed as the first entry in the table. + +If the number of arguments is smaller than 4 (four) they have to be listed behind the OPTION as seen in the OPTION **--status**. + +## SUBCHAPTER +For chapters that are made specifically as an individual SUBCHAPTER in a man page, the previous conditions regarding formatting apply. + +There are no restrictions for the use of paragraphs and tables. Within these paragraphs and tables the previous conditions regarding formatting apply. + +Strings of characters or numbers can be highlighted with `backticks`. Paths of any kind **must** be highlighted.\ +IMPORTANT: Only characters that are **not** part of categories mentioned before can be highlighted. This includes headers. For example it is not advised to highlight an OPTION or a **command**. + +SUBHEADINGS are displayed as follows: +### SUBHEADING +Text for SUBHEADINGS. + +## EXAMPLES +All EXAMPLES are listed in this section. This section should be at the end of each man page. Each EXAMPLE is always in one box. The box starts and ends with the last written line, **not** with a blank line. The `$` in front of the commands indicates that it can be run as a normal user, while the commands starting with `#` can only be run as root. + +### Description of the EXAMPLE +``` +$ podman command + +$ podman command -o + +$ cat $HOME/Dockerfile | podman command --option +``` + +### Description of the EXAMPLE 2 +``` +$ podman command --redhat + +$ podman command --redhat better + +$ podman command --redhat=better +``` diff --git a/docs/README.md b/docs/README.md index a00b8f39c..0f2af16d6 100644 --- a/docs/README.md +++ b/docs/README.md @@ -28,6 +28,10 @@ link on that page. | docs/links-to-html.lua | pandoc filter to do aliases for html files | | docs/use-pagetitle.lua | pandoc filter to set html document title | +## Manpage Syntax + +The syntax for the formatting of all man pages can be found [here](MANPAGE_SYNTAX.md). + ## API Reference The [latest online documentation](http://docs.podman.io/en/latest/_static/api.html) is |