diff options
| author | Ed Santiago <santiago@redhat.com> | 2022-08-29 08:32:49 -0600 |
|---|---|---|
| committer | Ed Santiago <santiago@redhat.com> | 2022-09-01 10:58:00 -0600 |
| commit | c63830166c31e7760f5bf4120cd774dda6683c60 (patch) | |
| tree | 1257bf610a2497611871fc8179c218262800b78b /docs/source/markdown/options/name.container.md | |
| parent | 0085fbb488eec30e71e6cced6a06dbdb134e32a6 (diff) | |
| download | podman-c63830166c31e7760f5bf4120cd774dda6683c60.tar.gz podman-c63830166c31e7760f5bf4120cd774dda6683c60.tar.bz2 podman-c63830166c31e7760f5bf4120cd774dda6683c60.zip | |
Man pages: refactor common options: --name
Only for podman-create and -run, unfortunately: all the
others are too different, and can't easily be combined.
I went with the podman-run version because it was most
recently updated in #5192.
Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'docs/source/markdown/options/name.container.md')
| -rw-r--r-- | docs/source/markdown/options/name.container.md | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/source/markdown/options/name.container.md b/docs/source/markdown/options/name.container.md new file mode 100644 index 000000000..0c3df6ef1 --- /dev/null +++ b/docs/source/markdown/options/name.container.md @@ -0,0 +1,14 @@ +#### **--name**=*name* + +Assign a name to the container. + +The operator can identify a container in three ways: + +- UUID long identifier (“f78375b1c487e03c9438c729345e54db9d20cfa2ac1fc3494b6eb60872e74778”); +- UUID short identifier (“f78375b1c487”); +- Name (“jonah”). + +Podman generates a UUID for each container, and if a name is not assigned +to the container with **--name** then it will generate a random +string name. The name is useful any place you need to identify a container. +This works for both background and foreground containers. |