summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2021-06-23 15:53:31 -0400
committerGitHub <noreply@github.com>2021-06-23 15:53:31 -0400
commite1a7a0efbeec4950815a29372a1c932bbf1bc9fb (patch)
tree1d6a2c65fbd14b40689a7a6b6cda0bbc33381446 /docs
parentd95ff1a687c12e794e808a8a535e2ab5a2becd03 (diff)
parent1f388ede6f1425ecc6e2a6fddba1d811bc41e2c0 (diff)
downloadpodman-e1a7a0efbeec4950815a29372a1c932bbf1bc9fb.tar.gz
podman-e1a7a0efbeec4950815a29372a1c932bbf1bc9fb.tar.bz2
podman-e1a7a0efbeec4950815a29372a1c932bbf1bc9fb.zip
Merge pull request #10747 from jwhonce/wip/report
Add --format to connection list
Diffstat (limited to 'docs')
-rw-r--r--docs/source/markdown/podman-system-connection-list.1.md19
1 files changed, 17 insertions, 2 deletions
diff --git a/docs/source/markdown/podman-system-connection-list.1.md b/docs/source/markdown/podman-system-connection-list.1.md
index f5fb5c8e3..6b25a045d 100644
--- a/docs/source/markdown/podman-system-connection-list.1.md
+++ b/docs/source/markdown/podman-system-connection-list.1.md
@@ -4,13 +4,28 @@
podman\-system\-connection\-list - List the destination for the Podman service(s)
## SYNOPSIS
-**podman system connection list**
+**podman system connection list** [*options*]
-**podman system connection ls**
+**podman system connection ls** [*options*]
## DESCRIPTION
List ssh destination(s) for podman service(s).
+## OPTIONS
+
+#### **--format**=*format*
+
+Change the default output format. This can be of a supported type like 'json' or a Go template.
+Valid placeholders for the Go template listed below:
+
+| **Placeholder** | **Description** |
+| --------------- | ----------------------------------------------------------------------------- |
+| *.Name* | Connection Name/Identifier |
+| *.Identity* | Path to file containing SSH identity |
+| *.URI* | URI to podman service. Valid schemes are ssh://[user@]*host*[:port]*Unix domain socket*[?secure=True], unix://*Unix domain socket*, and tcp://localhost[:*port*] |
+
+An asterisk is appended to the default connection.
+
## EXAMPLE
```
$ podman system connection list