diff options
Diffstat (limited to 'docs/source')
35 files changed, 101 insertions, 369 deletions
diff --git a/docs/source/Commands.rst b/docs/source/Commands.rst index 767b09c08..2911efe18 100644 --- a/docs/source/Commands.rst +++ b/docs/source/Commands.rst @@ -13,7 +13,7 @@ Commands :doc:`commit <markdown/podman-commit.1>` Create new image based on the changed container -:doc:`container <managecontainers>` Manage Containers +:doc:`container <markdown/podman-container.1>` Manage Containers :doc:`cp <markdown/podman-cp.1>` Copy files/folders between a container and the local filesystem @@ -27,13 +27,13 @@ Commands :doc:`export <markdown/podman-export.1>` Export container's filesystem contents as a tar archive -:doc:`generate <generate>` Generated structured data +:doc:`generate <markdown/podman-generate.1>` Generated structured data -:doc:`healthcheck <healthcheck>` Manage Healthcheck +:doc:`healthcheck <markdown/podman-healthcheck.1>` Manage Healthcheck :doc:`history <markdown/podman-history.1>` Show history of a specified image -:doc:`image <image>` Manage images +:doc:`image <markdown/podman-image.1>` Manage images :doc:`images <markdown/podman-images.1>` List images in local storage @@ -55,19 +55,19 @@ Commands :doc:`logs <markdown/podman-logs.1>` Fetch the logs of a container -:doc:`machine <machine>` Manage podman's virtual machine +:doc:`machine <markdown/podman-machine.1>` Manage podman's virtual machine -:doc:`manifest <manifest>` Create and manipulate manifest lists and image indexes +:doc:`manifest <markdown/podman-manifest.1>` Create and manipulate manifest lists and image indexes :doc:`mount <markdown/podman-mount.1>` Mount a working container's root filesystem -:doc:`network <network>` Manage Networks +:doc:`network <markdown/podman-network.1>` Manage Networks :doc:`pause <markdown/podman-pause.1>` Pause all the processes in one or more containers -:doc:`play <play>` Play a pod +:doc:`play <markdown/podman-play.1>` Play a pod -:doc:`pod <pod>` Manage pods +:doc:`pod <markdown/podman-pod.1>` Manage pods :doc:`port <markdown/podman-port.1>` List port mappings or a specific mapping for the container @@ -91,7 +91,7 @@ Commands :doc:`search <markdown/podman-search.1>` Search registry for image -:doc:`secret <secret>` Manage podman secrets +:doc:`secret <markdown/podman-secret.1>` Manage podman secrets :doc:`start <markdown/podman-start.1>` Start one or more containers @@ -99,7 +99,7 @@ Commands :doc:`stop <markdown/podman-stop.1>` Stop one or more containers -:doc:`system <system>` Manage podman +:doc:`system <markdown/podman-system.1>` Manage podman :doc:`tag <markdown/podman-tag.1>` Add an additional name to a local image @@ -115,6 +115,6 @@ Commands :doc:`version <markdown/podman-version.1>` Display the Podman Version Information -:doc:`volume <volume>` Manage volumes +:doc:`volume <markdown/podman-volume.1>` Manage volumes :doc:`wait <markdown/podman-wait.1>` Block on one or more containers diff --git a/docs/source/conf.py b/docs/source/conf.py index 8210022f2..7684dd3f7 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -15,7 +15,6 @@ # sys.path.insert(0, os.path.abspath('.')) import re -from recommonmark.transform import AutoStructify # -- Project information ----------------------------------------------------- @@ -29,7 +28,7 @@ author = "team" # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = ["sphinx_markdown_tables", "recommonmark"] +extensions = ["myst_parser"] # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] @@ -63,27 +62,18 @@ html_css_files = [ # -- Extension configuration ------------------------------------------------- +# IMPORTANT: explicitly unset the extensions, by default dollarmath is enabled. +# We use the dollar sign as text and do not want it to be interpreted as math expression. +myst_enable_extensions = [] + def convert_markdown_title(app, docname, source): # Process markdown files only docpath = app.env.doc2path(docname) if docpath.endswith(".md"): - # Convert pandoc title line into eval_rst block for recommonmark - source[0] = re.sub(r"^% (.*)", r"```eval_rst\n.. title:: \g<1>\n```", source[0]) + # Convert pandoc title line into eval_rst block for myst_parser + source[0] = re.sub(r"^% (.*)", r"```{title} \g<1>\n```", source[0]) def setup(app): app.connect("source-read", convert_markdown_title) - - app.add_config_value( - "recommonmark_config", - { - "enable_eval_rst": True, - "enable_auto_doc_ref": False, - "enable_auto_toc_tree": False, - "enable_math": False, - "enable_inline_math": False, - }, - True, - ) - app.add_transform(AutoStructify) diff --git a/docs/source/connection.rst b/docs/source/connection.rst deleted file mode 100644 index 64eb18c57..000000000 --- a/docs/source/connection.rst +++ /dev/null @@ -1,12 +0,0 @@ -Manage the destination(s) for Podman service(s) -================= - -:doc:`add <markdown/podman-system-connection-add.1>` Record destination for the Podman service - -:doc:`default <markdown/podman-system-connection-default.1>` Set named destination as default for the Podman service - -:doc:`list <markdown/podman-system-connection-list.1>` List the destination for the Podman service(s) - -:doc:`remove <markdown/podman-system-connection-remove.1>` Delete named destination - -:doc:`rename <markdown/podman-system-connection-rename.1>` Rename the destination for Podman service diff --git a/docs/source/generate.rst b/docs/source/generate.rst deleted file mode 100644 index fd267ce62..000000000 --- a/docs/source/generate.rst +++ /dev/null @@ -1,6 +0,0 @@ -Generate -======== - -:doc:`kube <markdown/podman-generate-kube.1>` Generate Kubernetes pod YAML from a container or pod - -:doc:`systemd <markdown/podman-generate-systemd.1>` Generate a systemd unit file for a Podman container diff --git a/docs/source/healthcheck.rst b/docs/source/healthcheck.rst deleted file mode 100644 index 2e2f88fbc..000000000 --- a/docs/source/healthcheck.rst +++ /dev/null @@ -1,4 +0,0 @@ -HealthCheck -=========== - -:doc:`run <markdown/podman-healthcheck-run.1>` run the health check of a container diff --git a/docs/source/image.rst b/docs/source/image.rst deleted file mode 100644 index 0987a0149..000000000 --- a/docs/source/image.rst +++ /dev/null @@ -1,47 +0,0 @@ -Image -===== - - -:doc:`build <markdown/podman-build.1>` Build an image using instructions from Containerfiles - -:doc:`diff <markdown/podman-image-diff.1>` Inspect changes on an image's filesystem - -:doc:`exists <markdown/podman-image-exists.1>` Check if an image exists in local storage - -:doc:`history <markdown/podman-history.1>` Show history of a specified image - -:doc:`import <markdown/podman-import.1>` Import a tarball to create a filesystem image - -:doc:`inspect <markdown/podman-inspect.1>` Display the configuration of an image - -:doc:`list <markdown/podman-images.1>` List images in local storage - -:doc:`load <markdown/podman-load.1>` Load an image from container archive - -:doc:`mount <markdown/podman-image-mount.1>` Mount an image's root filesystem. - -:doc:`prune <markdown/podman-image-prune.1>` Remove unused images - -:doc:`pull <markdown/podman-pull.1>` Pull an image from a registry - -:doc:`push <markdown/podman-push.1>` Push an image to a specified destination - -:doc:`rm <markdown/podman-rmi.1>` Removes one or more images from local storage - -:doc:`save <markdown/podman-save.1>` Save image to an archive - -:doc:`scp <markdown/podman-image-scp.1>` Securely copy an image from one host to another - -:doc:`search <markdown/podman-search.1>` Search a registry for an image - -:doc:`sign <markdown/podman-image-sign.1>` Sign an image - -:doc:`tag <markdown/podman-tag.1>` Add an additional name to a local image - -:doc:`tree <markdown/podman-image-tree.1>` Prints layer hierarchy of an image in a tree format - -:doc:`trust <markdown/podman-image-trust.1>` Manage container image trust policy - -:doc:`unmount <markdown/podman-image-unmount.1>` Unmount an image's root filesystem - -:doc:`untag <markdown/podman-untag.1>` Removes one or more names from a locally-stored image diff --git a/docs/source/machine.rst b/docs/source/machine.rst deleted file mode 100644 index 3962fca99..000000000 --- a/docs/source/machine.rst +++ /dev/null @@ -1,15 +0,0 @@ -Machine -====== - - -:doc:`init <markdown/podman-machine-init.1>` Initialize a new virtual machine - -:doc:`list <markdown/podman-machine-list.1>` List virtual machines - -:doc:`rm <markdown/podman-machine-rm.1>` Remove a virtual machine - -:doc:`ssh <markdown/podman-machine-ssh.1>` SSH into a virtual machine - -:doc:`start <markdown/podman-machine-start.1>` Start a virtual machine - -:doc:`stop <markdown/podman-machine-stop.1>` Stop a virtual machine diff --git a/docs/source/managecontainers.rst b/docs/source/managecontainers.rst deleted file mode 100644 index 9b3978f25..000000000 --- a/docs/source/managecontainers.rst +++ /dev/null @@ -1,68 +0,0 @@ -Manage Containers -================= - -:doc:`attach <markdown/podman-attach.1>` Attach to a running container - -:doc:`checkpoint <markdown/podman-container-checkpoint.1>` Checkpoints one or more containers - -:doc:`cleanup <markdown/podman-container-cleanup.1>` Cleanup network and mountpoints of one or more containers - -:doc:`commit <markdown/podman-commit.1>` Create new image based on the changed container - -:doc:`cp <markdown/podman-cp.1>` Copy files/folders between a container and the local filesystem - -:doc:`create <markdown/podman-create.1>` Create but do not start a container - -:doc:`diff <markdown/podman-diff.1>` Inspect changes on container's file systems - -:doc:`exec <markdown/podman-exec.1>` Run a process in a running container - -:doc:`exists <markdown/podman-container-exists.1>` Check if a container exists in local storage - -:doc:`export <markdown/podman-export.1>` Export container's filesystem contents as a tar archive - -:doc:`init <markdown/podman-init.1>` Initialize one or more containers - -:doc:`inspect <markdown/podman-inspect.1>` Display the configuration of a container or image - -:doc:`kill <markdown/podman-kill.1>` Kill one or more running containers with a specific signal - -:doc:`list <markdown/podman-ps.1>` List containers - -:doc:`logs <markdown/podman-logs.1>` Fetch the logs of a container - -:doc:`mount <markdown/podman-mount.1>` Mount a working container's root filesystem - -:doc:`pause <markdown/podman-pause.1>` Pause all the processes in one or more containers - -:doc:`port <markdown/podman-port.1>` List port mappings or a specific mapping for the container - -:doc:`prune <markdown/podman-container-prune.1>` Remove all stopped containers - -:doc:`ps <markdown/podman-ps.1>` List containers - -:doc:`rename <markdown/podman-rename.1>` Rename an existing container - -:doc:`restart <markdown/podman-restart.1>` Restart one or more containers - -:doc:`restore <markdown/podman-container-restore.1>` Restores one or more containers from a checkpoint - -:doc:`rm <markdown/podman-rm.1>` Remove one or more containers - -:doc:`run <markdown/podman-run.1>` Run a command in a new container - -:doc:`runlabel <markdown/podman-container-runlabel.1>` Execute the command described by an image label - -:doc:`start <markdown/podman-start.1>` Start one or more containers - -:doc:`stats <markdown/podman-stats.1>` Display a live stream of container resource usage statistics - -:doc:`stop <markdown/podman-stop.1>` Stop one or more containers - -:doc:`top <markdown/podman-top.1>` Display the running processes of a container - -:doc:`unmount <markdown/podman-unmount.1>` Unmounts working container's root filesystem - -:doc:`unpause <markdown/podman-unpause.1>` Unpause the processes in one or more containers - -:doc:`wait <markdown/podman-wait.1>` Block on one or more containers diff --git a/docs/source/manifest.rst b/docs/source/manifest.rst deleted file mode 100644 index f0a06c2c7..000000000 --- a/docs/source/manifest.rst +++ /dev/null @@ -1,18 +0,0 @@ -Create and manipulate manifest lists and image indexes -================= - -:doc:`add <markdown/podman-manifest-add.1>` Add an image to a manifest list or image index - -:doc:`annotate <markdown/podman-manifest-annotate.1>` Add or update information about an entry in a manifest list or image index - -:doc:`create <markdown/podman-manifest-create.1>` Create a manifest list or image index - -:doc:`exists <markdown/podman-manifest-exists.1>` Check if the given manifest list exists in local storage - -:doc:`inspect <markdown/podman-manifest-inspect.1>` Display a manifest list or image index - -:doc:`push <markdown/podman-manifest-push.1>` Push a manifest list or image index to a registry - -:doc:`remove <markdown/podman-manifest-remove.1>` Remove an image from a manifest list or image index - -:doc:`rm <markdown/podman-manifest-rm.1>` Remove manifest list or image index from local storage diff --git a/docs/source/markdown/podman-auto-update.1.md b/docs/source/markdown/podman-auto-update.1.md index a1d2f291b..4952e09dc 100644 --- a/docs/source/markdown/podman-auto-update.1.md +++ b/docs/source/markdown/podman-auto-update.1.md @@ -41,7 +41,7 @@ If the authorization state is not found there, `$HOME/.docker/config.json` is ch Note: There is also the option to override the default path of the authentication file by setting the `REGISTRY_AUTH_FILE` environment variable. This can be done with **export REGISTRY_AUTH_FILE=_path_**. -#### **--dry-run**=*true|false* +#### **--dry-run** Check for the availability of new images but do not perform any pull operation or restart any service or container. The `UPDATED` field indicates the availability of a new image with "pending". @@ -51,7 +51,7 @@ The `UPDATED` field indicates the availability of a new image with "pending". Change the default output format. This can be of a supported type like 'json' or a Go template. Valid placeholders for the Go template are listed below: -#### **--rollback**=*true|false* +#### **--rollback** If restarting a systemd unit after updating the image has failed, rollback to using the previous image and restart the unit another time. Default is true. diff --git a/docs/source/markdown/podman-build.1.md b/docs/source/markdown/podman-build.1.md index 3278436bd..98c8251b4 100644 --- a/docs/source/markdown/podman-build.1.md +++ b/docs/source/markdown/podman-build.1.md @@ -292,7 +292,7 @@ context. If you specify `-f -`, the Containerfile contents will be read from stdin. -#### **--force-rm**=*true|false* +#### **--force-rm** Always remove intermediate containers after a build, even if the build fails (default true). @@ -474,7 +474,7 @@ Suppress output messages which indicate which instruction is being processed, and of progress when pulling images from a registry, and when writing the output image. -#### **--rm**=*true|false* +#### **--rm** Remove intermediate containers after a successful build (default true). @@ -579,7 +579,7 @@ specified and therefore not changed, allowing the image's sha256 hash to remain same. All files committed to the layers of the image will be created with the timestamp. -#### **--tls-verify**=*true|false* +#### **--tls-verify** Require HTTPS and verify certificates when talking to container registries (defaults to true). (This option is not available with the remote Podman client) diff --git a/docs/source/markdown/podman-cp.1.md b/docs/source/markdown/podman-cp.1.md index 1929bed1f..0c375675d 100644 --- a/docs/source/markdown/podman-cp.1.md +++ b/docs/source/markdown/podman-cp.1.md @@ -56,7 +56,7 @@ Further note that `podman cp` does not support globbing (e.g., `cp dir/*.txt`). ## OPTIONS -#### **--archive**, **-a**=**true** | *false* +#### **--archive**, **-a** Archive mode (copy all uid/gid information). When set to true, files copied to a container will have changed ownership to the primary UID/GID of the container. diff --git a/docs/source/markdown/podman-create.1.md b/docs/source/markdown/podman-create.1.md index 63836d040..0c48f105e 100644 --- a/docs/source/markdown/podman-create.1.md +++ b/docs/source/markdown/podman-create.1.md @@ -346,7 +346,7 @@ This option allows arbitrary environment variables that are available for the pr See [**Environment**](#environment) note below for precedence and examples. -#### **--env-host**=*true|false* +#### **--env-host** Use host environment inside of the container. See **Environment** note below for precedence. (This option is not available with the remote Podman client) @@ -414,7 +414,7 @@ Sets the container host name that is available inside the container. Can only be Print usage statement -#### **--http-proxy**=*true|false* +#### **--http-proxy** By default proxy environment variables are passed into the container if set for the Podman process. This can be disabled by setting the `--http-proxy` @@ -465,7 +465,7 @@ pod when that pod is not running. Path to the container-init binary. -#### **--interactive**, **-i**=*true|false* +#### **--interactive**, **-i** Keep STDIN open even if not attached. The default is *false*. @@ -684,18 +684,18 @@ Valid _mode_ values are: Add network-scoped alias for the container -#### **--no-healthcheck**=*true|false* +#### **--no-healthcheck** Disable any defined healthchecks for container. -#### **--no-hosts**=*true|false* +#### **--no-hosts** Do not create /etc/hosts for the container. By default, Podman will manage /etc/hosts, adding the container's own IP address and any hosts from **--add-host**. #### **--no-hosts** disables this, and the image's **/etc/host** will be preserved unmodified. This option conflicts with **--add-host**. -#### **--oom-kill-disable**=*true|false* +#### **--oom-kill-disable** Whether to disable OOM Killer for the container or not. @@ -737,7 +737,7 @@ To make a pod with more granular options, use the `podman pod create` command be Run container in an existing pod and read the pod's ID from the specified file. If a container is run within a pod, and the pod has an infra-container, the infra-container will be started before the container is. -#### **--privileged**=*true|false* +#### **--privileged** Give extended privileges to this container. The default is *false*. @@ -776,7 +776,7 @@ associated ports. If one container binds to a port, no other container can use t within the pod while it is in use. Containers in the pod can also communicate over localhost by having one container bind to localhost in the pod, and another connect to that port. -#### **--publish-all**, **-P**=*true|false* +#### **--publish-all**, **-P** Publish all exposed ports to random ports on the host interfaces. The default is *false*. @@ -801,7 +801,7 @@ Defaults to *missing*. Suppress output information when pulling images -#### **--read-only**=*true|false* +#### **--read-only** Mount the container's root filesystem as read only. @@ -809,11 +809,11 @@ By default a container will have its root filesystem writable allowing processes to write files anywhere. By specifying the `--read-only` flag the container will have its root filesystem mounted as read only prohibiting any writes. -#### **--read-only-tmpfs**=*true|false* +#### **--read-only-tmpfs** If container is running in --read-only mode, then mount a read-write tmpfs on /run, /tmp, and /var/tmp. The default is *true* -#### **--replace**=**true**|**false** +#### **--replace** If another container with the same name already exists, replace and remove it. The default is **false**. @@ -839,7 +839,7 @@ Please note that restart will not restart containers after a system reboot. If this functionality is required in your environment, you can invoke Podman from a systemd unit file, or create an init script for whichever init system is in use. To generate systemd unit files, please see *podman generate systemd* -#### **--rm**=*true|false* +#### **--rm** Automatically remove the container when it exits. The default is *false*. @@ -1001,7 +1001,7 @@ Maximum time a container is allowed to run before conmon sends it the kill signal. By default containers will run until they exit or are stopped by `podman stop`. -#### **--tls-verify**=**true**|**false** +#### **--tls-verify** Require HTTPS and verify certificates when contacting registries (default: true). If explicitly set to true, then TLS verification will be used. If set to false, then TLS verification will not be used. If not specified, TLS verification will be used unless the target registry is listed as an insecure registry in registries.conf. @@ -1018,7 +1018,7 @@ options are the same as the Linux default `mount` flags. If you do not specify any options, the systems uses the following options: `rw,noexec,nosuid,nodev`. -#### **--tty**, **-t**=*true|false* +#### **--tty**, **-t** Allocate a pseudo-TTY. The default is *false*. diff --git a/docs/source/markdown/podman-events.1.md b/docs/source/markdown/podman-events.1.md index 4f9e9418f..3c8b46884 100644 --- a/docs/source/markdown/podman-events.1.md +++ b/docs/source/markdown/podman-events.1.md @@ -93,6 +93,10 @@ filters are supported: In the case where an ID is used, the ID may be in its full or shortened form. +#### **--no-trunc** + +Do not truncate the output (default *true*). + #### **--since**=*timestamp* Show all events created since the given timestamp diff --git a/docs/source/markdown/podman-exec.1.md b/docs/source/markdown/podman-exec.1.md index 524ee50f0..d739e1f5d 100644 --- a/docs/source/markdown/podman-exec.1.md +++ b/docs/source/markdown/podman-exec.1.md @@ -30,7 +30,7 @@ command to be executed. Read in a line delimited file of environment variables. -#### **--interactive**, **-i**=*true|false* +#### **--interactive**, **-i** When set to true, keep stdin open even if not attached. The default is *false*. diff --git a/docs/source/markdown/podman-history.1.md b/docs/source/markdown/podman-history.1.md index 2dd41e9f5..c9d01f105 100644 --- a/docs/source/markdown/podman-history.1.md +++ b/docs/source/markdown/podman-history.1.md @@ -29,19 +29,15 @@ Valid placeholders for the Go template are listed below: ## OPTIONS -#### **--human**, **-H**=*true|false* +#### **--human**, **-H** Display sizes and dates in human readable format (default *true*). -#### **--no-trunc**=*true|false* +#### **--no-trunc** Do not truncate the output (default *false*). -#### **--notruncate** - -Do not truncate the output - -#### **--quiet**, **-q**=*true|false* +#### **--quiet**, **-q** Print the numeric IDs only (default *false*). #### **--format**=*format* diff --git a/docs/source/markdown/podman-images.1.md b/docs/source/markdown/podman-images.1.md index 02385daec..a346b7810 100644 --- a/docs/source/markdown/podman-images.1.md +++ b/docs/source/markdown/podman-images.1.md @@ -35,13 +35,13 @@ Filter output based on conditions provided **before=IMAGE** Filter on images created before the given IMAGE (name or tag). - **dangling=true|false** + **dangling Show dangling images. Dangling images are a file system layer that was used in a previous build of an image and is no longer referenced by any image. They are denoted with the `<none>` tag, consume disk space and serve no active purpose. **label** Filter by images labels key and/or value. - **readonly=true|false** + **readonly Show only read only images or Read/Write images. The default is to show both. Read/Only images can be configured by modifying the "additionalimagestores" in the /etc/containers/storage.conf file. **reference=** @@ -74,13 +74,13 @@ Omit the table headings from the listing of images. #### **--no-trunc** -Do not truncate output. +Do not truncate the output (default *false*). #### **--quiet**, **-q** Lists only the image IDs. -#### **--sort**=*sort* +#### **--sort**=*sort*=*created* Sort by created, id, repository, size or tag (default: created) diff --git a/docs/source/markdown/podman-inspect.1.md b/docs/source/markdown/podman-inspect.1.md index bfd0cea3d..ae26c1bbb 100644 --- a/docs/source/markdown/podman-inspect.1.md +++ b/docs/source/markdown/podman-inspect.1.md @@ -13,14 +13,10 @@ all results in a JSON array. If the inspect type is all, the order of inspection So, if a container has the same name as an image, then the container JSON will be returned, and so on. If a format is specified, the given template will be executed for each result. -For more inspection options, see: - - podman container inspect - podman image inspect - podman network inspect - podman pod inspect - podman volume inspect - +For more inspection options, see also +[podman-network-inspect(1)](podman-network-inspect.1.md), +[podman-pod-inspect(1)](podman-pod-inspect.1.md), and +[podman-volume-inspect(1)](podman-volume-inspect.1.md). ## OPTIONS diff --git a/docs/source/markdown/podman-login.1.md b/docs/source/markdown/podman-login.1.md index 3e23600fa..2559f4b77 100644 --- a/docs/source/markdown/podman-login.1.md +++ b/docs/source/markdown/podman-login.1.md @@ -56,7 +56,7 @@ Password for registry Take the password from stdin -#### **--tls-verify**=*true|false* +#### **--tls-verify** Require HTTPS and verify certificates when contacting registries (default: true). If explicitly set to true, then TLS verification will be used. If set to false, then TLS verification will not be used. If not specified, diff --git a/docs/source/markdown/podman-mount.1.md b/docs/source/markdown/podman-mount.1.md index 1b1b09120..110fb0500 100644 --- a/docs/source/markdown/podman-mount.1.md +++ b/docs/source/markdown/podman-mount.1.md @@ -40,9 +40,9 @@ Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last started container could be from either of those methods. (This option is not available with the remote Podman client) -#### **--notruncate** +#### **--no-trunc** -Do not truncate IDs in output. +Do not truncate the output (default *false*). ## EXAMPLE diff --git a/docs/source/markdown/podman-play-kube.1.md b/docs/source/markdown/podman-play-kube.1.md index c170d6495..7e3e0f431 100644 --- a/docs/source/markdown/podman-play-kube.1.md +++ b/docs/source/markdown/podman-play-kube.1.md @@ -146,11 +146,11 @@ Suppress output information when pulling images Directory path for seccomp profiles (default: "/var/lib/kubelet/seccomp"). (This option is not available with the remote Podman client) -#### **--start**=*true|false* +#### **--start** Start the pod after creating it, set to false to only create it. -#### **--tls-verify**=*true|false* +#### **--tls-verify** Require HTTPS and verify certificates when contacting registries (default: true). If explicitly set to true, then TLS verification will be used. If set to false, then TLS verification will not be used. If not specified, diff --git a/docs/source/markdown/podman-pod-create.1.md b/docs/source/markdown/podman-pod-create.1.md index bed94080a..b4c3fc2eb 100644 --- a/docs/source/markdown/podman-pod-create.1.md +++ b/docs/source/markdown/podman-pod-create.1.md @@ -78,7 +78,7 @@ Print usage statement. Set a hostname to the pod -#### **--infra**=**true**|**false** +#### **--infra** Create an infra container and associate it with the pod. An infra container is a lightweight container used to coordinate the shared kernel namespace of a pod. Default: true. @@ -143,7 +143,7 @@ Set network mode for the pod. Supported values are: Add a DNS alias for the container. When the container is joined to a CNI network with support for the dnsname plugin, the container will be accessible through this name from other containers in the network. -#### **--no-hosts**=**true**|**false** +#### **--no-hosts** Disable creation of /etc/hosts for the pod. @@ -170,7 +170,7 @@ Use `podman port` to see the actual mapping: `podman port CONTAINER $CONTAINERPO NOTE: This cannot be modified once the pod is created. -#### **--replace**=**true**|**false** +#### **--replace** If another pod with the same name already exists, replace and remove it. The default is **false**. diff --git a/docs/source/markdown/podman-pod-ps.1.md b/docs/source/markdown/podman-pod-ps.1.md index ed0789e93..41e06347e 100644 --- a/docs/source/markdown/podman-pod-ps.1.md +++ b/docs/source/markdown/podman-pod-ps.1.md @@ -50,7 +50,7 @@ Omit the table headings from the listing of pods. #### **--no-trunc** -Display the extended information +Do not truncate the output (default *false*). #### **--ns** diff --git a/docs/source/markdown/podman-ps.1.md b/docs/source/markdown/podman-ps.1.md index 40d26b86d..b1a944942 100644 --- a/docs/source/markdown/podman-ps.1.md +++ b/docs/source/markdown/podman-ps.1.md @@ -106,7 +106,7 @@ Omit the table headings from the listing of containers. #### **--no-trunc** -Display the extended information +Do not truncate the output (default *false*). #### **--pod**, **-p** @@ -116,11 +116,10 @@ Display the pods the containers are associated with Print the numeric IDs of the containers only -#### **--sort** +#### **--sort**=*created* Sort by command, created, id, image, names, runningfor, size, or status", Note: Choosing size will sort by size of rootFs, not alphabetically like the rest of the options -Default: created #### **--size**, **-s** diff --git a/docs/source/markdown/podman-pull.1.md b/docs/source/markdown/podman-pull.1.md index aa0815f4b..7fd9732d6 100644 --- a/docs/source/markdown/podman-pull.1.md +++ b/docs/source/markdown/podman-pull.1.md @@ -95,7 +95,7 @@ Specify the platform for selecting the image. The `--platform` option can be use Suppress output information when pulling images -#### **--tls-verify**=*true|false* +#### **--tls-verify** Require HTTPS and verify certificates when contacting registries (default: true). If explicitly set to true, then TLS verification will be used. If set to false, then TLS verification will not be used. If not specified, @@ -234,7 +234,7 @@ Storing signatures ``` ## SEE ALSO -**[podman(1)](podman.1.md)**, **[podman-push(1)](podman-push.1.md)**, **[podman-login(1)](podman-login.1.md)**, **[containers-certs.d(5](https://github.com/containers/image/blob/main/docs/containers-certs.d.5.md)**, **[containers-registries.conf(5)](https://github.com/containers/image/blob/main/docs/containers-registries.d.5.md)**, **[containers-transports(5)](https://github.com/containers/image/blob/main/docs/containers-transports.5.md)** +**[podman(1)](podman.1.md)**, **[podman-push(1)](podman-push.1.md)**, **[podman-login(1)](podman-login.1.md)**, **[containers-certs.d(5)](https://github.com/containers/image/blob/main/docs/containers-certs.d.5.md)**, **[containers-registries.conf(5)](https://github.com/containers/image/blob/main/docs/containers-registries.d.5.md)**, **[containers-transports(5)](https://github.com/containers/image/blob/main/docs/containers-transports.5.md)** ## HISTORY July 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com> diff --git a/docs/source/markdown/podman-push.1.md b/docs/source/markdown/podman-push.1.md index 68478accd..089d169fb 100644 --- a/docs/source/markdown/podman-push.1.md +++ b/docs/source/markdown/podman-push.1.md @@ -97,7 +97,7 @@ Discard any pre-existing signatures in the image. (This option is not available Add a signature at the destination using the specified key. (This option is not available with the remote Podman client) -#### **--tls-verify**=*true|false* +#### **--tls-verify** Require HTTPS and verify certificates when contacting registries (default: true). If explicitly set to true, then TLS verification will be used. If set to false, then TLS verification will not be used. If not specified, diff --git a/docs/source/markdown/podman-run.1.md b/docs/source/markdown/podman-run.1.md index 3a6803aaa..7b6a56fc6 100644 --- a/docs/source/markdown/podman-run.1.md +++ b/docs/source/markdown/podman-run.1.md @@ -270,7 +270,7 @@ Memory nodes (MEMs) in which to allow execution. Only effective on NUMA systems. For example, if you have four memory nodes (0-3) on your system, use **--cpuset-mems=0,1** to only use memory from the first two memory nodes. -#### **--detach**, **-d**=**true**|**false** +#### **--detach**, **-d** Detached mode: run the container in the background and print the new container ID. The default is *false*. @@ -381,7 +381,7 @@ This option allows arbitrary environment variables that are available for the pr See [**Environment**](#environment) note below for precedence and examples. -#### **--env-host**=**true**|**false** +#### **--env-host** Use host environment inside of the container. See **Environment** note below for precedence. (This option is not available with the remote Podman client) @@ -456,7 +456,7 @@ Container host name Sets the container host name that is available inside the container. Can only be used with a private UTS namespace `--uts=private` (default). If `--pod` is specified and the pod shares the UTS namespace (default) the pod's hostname will be used. -#### **--http-proxy**=**true**|**false** +#### **--http-proxy** By default proxy environment variables are passed into the container if set for the Podman process. This can be disabled by setting the value to **false**. @@ -488,7 +488,7 @@ Run an init inside the container that forwards signals and reaps processes. Path to the container-init binary. -#### **--interactive**, **-i**=**true**|**false** +#### **--interactive**, **-i** When set to **true**, keep stdin open even if not attached. The default is **false**. @@ -704,11 +704,11 @@ Valid _mode_ values are: Add network-scoped alias for the container -#### **--no-healthcheck**=*true|false* +#### **--no-healthcheck** Disable any defined healthchecks for container. -#### **--no-hosts**=**true**|**false** +#### **--no-hosts** Do not create _/etc/hosts_ for the container. @@ -716,7 +716,7 @@ By default, Podman will manage _/etc/hosts_, adding the container's own IP addre #### **--no-hosts** disables this, and the image's _/etc/hosts_ will be preserved unmodified. This option conflicts with **--add-host**. -#### **--oom-kill-disable**=**true**|**false** +#### **--oom-kill-disable** Whether to disable OOM Killer for the container or not. @@ -766,7 +766,7 @@ If a container is run within a pod, and the pod has an infra-container, the infr Pass down to the process N additional file descriptors (in addition to 0, 1, 2). The total FDs will be 3+N. (This option is not available with the remote Podman client) -#### **--privileged**=**true**|**false** +#### **--privileged** Give extended privileges to this container. The default is **false**. @@ -804,7 +804,7 @@ associated ports. If one container binds to a port, no other container can use t within the pod while it is in use. Containers in the pod can also communicate over localhost by having one container bind to localhost in the pod, and another connect to that port. -#### **--publish-all**, **-P**=**true**|**false** +#### **--publish-all**, **-P** Publish all exposed ports to random ports on the host interfaces. The default is **false**. @@ -829,7 +829,7 @@ Pull image before running. The default is **missing**. Suppress output information when pulling images -#### **--read-only**=**true**|**false** +#### **--read-only** Mount the container's root filesystem as read only. @@ -837,11 +837,11 @@ By default a container will have its root filesystem writable allowing processes to write files anywhere. By specifying the **--read-only** flag, the container will have its root filesystem mounted as read only prohibiting any writes. -#### **--read-only-tmpfs**=**true**|**false** +#### **--read-only-tmpfs** If container is running in **--read-only** mode, then mount a read-write tmpfs on _/run_, _/tmp_, and _/var/tmp_. The default is **true**. -#### **--replace**=**true**|**false** +#### **--replace** If another container with the same name already exists, replace and remove it. The default is **false**. @@ -867,11 +867,11 @@ Please note that restart will not restart containers after a system reboot. If this functionality is required in your environment, you can invoke Podman from a **systemd.unit**(5) file, or create an init script for whichever init system is in use. To generate systemd unit files, please see **podman generate systemd**. -#### **--rm**=**true**|**false** +#### **--rm** Automatically remove the container when it exits. The default is **false**. -#### **--rmi**=*true|false* +#### **--rmi** After exit of the container, remove the image unless another container is using it. The default is *false*. @@ -974,7 +974,7 @@ Size of _/dev/shm_. A _unit_ can be **b** (bytes), **k** (kilobytes), **m** (meg If you omit the unit, the system uses bytes. If you omit the size entirely, the default is **64m**. When _size_ is **0**, there is no limit on the amount of memory used for IPC by the container. -#### **--sig-proxy**=**true**|**false** +#### **--sig-proxy** Sets whether the signals sent to the **podman run** command are proxied to the container process. SIGCHLD, SIGSTOP, and SIGKILL are not proxied. The default is **true**. @@ -1058,7 +1058,7 @@ Maximum time a container is allowed to run before conmon sends it the kill signal. By default containers will run until they exit or are stopped by `podman stop`. -#### **--tls-verify**=**true**|**false** +#### **--tls-verify** Require HTTPS and verify certificates when contacting registries (default: true). If explicitly set to true, then TLS verification will be used. If set to false, then TLS verification will not be used. If not specified, TLS verification will be used unless the target registry is listed as an insecure registry in registries.conf. @@ -1077,7 +1077,7 @@ options are the same as the Linux default mount flags. If you do not specify any options, the systems uses the following options: **rw,noexec,nosuid,nodev**. -#### **--tty**, **-t**=**true**|**false** +#### **--tty**, **-t** Allocate a pseudo-TTY. The default is **false**. diff --git a/docs/source/markdown/podman-search.1.md b/docs/source/markdown/podman-search.1.md index 661ad6742..d541e5c93 100644 --- a/docs/source/markdown/podman-search.1.md +++ b/docs/source/markdown/podman-search.1.md @@ -81,9 +81,9 @@ The result contains the Image name and its tag, one line for every tag associate #### **--no-trunc** -Do not truncate the output +Do not truncate the output (default *false*). -#### **--tls-verify**=*true|false* +#### **--tls-verify** Require HTTPS and verify certificates when contacting registries (default: true). If explicitly set to true, then TLS verification will be used. If set to false, then TLS verification will not be used if needed. If not specified, @@ -169,7 +169,7 @@ Note: This works only with registries that implement the v2 API. If tried with a **registries.conf** (`/etc/containers/registries.conf`) - registries.conf is the configuration file which specifies which container registries should be consulted when completing image names which do not include a registry or domain portion. +registries.conf is the configuration file which specifies which container registries should be consulted when completing image names which do not include a registry or domain portion. ## SEE ALSO podman(1), containers-registries.conf(5) diff --git a/docs/source/markdown/podman-start.1.md b/docs/source/markdown/podman-start.1.md index ae05da817..a751a098b 100644 --- a/docs/source/markdown/podman-start.1.md +++ b/docs/source/markdown/podman-start.1.md @@ -34,7 +34,7 @@ Attach container's STDIN. The default is false. Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last started container could be from either of those methods. (This option is not available with the remote Podman client) -#### **--sig-proxy**=*true|false* +#### **--sig-proxy** Proxy received signals to the process (non-TTY mode only). SIGCHLD, SIGSTOP, and SIGKILL are not proxied. The default is *true* when attaching, *false* otherwise. diff --git a/docs/source/markdown/podman.1.md b/docs/source/markdown/podman.1.md index 2510eaa81..8b5f385cb 100644 --- a/docs/source/markdown/podman.1.md +++ b/docs/source/markdown/podman.1.md @@ -152,7 +152,7 @@ specify additional options via the `--storage-opt` flag. Storage driver option, Default storage driver options are configured in /etc/containers/storage.conf (`$HOME/.config/containers/storage.conf` in rootless mode). The `STORAGE_OPTS` environment variable overrides the default. The --storage-opt specified options overrides all. If you specify --storage-opt="", no storage options will be used. -#### **--syslog**=*true|false* +#### **--syslog** Output logging information to syslog as well as the console (default *false*). @@ -276,7 +276,7 @@ the exit codes follow the `chroot` standard, see below: **containers.conf** (`/usr/share/containers/containers.conf`, `/etc/containers/containers.conf`, `$HOME/.config/containers/containers.conf`) - Podman has builtin defaults for command line options. These defaults can be overridden using the containers.conf configuration files. +Podman has builtin defaults for command line options. These defaults can be overridden using the containers.conf configuration files. Distributions ship the `/usr/share/containers/containers.conf` file with their default settings. Administrators can override fields in this file by creating the `/etc/containers/containers.conf` file. Users can further modify defaults by creating the `$HOME/.config/containers/containers.conf` file. Podman merges its builtin defaults with the specified fields from these files, if they exist. Fields specified in the users file override the administrator's file, which overrides the distribution's file, which override the built-in defaults. @@ -286,31 +286,31 @@ If the **CONTAINERS_CONF** environment variable is set, then its value is used f **mounts.conf** (`/usr/share/containers/mounts.conf`) - The mounts.conf file specifies volume mount directories that are automatically mounted inside containers when executing the `podman run` or `podman start` commands. Administrators can override the defaults file by creating `/etc/containers/mounts.conf`. +The mounts.conf file specifies volume mount directories that are automatically mounted inside containers when executing the `podman run` or `podman start` commands. Administrators can override the defaults file by creating `/etc/containers/mounts.conf`. When Podman runs in rootless mode, the file `$HOME/.config/containers/mounts.conf` will override the default if it exists. Please refer to containers-mounts.conf(5) for further details. **policy.json** (`/etc/containers/policy.json`) - Signature verification policy files are used to specify policy, e.g. trusted keys, applicable when deciding whether to accept an image, or individual signatures of that image, as valid. +Signature verification policy files are used to specify policy, e.g. trusted keys, applicable when deciding whether to accept an image, or individual signatures of that image, as valid. **registries.conf** (`/etc/containers/registries.conf`, `$HOME/.config/containers/registries.conf`) - registries.conf is the configuration file which specifies which container registries should be consulted when completing image names which do not include a registry or domain portion. +registries.conf is the configuration file which specifies which container registries should be consulted when completing image names which do not include a registry or domain portion. - Non root users of Podman can create the `$HOME/.config/containers/registries.conf` file to be used instead of the system defaults. +Non root users of Podman can create the `$HOME/.config/containers/registries.conf` file to be used instead of the system defaults. - If the **CONTAINERS_REGISTRIES_CONF** environment variable is set, then its value is used for the registries.conf file rather than the default. +If the **CONTAINERS_REGISTRIES_CONF** environment variable is set, then its value is used for the registries.conf file rather than the default. **storage.conf** (`/etc/containers/storage.conf`, `$HOME/.config/containers/storage.conf`) - storage.conf is the storage configuration file for all tools using containers/storage +storage.conf is the storage configuration file for all tools using containers/storage - The storage configuration file specifies all of the available container storage options for tools using shared container storage. +The storage configuration file specifies all of the available container storage options for tools using shared container storage. - When Podman runs in rootless mode, the file `$HOME/.config/containers/storage.conf` is used instead of the system defaults. +When Podman runs in rootless mode, the file `$HOME/.config/containers/storage.conf` is used instead of the system defaults. - If the **CONTAINERS_STORAGE_CONF** environment variable is set, the its value is used for the storage.conf file rather than the default. +If the **CONTAINERS_STORAGE_CONF** environment variable is set, the its value is used for the storage.conf file rather than the default. ## Rootless mode Podman can also be used as non-root user. When podman runs in rootless mode, a user namespace is automatically created for the user, defined in /etc/subuid and /etc/subgid. diff --git a/docs/source/network.rst b/docs/source/network.rst deleted file mode 100644 index eb0c2c7f9..000000000 --- a/docs/source/network.rst +++ /dev/null @@ -1,20 +0,0 @@ -Network -======= - -:doc:`connect <markdown/podman-network-connect.1>` network connect - -:doc:`create <markdown/podman-network-create.1>` network create - -:doc:`disconnect <markdown/podman-network-disconnect.1>` network disconnect - -:doc:`exists <markdown/podman-network-exists.1>` network exists - -:doc:`inspect <markdown/podman-network-inspect.1>` network inspect - -:doc:`ls <markdown/podman-network-ls.1>` network list - -:doc:`prune <markdown/podman-network-prune.1>` network prune - -:doc:`reload <markdown/podman-network-reload.1>` network reload - -:doc:`rm <markdown/podman-network-rm.1>` network rm diff --git a/docs/source/play.rst b/docs/source/play.rst deleted file mode 100644 index 8f00d2f45..000000000 --- a/docs/source/play.rst +++ /dev/null @@ -1,4 +0,0 @@ -Play -==== - -:doc:`kube <markdown/podman-play-kube.1>` Play a pod based on Kubernetes YAML diff --git a/docs/source/pod.rst b/docs/source/pod.rst deleted file mode 100644 index d9ad07d83..000000000 --- a/docs/source/pod.rst +++ /dev/null @@ -1,32 +0,0 @@ -Pod -=== - -:doc:`create <markdown/podman-pod-create.1>` Create a new empty pod - -:doc:`exists <markdown/podman-pod-exists.1>` Check if a pod exists in local storage - -:doc:`inspect <markdown/podman-pod-inspect.1>` Displays a pod configuration - -:doc:`kill <markdown/podman-pod-kill.1>` Send the specified signal or SIGKILL to containers in pod - -:doc:`logs <markdown/podman-pod-logs.1>` Displays logs for pod with one or more containers - -:doc:`pause <markdown/podman-pause.1>` Pause one or more pods - -:doc:`prune <markdown/podman-pod-prune.1>` Remove all stopped pods and their containers - -:doc:`ps <markdown/podman-pod-ps.1>` List pods - -:doc:`restart <markdown/podman-pod-restart.1>` Restart one or more pods - -:doc:`rm <markdown/podman-pod-rm.1>` Remove one or more stopped pods and containers - -:doc:`start <markdown/podman-pod-start.1>` Start one or more pods - -:doc:`stats <markdown/podman-pod-stats.1>` Display a live stream of resource usage statistics for the containers in one or more pods - -:doc:`stop <markdown/podman-pod-stop.1>` Stop one or more pods - -:doc:`top <markdown/podman-pod-top.1>` Display the running processes of containers in a pod - -:doc:`unpause <markdown/podman-pod-unpause.1>` Unpause one or more pods diff --git a/docs/source/secret.rst b/docs/source/secret.rst deleted file mode 100644 index 3825ad1df..000000000 --- a/docs/source/secret.rst +++ /dev/null @@ -1,9 +0,0 @@ -Secret -====== -:doc:`create <markdown/podman-secret-create.1>` Create a new secert - -:doc:`inspect <markdown/podman-secret-inspect.1>` Display detailed information on one or more secrets - -:doc:`ls <markdown/podman-secret-ls.1>` List secrets - -:doc:`rm <markdown/podman-secret-rm.1>` Remove one or more secrets diff --git a/docs/source/system.rst b/docs/source/system.rst deleted file mode 100644 index 566fd1a95..000000000 --- a/docs/source/system.rst +++ /dev/null @@ -1,18 +0,0 @@ -System -====== - -:doc:`connection <connection>` Manage the destination(s) for Podman service(s) - -:doc:`df <markdown/podman-system-df.1>` Show podman disk usage - -:doc:`info <markdown/podman-info.1>` Display podman system information - -:doc:`migrate <markdown/podman-system-migrate.1>` Migrate containers - -:doc:`prune <markdown/podman-system-prune.1>` Remove unused data - -:doc:`renumber <markdown/podman-system-renumber.1>` Migrate lock numbers - -:doc:`reset <markdown/podman-system-reset.1>` Reset podman storage - -:doc:`service <markdown/podman-system-service.1>` Run an API service |