spiegel_podman/docs
Naja Melan 357eff7235 Make the documentation of user namespace options in podman-run clearer
This proposes a more comprehensible man page.

A number of things have been lost in translation and this should be reviewed:
- the former docs from --userns say that it is disabled by default. I
  suppose that this is the same as --userns:host, but this should be confirmed.
  It also stated that is would use options like pid=host, which confuses me
  as pid namespaces are a totally different thing from user namespaces. It also
  mentions the enabling of --privileged. I think the difference between using
  --userns:host and not using any user namespace options at all is not clear
  and maybe not very logical. Also what would be the difference between using
  --userns:host and using --priveleged alone?
- I found the syntax for --gidmap at the bottom of the man page in the examples.
  In the example it doesn't use '=', eg. podman run `--gidmap 0:30000:2000`.
  For consistency with the other options I have used '=' for now, but if it is
  optional, I would remove it everywhere, as less tokens is usually improved
  readability. For now the inconsistency remains between the options doc and the
  examples section.
- It wasn't very clear to me whether one should hard wrap long lines or not as the
  contains a mix.
- I haven't for now looked at user namespace options on other commands, but
  that should be done surely before merging.
- I didn't know which command to run to generate the groff, so that needs doing still.

from issue #1374

Signed-off-by: Naja Melan <najamelan@autistici.org>

Signed-off-by: Naja Melan <najamelan@autistici.org>

Closes: #1380
Approved by: rhatdan
2018-08-31 13:52:11 +00:00
..
links Add podman-image and podman-container man page links 2018-06-25 21:38:46 +00:00
tutorials tutorial: point to containers/skopeo 2018-08-18 15:19:23 +00:00
varlink Fix varlink remove image force 2018-05-11 16:05:10 +00:00
containers-mounts.conf.5.md docs: consistent headings 2018-08-30 16:51:56 +00:00
dckrman.sh Add support for mimicing docker CLI 2018-01-18 07:01:48 -05:00
generate.go Rename varlink socket and interface 2018-08-06 14:49:11 +00:00
libpod.conf.5.md docs: consistent headings 2018-08-30 16:51:56 +00:00
play.png Initial checkin from CRI-O repo 2017-11-01 11:24:59 -04:00
podman-attach.1.md docs: consistent format for example 2018-08-30 16:51:56 +00:00
podman-build.1.md docs: consistent format for example 2018-08-30 16:51:56 +00:00
podman-commit.1.md docs: consistent format for example 2018-08-30 16:51:56 +00:00
podman-container-cleanup.1.md docs: fix headers 2018-08-30 16:51:56 +00:00
podman-container-refresh.1.md docs: consistent format for example 2018-08-30 16:51:56 +00:00
podman-container.1.md docs: fix headers 2018-08-30 16:51:56 +00:00
podman-cp.1.md docs: fix headers 2018-08-30 16:51:56 +00:00
podman-create.1.md docs: consistent format for example 2018-08-30 16:51:56 +00:00
podman-diff.1.md docs: fix headers 2018-08-30 16:51:56 +00:00
podman-exec.1.md docs: consistent format for example 2018-08-30 16:51:56 +00:00
podman-export.1.md docs: consistent format for example 2018-08-30 16:51:56 +00:00
podman-history.1.md docs: consistent format for example 2018-08-30 16:51:56 +00:00
podman-image.1.md docs: fix headers 2018-08-30 16:51:56 +00:00
podman-images.1.md docs: fix headers 2018-08-30 16:51:56 +00:00
podman-import.1.md docs: consistent format for example 2018-08-30 16:51:56 +00:00
podman-info.1.md docs: fix headers 2018-08-30 16:51:56 +00:00
podman-inspect.1.md docs: fix headers 2018-08-30 16:51:56 +00:00
podman-kill.1.md docs: fix headers 2018-08-30 16:51:56 +00:00
podman-load.1.md docs: consistent format for example 2018-08-30 16:51:56 +00:00
podman-login.1.md docs: consistent format for example 2018-08-30 16:51:56 +00:00
podman-logout.1.md docs: consistent format for example 2018-08-30 16:51:56 +00:00
podman-logs.1.md docs: make HISTORY consistent 2018-08-30 16:51:56 +00:00
podman-mount.1.md docs: fix headers 2018-08-30 16:51:56 +00:00
podman-pause.1.md docs: fix headers 2018-08-30 16:51:56 +00:00
podman-pod-create.1.md docs: consistent format for example 2018-08-30 16:51:56 +00:00
podman-pod-inspect.1.md docs: fix headers 2018-08-30 16:51:56 +00:00
podman-pod-kill.1.md docs: fix headers 2018-08-30 16:51:56 +00:00
podman-pod-pause.1.md docs: fix headers 2018-08-30 16:51:56 +00:00
podman-pod-ps.1.md docs: consistent format for example 2018-08-30 16:51:56 +00:00
podman-pod-restart.1.md docs: fix headers 2018-08-30 16:51:56 +00:00
podman-pod-rm.1.md docs: fix headers 2018-08-30 16:51:56 +00:00
podman-pod-start.1.md docs: fix headers 2018-08-30 16:51:56 +00:00
podman-pod-stop.1.md docs: fix headers 2018-08-30 16:51:56 +00:00
podman-pod-top.1.md docs: consistent format for example 2018-08-30 16:51:56 +00:00
podman-pod-unpause.1.md docs: fix headers 2018-08-30 16:51:56 +00:00
podman-pod.1.md docs: consistent headings 2018-08-30 16:51:56 +00:00
podman-port.1.md docs: fix headers 2018-08-30 16:51:56 +00:00
podman-ps.1.md docs: consistent format for example 2018-08-30 16:51:56 +00:00
podman-pull.1.md docs: consistent format for example 2018-08-30 16:51:56 +00:00
podman-push.1.md docs: fix headers 2018-08-30 16:51:56 +00:00
podman-restart.1.md docs: consistent format for example 2018-08-30 16:51:56 +00:00
podman-rm.1.md docs: fix headers 2018-08-30 16:51:56 +00:00
podman-rmi.1.md docs: fix headers 2018-08-30 16:51:56 +00:00
podman-run.1.md Make the documentation of user namespace options in podman-run clearer 2018-08-31 13:52:11 +00:00
podman-save.1.md docs: consistent format for example 2018-08-30 16:51:56 +00:00
podman-search.1.md docs: consistent format for example 2018-08-30 16:51:56 +00:00
podman-start.1.md docs: fix headers 2018-08-30 16:51:56 +00:00
podman-stats.1.md docs: Follow man-pages(7) suggestions for SYNOPSIS 2018-07-04 09:40:37 +00:00
podman-stop.1.md docs: Follow man-pages(7) suggestions for SYNOPSIS 2018-07-04 09:40:37 +00:00
podman-tag.1.md docs: consistent format for example 2018-08-30 16:51:56 +00:00
podman-top.1.md docs: consistent format for example 2018-08-30 16:51:56 +00:00
podman-umount.1.md Add --force to podman umount to force the unmounting of the rootfs 2018-08-01 17:53:30 +00:00
podman-unpause.1.md docs: Follow man-pages(7) suggestions for SYNOPSIS 2018-07-04 09:40:37 +00:00
podman-varlink.1.md docs: consistent format for example 2018-08-30 16:51:56 +00:00
podman-version.1.md Man page fixes found by https://pagure.io/ManualPageScan 2018-08-02 09:21:43 -04:00
podman-wait.1.md docs: consistent format for example 2018-08-30 16:51:56 +00:00
podman.1.md docs: consistent headings 2018-08-30 16:51:56 +00:00