summaryrefslogtreecommitdiff
path: root/docs/podman-login.1.md
diff options
context:
space:
mode:
authorDaniel J Walsh <dwalsh@redhat.com>2017-12-15 16:58:36 -0500
committerAtomic Bot <atomic-devel@projectatomic.io>2017-12-18 16:46:05 +0000
commit5770dc2640c216525ab84031e3712fcc46b3b087 (patch)
tree8a1c5c4e4a6ce6a35a3767247623a62bfd698f77 /docs/podman-login.1.md
parentde3468e120d489d046c08dad72ba2262e222ccb1 (diff)
downloadpodman-5770dc2640c216525ab84031e3712fcc46b3b087.tar.gz
podman-5770dc2640c216525ab84031e3712fcc46b3b087.tar.bz2
podman-5770dc2640c216525ab84031e3712fcc46b3b087.zip
Rename all references to kpod to podman
The decision is in, kpod is going to be named podman. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com> Closes: #145 Approved by: umohnani8
Diffstat (limited to 'docs/podman-login.1.md')
-rw-r--r--docs/podman-login.1.md65
1 files changed, 65 insertions, 0 deletions
diff --git a/docs/podman-login.1.md b/docs/podman-login.1.md
new file mode 100644
index 000000000..8d8e688c1
--- /dev/null
+++ b/docs/podman-login.1.md
@@ -0,0 +1,65 @@
+% podman(1) podman-login - Simple tool to login to a registry server
+% Urvashi Mohnani
+# podman-login "1" "August 2017" "podman"
+
+## NAME
+podman-login - Login to a container registry
+
+## SYNOPSIS
+**podman login**
+[**--help**|**-h**]
+[**--authfile**]
+[**--user**|**-u**]
+[**--password**|**-p**]
+**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
+
+## 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!
+```
+
+## SEE ALSO
+podman(1), podman-logout(1), crio(8), crio.conf(5)
+
+## HISTORY
+August 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>