podman/docs/source
Ed Santiago 46f31361f8 Man pages: refactor common options: --cidfile
There are two meanings: one writes a cidfile, the other reads.
Split into two .md files.

This can be reviewed with hack/markdown-preprocess-review .
The main differences you'll see are all in cidfile.read:

  1) I use the <<subcommand>> feature. This works nicely for
     kill, pause/unpause, and stop. It works less nicely for
     rm, because the man page will show "...and rm the container"
     (a human might prefer to see "REMOVE the container"). Given
     the benefit of this cleanup, I think this is a fine tradeoff.

  2) I choose to include the "multiple times" text even on man pages
     where it wasn't present before. I tested to make sure it works.

  3) The #### line I choose is IMHO the best one.

Minor differences:

  * I believe the "remove the container" text in podman-kill
    and podman-stop is a copy/paste error. This PR fixes it.

  * The only differences between the cidfile.write texts is
    the #### line (my version is best) and a final period.

Signed-off-by: Ed Santiago <santiago@redhat.com>
2022-08-22 12:17:20 -06:00
..
_static Show API doc for several versions 2022-02-09 18:17:52 +01:00
markdown Man pages: refactor common options: --cidfile 2022-08-22 12:17:20 -06:00
Commands.rst Add "podman kube play" cmd 2022-07-13 15:27:03 +01:00
Introduction.rst [CI:DOCS] Update first line in intro page 2021-05-14 17:08:35 -04:00
Reference.rst Add 4.1 branch to API documentation 2022-05-06 15:05:03 +02:00
Search.rst [CI:DOCS] Docs revamp. 2020-05-21 17:16:10 -04:00
Tutorials.rst [CI:DOCS] Tutorials.rst: add socket activation 2022-07-15 17:36:33 +02:00
conf.py readthedocs(sphinx): run the markdown preprocessor 2022-08-04 11:46:54 +02:00
includes.rst [CI:DOCS] Fix GitHub URL to Podman logo 2021-07-21 11:22:01 -04:00
index.rst [CI:DOCS]update state of restful service 2021-01-26 09:12:07 -06:00
volume.rst volumes: Add volume import to allow importing contents on tar into volume 2021-08-26 14:14:14 +05:30