moby/docs/man
Qiang Huang 837eec064d move resources from Config to HostConfig
Cgroup resources are host dependent, they should be in hostConfig.

For backward compatibility, we just copy it to hostConfig, and leave it in
Config for now, so there is no regressions, but the right way to use this
throught json is to put it in HostConfig, like:
  {
      "Hostname": "",
      ...
      "HostConfig": {
	  "CpuShares": 512,
          "Memory": 314572800,
          ...
      }
  }

As we will add CpusetMems, CpusetCpus is definitely a better name, but some
users are already using Cpuset in their http APIs, we also make it compatible.

The main idea is keep using Cpuset in Config Struct, and make it has the same
value as CpusetCpus, but not always, some scenarios:
 - Users use --cpuset in docker command, it can setup cpuset.cpus and can
   get Cpuset field from docker inspect or other http API which will get
   config info.
 - Users use --cpuset-cpus in docker command, ditto.
 - Users use Cpuset field in their http APIs, ditto.
 - Users use CpusetCpus field in their http APIs, they won't get Cpuset field
   in Config info, because by then, they should already know what happens
   to Cpuset.

Signed-off-by: Qiang Huang <h.huangqiang@huawei.com>
2015-03-11 09:31:18 +08:00
..
docker-attach.1.md Docker attach documentation didn't make sense to me 2015-02-03 11:53:14 +10:00
docker-build.1.md docs: fix another typo in docker-build man page 2015-02-02 10:39:28 +08:00
docker-commit.1.md pass --change changes to the import job 2015-02-24 13:01:36 -05:00
docker-cp.1.md Add support for 'docker cp' to write to stdout 2015-03-05 15:22:08 -08:00
docker-create.1.md move resources from Config to HostConfig 2015-03-11 09:31:18 +08:00
docker-diff.1.md --help option and help command should print to stdout not stderr 2015-01-06 13:40:14 +01:00
docker-events.1.md Update events format in man page 2015-01-29 15:18:25 -08:00
docker-exec.1.md --help option and help command should print to stdout not stderr 2015-01-06 13:40:14 +01:00
docker-export.1.md docs: add See Also for description of export/import and save/load 2015-03-04 20:21:38 -05:00
docker-history.1.md --help option and help command should print to stdout not stderr 2015-01-06 13:40:14 +01:00
docker-images.1.md Add build --pull and evenets --filter flags to the docs for 1.4 2015-01-15 15:20:48 +13:00
docker-import.1.md docs: add See Also for description of export/import and save/load 2015-03-04 20:21:38 -05:00
docker-info.1.md --help option and help command should print to stdout not stderr 2015-01-06 13:40:14 +01:00
docker-inspect.1.md add logpath to docker inspect. 2015-02-18 10:19:52 -05:00
docker-kill.1.md --help option and help command should print to stdout not stderr 2015-01-06 13:40:14 +01:00
docker-load.1.md docs: add See Also for description of export/import and save/load 2015-03-04 20:21:38 -05:00
docker-login.1.md docs: add See Also for description of login/logout and start/stop 2015-03-01 01:36:00 -05:00
docker-logout.1.md docs: add See Also for description of login/logout and start/stop 2015-03-01 01:36:00 -05:00
docker-logs.1.md Add build --pull and evenets --filter flags to the docs for 1.4 2015-01-15 15:20:48 +13:00
docker-pause.1.md Merge pull request #10468 from noironetworks/10457-Pause-and-unpause-accept-multi-containers 2015-02-19 15:16:05 -08:00
docker-port.1.md --help option and help command should print to stdout not stderr 2015-01-06 13:40:14 +01:00
docker-ps.1.md Added missing documentation for PR #8543 2015-02-19 22:05:14 +00:00
docker-pull.1.md --help option and help command should print to stdout not stderr 2015-01-06 13:40:14 +01:00
docker-push.1.md --help option and help command should print to stdout not stderr 2015-01-06 13:40:14 +01:00
docker-rename.1.md rename a existing container 2015-01-13 03:27:17 +00:00
docker-restart.1.md --help option and help command should print to stdout not stderr 2015-01-06 13:40:14 +01:00
docker-rm.1.md --help option and help command should print to stdout not stderr 2015-01-06 13:40:14 +01:00
docker-rmi.1.md --help option and help command should print to stdout not stderr 2015-01-06 13:40:14 +01:00
docker-run.1.md move resources from Config to HostConfig 2015-03-11 09:31:18 +08:00
docker-save.1.md docs: add See Also for description of export/import and save/load 2015-03-04 20:21:38 -05:00
docker-search.1.md Merge pull request #9840 from nhsiehgit/searchapidocs 2015-01-15 17:40:04 -05:00
docker-start.1.md Fix docker start help message 2015-03-07 20:45:46 +08:00
docker-stats.1.md Implements stats for lxc driver 2015-02-23 10:16:52 +00:00
docker-stop.1.md docs: add See Also for description of login/logout and start/stop 2015-03-01 01:36:00 -05:00
docker-tag.1.md --help option and help command should print to stdout not stderr 2015-01-06 13:40:14 +01:00
docker-top.1.md --help option and help command should print to stdout not stderr 2015-01-06 13:40:14 +01:00
docker-unpause.1.md Merge pull request #10468 from noironetworks/10457-Pause-and-unpause-accept-multi-containers 2015-02-19 15:16:05 -08:00
docker-version.1.md Update cli.md and man pages to match current cli 2014-07-03 10:22:20 +10:00
docker-wait.1.md --help option and help command should print to stdout not stderr 2015-01-06 13:40:14 +01:00
docker.1.md Add support for 'docker cp' to write to stdout 2015-03-05 15:22:08 -08:00
Dockerfile Use pure go markdown processor to generate man files 2014-08-07 07:06:39 -04:00
Dockerfile.5.md docs: fix a typo in Dockerfile.5.md 2015-02-15 11:06:18 +08:00
md2man-all.sh Use pure go markdown processor to generate man files 2014-08-07 07:06:39 -04:00
README.md Remove File List 2015-02-02 09:47:19 -02:00

Docker Documentation

This directory contains the Docker user manual in the Markdown format. Do not edit the man pages in the man1 directory. Instead, amend the Markdown (*.md) files.

Generating man pages from the Markdown files

The recommended approach for generating the man pages is via a Docker container using the supplied Dockerfile to create an image with the correct environment. This uses go-md2man, a pure Go Markdown to man page generator.

Building the md2man image

There is a Dockerfile provided in the docker/docs/man directory.

Using this Dockerfile, create a Docker image tagged docker/md2man:

docker build -t docker/md2man .

Utilizing the image

Once the image is built, run a container using the image with volumes:

docker run -v /<path-to-git-dir>/docker/docs/man:/docs:rw \
-w /docs -i docker/md2man /docs/md2man-all.sh

The md2man Docker container will process the Markdown files and generate the man pages inside the docker/docs/man/man1 directory using Docker volumes. For more information on Docker volumes see the man page for docker run and also look at the article [Sharing Directories via Volumes] (http://docs.docker.com/use/working_with_volumes/).