diff options
| author | openshift-ci[bot] <75433959+openshift-ci[bot]@users.noreply.github.com> | 2022-07-14 13:14:41 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-07-14 13:14:41 +0000 |
| commit | 35e637daf894a8c2e01fe52a6a8768166ba38e7f (patch) | |
| tree | ce293d7a147d0095642ade3167f0992aab5cdb4b /docs/MANPAGE_SYNTAX.md | |
| parent | 23a266b2e76ba06041743aae3f5984cf937dda53 (diff) | |
| parent | ad7c54e13a17eed8efb7b1367a17859d6f7e3032 (diff) | |
| download | podman-35e637daf894a8c2e01fe52a6a8768166ba38e7f.tar.gz podman-35e637daf894a8c2e01fe52a6a8768166ba38e7f.tar.bz2 podman-35e637daf894a8c2e01fe52a6a8768166ba38e7f.zip | |
Merge pull request #14914 from edsantiago/xref_manpages_stricter
[CI:DOCS] man page checker: enforce stricter options format
Diffstat (limited to 'docs/MANPAGE_SYNTAX.md')
| -rw-r--r-- | docs/MANPAGE_SYNTAX.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/MANPAGE_SYNTAX.md b/docs/MANPAGE_SYNTAX.md index 7fff167ba..60bffdace 100644 --- a/docs/MANPAGE_SYNTAX.md +++ b/docs/MANPAGE_SYNTAX.md @@ -60,15 +60,15 @@ Example sentence: Use **[podman-generate-systemd --new](./source/markdown/podman #### **--version**, **-v** -OPTIONS can be put after the command in two different ways. Either 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 two versions of one command the long version is always shown in front. If the arguments behind the OPTION are boolean, it is not shown behind the OPTION itself. The default boolean argument is shown in the same way normal default arguments are displayed.\ +OPTIONS can be put after the command in two different ways. Either 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 two versions of one command the long version is always shown in front. If OPTION is boolean, *true/false* are not enumerated. The default boolean argument is shown in the same way normal default arguments are displayed.\ Example: The default is **false**.\ *IMPORTANT: This OPTION is not available with the remote Podman client.* #### **--exit** -An example of an OPTION that has only one possible structure. Thus, it cannot be executed by the extension **-e**. +An example of a boolean OPTION that is only available in long form. -#### **--answer**=, **-a**=**active** | *disable* +#### **--answer**, **-a**=**active** | *disable* The **--answer** OPTION above is an example of an OPTION that accepts two possible arguments as inputs. If a default argument is selected when the OPTION is not used in the command, it is shown in **bold**. If the OPTION is used, it must include an argument afterward. It must always be ensured that the standard argument is in the first position after the OPTION. In this example, there are two different ways to execute the command. Both possible OPTIONS have to be shown with the arguments following them.\ The default value is shown as **active**. |