man-pages(7) has [1]: > For commands, this shows the syntax of the command and its arguments > (including options); boldface is used for as-is text and italics are > used to indicate replaceable arguments. Brackets ([]) surround > optional arguments, vertical bars (|) separate choices, and ellipses > (...) can be repeated. I've adjusted our SYNOPSIS entries to match that formatting, and generally tried to make them more consistent with the precedent set by the man-pages project. Outside of the SYNOPSIS entry, I prefer using backticks for literals, although in some places I've left the ** bolding to keep things visually similar to a nearby SYNOPSIS entry. [1]: http://man7.org/linux/man-pages/man7/man-pages.7.html Signed-off-by: W. Trevor King <wking@tremily.us> Closes: #1027 Approved by: rhatdan
1.8 KiB
% podman-login "1"
NAME
podman-login - Login to a container registry
SYNOPSIS
podman login [options] registry
DESCRIPTION
podman login logs into a specified registry server with the correct username and password. podman login reads in the username and password from STDIN. The username and password can also be set using the username and password flags. The path of the authentication file can be specified by the user by setting the authfile flag. The default path used is ${XDG_RUNTIME_DIR}/containers/auth.json.
podman [GLOBAL OPTIONS]
podman login [GLOBAL OPTIONS]
podman login [OPTIONS] REGISTRY [GLOBAL OPTIONS]
OPTIONS
--password, -p
Password for registry
--username, -u
Username for registry
--authfile
Path of the authentication file. Default is ${XDG_\RUNTIME_DIR}/containers/auth.json
--cert-dir
Pathname of a directory containing TLS certificates and keys used to connect to the registry. Default certificates directory is /etc/containers/certs.d.
--tls-verify
Require HTTPS and verify certificates when contacting registries (default: true)
--help, -h
Print usage statement
EXAMPLES
# podman login docker.io
Username: umohnani
Password:
Login Succeeded!
# podman login -u testuser -p testpassword localhost:5000
Login Succeeded!
# podman login --authfile authdir/myauths.json docker.io
Username: umohnani
Password:
Login Succeeded!
$ podman login --tls-verify=false -u test -p test localhost:5000
Login Succeeded!
$ podman login --cert-dir /etc/containers/certs.d/ -u foo -p bar localhost:5000
Login Succeeded!
SEE ALSO
podman(1), podman-logout(1), crio(8)
HISTORY
August 2017, Originally compiled by Urvashi Mohnani umohnani@redhat.com