summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-logout.1.md
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2019-10-31 19:39:44 +0100
committerGitHub <noreply@github.com>2019-10-31 19:39:44 +0100
commitffe36ea9964242235571ad1d21a0c4d825ef5971 (patch)
treeb38d2d9c492ab2b2ad951135fde7e90c37344711 /docs/source/markdown/podman-logout.1.md
parent3e2d9f8662663f2f703bf674408d5255e493e18e (diff)
parent486fcd4e1e6f00424f1016d8e331582523bd2c68 (diff)
downloadpodman-ffe36ea9964242235571ad1d21a0c4d825ef5971.tar.gz
podman-ffe36ea9964242235571ad1d21a0c4d825ef5971.tar.bz2
podman-ffe36ea9964242235571ad1d21a0c4d825ef5971.zip
Merge pull request #4354 from baude/newdocsstruct
Restructure documentation dir
Diffstat (limited to 'docs/source/markdown/podman-logout.1.md')
-rw-r--r--docs/source/markdown/podman-logout.1.md59
1 files changed, 59 insertions, 0 deletions
diff --git a/docs/source/markdown/podman-logout.1.md b/docs/source/markdown/podman-logout.1.md
new file mode 100644
index 000000000..01dc52ecd
--- /dev/null
+++ b/docs/source/markdown/podman-logout.1.md
@@ -0,0 +1,59 @@
+% podman-logout(1)
+
+## NAME
+podman\-logout - Logout of a container registry
+
+## SYNOPSIS
+**podman logout** [*options*] *registry*
+
+## DESCRIPTION
+**podman logout** logs out of a specified registry server by deleting the cached credentials
+stored in the **auth.json** file. The path of the authentication file can be overridden by the user by setting the **authfile** flag.
+The default path used is **${XDG\_RUNTIME\_DIR}/containers/auth.json**.
+All the cached credentials can be removed by setting the **all** flag.
+
+**podman [GLOBAL OPTIONS]**
+
+**podman logout [GLOBAL OPTIONS]**
+
+**podman logout [OPTIONS] REGISTRY [GLOBAL OPTIONS]**
+
+## OPTIONS
+
+**--authfile**=*path*
+
+Path of the authentication file. Default is ${XDG\_RUNTIME\_DIR}/containers/auth.json (Not available for remote commands)
+
+Note: You can also override the default path of the authentication file by setting the REGISTRY\_AUTH\_FILE
+environment variable. `export REGISTRY_AUTH_FILE=path`
+
+**--all**, **-a**
+
+Remove the cached credentials for all registries in the auth file
+
+**--help**, **-h**
+
+Print usage statement
+
+## EXAMPLES
+
+```
+$ podman logout docker.io
+Remove login credentials for https://registry-1.docker.io/v2/
+```
+
+```
+$ podman logout --authfile authdir/myauths.json docker.io
+Remove login credentials for https://registry-1.docker.io/v2/
+```
+
+```
+$ podman logout --all
+Remove login credentials for all registries
+```
+
+## SEE ALSO
+podman(1), podman-login(1)
+
+## HISTORY
+August 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>