summaryrefslogtreecommitdiff
path: root/docs/source/man/podman-logout.1.md
diff options
context:
space:
mode:
authorbaude <bbaude@redhat.com>2019-10-24 14:54:57 -0500
committerbaude <bbaude@redhat.com>2019-10-31 12:31:39 -0500
commit52b92023edeba3a5e2c466d92d742e54b14a85cb (patch)
tree44e6193d49afd1277b7d07b0df41fc80d31b3adb /docs/source/man/podman-logout.1.md
parent5af166ff513265b17aee92a9ce3a1522090d7dec (diff)
downloadpodman-52b92023edeba3a5e2c466d92d742e54b14a85cb.tar.gz
podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.tar.bz2
podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.zip
Restructure documentation dir
Restructuring the docs dir to make integration with sphinx easier. man pages now exist in docs/source/man and the sphinx make files exists in docs. Signed-off-by: baude <bbaude@redhat.com>
Diffstat (limited to 'docs/source/man/podman-logout.1.md')
-rw-r--r--docs/source/man/podman-logout.1.md59
1 files changed, 59 insertions, 0 deletions
diff --git a/docs/source/man/podman-logout.1.md b/docs/source/man/podman-logout.1.md
new file mode 100644
index 000000000..01dc52ecd
--- /dev/null
+++ b/docs/source/man/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>