Files

Mary Anthony 8050e305f6 First pass at consolidating

Removing old networking.md
Updating dockernetworks.md with images
Adding information on network plugins
Adding blurb about links to docker networking
Updating the working documentation
Adding Overlay Getting Started
Downplaying links by removing refs/examples, adding refs/examples for network.
Updating getting started to reflect networks not links
Pulling out old network material
Updating per discussion with Madhu to add Default docs section
Updating with bridge default
Fix bad merge
Updating with new cluster-advertise behavior
Update working and NetworkSettings examples
Correcting example for default bridge discovery behavior
Entering comments
Fixing broken Markdown Syntax
Updating with comments
Updating all the links

Signed-off-by: Mary Anthony <mary@docker.com>
Upstream-commit: 02a859b9f3
Component: cli

2017-06-02 00:07:15 +00:00

docker-attach.1.md

First pass at consolidating

2017-06-02 00:07:15 +00:00

docker-build.1.md

Add ability to add multiple tags with docker build

2017-06-02 00:07:14 +00:00

docker-commit.1.md

Fix man and commandline docs

2017-06-02 00:07:11 +00:00

docker-cp.1.md

typo

2017-06-02 00:07:09 +00:00

docker-create.1.md

Add Splunk logging driver #16207

2017-06-02 00:07:14 +00:00

docker-daemon.8.md

First pass at consolidating

2017-06-02 00:07:15 +00:00

docker-diff.1.md

Moving man pages out of docs

2017-06-02 00:06:57 +00:00

docker-events.1.md

Sync with remote API

2017-06-02 00:07:11 +00:00

docker-exec.1.md

Updated test to check for exec --privileged side-effects

2017-06-02 00:07:05 +00:00

docker-export.1.md

various man page typos

2017-06-02 00:07:12 +00:00

docker-history.1.md

add -H to SYNOPSIS man-history

2017-06-02 00:07:06 +00:00

docker-images.1.md

Fix #8048 : make docker images repository:tag work

2017-06-02 00:07:05 +00:00

docker-import.1.md

various man page typos

2017-06-02 00:07:12 +00:00

docker-info.1.md

use Server Version

2017-06-02 00:07:13 +00:00

docker-inspect.1.md

First pass at consolidating

2017-06-02 00:07:15 +00:00

docker-kill.1.md

Moving man pages out of docs

2017-06-02 00:06:57 +00:00

docker-load.1.md

Carry man page for 14637

2017-06-02 00:07:03 +00:00

docker-login.1.md

update reference to config file

2017-06-02 00:07:01 +00:00

docker-logout.1.md

Unify docker commands' usage in man and help

2017-06-02 00:06:59 +00:00

docker-logs.1.md

Add log reading to the journald log driver

2017-06-02 00:07:08 +00:00

docker-network-connect.1.md

Updating network commands: adding man pages

2017-06-02 00:07:15 +00:00

docker-network-create.1.md

Updating network commands: adding man pages

2017-06-02 00:07:15 +00:00

docker-network-disconnect.1.md

Updating network commands: adding man pages

2017-06-02 00:07:15 +00:00

docker-network-inspect.1.md

Updating network commands: adding man pages

2017-06-02 00:07:15 +00:00

docker-network-ls.1.md

Updating network commands: adding man pages

2017-06-02 00:07:15 +00:00

docker-network-rm.1.md

Updating network commands: adding man pages

2017-06-02 00:07:15 +00:00

docker-pause.1.md

Moving man pages out of docs

2017-06-02 00:06:57 +00:00

docker-port.1.md

Moving man pages out of docs

2017-06-02 00:06:57 +00:00

docker-ps.1.md

Fix man and commandline docs

2017-06-02 00:07:11 +00:00

docker-pull.1.md

correct man docker-pull

2017-06-02 00:07:08 +00:00

docker-push.1.md

Modify man pages for image-naming

2017-06-02 00:07:01 +00:00

docker-rename.1.md

various man page typos

2017-06-02 00:07:12 +00:00

docker-restart.1.md

docker restarts running OR stopped containers, docs edit rm "running"

2017-06-02 00:07:09 +00:00

docker-rm.1.md

various man page typos

2017-06-02 00:07:12 +00:00

docker-rmi.1.md

Robert P.J. Day found this problems in man pages

2017-06-02 00:07:01 +00:00

docker-run.1.md

Add Splunk logging driver #16207

2017-06-02 00:07:14 +00:00

docker-save.1.md

Moving man pages out of docs

2017-06-02 00:06:57 +00:00

docker-search.1.md

typo man/search

2017-06-02 00:07:10 +00:00

docker-start.1.md

Fix man and commandline docs

2017-06-02 00:07:11 +00:00

docker-stats.1.md

various man page typos

2017-06-02 00:07:12 +00:00

docker-stop.1.md

Fix man and commandline docs

2017-06-02 00:07:11 +00:00

docker-tag.1.md

man docker-tag minor fixup

2017-06-02 00:07:08 +00:00

docker-top.1.md

Unify docker commands' usage in man and help

2017-06-02 00:06:59 +00:00

docker-unpause.1.md

Moving man pages out of docs

2017-06-02 00:06:57 +00:00

docker-version.1.md

add --format flag to docker version

2017-06-02 00:07:01 +00:00

docker-volume-create.1.md

update docker volume man pages

2017-06-02 00:07:08 +00:00

docker-volume-inspect.1.md

update docker volume man pages

2017-06-02 00:07:08 +00:00

docker-volume-ls.1.md

update docker volume man pages

2017-06-02 00:07:08 +00:00

docker-volume-rm.1.md

update docker volume man pages

2017-06-02 00:07:08 +00:00

docker-wait.1.md

Moving man pages out of docs

2017-06-02 00:06:57 +00:00

docker.1.md

Default the tcp port to 2376 if tls is on, and 2375 if not

2017-06-02 00:07:12 +00:00

Dockerfile

Bump go-md2man to 1.0.3

2017-06-02 00:07:02 +00:00

Dockerfile.5.md

updating docs for EXPOSE option on run command; fixes #16634

2017-06-02 00:07:12 +00:00

md2man-all.sh

Moving man pages out of docs

2017-06-02 00:06:57 +00:00

README.md

updates to readme documents for manual page

2017-06-02 00:07:09 +00:00

README.md

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 /man directory of your 'docker/docker' fork.

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

docker build -t docker/md2man .

Utilizing the image

From within the /man directory run the following command:

docker run -v $(pwd):/man -w /man -i docker/md2man ./md2man-all.sh

The md2man Docker container will process the Markdown files and generate the man pages inside the /man/man1 directory of your fork 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] (https://docs.docker.com/use/working_with_volumes/).