summaryrefslogtreecommitdiff
path: root/docs/kpod-logout.1.md
diff options
context:
space:
mode:
authorMatthew Heon <matthew.heon@gmail.com>2017-11-01 11:24:59 -0400
committerMatthew Heon <matthew.heon@gmail.com>2017-11-01 11:24:59 -0400
commita031b83a09a8628435317a03f199cdc18b78262f (patch)
treebc017a96769ce6de33745b8b0b1304ccf38e9df0 /docs/kpod-logout.1.md
parent2b74391cd5281f6fdf391ff8ad50fd1490f6bf89 (diff)
downloadpodman-a031b83a09a8628435317a03f199cdc18b78262f.tar.gz
podman-a031b83a09a8628435317a03f199cdc18b78262f.tar.bz2
podman-a031b83a09a8628435317a03f199cdc18b78262f.zip
Initial checkin from CRI-O repo
Signed-off-by: Matthew Heon <matthew.heon@gmail.com>
Diffstat (limited to 'docs/kpod-logout.1.md')
-rw-r--r--docs/kpod-logout.1.md56
1 files changed, 56 insertions, 0 deletions
diff --git a/docs/kpod-logout.1.md b/docs/kpod-logout.1.md
new file mode 100644
index 000000000..5f119a18a
--- /dev/null
+++ b/docs/kpod-logout.1.md
@@ -0,0 +1,56 @@
+% kpod(1) kpod-logout - Simple tool to logout of a registry server
+% Urvashi Mohnani
+# kpod-logout "1" "August 2017" "kpod"
+
+## NAME
+kpod-logout - Logout of a container registry
+
+## SYNOPSIS
+**kpod logout**
+[**--help**|**-h**]
+[**--authfile**]
+[**--all**|**-a**]
+**REGISTRY**
+
+## DESCRIPTION
+**kpod 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 overrriden 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.
+
+**kpod [GLOBAL OPTIONS]**
+
+**kpod logout [GLOBAL OPTIONS]**
+
+**kpod logout [OPTIONS] REGISTRY [GLOBAL OPTIONS]**
+
+## OPTIONS
+
+**--authfile**
+Path of the authentication file. Default is ${XDG_\RUNTIME\_DIR}/containers/auth.json
+
+**--all, -a**
+Remove the cached credentials for all registries in the auth file
+
+## EXAMPLES
+
+```
+# kpod logout docker.io
+Remove login credentials for https://registry-1.docker.io/v2/
+```
+
+```
+# kpod logout --authfile authdir/myauths.json docker.io
+Remove login credentials for https://registry-1.docker.io/v2/
+```
+
+```
+# kpod logout --all
+Remove login credentials for all registries
+```
+
+## SEE ALSO
+kpod(1), kpod-login(1), crio(8), crio.conf(5)
+
+## HISTORY
+August 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>