История

Yong Tang 9b6b3c2076 Add `--dns-option` to `docker run` and hide `--dns-opt` This fix is a follow up to #27567 based on: https://github.com/docker/docker/pull/27567#issuecomment-259295055 In #27567, `--dns-options` has been added to `service create/update`, together with `--dns` and `--dns-search`. The `--dns-opt` was used in `docker run`. This fix add `--dns-option` (not `--dns-options`) to `docker run/create`, and hide `--dns-opt`. It is still possible to use `--dns-opt` with `docker run/create`, though it will not show up in help output. This fix change `--dns-options`to --dns-option` for `docker service create` and `docker service update`. This fix also updates the docs and bash/zsh completion scripts. Signed-off-by: Yong Tang <yong.tang.github@outlook.com>		2016-11-09 12:13:25 -08:00
..
Dockerfile	project: use vndr for vendoring	2016-11-03 15:31:46 -07:00
Dockerfile.5.md	Convert Unused ARG error to warning	2016-10-31 21:42:50 -05:00
Dockerfile.aarch64	project: use vndr for vendoring	2016-11-03 15:31:46 -07:00
Dockerfile.armhf	project: use vndr for vendoring	2016-11-03 15:31:46 -07:00
Dockerfile.ppc64le	project: use vndr for vendoring	2016-11-03 15:31:46 -07:00
Dockerfile.s390x	project: use vndr for vendoring	2016-11-03 15:31:46 -07:00
README.md	Make README less scabious	2016-07-22 09:43:08 +01:00
docker-attach.1.md	Fix a couple of typos in the docs of `docker attach`	2016-06-06 19:06:50 -07:00
docker-build.1.md	Adds ability to squash image after build	2016-11-01 13:41:59 -04:00
docker-commit.1.md	Document valid chars in image name and tag	2016-05-21 19:49:19 +01:00
docker-config-json.5.md	man: mv config-json.5 to docker-config-json.5	2016-06-03 15:28:19 +02:00
docker-cp.1.md	update docs/reference/commandline/cp.md	2016-05-24 11:09:38 +00:00
docker-create.1.md	Add `--dns-option` to `docker run` and hide `--dns-opt`	2016-11-09 12:13:25 -08:00
docker-diff.1.md	…
docker-events.1.md	Complete docker-events man page with filter list…	2016-10-28 13:07:00 -07:00
docker-exec.1.md	Exec: Add ability to set environment variables	2016-10-19 12:39:25 -02:00
docker-export.1.md	various man page typos	2015-10-13 11:52:14 -04:00
docker-history.1.md	remove =false from options that default to false in the docs	2015-12-23 07:11:35 -08:00
docker-images.1.md	Add --format to man and fix some typos	2016-10-28 22:31:20 +08:00
docker-import.1.md	Fix some flaws in man.	2016-02-25 09:48:21 +08:00
docker-info.1.md	Fix typs from go to Go	2016-10-18 19:40:16 +08:00
docker-inspect.1.md	Modify short and flags for docker inspect	2016-10-31 18:11:25 +08:00
docker-kill.1.md	Fix man pages	2015-11-10 09:33:55 +08:00
docker-load.1.md	Update docker-load documentation	2016-06-08 17:40:37 +02:00
docker-login.1.md	fix docs about `sudo docker login`	2016-09-05 04:44:18 +00:00
docker-logout.1.md	Remove some references to "register" through login	2016-03-01 17:33:23 +01:00
docker-logs.1.md	Replace U+2018 and U+2019 with U+0027 in manpages	2016-05-20 20:15:57 +02:00
docker-network-connect.1.md	Improve wording about re-assigning IP addresses	2016-01-27 17:11:12 +00:00
docker-network-create.1.md	Fix incorrect aux-address examples and test	2016-09-27 01:12:29 +02:00
docker-network-disconnect.1.md	Forced endpoint cleanup	2016-01-13 21:28:52 -08:00
docker-network-inspect.1.md	Fix typs from go to Go	2016-10-18 19:40:16 +08:00
docker-network-ls.1.md	Fix incorrect help output in `docker network ls`	2016-09-05 08:24:22 -07:00
docker-network-rm.1.md	Fix some flaws in man.	2016-02-25 09:48:21 +08:00
docker-pause.1.md	Implement Pause Resume support for Windows	2016-10-11 16:23:35 -07:00
docker-port.1.md	…
docker-ps.1.md	Adds container health support to docker ps filter	2016-10-28 15:43:04 -04:00
docker-pull.1.md	Mention "docker login" in push/pull documentation	2016-03-28 17:22:41 -07:00
docker-push.1.md	Synchronize push reference with man page	2016-09-15 18:53:46 +02:00
docker-rename.1.md	Modify rename function usage	2016-09-01 14:48:02 +08:00
docker-restart.1.md	Modify docker-restart.1.md	2016-09-02 13:06:08 +08:00
docker-rm.1.md	Fix some flaws in man.	2016-02-25 09:48:21 +08:00
docker-rmi.1.md	remove =false from options that default to false in the docs	2015-12-23 07:11:35 -08:00
docker-run.1.md	Add `--dns-option` to `docker run` and hide `--dns-opt`	2016-11-09 12:13:25 -08:00
docker-save.1.md	Update 'save' command help	2016-03-22 08:16:52 +01:00
docker-search.1.md	Add `--limit` option to `docker search`	2016-06-02 19:12:20 -07:00
docker-start.1.md	Implement configurable detach key	2016-01-03 23:03:39 +01:00
docker-stats.1.md	Add documentation for docker stats --format	2016-09-26 09:26:48 +03:00
docker-stop.1.md	Fix man pages	2015-11-10 09:33:55 +08:00
docker-tag.1.md	Document valid chars in image name and tag	2016-05-21 19:49:19 +01:00
docker-top.1.md	Improvement of docker top Man Page	2015-12-02 18:54:52 +01:00
docker-unpause.1.md	Implement Pause Resume support for Windows	2016-10-11 16:23:35 -07:00
docker-update.1.md	Fix bunch of typos	2016-10-29 15:03:26 +08:00
docker-version.1.md	Fix typs from go to Go	2016-10-18 19:40:16 +08:00
docker-wait.1.md	…
docker.1.md	Align arg with other cli	2016-11-05 13:47:02 +08:00
dockerd.8.md	daemon: add a flag to override the default seccomp profile	2016-11-02 21:41:29 +01:00
generate.go	Move api/client -> cli/command	2016-09-08 15:46:29 -04:00
generate.sh	Add a script to generate man pages from cobra commands.	2016-07-19 12:00:21 -04:00
glide.lock	Update sfp13/pflag	2016-10-18 17:17:22 -07:00
glide.yaml	Add a script to generate man pages from cobra commands.	2016-07-19 12:00:21 -04:00
md2man-all.sh	…

README.md

Docker Documentation

This directory contains scripts for generating the man pages. Many of the man pages are generated directly from the spf13/cobra Command definition. Some legacy pages are still generated from the markdown files in this directory. Do not edit the man pages in the man1 directory. Instead, update the Cobra command or amend the Markdown files for legacy pages.

Generate the man pages

From within the project root directory run:

make manpages