shu-kitamura fa67681601 docs: add three examples to podman-generate-spec man page ...

This patch adds three examples to the podman-generate-spec.1 man page:

- Example of executed without any options
- Example of executed with the `--compact` option
- Example of executed with the `--filename` option

Fixes: #26377

Signed-off-by: shu-kitamura <shusei3316@yahoo.co.jp>

2025-06-19 20:17:08 +09:00

..

links

Install podman-systemd.unit man page, make quadlet discoverable

2023-02-03 08:42:20 -06:00

options

artifact mount: add new name option to specify filename

2025-06-14 12:25:21 +02:00

.gitignore

Add --no-trunc to artifact ls

2025-01-31 16:19:18 -06:00

podman-artifact-add.1.md.in

Add ability to set layer media type for artifacts

2025-04-17 10:36:21 -05:00

podman-artifact-extract.1.md

add podman artifact extract

2025-02-11 14:36:53 +01:00

podman-artifact-inspect.1.md

podman artifact

2025-01-21 12:47:30 -06:00

podman-artifact-ls.1.md.in

Add --noheading to artifact ls

2025-02-03 10:50:46 -06:00

podman-artifact-pull.1.md.in

podman artifact

2025-01-21 12:47:30 -06:00

podman-artifact-push.1.md.in

podman artifact

2025-01-21 12:47:30 -06:00

podman-artifact-rm.1.md

Add --all to artifact rm

2025-02-20 09:38:50 -06:00

podman-artifact.1.md

add podman artifact extract

2025-02-11 14:36:53 +01:00

podman-attach.1.md.in

Add information about --latest support on man pages

2024-01-23 07:28:40 -05:00

podman-auto-update.1.md.in

Avoid indirect links through quadlet(5)

2025-01-22 13:19:50 -07:00

podman-build.1.md.in

Bump to Buildah v1.40.0

2025-04-22 16:50:02 -04:00

podman-commit.1.md

Create a podman-troubleshooting man page

2024-08-28 05:49:45 -06:00

podman-completion.1.md

Remove unnecessary backslashes

2023-08-02 15:01:16 +01:00

podman-compose.1.md.in

compose docs: fix typo

2025-01-17 08:30:45 +01:00

podman-container-checkpoint.1.md

docs: drop --pre-checkpoint requirement

2025-05-15 08:42:31 +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

Fix up example description of podman-container commands

2024-02-19 15:18:51 -05:00

podman-container-diff.1.md.in

fix 26348: add container diff --latest doc

2025-06-13 11:28:11 +02: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

Bunch of trivial manpage fixes

2025-06-12 02:22:42 -04:00

podman-container-prune.1.md

Fix up example description of podman-container commands

2024-02-19 15:18:51 -05:00

podman-container-restore.1.md

Bunch of trivial manpage fixes

2025-06-12 02:22:42 -04: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

docs: Improve spelling and formatting

2025-03-24 16:35:29 -06:00

podman-create.1.md.in

Add --no-hostname option

2025-01-15 06:51:32 -05:00

podman-diff.1.md.in

Bunch of trivial manpage fixes

2025-06-12 02:22:42 -04:00

podman-events.1.md

Add "create" and "remove" events for secrets.

2025-02-28 16:58:06 +01:00

podman-exec.1.md.in

Manpages: add podman exec missing example of detach option

2025-06-12 14:43:15 +02:00

podman-export.1.md

Fix up example description of podman-export/export commands

2024-02-18 12:26:33 -05:00

podman-farm-build.1.md.in

Bump to Buildah v1.40.0

2025-04-22 16:50:02 -04:00

podman-farm-create.1.md

Bunch of trivial manpage fixes

2025-06-12 02:22:42 -04:00

podman-farm-list.1.md

Fix up example description of podman-farm commands

2024-02-18 08:02:29 -05:00

podman-farm-remove.1.md

Fix up example description of podman-farm commands

2024-02-18 08:02:29 -05:00

podman-farm-update.1.md

Fix up example description of podman-farm commands

2024-02-18 08:02:29 -05:00

podman-farm.1.md

document new connection/farm storage location

2024-02-08 18:05:32 +01:00

podman-generate-spec.1.md

docs: add three examples to podman-generate-spec man page

2025-06-19 20:17:08 +09:00

podman-generate-systemd.1.md

docs: generate-systemd: add clarification statement

2024-03-11 09:03:36 +01:00

podman-generate.1.md

Deprecate podman generate systemd

2023-08-03 06:58:53 -04:00

podman-healthcheck-run.1.md

Fix up example description of podman-healthcheck-run.1.md

2024-02-17 13:54:15 -05:00

podman-healthcheck.1.md

…

podman-history.1.md

Apply suggestions from code review

2024-02-20 05:38:19 -05:00

podman-image-diff.1.md

Bunch of trivial manpage fixes

2025-06-12 02:22:42 -04:00

podman-image-exists.1.md

Fix up example description of podman-image commands

2024-02-18 07:41:47 -05:00

podman-image-inspect.1.md

Fix up example description of podman-image commands

2024-02-18 07:41:47 -05:00

podman-image-mount.1.md

Bunch of trivial manpage fixes

2025-06-12 02:22:42 -04:00

podman-image-prune.1.md

docs: Improve spelling and formatting

2025-03-24 16:35:29 -06:00

podman-image-scp.1.md

Fix up example description of podman-image commands

2024-02-18 07:41:47 -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

Fix up example description of podman-image commands

2024-02-18 07:41:47 -05:00

podman-image-trust.1.md.in

Fix up example description of podman-image commands

2024-02-18 07:41:47 -05:00

podman-image-unmount.1.md

add more exmples applying current style for each page

2025-06-16 19:52:36 +02: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

Bunch of trivial manpage fixes

2025-06-12 02:22:42 -04:00

podman-import.1.md

Improve the file format documentation of podman-import.

2025-03-31 18:00:23 +02:00

podman-info.1.md

Fix up example description of podman-info.1.md

2024-02-17 13:54:19 -05:00

podman-init.1.md.in

Add examples of --all flag

2025-06-13 04:47:22 -04:00

podman-inspect.1.md.in

Bunch of trivial manpage fixes

2025-06-12 02:22:42 -04:00

podman-kill.1.md.in

Fix up example description of podman-kill.1.md.in

2024-02-19 10:06:05 -05: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

Add support for Job to kube generate & play

2024-09-05 11:36:38 -04:00

podman-kube-play.1.md.in

Support --cpuset-<cpus/mems> in podman kube play

2025-05-22 11:45:01 +02:00

podman-kube.1.md

[CI:DOCS] Update kube docs

2024-04-04 09:28:21 -04:00

podman-load.1.md

Bunch of trivial manpage fixes

2025-06-12 02:22:42 -04:00

podman-login.1.md.in

man pages: refactor two more options

2024-09-03 11:13:46 -06:00

podman-logout.1.md.in

man pages: refactor two more options

2024-09-03 11:13:46 -06:00

podman-logs.1.md.in

Fix language, typos and markdown layout

2023-07-24 11:18:25 +02:00

podman-machine-cp.1.md

Introduce podman machine cp command

2025-02-28 09:56:46 -05:00

podman-machine-info.1.md

Add disclaimer to podman machine info manpage.

2024-09-03 15:23:18 -04:00

podman-machine-init.1.md.in

Manpages: podman machine init add example with --now

2025-06-13 08:00:01 +02:00

podman-machine-inspect.1.md

Add Rosetta support for Apple Silicon mac

2024-05-17 17:53:28 +09:00

podman-machine-list.1.md.in

feat: Add support for configuring swap in Podman machine

2025-04-29 12:20:24 +10:00

podman-machine-os-apply.1.md

Update documentation for podman-machine-os-apply

2025-03-04 13:43:15 -06:00

podman-machine-os.1.md

Introduce podman machine os apply

2023-02-15 14:48:12 -05:00

podman-machine-reset.1.md

add more exmples applying current style for each page

2025-06-16 19:52:36 +02:00

podman-machine-rm.1.md

Add information about --latest support on man pages

2024-01-23 07:28:40 -05:00

podman-machine-set.1.md.in

Mention containers.conf settings for podman machine commands

2024-10-14 08:17:47 -04:00

podman-machine-ssh.1.md

Add information about --latest support on man pages

2024-01-23 07:28:40 -05:00

podman-machine-start.1.md

Add information about --latest support on man pages

2024-01-23 07:28:40 -05:00

podman-machine-stop.1.md

Add information about --latest support on man pages

2024-01-23 07:28:40 -05:00

podman-machine.1.md

Introduce podman machine cp command

2025-02-28 09:56:46 -05:00

podman-manifest-add.1.md.in

Bunch of trivial manpage fixes

2025-06-12 02:22:42 -04:00

podman-manifest-annotate.1.md.in

Bunch of trivial manpage fixes

2025-06-12 02:22:42 -04:00

podman-manifest-create.1.md.in

Add man page content for artifacts

2024-02-29 11:47:44 -05:00

podman-manifest-exists.1.md

Fix up example description of podman-manifest commands

2024-02-17 13:54:04 -05:00

podman-manifest-inspect.1.md.in

Bunch of trivial manpage fixes

2025-06-12 02:22:42 -04:00

podman-manifest-push.1.md.in

Bunch of trivial manpage fixes

2025-06-12 02:22:42 -04:00

podman-manifest-remove.1.md

podman-manifest-remove: update docs and help output

2024-09-17 11:36:12 -04:00

podman-manifest-rm.1.md

Bunch of trivial manpage fixes

2025-06-12 02:22:42 -04:00

podman-manifest.1.md

podman-manifest-remove: update docs and help output

2024-09-17 11:36:12 -04:00

podman-mount.1.md.in

Bunch of trivial manpage fixes

2025-06-12 02:22:42 -04:00

podman-network-connect.1.md

Fixes: #26374 add example network connect with mac address

2025-06-14 16:45:41 +09:00

podman-network-create.1.md

Bunch of trivial manpage fixes

2025-06-12 02:22:42 -04:00

podman-network-disconnect.1.md

Fix up example description of podman-network commands

2024-02-18 07:48:08 -05:00

podman-network-exists.1.md

Fix up example description of podman-network commands

2024-02-18 07:48:08 -05:00

podman-network-inspect.1.md

podman network inspect: include running containers

2024-02-28 16:33:26 +01:00

podman-network-ls.1.md.in

Fix up example description of podman-network commands

2024-02-18 07:48:08 -05:00

podman-network-prune.1.md

Fix up example description of podman-network commands

2024-02-18 07:48:08 -05:00

podman-network-reload.1.md.in

Fix up example description of podman-network commands

2024-02-18 07:48:08 -05:00

podman-network-rm.1.md

Removed the 'Deleted: ' prefix from each example

2025-06-17 19:00:44 +09:00

podman-network-update.1.md

Fix up example description of podman-network commands

2024-02-18 07:48:08 -05:00

podman-network.1.md

Fix slirp4netns typo in podman-network.1.md

2025-01-04 20:04:59 +02:00

podman-pause.1.md.in

update markdown documents with command filter

2025-03-31 19:27:43 +03:00

podman-pod-clone.1.md.in

Merge pull request #21180 from rhatdan/nvidia

2024-01-30 14:59:02 +00:00

podman-pod-create.1.md.in

Add --no-hostname option

2025-01-15 06:51:32 -05:00

podman-pod-exists.1.md

Fix up example description of podman-pod commands

2024-02-19 10:03:30 -05:00

podman-pod-inspect.1.md.in

Fix up example description of podman-pod commands

2024-02-19 10:03:30 -05:00

podman-pod-kill.1.md.in

Fix up example description of podman-pod commands

2024-02-19 10:03:30 -05:00

podman-pod-logs.1.md.in

Fix up example description of podman-pod commands

2024-02-19 10:03:30 -05:00

podman-pod-pause.1.md

Add examples of --all flag

2025-06-13 04:47:22 -04:00

podman-pod-prune.1.md

add more exmples applying current style for each page

2025-06-16 19:52:36 +02:00

podman-pod-ps.1.md.in

Add information about --latest support on man pages

2024-01-23 07:28:40 -05:00

podman-pod-restart.1.md

fix podman-pod-restart.1.md typo

2024-04-18 19:53:33 -04:00

podman-pod-rm.1.md.in

Fix up example description of podman-pod commands

2024-02-19 10:03:30 -05:00

podman-pod-start.1.md.in

Fix up example description of podman-pod commands

2024-02-19 10:03:30 -05:00

podman-pod-stats.1.md.in

Bunch of trivial manpage fixes

2025-06-12 02:22:42 -04:00

podman-pod-stop.1.md.in

Add information about --latest support on man pages

2024-01-23 07:28:40 -05:00

podman-pod-top.1.md.in

Add information about --latest support on man pages

2024-01-23 07:28:40 -05:00

podman-pod-unpause.1.md

Fix up example description of podman-pod commands

2024-02-19 10:03:30 -05: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

Apply suggestions from code review

2024-02-20 05:46:41 -05:00

podman-ps.1.md

docs: remove bogus markdown heading in podman-ps

2025-06-13 16:46:58 +01:00

podman-pull.1.md.in

Minor typo noticed when reading podman man page

2024-09-13 13:04:57 +01:00

podman-push.1.md.in

Bunch of trivial manpage fixes

2025-06-12 02:22:42 -04:00

podman-remote.1.md

Create a podman-troubleshooting man page

2024-08-28 05:49:45 -06:00

podman-rename.1.md

Add information about --latest support on man pages

2024-01-23 07:28:40 -05:00

podman-restart.1.md.in

update markdown documents with command filter

2025-03-31 19:27:43 +03:00

podman-rm.1.md.in

Bunch of trivial manpage fixes

2025-06-12 02:22:42 -04:00

podman-rmi.1.md

Merge pull request #26388 from tyll/rmi-no-prune

2025-06-12 13:42:50 +00:00

podman-run.1.md.in

docs: Improve spelling and formatting

2025-03-24 16:35:29 -06:00

podman-save.1.md.in

Bunch of trivial manpage fixes

2025-06-12 02:22:42 -04:00

podman-search.1.md.in

Bunch of trivial manpage fixes

2025-06-12 02:22:42 -04:00

podman-secret-create.1.md

Update podman-secret-create.1.md

2025-05-06 22:41:49 +01: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

Update docs/source/markdown/podman-secret-inspect.1.md

2025-06-12 15:52:31 +02:00

podman-secret-ls.1.md.in

chore: remove repetitive words

2024-03-22 15:11:29 +08:00

podman-secret-rm.1.md

docs: add an example to podman-secret-rm man page

2025-06-18 21:10:17 +09:00

podman-secret.1.md

Add support for secret exists

2023-04-03 15:33:50 +03:00

podman-start.1.md.in

update markdown documents with command filter

2025-03-31 19:27:43 +03:00

podman-stats.1.md.in

Apply suggestions from code review

2024-02-20 05:49:04 -05:00

podman-stop.1.md.in

update markdown documents with command filter

2025-03-31 19:27:43 +03:00

podman-system-check.1.md

Skip layer digests for podman system check --quick

2025-06-05 17:00:50 +00:00

podman-system-connection-add.1.md

Fix up example description of podman-system commands

2024-02-20 08:18:51 -05:00

podman-system-connection-default.1.md

Fix up example description of podman-system commands

2024-02-20 08:18:51 -05:00

podman-system-connection-list.1.md

Fix up example description of podman-system commands

2024-02-20 08:18:51 -05:00

podman-system-connection-remove.1.md

Add examples of --all flag

2025-06-13 04:47:22 -04:00

podman-system-connection-rename.1.md

Fix up example description of podman-system commands

2024-02-20 08:18:51 -05:00

podman-system-connection.1.md

Fix up example description of podman-system commands

2024-02-20 08:18:51 -05:00

podman-system-df.1.md

docs: add note about systemd df RECLAIMABLE bug

2025-03-17 13:38:06 +01:00

podman-system-migrate.1.md

docs: add examples to podman-system-migrate man page

2025-06-15 01:48:21 -04:00

podman-system-prune.1.md

add more exmples applying current style for each page

2025-06-16 19:52:36 +02: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

add more exmples applying current style for each page

2025-06-16 19:52:36 +02:00

podman-system-service.1.md

Add information about --latest support on man pages

2024-01-23 07:28:40 -05:00

podman-system.1.md

Add podman system check for checking storage consistency

2024-06-04 10:00:37 -04:00

podman-systemd.unit.5.md

quadlet: add InterfaceName option to network unit

2025-06-04 16:46:39 +02:00

podman-tag.1.md

Add information about --latest support on man pages

2024-01-23 07:28:40 -05:00

podman-top.1.md.in

Add information about --latest support on man pages

2024-01-23 07:28:40 -05:00

podman-unmount.1.md.in

add more exmples applying current style for each page

2025-06-16 19:52:36 +02:00

podman-unpause.1.md.in

update markdown documents with command filter

2025-03-31 19:27:43 +03:00

podman-unshare.1.md

Fix up example description of podman-unshare.1.md

2024-02-17 13:54:29 -05:00

podman-untag.1.md

Add information about --latest support on man pages

2024-01-23 07:28:40 -05:00

podman-update.1.md.in

podman-update: fix EXAMPLES

2025-06-10 14:25:57 -07:00

podman-version.1.md

…

podman-volume-create.1.md

Move 'Examples' section down in the podman-volume-create man page

2025-06-13 11:05:06 +02: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

Add information about --latest support on man pages

2024-01-23 07:28:40 -05:00

podman-volume-import.1.md

Add information about --latest support on man pages

2024-01-23 07:28:40 -05:00

podman-volume-inspect.1.md

Only stop chowning volumes once they're not empty

2024-05-22 17:47:01 -04:00

podman-volume-ls.1.md.in

Add information about --latest support on man pages

2024-01-23 07:28:40 -05:00

podman-volume-mount.1.md

Fix up example description of podman-volume commands

2024-02-19 10:09:06 -05:00

podman-volume-prune.1.md

Add information about --latest support on man pages

2024-01-23 07:28:40 -05:00

podman-volume-reload.1.md

Add information about --latest support on man pages

2024-01-23 07:28:40 -05:00

podman-volume-rm.1.md

Add information about --latest support on man pages

2024-01-23 07:28:40 -05:00

podman-volume-unmount.1.md

Fix up example description of podman-volume commands

2024-02-19 10:09:06 -05: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

podman wait: allow waiting for removal of containers

2024-08-16 15:44:02 +02:00

podman.1.md

Update links and markup in man pages

2025-04-02 17:22:43 +02:00

podmansh.1.md

docs: replace RemapUsers=keep-id with UserNS=keep-id

2025-06-08 09:06:25 +02:00