summaryrefslogtreecommitdiff
path: root/docs/source
diff options
context:
space:
mode:
authorJhon Honce <jhonce@redhat.com>2021-06-21 14:52:41 -0700
committerJhon Honce <jhonce@redhat.com>2021-06-22 11:07:12 -0700
commit1f388ede6f1425ecc6e2a6fddba1d811bc41e2c0 (patch)
treed1dfa4e33924f5ed3ef37660174868692296a0a8 /docs/source
parentbe15e69a6189685ac1afba06cb67013e960065ed (diff)
downloadpodman-1f388ede6f1425ecc6e2a6fddba1d811bc41e2c0.tar.gz
podman-1f388ede6f1425ecc6e2a6fddba1d811bc41e2c0.tar.bz2
podman-1f388ede6f1425ecc6e2a6fddba1d811bc41e2c0.zip
Add --format to connection list
Add support for the --format option to podman system connection list. Signed-off-by: Jhon Honce <jhonce@redhat.com>
Diffstat (limited to 'docs/source')
-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