opensource/podman
1
0
Fork 0
mirror of https://github.com/containers/podman.git synced 2025-08-06 19:44:14 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
podman/docs/source/markdown
History
Ed Santiago dbe0e67897 Man pages: tighter documenting of --format fields 
Initial impetus was #20958 (ps --format .Label abc). This is
a complicated solution to a simple-seeming problem.

The problem: .Label is a cobra *function*, something I did not
know about nor handle.

Solution: recognize cobra functions. Switch to __complete,
not __completeNoDesc, so we can see the number of arguments
required. Invent new man-page format for documenting functions.
And, finally, start enforcing how functions (and cobra structs)
are documented.

This discovered a never-used completion function, .Recycle(),
in podman-events. Remove it.

[NO NEW TESTS NEEDED] - the .go change is an excision of dead code.

Signed-off-by: Ed Santiago <santiago@redhat.com>
2024-01-15 13:11:27 -07:00
..
links
Install podman-systemd.unit man page, make quadlet discoverable
2023-02-03 08:42:20 -06:00
options
Merge pull request #21069 from umohnani8/new-farmbuild-2
2024-01-15 18:41:29 +00:00
.gitignore
Remove unnencessary pregenerated doc
2023-11-23 20:07:48 +02:00
podman-attach.1.md.in
Clean up more language for inclusiveness
2023-01-27 09:40:27 -05:00
podman-auto-update.1.md.in
[CI:DOCS] update auto-update docs
2023-08-22 16:19:06 +02:00
podman-build.1.md.in
docs: fix typos
2024-01-04 12:10:11 +02:00
podman-commit.1.md
Accept a config blob alongside the "changes" slice when committing
2023-11-30 09:00:52 -05:00
podman-completion.1.md
Remove unnecessary backslashes
2023-08-02 15:01:16 +01:00
podman-compose.1.md.in
add a podman-compose command
2023-07-24 19:23:04 +02:00
podman-container-checkpoint.1.md
man pages and command help: clean up descriptions
2023-05-28 18:57:43 +02:00
podman-container-cleanup.1.md
Remove future tense from man pages
2023-05-16 15:10:33 -04:00
podman-container-clone.1.md.in
man pages and command help: clean up descriptions
2023-05-28 18:57:43 +02:00
podman-container-diff.1.md.in
Remove future tense from man pages
2023-05-16 15:10:33 -04:00
podman-container-exists.1.md
Remove future tense from man pages
2023-05-16 15:10:33 -04:00
podman-container-inspect.1.md.in
Man pages: tighter documenting of --format fields
2024-01-15 13:11:27 -07:00
podman-container-prune.1.md
[CI:DOCS] consistentize filter options in man pages
2023-09-18 07:41:28 -06:00
podman-container-restore.1.md
Remove unnecessary use of the word "please".
2023-07-23 17:31:29 +02:00
podman-container-runlabel.1.md.in
Remove unnecessary use of the word "please".
2023-07-23 17:31:29 +02:00
podman-container.1.md
man pages and command help: clean up descriptions
2023-05-28 18:57:43 +02:00
podman-cp.1.md
Remove future tense from man pages
2023-05-16 15:10:33 -04:00
podman-create.1.md.in
Add documentation for Intel RDT support
2023-09-27 16:44:13 +00:00
podman-diff.1.md.in
Remove future tense from man pages
2023-05-16 15:10:33 -04:00
podman-events.1.md
Man pages: tighter documenting of --format fields
2024-01-15 13:11:27 -07:00
podman-exec.1.md.in
podman: new option --preserve-fd
2023-12-05 10:16:41 +01:00
podman-export.1.md
Fix manpage headers
2022-09-06 09:37:13 -07:00
podman-farm-build.1.md.in
farm build: push built images to registry
2024-01-15 11:31:17 -05:00
podman-farm-create.1.md
farm build: push built images to registry
2024-01-15 11:31:17 -05:00
podman-farm-list.1.md
Clean up farm-build miscommit
2023-11-27 06:15:43 -07:00
podman-farm-remove.1.md
Add podman farm remove command
2023-08-09 13:37:37 -04:00
podman-farm-update.1.md
Add podman farm update command
2023-08-09 13:37:37 -04:00
podman-farm.1.md
[CI:DOCS] Add podman farm build doc
2023-11-22 11:00:13 -05:00
podman-generate-spec.1.md
Remove future tense from man pages
2023-05-16 15:10:33 -04:00
podman-generate-systemd.1.md
Deprecate podman generate systemd
2023-08-03 06:58:53 -04:00
podman-generate.1.md
Deprecate podman generate systemd
2023-08-03 06:58:53 -04:00
podman-healthcheck-run.1.md
Fix manpage headers
2022-09-06 09:37:13 -07:00
podman-healthcheck.1.md
Fix manpage headers
2022-09-06 09:37:13 -07:00
podman-history.1.md
man page --format xref: tighten the autocompletion check
2023-02-14 08:11:54 -07:00
podman-image-diff.1.md
Remove future tense from man pages
2023-05-16 15:10:33 -04:00
podman-image-exists.1.md
Remove future tense from man pages
2023-05-16 15:10:33 -04:00
podman-image-inspect.1.md
Man pages: tighter documenting of --format fields
2024-01-15 13:11:27 -07:00
podman-image-mount.1.md
Remove future tense from man pages
2023-05-16 15:10:33 -04:00
podman-image-prune.1.md
[CI:DOCS] consistentize filter options in man pages
2023-09-18 07:41:28 -06:00
podman-image-scp.1.md
Remove 'you' from man pages
2022-12-07 09:29:29 -05:00
podman-image-sign.1.md.in
Correct markdown in docs
2023-05-18 16:44:24 -07:00
podman-image-tree.1.md
man pages and command help: clean up descriptions
2023-05-28 18:57:43 +02:00
podman-image-trust.1.md.in
Remove future tense from man pages
2023-05-16 15:10:33 -04:00
podman-image-unmount.1.md
Remove future tense from man pages
2023-05-16 15:10:33 -04:00
podman-image.1.md
man pages and command help: clean up descriptions
2023-05-28 18:57:43 +02:00
podman-images.1.md.in
Man pages: tighter documenting of --format fields
2024-01-15 13:11:27 -07:00
podman-import.1.md
Fix manpage headers
2022-09-06 09:37:13 -07:00
podman-info.1.md
libpod: Podman info output more network information
2023-06-13 11:19:29 +09:00
podman-init.1.md.in
The podman init command cannot modify containers.
2023-09-12 13:28:42 -04:00
podman-inspect.1.md.in
Remove future tense from man pages
2023-05-16 15:10:33 -04:00
podman-kill.1.md.in
Remove future tense from man pages
2023-05-16 15:10:33 -04:00
podman-kube-apply.1.md
Try to fix the broken formatting of man podman‐kube‐apply(1).
2023-11-06 14:53:35 +01:00
podman-kube-down.1.md
Remove future tense from man pages
2023-05-16 15:10:33 -04:00
podman-kube-generate.1.md
docs: update mariadb example
2024-01-09 13:31:39 +11:00
podman-kube-play.1.md.in
Add support for the userns annotation in kube play
2023-12-02 23:14:29 +01:00
podman-kube.1.md
Remove future tense from man pages
2023-05-16 15:10:33 -04:00
podman-load.1.md
[CI:DOCS] Update podman load doc
2023-09-28 10:51:26 -04:00
podman-login.1.md.in
Add support for --compat-auth-file in login/logout
2023-11-17 16:44:06 +01:00
podman-logout.1.md.in
Add support for --compat-auth-file in login/logout
2023-11-17 16:44:06 +01:00
podman-logs.1.md.in
Fix language, typos and markdown layout
2023-07-24 11:18:25 +02:00
podman-machine-info.1.md
Add format to podman machine info
2023-03-15 16:15:59 -04:00
podman-machine-init.1.md.in
machine: qemu: add usb host passthrough
2023-11-08 23:38:53 +01:00
podman-machine-inspect.1.md
Man pages: tighter documenting of --format fields
2024-01-15 13:11:27 -07:00
podman-machine-list.1.md.in
[CI:DOCS] man: remove duplicate entry .LastUp
2023-08-04 08:47:08 +02:00
podman-machine-os-apply.1.md
fix: default typo
2023-08-31 18:14:59 +08:00
podman-machine-os.1.md
Introduce podman machine os apply
2023-02-15 14:48:12 -05:00
podman-machine-rm.1.md
Use single persistent ssh key for all machines
2024-01-04 23:47:49 -05:00
podman-machine-set.1.md.in
machine: qemu: add usb host passthrough
2023-11-08 23:38:53 +01:00
podman-machine-ssh.1.md
Remove future tense from man pages
2023-05-16 15:10:33 -04:00
podman-machine-start.1.md
Remove future tense from man pages
2023-05-16 15:10:33 -04:00
podman-machine-stop.1.md
Document podman-machine-default behavior
2023-05-15 14:23:17 -04:00
podman-machine.1.md
man pages and command help: clean up descriptions
2023-05-28 18:57:43 +02:00
podman-manifest-add.1.md.in
Remove future tense from man pages
2023-05-16 15:10:33 -04:00
podman-manifest-annotate.1.md.in
Man pages: refactor common options: --annotation (manifest)
2022-10-12 08:54:04 -06:00
podman-manifest-create.1.md.in
Remove future tense from man pages
2023-05-16 15:10:33 -04:00
podman-manifest-exists.1.md
source code comments and docs: fix typos, language, Markdown layout
2023-05-22 07:52:16 +02:00
podman-manifest-inspect.1.md.in
manifest inspect: support authentication
2023-07-10 16:26:19 +02:00
podman-manifest-push.1.md.in
[CI:DOCS] Fix markdown bugs
2023-11-28 17:28:08 +01:00
podman-manifest-remove.1.md
Fix manpage headers
2022-09-06 09:37:13 -07:00
podman-manifest-rm.1.md
Add links to all SEE ALSO sections
2021-11-10 09:29:21 -05:00
podman-manifest.1.md
Remove future tense from man pages
2023-05-16 15:10:33 -04:00
podman-mount.1.md.in
Remove future tense from man pages
2023-05-16 15:10:33 -04:00
podman-network-connect.1.md
Remove future tense from man pages
2023-05-16 15:10:33 -04:00
podman-network-create.1.md
docs: make CNI removal explicit
2023-11-06 10:45:59 +01:00
podman-network-disconnect.1.md
Remove future tense from man pages
2023-05-16 15:10:33 -04:00
podman-network-exists.1.md
Remove future tense from man pages
2023-05-16 15:10:33 -04:00
podman-network-inspect.1.md
Man pages: tighter documenting of --format fields
2024-01-15 13:11:27 -07:00
podman-network-ls.1.md.in
Man pages: tighter documenting of --format fields
2024-01-15 13:11:27 -07:00
podman-network-prune.1.md
[CI:DOCS] consistentize filter options in man pages
2023-09-18 07:41:28 -06:00
podman-network-reload.1.md.in
Remove 'you' from man pages
2022-12-07 09:29:29 -05:00
podman-network-rm.1.md
Add support for passing container stop timeout as -1 (infinite)
2023-08-04 08:36:45 -04:00
podman-network-update.1.md
network: add support for podman network update and --network-dns-server
2023-01-12 20:19:14 +05:30
podman-network.1.md
docs: make CNI removal explicit
2023-11-06 10:45:59 +01:00
podman-pause.1.md.in
man page crossrefs: add --filter autocompletes
2023-09-17 06:20:33 -06:00
podman-pod-clone.1.md.in
man pages and command help: clean up descriptions
2023-05-28 18:57:43 +02:00
podman-pod-create.1.md.in
Remove future tense from man pages
2023-05-16 15:10:33 -04:00
podman-pod-exists.1.md
Remove future tense from man pages
2023-05-16 15:10:33 -04:00
podman-pod-inspect.1.md.in
Man pages: tighter documenting of --format fields
2024-01-15 13:11:27 -07:00
podman-pod-kill.1.md.in
Remove future tense from man pages
2023-05-16 15:10:33 -04:00
podman-pod-logs.1.md.in
man pages and command help: clean up descriptions
2023-05-28 18:57:43 +02:00
podman-pod-pause.1.md
Fix manpage headers
2022-09-06 09:37:13 -07:00
podman-pod-prune.1.md
Fix manpage headers
2022-09-06 09:37:13 -07:00
podman-pod-ps.1.md.in
Man pages: tighter documenting of --format fields
2024-01-15 13:11:27 -07:00
podman-pod-restart.1.md
Remove future tense from man pages
2023-05-16 15:10:33 -04:00
podman-pod-rm.1.md.in
Remove future tense from man pages
2023-05-16 15:10:33 -04:00
podman-pod-start.1.md.in
Remove 'you' from man pages
2022-12-07 09:29:29 -05:00
podman-pod-stats.1.md.in
Remove 'you' from man pages
2022-12-07 09:29:29 -05:00
podman-pod-stop.1.md.in
Remove 'you' from man pages
2022-12-07 09:29:29 -05:00
podman-pod-top.1.md.in
Remove unnecessary use of the word "please".
2023-07-23 17:31:29 +02:00
podman-pod-unpause.1.md
Fix manpage headers
2022-09-06 09:37:13 -07:00
podman-pod.1.md
man pages and command help: clean up descriptions
2023-05-28 18:57:43 +02:00
podman-port.1.md.in
Remove 'you' from man pages
2022-12-07 09:29:29 -05:00
podman-ps.1.md
Man pages: tighter documenting of --format fields
2024-01-15 13:11:27 -07:00
podman-pull.1.md.in
Remove future tense from man pages
2023-05-16 15:10:33 -04:00
podman-push.1.md.in
[CI:DOCS] Fix markdown bugs
2023-11-28 17:28:08 +01:00
podman-remote.1.md
Fix specification of unix:///run
2023-09-17 07:37:14 -04:00
podman-rename.1.md
Remove future tense from man pages
2023-05-16 15:10:33 -04:00
podman-restart.1.md.in
man page crossrefs: add --filter autocompletes
2023-09-17 06:20:33 -06:00
podman-rm.1.md.in
man page crossrefs: add --filter autocompletes
2023-09-17 06:20:33 -06:00
podman-rmi.1.md
man pages and command help: clean up descriptions
2023-05-28 18:57:43 +02:00
podman-run.1.md.in
Merge pull request #21204 from grooverdan/markdown_man_pages_mariadb
2024-01-09 12:49:51 +00:00
podman-save.1.md.in
docs: oci-dir does not support compress as suggested
2023-12-15 19:40:46 +00:00
podman-search.1.md.in
Remove future tense from man pages
2023-05-16 15:10:33 -04:00
podman-secret-create.1.md
document available secret drivers
2023-08-16 16:23:39 +02:00
podman-secret-exists.1.md
Remove future tense from man pages
2023-05-16 15:10:33 -04:00
podman-secret-inspect.1.md
Man pages: tighter documenting of --format fields
2024-01-15 13:11:27 -07:00
podman-secret-ls.1.md.in
Man pages: tighter documenting of --format fields
2024-01-15 13:11:27 -07:00
podman-secret-rm.1.md
secret: add support for --ignore with rm
2023-08-02 11:13:08 +05:30
podman-secret.1.md
Add support for secret exists
2023-04-03 15:33:50 +03:00
podman-start.1.md.in
man page crossrefs: add --filter autocompletes
2023-09-17 06:20:33 -06:00
podman-stats.1.md.in
Update podman-stats.1.md.in
2023-11-13 13:34:44 +00:00
podman-stop.1.md.in
man page crossrefs: add --filter autocompletes
2023-09-17 06:20:33 -06:00
podman-system-connection-add.1.md
Fix language, typos and markdown layout
2023-07-24 11:18:25 +02:00
podman-system-connection-default.1.md
Fix manpage headers
2022-09-06 09:37:13 -07:00
podman-system-connection-list.1.md
man page --format xref: tighten the autocompletion check
2023-02-14 08:11:54 -07:00
podman-system-connection-remove.1.md
Fix manpage headers
2022-09-06 09:37:13 -07:00
podman-system-connection-rename.1.md
Fix manpage headers
2022-09-06 09:37:13 -07:00
podman-system-connection.1.md
Fix language, typos and markdown layout
2023-07-24 11:18:25 +02:00
podman-system-df.1.md
Add format to podman system df
2023-03-15 16:15:59 -04:00
podman-system-migrate.1.md
Remove future tense from man pages
2023-05-16 15:10:33 -04:00
podman-system-prune.1.md
[CI:DOCS] consistentize filter options in man pages
2023-09-18 07:41:28 -06:00
podman-system-renumber.1.md
Remove future tense from man pages
2023-05-16 15:10:33 -04:00
podman-system-reset.1.md
system reset: show graphRoot/runRoot before removal
2023-04-26 16:02:59 +02:00
podman-system-service.1.md
Ensure that we appropriately warn that TCP is insecure
2023-07-20 14:22:04 -04:00
podman-system.1.md
man pages and command help: clean up descriptions
2023-05-28 18:57:43 +02:00
podman-systemd.unit.5.md
quadlet: fix quoting of example option values in container unit file documentation
2024-01-11 00:02:41 +01:00
podman-tag.1.md
[CI:DOCS] Improve podman-tag man page
2023-09-18 21:55:06 +05:30
podman-top.1.md.in
Remove unnecessary use of the word "please".
2023-07-23 17:31:29 +02:00
podman-unmount.1.md.in
Remove future tense from man pages
2023-05-16 15:10:33 -04:00
podman-unpause.1.md.in
man page crossrefs: add --filter autocompletes
2023-09-17 06:20:33 -06:00
podman-unshare.1.md
[CI:DOCS] Add CNI deprecation notices to documentation
2023-01-19 08:09:32 -06:00
podman-untag.1.md
man pages and command help: clean up descriptions
2023-05-28 18:57:43 +02:00
podman-update.1.md.in
man pages and command help: clean up descriptions
2023-05-28 18:57:43 +02:00
podman-version.1.md
[CI:DOCS] man pages: document some --format options
2022-09-15 09:59:32 -06:00
podman-volume-create.1.md
Support size option when creating tmpfs volumes
2023-10-23 16:31:54 -04:00
podman-volume-exists.1.md
Remove future tense from man pages
2023-05-16 15:10:33 -04:00
podman-volume-export.1.md
man pages and command help: clean up descriptions
2023-05-28 18:57:43 +02:00
podman-volume-import.1.md
Remove future tense from man pages
2023-05-16 15:10:33 -04:00
podman-volume-inspect.1.md
Man pages: tighter documenting of --format fields
2024-01-15 13:11:27 -07:00
podman-volume-ls.1.md.in
Man pages: tighter documenting of --format fields
2024-01-15 13:11:27 -07:00
podman-volume-mount.1.md
Remove future tense from man pages
2023-05-16 15:10:33 -04:00
podman-volume-prune.1.md
[CI:DOCS] consistentize filter options in man pages
2023-09-18 07:41:28 -06:00
podman-volume-reload.1.md
Fix manpage headers
2022-09-06 09:37:13 -07:00
podman-volume-rm.1.md
Add support for passing container stop timeout as -1 (infinite)
2023-08-04 08:36:45 -04:00
podman-volume-unmount.1.md
Fix manpage headers
2022-09-06 09:37:13 -07:00
podman-volume.1.md
man pages and command help: clean up descriptions
2023-05-28 18:57:43 +02:00
podman-wait.1.md.in
container wait: support health states
2023-06-23 14:16:32 +02:00
podman.1.md
cmd: support --config option to locate authentication file
2024-01-10 09:31:43 +01:00
podmansh.1.md
[skip-ci] Improve podmansh(1)
2023-09-30 17:33:17 +05:30