b0601cb34a
Somewhere in the CIv2 migration we lost the man page vs --help
cross-checker. Add it back, by adding it into the man-page-check
Makefile target; this is part of 'make validate', which is run
in CI even on CI:DOCS PRs.
As happens when CI doesn't run, things broke. Man pages got out
of sync with --help. This PR:
1) Fixes hack/xref-helpmsgs-manpages to deal with the new
"Options" (instead of "Flags") form of podman help. #8034
did part of that, but one of my review comments was
accidentally left out.
2) Fixes hack/xref-helpmsgs-manpages to deal with the new
option syntax in man pages, post- #8292, in which each
option is preceded by four hashes so as to make them
HTML <h4> elements with named anchors.
3) Fixes man pages that #8292 accidentally missed.
4) Adds man page entries for two flags that got added
to podman but not documented (pod create --network-alias,
play kube --log-driver)
Fixes: #8296
Signed-off-by: Ed Santiago <santiago@redhat.com>
1.4 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]
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
-d, --default=false
Make the new destination the default for this user.
--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.
-p, --port=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
SEE ALSO
podman-system(1) , podman-system-connection(1) , containers.conf(5)
HISTORY
June 2020, Originally compiled by Jhon Honce (jhonce at redhat dot com)