summaryrefslogtreecommitdiff
path: root/docs/source
diff options
context:
space:
mode:
authorEd Santiago <santiago@redhat.com>2022-08-22 07:32:36 -0600
committerEd Santiago <santiago@redhat.com>2022-08-22 09:39:37 -0600
commitbd90818b02309bbda3fd953e8f6e574970e6918b (patch)
tree6bb467d7dee31376e0d5ed7a136c3ca0d0b796a0 /docs/source
parent11cc72d580e633f7f236cc1c78fb6146d4042c01 (diff)
downloadpodman-bd90818b02309bbda3fd953e8f6e574970e6918b.tar.gz
podman-bd90818b02309bbda3fd953e8f6e574970e6918b.tar.bz2
podman-bd90818b02309bbda3fd953e8f6e574970e6918b.zip
Man pages: refactor common options: --creds
Refactor the --creds option. I went with the one in podman-pull The main difference between all of them is the '####' line, differences in the param descriptions. podman-pull had the clearest one. This is another one that hack/markdown-preprocess-review is good for reviewing. Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'docs/source')
-rw-r--r--docs/source/markdown/options/creds.md5
-rw-r--r--docs/source/markdown/podman-build.1.md.in6
-rw-r--r--docs/source/markdown/podman-container-runlabel.1.md.in4
-rw-r--r--docs/source/markdown/podman-kube-play.1.md.in6
-rw-r--r--docs/source/markdown/podman-manifest-add.1.md.in6
-rw-r--r--docs/source/markdown/podman-manifest-push.1.md.in6
-rw-r--r--docs/source/markdown/podman-pull.1.md.in6
-rw-r--r--docs/source/markdown/podman-push.1.md.in6
8 files changed, 12 insertions, 33 deletions
diff --git a/docs/source/markdown/options/creds.md b/docs/source/markdown/options/creds.md
new file mode 100644
index 000000000..23399dda4
--- /dev/null
+++ b/docs/source/markdown/options/creds.md
@@ -0,0 +1,5 @@
+#### **--creds**=*[username[:password]]*
+
+The [username[:password]] to use to authenticate with the registry if required.
+If one or both values are not supplied, a command line prompt will appear and the
+value can be entered. The password is entered without echo.
diff --git a/docs/source/markdown/podman-build.1.md.in b/docs/source/markdown/podman-build.1.md.in
index c29cf997d..772567e53 100644
--- a/docs/source/markdown/podman-build.1.md.in
+++ b/docs/source/markdown/podman-build.1.md.in
@@ -195,11 +195,7 @@ Set additional flags to pass to the C Preprocessor cpp(1). Containerfiles ending
@@option cpuset-mems
-#### **--creds**=*creds*
-
-The [username[:password]] to use to authenticate with the registry if required.
-If one or both values are not supplied, a command line prompt will appear and
-the value can be entered. The password is entered without echo.
+@@option creds
#### **--decryption-key**=*key[:passphrase]*
diff --git a/docs/source/markdown/podman-container-runlabel.1.md.in b/docs/source/markdown/podman-container-runlabel.1.md.in
index 7f462bf70..59eb48fd3 100644
--- a/docs/source/markdown/podman-container-runlabel.1.md.in
+++ b/docs/source/markdown/podman-container-runlabel.1.md.in
@@ -37,9 +37,7 @@ Will be replaced with the current working directory.
Use certificates at *path* (\*.crt, \*.cert, \*.key) to connect to the registry. (Default: /etc/containers/certs.d)
Please refer to containers-certs.d(5) for details. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines)
-#### **--creds**=*[username[:password]]*
-
-The [username[:password]] to use to authenticate with the registry if required. If one or both values are not supplied, a command line prompt will appear and the value can be entered. The password is entered without echo.
+@@option creds
#### **--display**
diff --git a/docs/source/markdown/podman-kube-play.1.md.in b/docs/source/markdown/podman-kube-play.1.md.in
index 14c5f2498..1b9544fb6 100644
--- a/docs/source/markdown/podman-kube-play.1.md.in
+++ b/docs/source/markdown/podman-kube-play.1.md.in
@@ -130,11 +130,7 @@ Note: The *--configmap* option can be used multiple times or a comma-separated l
Use *path* as the build context directory for each image. Requires --build option be true. (This option is not available with the remote Podman client)
-#### **--creds**
-
-The [username[:password]] to use to authenticate with the registry if required.
-If one or both values are not supplied, a command line prompt will appear and the
-value can be entered. The password is entered without echo.
+@@option creds
#### **--help**, **-h**
diff --git a/docs/source/markdown/podman-manifest-add.1.md.in b/docs/source/markdown/podman-manifest-add.1.md.in
index a1c498e4f..adffe1875 100644
--- a/docs/source/markdown/podman-manifest-add.1.md.in
+++ b/docs/source/markdown/podman-manifest-add.1.md.in
@@ -40,11 +40,7 @@ retrieved from the image's configuration information.
Use certificates at *path* (\*.crt, \*.cert, \*.key) to connect to the registry. (Default: /etc/containers/certs.d)
Please refer to containers-certs.d(5) for details. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines)
-#### **--creds**=*creds*
-
-The [username[:password]] to use to authenticate with the registry if required.
-If one or both values are not supplied, a command line prompt will appear and the
-value can be entered. The password is entered without echo.
+@@option creds
#### **--features**
diff --git a/docs/source/markdown/podman-manifest-push.1.md.in b/docs/source/markdown/podman-manifest-push.1.md.in
index 631ead376..515f07207 100644
--- a/docs/source/markdown/podman-manifest-push.1.md.in
+++ b/docs/source/markdown/podman-manifest-push.1.md.in
@@ -30,11 +30,7 @@ Please refer to containers-certs.d(5) for details. (This option is not available
Specifies the compression format to use. Supported values are: `gzip`, `zstd` and `zstd:chunked`. The default is `gzip` unless overridden in the containers.conf file.
-#### **--creds**=*creds*
-
-The [username[:password]] to use to authenticate with the registry if required.
-If one or both values are not supplied, a command line prompt will appear and the
-value can be entered. The password is entered without echo.
+@@option creds
#### **--digestfile**=*Digestfile*
diff --git a/docs/source/markdown/podman-pull.1.md.in b/docs/source/markdown/podman-pull.1.md.in
index 46eaa706a..5d875590f 100644
--- a/docs/source/markdown/podman-pull.1.md.in
+++ b/docs/source/markdown/podman-pull.1.md.in
@@ -55,11 +55,7 @@ All tagged images in the repository will be pulled.
@@option cert-dir
-#### **--creds**=*[username[:password]]*
-
-The [username[:password]] to use to authenticate with the registry if required.
-If one or both values are not supplied, a command line prompt will appear and the
-value can be entered. The password is entered without echo.
+@@option creds
#### **--disable-content-trust**
diff --git a/docs/source/markdown/podman-push.1.md.in b/docs/source/markdown/podman-push.1.md.in
index 1c936cd66..f32261bab 100644
--- a/docs/source/markdown/podman-push.1.md.in
+++ b/docs/source/markdown/podman-push.1.md.in
@@ -63,11 +63,7 @@ Note: This flag can only be set when using the **dir** transport
Specifies the compression format to use. Supported values are: `gzip`, `zstd` and `zstd:chunked`. The default is `gzip` unless overridden in the containers.conf file.
-#### **--creds**=*[username[:password]]*
-
-The [username[:password]] to use to authenticate with the registry if required.
-If one or both values are not supplied, a command line prompt will appear and the
-value can be entered. The password is entered without echo.
+@@option creds
#### **--digestfile**=*Digestfile*