containers
/
podman
mirror of https://github.com/containers/podman.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
podman/docs/source/markdown
History
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
..
links Add "podman kube generate" command 2022-08-11 16:58:24 +01:00
options Man pages: refactor common options: --cidfile 2022-08-22 12:17:20 -06:00
.gitignore Man pages: refactor common options: --cidfile 2022-08-22 12:17:20 -06:00
podman-attach.1.md
…
podman-auto-update.1.md.in Man pages: refactor common options: authfile 2022-08-16 09:13:38 -06:00
podman-build.1.md.in Merge pull request #15412 from edsantiago/docs_dedup_creds 2022-08-22 14:16:44 -04:00
podman-commit.1.md man page checker: enforce stricter options format 2022-07-14 06:35:51 -06:00
podman-completion.1.md
…
podman-container-checkpoint.1.md Add support for checkpoint image 2022-04-20 18:55:39 +01:00
podman-container-cleanup.1.md Fix spelling "setup" -> "set up" and similar 2022-06-22 18:39:21 +02:00
podman-container-clone.1.md.in Man pages: refactor common options 2022-08-09 16:18:53 -06:00
podman-container-diff.1.md
…
podman-container-exists.1.md
…
podman-container-inspect.1.md Add support for ipc namespace modes "none, private, sharable" 2022-04-12 13:35:51 -04:00
podman-container-prune.1.md
…
podman-container-restore.1.md Add support for checkpoint image 2022-04-20 18:55:39 +01:00
podman-container-runlabel.1.md.in Man pages: refactor common options: --creds 2022-08-22 09:39:37 -06:00
podman-container.1.md Fix spelling "setup" -> "set up" and similar 2022-06-22 18:39:21 +02:00
podman-cp.1.md podman cp: do not overwrite non-dirs with dirs and vice versa 2022-06-10 09:42:19 +02:00
podman-create.1.md.in Man pages: refactor common options: --cidfile 2022-08-22 12:17:20 -06:00
podman-diff.1.md
…
podman-events.1.md Add podman events -f to be alias for --filter 2022-07-13 10:55:27 -04:00
podman-exec.1.md [CI:DOCS] Rewrite --env docs 2022-06-19 09:56:46 +02:00
podman-export.1.md man pages: sort flags, and keep them that way 2022-03-23 13:49:42 -06:00
podman-generate-spec.1.md podman generate spec 2022-08-04 13:59:58 -04:00
podman-generate-systemd.1.md [CI:DOCS] podman-generate-systemd.1.md: document --sdnotify 2022-07-26 07:16:09 +02:00
podman-generate.1.md Add "podman kube generate" command 2022-08-11 16:58:24 +01:00
podman-healthcheck-run.1.md
…
podman-healthcheck.1.md
…
podman-history.1.md [CI:DOCS] man pages: fix inconsistencies 2022-05-11 13:14:08 -06:00
podman-image-diff.1.md
…
podman-image-exists.1.md
…
podman-image-inspect.1.md
…
podman-image-mount.1.md
…
podman-image-prune.1.md
…
podman-image-scp.1.md Update test output expectation 2022-06-02 16:05:05 -04:00
podman-image-sign.1.md.in Man pages: refactor common options: authfile 2022-08-16 09:13:38 -06:00
podman-image-tree.1.md
…
podman-image-trust.1.md man page checker: enforce stricter options format 2022-07-14 06:35:51 -06:00
podman-image-unmount.1.md Run codespell on code 2022-04-22 06:18:20 -04:00
podman-image.1.md
…
podman-images.1.md podman images and friends can take one image as argument 2022-08-15 13:34:42 -04:00
podman-import.1.md Makefile: use order-only prereq for podman-remote 2022-07-19 10:33:53 -06:00
podman-info.1.md podman info: hide `--debug` 2022-08-04 13:39:15 +02:00
podman-init.1.md Unify examples section across several man pages: init/kill 2022-04-04 22:46:28 +02:00
podman-inspect.1.md man pages: sort flags, and keep them that way 2022-03-23 13:49:42 -06:00
podman-kill.1.md.in Man pages: refactor common options: --cidfile 2022-08-22 12:17:20 -06:00
podman-kube-down.1.md Add "podman kube generate" command 2022-08-11 16:58:24 +01:00
podman-kube-generate.1.md Add "podman kube generate" command 2022-08-11 16:58:24 +01:00
podman-kube-play.1.md.in Man pages: refactor common options: --creds 2022-08-22 09:39:37 -06:00
podman-kube.1.md Add "podman kube generate" command 2022-08-11 16:58:24 +01:00
podman-load.1.md man pages: sort flags, and keep them that way 2022-03-23 13:49:42 -06:00
podman-login.1.md.in Man pages: refactor common options: authfile 2022-08-16 09:13:38 -06:00
podman-logout.1.md.in Man pages: refactor common options: authfile 2022-08-16 09:13:38 -06:00
podman-logs.1.md Add option for pod logs to display different colors per container. 2022-03-29 17:29:13 +02:00
podman-machine-info.1.md man page checker: enforce stricter options format 2022-07-14 06:35:51 -06:00
podman-machine-init.1.md man page checker: enforce stricter options format 2022-07-14 06:35:51 -06:00
podman-machine-inspect.1.md Only allow Rootless runs of Podman Machine 2022-06-29 09:19:09 -04:00
podman-machine-list.1.md Only allow Rootless runs of Podman Machine 2022-06-29 09:19:09 -04:00
podman-machine-rm.1.md Only allow Rootless runs of Podman Machine 2022-06-29 09:19:09 -04:00
podman-machine-set.1.md man page checker: enforce stricter options format 2022-07-14 06:35:51 -06:00
podman-machine-ssh.1.md Only allow Rootless runs of Podman Machine 2022-06-29 09:19:09 -04:00
podman-machine-start.1.md Only allow Rootless runs of Podman Machine 2022-06-29 09:19:09 -04:00
podman-machine-stop.1.md Only allow Rootless runs of Podman Machine 2022-06-29 09:19:09 -04:00
podman-machine.1.md Podman machine info 2022-07-05 15:18:41 -04:00
podman-manifest-add.1.md.in Man pages: refactor common options: --creds 2022-08-22 09:39:37 -06:00
podman-manifest-annotate.1.md man page checker: enforce stricter options format 2022-07-14 06:35:51 -06:00
podman-manifest-create.1.md Add podman manifest create -a. Alias for --amend:Docker compatibility 2022-08-17 15:02:53 -04:00
podman-manifest-exists.1.md
…
podman-manifest-inspect.1.md
…
podman-manifest-push.1.md.in Man pages: refactor common options: --creds 2022-08-22 09:39:37 -06:00
podman-manifest-remove.1.md
…
podman-manifest-rm.1.md
…
podman-manifest.1.md [CI:DOCS] Fix typo in manifest manpage 2022-07-19 17:22:52 +09:00
podman-mount.1.md
…
podman-network-connect.1.md docs: remove CNI word where it is not applicable 2022-07-22 13:46:28 +02:00
podman-network-create.1.md docs: remove CNI word where it is not applicable 2022-07-22 13:46:28 +02:00
podman-network-disconnect.1.md
…
podman-network-exists.1.md
…
podman-network-inspect.1.md docs: remove CNI word where it is not applicable 2022-07-22 13:46:28 +02:00
podman-network-ls.1.md docs: remove CNI word where it is not applicable 2022-07-22 13:46:28 +02:00
podman-network-prune.1.md Unify examples section across several man pages 2022-03-28 21:56:13 +02:00
podman-network-reload.1.md Docs rootfull -> rootful 2022-04-25 11:53:57 -04:00
podman-network-rm.1.md docs: remove CNI word where it is not applicable 2022-07-22 13:46:28 +02:00
podman-network.1.md docs: remove CNI word where it is not applicable 2022-07-22 13:46:28 +02:00
podman-pause.1.md.in Man pages: refactor common options: --cidfile 2022-08-22 12:17:20 -06:00
podman-pod-clone.1.md.in Man pages: refactor common options 2022-08-09 16:18:53 -06:00
podman-pod-create.1.md.in Reword --exit-policy option 2022-08-14 10:09:38 +03:00
podman-pod-exists.1.md
…
podman-pod-inspect.1.md man page checker: enforce stricter options format 2022-07-14 06:35:51 -06:00
podman-pod-kill.1.md Unify examples section across several man pages: init/kill 2022-04-04 22:46:28 +02:00
podman-pod-logs.1.md Add option for pod logs to display different colors per container. 2022-03-29 17:29:13 +02:00
podman-pod-pause.1.md Unify examples section across several man pages 2022-03-28 21:56:13 +02:00
podman-pod-prune.1.md
…
podman-pod-ps.1.md man pages: sort flags, and keep them that way 2022-03-23 13:49:42 -06:00
podman-pod-restart.1.md
…
podman-pod-rm.1.md Unify examples section across several man pages: pod rm/start/unpause 2022-04-05 23:40:07 +02:00
podman-pod-start.1.md Unify examples section across several man pages: pod rm/start/unpause 2022-04-05 23:40:07 +02:00
podman-pod-stats.1.md man pages: sort flags, and keep them that way 2022-03-23 13:49:42 -06:00
podman-pod-stop.1.md man pages: sort flags, and keep them that way 2022-03-23 13:49:42 -06:00
podman-pod-top.1.md
…
podman-pod-unpause.1.md Unify examples section across several man pages: pod rm/start/unpause 2022-04-05 23:40:07 +02:00
podman-pod.1.md podman pod clone 2022-06-10 14:23:19 -04:00
podman-port.1.md Fix spelling "setup" -> "set up" and similar 2022-06-22 18:39:21 +02:00
podman-ps.1.md man pages: sort flags, and keep them that way 2022-03-23 13:49:42 -06:00
podman-pull.1.md.in Merge pull request #15412 from edsantiago/docs_dedup_creds 2022-08-22 14:16:44 -04:00
podman-push.1.md.in Man pages: refactor common options: --creds 2022-08-22 09:39:37 -06:00
podman-remote.1.md
…
podman-rename.1.md
…
podman-restart.1.md Add restart --cidfile, --filter 2022-08-12 09:22:53 +09:00
podman-rm.1.md.in Man pages: refactor common options: --cidfile 2022-08-22 12:17:20 -06:00
podman-rmi.1.md remove image podman no prune 2022-08-04 14:55:03 -04:00
podman-run.1.md.in Man pages: refactor common options: --cidfile 2022-08-22 12:17:20 -06:00
podman-save.1.md man pages: sort flags, and keep them that way 2022-03-23 13:49:42 -06:00
podman-search.1.md.in Man pages: refactor common options: authfile 2022-08-16 09:13:38 -06:00
podman-secret-create.1.md Add podman secret create -d as alias for --driver for Docker compatibility 2022-08-17 12:44:42 -04:00
podman-secret-inspect.1.md Add podman secret inspect -f alias for --format: Docker compatibility 2022-08-17 12:49:30 -04:00
podman-secret-ls.1.md man pages: sort flags, and keep them that way 2022-03-23 13:49:42 -06:00
podman-secret-rm.1.md
…
podman-secret.1.md
…
podman-start.1.md man pages: sort flags, and keep them that way 2022-03-23 13:49:42 -06:00
podman-stats.1.md Add podman stats --no-trunc option 2022-08-17 13:16:01 -04:00
podman-stop.1.md.in Man pages: refactor common options: --cidfile 2022-08-22 12:17:20 -06:00
podman-system-connection-add.1.md man page checker: enforce stricter options format 2022-07-14 06:35:51 -06:00
podman-system-connection-default.1.md
…
podman-system-connection-list.1.md [CI:DOCS] man pages: fix inconsistencies 2022-05-11 13:14:08 -06:00
podman-system-connection-remove.1.md man page checker: enforce stricter options format 2022-07-14 06:35:51 -06:00
podman-system-connection-rename.1.md
…
podman-system-connection.1.md
…
podman-system-df.1.md
…
podman-system-migrate.1.md
…
podman-system-prune.1.md podman system prune support prune unused networks 2022-06-14 14:04:03 +09:00
podman-system-renumber.1.md
…
podman-system-reset.1.md podman system reset removed machines incorrectly 2022-05-04 10:31:42 -04:00
podman-system-service.1.md Make it clear the REST API could be a security issue 2022-06-16 09:56:44 -04:00
podman-system.1.md podman system prune support prune unused networks 2022-06-14 14:04:03 +09:00
podman-tag.1.md
…
podman-top.1.md
…
podman-unmount.1.md Unify examples section across several man pages 2022-03-28 21:56:13 +02:00
podman-unpause.1.md.in Man pages: refactor common options: --cidfile 2022-08-22 12:17:20 -06:00
podman-unshare.1.md podman unshare: document that command cannot be used with remote 2022-03-22 17:54:37 +01:00
podman-untag.1.md
…
podman-version.1.md man pages: sort flags, and keep them that way 2022-03-23 13:49:42 -06:00
podman-volume-create.1.md man page checker: enforce stricter options format 2022-07-14 06:35:51 -06:00
podman-volume-exists.1.md
…
podman-volume-export.1.md man pages: sort flags, and keep them that way 2022-03-23 13:49:42 -06:00
podman-volume-import.1.md podman-volume-import: Reword "precendence" 2022-07-31 20:34:14 +00:00
podman-volume-inspect.1.md man page checker: enforce stricter options format 2022-07-14 06:35:51 -06:00
podman-volume-ls.1.md man page checker: enforce stricter options format 2022-07-14 06:35:51 -06:00
podman-volume-mount.1.md
…
podman-volume-prune.1.md man pages: sort flags, and keep them that way 2022-03-23 13:49:42 -06:00
podman-volume-reload.1.md add podman volume reload to sync volume plugins 2022-06-23 18:36:30 +02:00
podman-volume-rm.1.md
…
podman-volume-unmount.1.md Unify examples section across several man pages 2022-03-28 21:56:13 +02:00
podman-volume.1.md add podman volume reload to sync volume plugins 2022-06-23 18:36:30 +02:00
podman-wait.1.md
…
podman.1.md podman ssh work, using new c/common interface 2022-08-09 14:00:58 -04:00