summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-logout.1.md
diff options
context:
space:
mode:
authorEd Santiago <santiago@redhat.com>2022-08-16 07:35:18 -0600
committerEd Santiago <santiago@redhat.com>2022-08-16 09:13:38 -0600
commitf0e8640755569ba7da803f7c8f4589953939fad0 (patch)
tree30d31d6280c42c304184fb8224028e59be001361 /docs/source/markdown/podman-logout.1.md
parent3dace12777e27a7732acb25ae78f86ced8ae04da (diff)
downloadpodman-f0e8640755569ba7da803f7c8f4589953939fad0.tar.gz
podman-f0e8640755569ba7da803f7c8f4589953939fad0.tar.bz2
podman-f0e8640755569ba7da803f7c8f4589953939fad0.zip
Man pages: refactor common options: authfile
Refactor the --authfile option. My suggestion for review: 1) run hack/markdown-preprocess-review and immediately Ctrl-Q to quit out of diffuse, which is completely unusable for this many files; then 2) cd /tmp/markdown-preprocess-review.diffs/authfile - this is the directory created by the review script 3) rm podman-image-sign* podman-log* podman-search.1.md.in - because they're essentially identical to podman-create 4) rm podman-manifest-* podman-push.* - because they're 100% identical to podman-kube-play 5) rm podman-kube-play* - because it's apart-from-whitespace identical to podman-build (use "wdiff" to confirm) 6) rm podman-auto-update* - because that's the one I chose (hence == zzz-chosen.md) (You should obviously run your own diff/cmp before rm, to confirm my assertions about which files are identical). After all that, you have a manageable number of files which you can scan, read, diff against zzz-chosen.md, even run diffuse. This option is IMHO the poster child for why we need this kind of man page refactoring. Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'docs/source/markdown/podman-logout.1.md')
-rw-r--r--docs/source/markdown/podman-logout.1.md60
1 files changed, 0 insertions, 60 deletions
diff --git a/docs/source/markdown/podman-logout.1.md b/docs/source/markdown/podman-logout.1.md
deleted file mode 100644
index 96ac98f35..000000000
--- a/docs/source/markdown/podman-logout.1.md
+++ /dev/null
@@ -1,60 +0,0 @@
-% 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. If the registry is not specified, the first registry under [registries.search]
-from registries.conf will be used. 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**. For more details about format and configurations of the auth,json file, please refer to containers-auth.json(5)
-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
-
-#### **--all**, **-a**
-
-Remove the cached credentials for all registries in the auth file
-
-#### **--authfile**=*path*
-
-Path of the authentication file. Default is ${XDG\_RUNTIME\_DIR}/containers/auth.json.
-
-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`
-
-#### **--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.1.md)**, **[podman-login(1)](podman-login.1.md)**, **[containers-auth.json(5)](https://github.com/containers/image/blob/main/docs/containers-auth.json.5.md)**
-
-## HISTORY
-August 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>