Files
podman/docs/source/markdown/podman-system-connection-add.1.md
Ed Santiago ad7c54e13a man page checker: enforce stricter options format
Followup to #14906, in which a nonexistent option was found
in a man page. The xref script was designed to catch that,
but I was too lax in my parsing: the option was documented
using wrong syntax, and the script didn't catch it.

Solution: do not allow *any* unrecognized cruft in the
option description lines. And fix all improperly-written
entries to conform to the rule:

    **--option**=*value(s)*

Two asterisks around option, which must have two dashes. One
asterisk around value(s).

This is going to cause headaches for some people adding new
options, but I don't think I can fix that: there are many
factors that make an unparseable line. Adding 'hint' code
would make the script even more complex than it is. I have
to assume that our contributors are smart enough to look
at surrounding context and figure out the right way to
specify options.

Signed-off-by: Ed Santiago <santiago@redhat.com>
2022-07-14 06:35:51 -06:00

1.7 KiB

% podman-system-connection-add(1)

NAME

podman-system-connection-add - Record destination for the Podman service

SYNOPSIS

podman system connection add [options] name destination

DESCRIPTION

Record ssh destination for remote podman service(s). The ssh destination is given as one of:

  • [user@]hostname[:port]
  • ssh://[user@]hostname[:port]
  • unix://path
  • tcp://hostname:port

The user will be prompted for the remote ssh login password or key file pass phrase as required. The ssh-agent is supported if it is running.

OPTIONS

--default, -d

Make the new destination the default for this user. The default is false.

--identity=path

Path to ssh identity file. If the identity file has been encrypted, Podman prompts the user for the passphrase. If no identity file is provided and no user is given, Podman defaults to the user running the podman command. Podman prompts for the login password on the remote server.

--port, -p=port

Port for ssh destination. The default value is 22.

--socket-path=path

Path to the Podman service unix domain socket on the ssh destination host

EXAMPLE

$ podman system connection add QA podman.example.com

$ podman system connection add --identity ~/.ssh/dev_rsa production ssh://root@server.example.com:2222

$ podman system connection add testing unix:///run/podman/podman.sock

$ podman system connection add debug tcp://localhost:8080

SEE ALSO

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

HISTORY

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