Files
podman/docs/source/markdown/podman-system-connection-list.1.md
Ed Santiago 3a9d14d4e9 man page --format xref: tighten the autocompletion check
Followup to #17486: stricter checks on --format.

  * If a subcommand offers autocompletion for templates,
    it must also offer a '--format json' option.

  * If a subcommand has a --format option that DOES NOT
    offer autocompletion for templates, it must be listed
    in a hardcoded grandparented-in table of commands
    where that's not applicable. (Mostly commands
    like build, commit, save, where "format" is used
    in the context of "oci/docker").

Only likely to trigger on PRs which add new subcommands,
and is intended to catch oversights.

Also, test for alphanumeric order in man page tables.
Sort all existing tables.

Signed-off-by: Ed Santiago <santiago@redhat.com>
2023-02-14 08:11:54 -07:00

1.6 KiB

% podman-system-connection-list 1

NAME

podman-system-connection-list - List the destination for the Podman service(s)

SYNOPSIS

podman system connection list [options]

podman system connection ls [options]

DESCRIPTION

List ssh destination(s) for podman service(s).

OPTIONS

--format, -f=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
.Default Indicates whether connection is the default
.Identity Path to file containing SSH identity
.Name Connection Name/Identifier
.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]

--quiet, -q

Only show connection names

EXAMPLE

$ podman system connection list
Name URI                                                      Identity	    Default
devl ssh://root@example.com:/run/podman/podman.sock           ~/.ssh/id_rsa True
devl ssh://user@example.com:/run/user/1000/podman/podman.sock ~/.ssh/id_rsa False

SEE ALSO

podman(1), podman-system(1), podman-system-connection(1)

HISTORY

July 2020, Originally compiled by Jhon Honce (jhonce at redhat dot com)