containers
/
podman
mirror of https://github.com/containers/podman.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
podman/docs
History
Jhon Honce cbca625328 V2 Add support for ssh authentication methods 
* podman --remote ssh://<user>:<password>@<host>:<port><path>
* podman --remote ssh://<user>:<password>@<host>:<port><path> \
  --identity <path> --passphrase <phrase>
* ssh-add <key>
  podman --remote ssh://<user>@<host><path>
* Fix `podman help` to run even if podman missing components
* Prompt for passphrase on stdin IFF key is protected and passphrase
  not given via any other configuration

* cobra flags do not support optional value flags therefore refactored
  --remote to be a boolean and --url will now contain the URI to Podman
  service

Signed-off-by: Jhon Honce <jhonce@redhat.com>
 		2020-06-03 09:54:39 -07:00
..
source V2 Add support for ssh authentication methods 2020-06-03 09:54:39 -07:00
tutorials [CI:DOCS] update httpd location in tutorial 2020-05-30 13:51:44 -04:00
varlink make lint: include docs/ 2020-01-14 09:54:48 +01:00
Makefile Restructure documentation dir 2019-10-31 12:31:39 -05:00
Readme.md [CI:DOCS] Fix readthedocs link 2020-05-22 18:18:37 -04:00
dckrman.sh Fix docker man page links 2020-03-19 14:03:02 -04:00
generate.go V2 Move varlink home 2020-03-30 08:18:35 -07:00
links-to-html.lua Update XML to not embed quote in PATH on windows 2020-01-31 15:22:20 -07:00
make.bat Restructure documentation dir 2019-10-31 12:31:39 -05:00
play.png Initial checkin from CRI-O repo 2017-11-01 11:24:59 -04:00
podman-derivative-api systemd: expect full path /usr/sbin/init 2019-10-09 23:38:45 +02:00
remote-docs.sh Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
requirements.txt Restructure documentation dir 2019-10-31 12:31:39 -05:00

Readme.md

Podman Documentation

The online man pages and other documents regarding Podman can be found at Read The Docs. The man pages can be found under the Commands link on that page.

Build the Docs

Directory Structure

Directory
Markdown source for man pages docs/source/markdown/
man pages aliases as .so files docs/source/markdown/links/
restructured text for readthedocs.io docs/rst/
target for output docs/build
man pages docs/build/man
remote linux man pages docs/build/remote/linux
remote darwin man pages docs/build/remote/darwin
remote windows html pages docs/build/remote/windows

Support files
docs/remote-docs.sh Read the docs/source/markdown files and format for each platform
docs/links-to-html.lua pandoc filter to do aliases for html files

API Reference

The latest online documentation is automatically generated from committed upstream sources. There is a short-duration cache involved, in case old content or an error is returned, try clearing your browser cache or returning to the site after 10-30 minutes.

Maintainers Note: Please refer to the Cirrus-CI tasks documentation for important operational details.