kotovalexarian-likes-github/moby--moby
1
0
Fork 0
mirror of https://github.com/moby/moby.git synced 2022-11-09 12:21:53 -05:00
Code Releases Activity

Merge pull request #6790 from SvenDowideit/pr_out_update_cli_md

Browse source 
update cli.md
This commit is contained in:
Fred Lifton 2014-07-02 17:24:53 -07:00
commit 2c32c195d9
40 changed files with 716 additions and 360 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

60
api/client/commands.go
View file

@ -67,25 +67,25 @@ func (cli *DockerCli) CmdHelp(args ...string) error {
{"inspect", "Return low-level information on a container"}, {"inspect", "Return low-level information on a container"},
{"kill", "Kill a running container"}, {"kill", "Kill a running container"},
{"load", "Load an image from a tar archive"}, {"load", "Load an image from a tar archive"},
{"login", "Register or Login to the docker registry server"}, {"login", "Register or log in to the Docker registry server"},
{"logs", "Fetch the logs of a container"}, {"logs", "Fetch the logs of a container"},
{"port", "Lookup the public-facing port which is NAT-ed to PRIVATE_PORT"}, {"port", "Lookup the public-facing port that is NAT-ed to PRIVATE_PORT"},
{"pause", "Pause all processes within a container"}, {"pause", "Pause all processes within a container"},
{"ps", "List containers"}, {"ps", "List containers"},
{"pull", "Pull an image or a repository from the docker registry server"}, {"pull", "Pull an image or a repository from a Docker registry server"},
{"push", "Push an image or a repository to the docker registry server"}, {"push", "Push an image or a repository to a Docker registry server"},
{"restart", "Restart a running container"}, {"restart", "Restart a running container"},
{"rm", "Remove one or more containers"}, {"rm", "Remove one or more containers"},
{"rmi", "Remove one or more images"}, {"rmi", "Remove one or more images"},
{"run", "Run a command in a new container"}, {"run", "Run a command in a new container"},
{"save", "Save an image to a tar archive"}, {"save", "Save an image to a tar archive"},
{"search", "Search for an image in the docker index"}, {"search", "Search for an image on the Docker Hub"},
{"start", "Start a stopped container"}, {"start", "Start a stopped container"},
{"stop", "Stop a running container"}, {"stop", "Stop a running container"},
{"tag", "Tag an image into a repository"}, {"tag", "Tag an image into a repository"},
{"top", "Lookup the running processes of a container"}, {"top", "Lookup the running processes of a container"},
{"unpause", "Unpause a paused container"}, {"unpause", "Unpause a paused container"},
{"version", "Show the docker version information"}, {"version", "Show the Docker version information"},
{"wait", "Block until a container stops, then print its exit code"}, {"wait", "Block until a container stops, then print its exit code"},
} { } {
help += fmt.Sprintf(" %-10.10s%s\n", command[0], command[1]) help += fmt.Sprintf(" %-10.10s%s\n", command[0], command[1])
@ -123,12 +123,12 @@ func (cli *DockerCli) CmdBuild(args ...string) error {
buf := bufio.NewReader(cli.in) buf := bufio.NewReader(cli.in)
magic, err := buf.Peek(tarHeaderSize) magic, err := buf.Peek(tarHeaderSize)
if err != nil && err != io.EOF { if err != nil && err != io.EOF {
return fmt.Errorf("failed to peek context header from stdin: %v", err) return fmt.Errorf("failed to peek context header from STDIN: %v", err)
} }
if !archive.IsArchive(magic) { if !archive.IsArchive(magic) {
dockerfile, err := ioutil.ReadAll(buf) dockerfile, err := ioutil.ReadAll(buf)
if err != nil { if err != nil {
return fmt.Errorf("failed to read Dockerfile from stdin: %v", err) return fmt.Errorf("failed to read Dockerfile from STDIN: %v", err)
} }
context, err = archive.Generate("Dockerfile", string(dockerfile)) context, err = archive.Generate("Dockerfile", string(dockerfile))
} else { } else {
@ -248,7 +248,7 @@ func (cli *DockerCli) CmdBuild(args ...string) error {
// 'docker login': login / register a user to registry service. // 'docker login': login / register a user to registry service.
func (cli *DockerCli) CmdLogin(args ...string) error { func (cli *DockerCli) CmdLogin(args ...string) error {
cmd := cli.Subcmd("login", "[OPTIONS] [SERVER]", "Register or Login to a docker registry server, if no server is specified \""+registry.IndexServerAddress()+"\" is the default.") cmd := cli.Subcmd("login", "[OPTIONS] [SERVER]", "Register or log in to a Docker registry server, if no server is specified \""+registry.IndexServerAddress()+"\" is the default.")
var username, password, email string var username, password, email string
@ -374,7 +374,7 @@ func (cli *DockerCli) CmdWait(args ...string) error {
// 'docker version': show version information // 'docker version': show version information
func (cli *DockerCli) CmdVersion(args ...string) error { func (cli *DockerCli) CmdVersion(args ...string) error {
cmd := cli.Subcmd("version", "", "Show the docker version information.") cmd := cli.Subcmd("version", "", "Show the Docker version information.")
if err := cmd.Parse(args); err != nil { if err := cmd.Parse(args); err != nil {
return nil return nil
} }
@ -497,8 +497,8 @@ func (cli *DockerCli) CmdInfo(args ...string) error {
} }
func (cli *DockerCli) CmdStop(args ...string) error { func (cli *DockerCli) CmdStop(args ...string) error {
cmd := cli.Subcmd("stop", "[OPTIONS] CONTAINER [CONTAINER...]", "Stop a running container (Send SIGTERM, and then SIGKILL after grace period)") cmd := cli.Subcmd("stop", "[OPTIONS] CONTAINER [CONTAINER...]", "Stop a running container by sending SIGTERM and then SIGKILL after a grace period")
nSeconds := cmd.Int([]string{"t", "-time"}, 10, "Number of seconds to wait for the container to stop before killing it.") nSeconds := cmd.Int([]string{"t", "-time"}, 10, "Number of seconds to wait for the container to stop before killing it. Default is 10 seconds.")
if err := cmd.Parse(args); err != nil { if err := cmd.Parse(args); err != nil {
return nil return nil
} }
@ -525,7 +525,7 @@ func (cli *DockerCli) CmdStop(args ...string) error {
func (cli *DockerCli) CmdRestart(args ...string) error { func (cli *DockerCli) CmdRestart(args ...string) error {
cmd := cli.Subcmd("restart", "[OPTIONS] CONTAINER [CONTAINER...]", "Restart a running container") cmd := cli.Subcmd("restart", "[OPTIONS] CONTAINER [CONTAINER...]", "Restart a running container")
nSeconds := cmd.Int([]string{"t", "-time"}, 10, "Number of seconds to try to stop for before killing the container. Once killed it will then be restarted. Default=10") nSeconds := cmd.Int([]string{"t", "-time"}, 10, "Number of seconds to try to stop for before killing the container. Once killed it will then be restarted. Default is 10 seconds.")
if err := cmd.Parse(args); err != nil { if err := cmd.Parse(args); err != nil {
return nil return nil
} }
@ -582,8 +582,8 @@ func (cli *DockerCli) CmdStart(args ...string) error {
tty bool tty bool
cmd = cli.Subcmd("start", "CONTAINER [CONTAINER...]", "Restart a stopped container") cmd = cli.Subcmd("start", "CONTAINER [CONTAINER...]", "Restart a stopped container")
attach = cmd.Bool([]string{"a", "-attach"}, false, "Attach container's stdout/stderr and forward all signals to the process") attach = cmd.Bool([]string{"a", "-attach"}, false, "Attach container's STDOUT and STDERR and forward all signals to the process")
openStdin = cmd.Bool([]string{"i", "-interactive"}, false, "Attach container's stdin") openStdin = cmd.Bool([]string{"i", "-interactive"}, false, "Attach container's STDIN")
) )
if err := cmd.Parse(args); err != nil { if err := cmd.Parse(args); err != nil {
@ -714,7 +714,7 @@ func (cli *DockerCli) CmdPause(args ...string) error {
} }
func (cli *DockerCli) CmdInspect(args ...string) error { func (cli *DockerCli) CmdInspect(args ...string) error {
cmd := cli.Subcmd("inspect", "CONTAINER|IMAGE [CONTAINER|IMAGE...]", "Return low-level information on a container/image") cmd := cli.Subcmd("inspect", "CONTAINER|IMAGE [CONTAINER|IMAGE...]", "Return low-level information on a container or image")
tmplStr := cmd.String([]string{"f", "#format", "-format"}, "", "Format the output using the given go template.") tmplStr := cmd.String([]string{"f", "#format", "-format"}, "", "Format the output using the given go template.")
if err := cmd.Parse(args); err != nil { if err := cmd.Parse(args); err != nil {
return nil return nil
@ -794,7 +794,7 @@ func (cli *DockerCli) CmdInspect(args ...string) error {
} }
func (cli *DockerCli) CmdTop(args ...string) error { func (cli *DockerCli) CmdTop(args ...string) error {
cmd := cli.Subcmd("top", "CONTAINER [ps OPTIONS]", "Lookup the running processes of a container") cmd := cli.Subcmd("top", "CONTAINER [ps OPTIONS]", "Display the running processes of a container")
if err := cmd.Parse(args); err != nil { if err := cmd.Parse(args); err != nil {
return nil return nil
} }
@ -829,7 +829,7 @@ func (cli *DockerCli) CmdTop(args ...string) error {
} }
func (cli *DockerCli) CmdPort(args ...string) error { func (cli *DockerCli) CmdPort(args ...string) error {
cmd := cli.Subcmd("port", "CONTAINER PRIVATE_PORT", "Lookup the public-facing port which is NAT-ed to PRIVATE_PORT") cmd := cli.Subcmd("port", "CONTAINER PRIVATE_PORT", "Lookup the public-facing port that is NAT-ed to PRIVATE_PORT")
if err := cmd.Parse(args); err != nil { if err := cmd.Parse(args); err != nil {
return nil return nil
} }
@ -877,7 +877,7 @@ func (cli *DockerCli) CmdPort(args ...string) error {
func (cli *DockerCli) CmdRmi(args ...string) error { func (cli *DockerCli) CmdRmi(args ...string) error {
var ( var (
cmd = cli.Subcmd("rmi", "IMAGE [IMAGE...]", "Remove one or more images") cmd = cli.Subcmd("rmi", "IMAGE [IMAGE...]", "Remove one or more images")
force = cmd.Bool([]string{"f", "-force"}, false, "Force") force = cmd.Bool([]string{"f", "-force"}, false, "Force removal of the image")
noprune = cmd.Bool([]string{"-no-prune"}, false, "Do not delete untagged parents") noprune = cmd.Bool([]string{"-no-prune"}, false, "Do not delete untagged parents")
) )
if err := cmd.Parse(args); err != nil { if err := cmd.Parse(args); err != nil {
@ -980,7 +980,7 @@ func (cli *DockerCli) CmdHistory(args ...string) error {
func (cli *DockerCli) CmdRm(args ...string) error { func (cli *DockerCli) CmdRm(args ...string) error {
cmd := cli.Subcmd("rm", "[OPTIONS] CONTAINER [CONTAINER...]", "Remove one or more containers") cmd := cli.Subcmd("rm", "[OPTIONS] CONTAINER [CONTAINER...]", "Remove one or more containers")
v := cmd.Bool([]string{"v", "-volumes"}, false, "Remove the volumes associated to the container") v := cmd.Bool([]string{"v", "-volumes"}, false, "Remove the volumes associated with the container")
link := cmd.Bool([]string{"l", "#link", "-link"}, false, "Remove the specified link and not the underlying container") link := cmd.Bool([]string{"l", "#link", "-link"}, false, "Remove the specified link and not the underlying container")
force := cmd.Bool([]string{"f", "-force"}, false, "Force removal of running container") force := cmd.Bool([]string{"f", "-force"}, false, "Force removal of running container")
@ -1017,7 +1017,7 @@ func (cli *DockerCli) CmdRm(args ...string) error {
// 'docker kill NAME' kills a running container // 'docker kill NAME' kills a running container
func (cli *DockerCli) CmdKill(args ...string) error { func (cli *DockerCli) CmdKill(args ...string) error {
cmd := cli.Subcmd("kill", "[OPTIONS] CONTAINER [CONTAINER...]", "Kill a running container (send SIGKILL, or specified signal)") cmd := cli.Subcmd("kill", "[OPTIONS] CONTAINER [CONTAINER...]", "Kill a running container using SIGKILL or a specified signal")
signal := cmd.String([]string{"s", "-signal"}, "KILL", "Signal to send to the container") signal := cmd.String([]string{"s", "-signal"}, "KILL", "Signal to send to the container")
if err := cmd.Parse(args); err != nil { if err := cmd.Parse(args); err != nil {
@ -1149,7 +1149,7 @@ func (cli *DockerCli) CmdPush(args ...string) error {
func (cli *DockerCli) CmdPull(args ...string) error { func (cli *DockerCli) CmdPull(args ...string) error {
cmd := cli.Subcmd("pull", "NAME[:TAG]", "Pull an image or a repository from the registry") cmd := cli.Subcmd("pull", "NAME[:TAG]", "Pull an image or a repository from the registry")
tag := cmd.String([]string{"#t", "#-tag"}, "", "Download tagged image in repository") tag := cmd.String([]string{"#t", "#-tag"}, "", "Download tagged image in a repository")
if err := cmd.Parse(args); err != nil { if err := cmd.Parse(args); err != nil {
return nil return nil
} }
@ -1540,9 +1540,9 @@ func (cli *DockerCli) CmdCommit(args ...string) error {
cmd := cli.Subcmd("commit", "[OPTIONS] CONTAINER [REPOSITORY[:TAG]]", "Create a new image from a container's changes") cmd := cli.Subcmd("commit", "[OPTIONS] CONTAINER [REPOSITORY[:TAG]]", "Create a new image from a container's changes")
flPause := cmd.Bool([]string{"p", "-pause"}, true, "Pause container during commit") flPause := cmd.Bool([]string{"p", "-pause"}, true, "Pause container during commit")
flComment := cmd.String([]string{"m", "-message"}, "", "Commit message") flComment := cmd.String([]string{"m", "-message"}, "", "Commit message")
flAuthor := cmd.String([]string{"a", "#author", "-author"}, "", "Author (eg. \"John Hannibal Smith <hannibal@a-team.com>\")") flAuthor := cmd.String([]string{"a", "#author", "-author"}, "", "Author (e.g., \"John Hannibal Smith <hannibal@a-team.com>\")")
// FIXME: --run is deprecated, it will be replaced with inline Dockerfile commands. // FIXME: --run is deprecated, it will be replaced with inline Dockerfile commands.
flConfig := cmd.String([]string{"#run", "#-run"}, "", "this option is deprecated and will be removed in a future version in favor of inline Dockerfile-compatible commands") flConfig := cmd.String([]string{"#run", "#-run"}, "", "This option is deprecated and will be removed in a future version in favor of inline Dockerfile-compatible commands")
if err := cmd.Parse(args); err != nil { if err := cmd.Parse(args); err != nil {
return nil return nil
} }
@ -1735,8 +1735,8 @@ func (cli *DockerCli) CmdLogs(args ...string) error {
func (cli *DockerCli) CmdAttach(args ...string) error { func (cli *DockerCli) CmdAttach(args ...string) error {
var ( var (
cmd = cli.Subcmd("attach", "[OPTIONS] CONTAINER", "Attach to a running container") cmd = cli.Subcmd("attach", "[OPTIONS] CONTAINER", "Attach to a running container")
noStdin = cmd.Bool([]string{"#nostdin", "-no-stdin"}, false, "Do not attach stdin") noStdin = cmd.Bool([]string{"#nostdin", "-no-stdin"}, false, "Do not attach STDIN")
proxy = cmd.Bool([]string{"#sig-proxy", "-sig-proxy"}, true, "Proxify received signals to the process (even in non-tty mode). SIGCHLD is not proxied") proxy = cmd.Bool([]string{"#sig-proxy", "-sig-proxy"}, true, "Proxify all received signals to the process (even in non-TTY mode). SIGCHLD is not proxied.")
) )
if err := cmd.Parse(args); err != nil { if err := cmd.Parse(args); err != nil {
@ -1807,11 +1807,11 @@ func (cli *DockerCli) CmdAttach(args ...string) error {
} }
func (cli *DockerCli) CmdSearch(args ...string) error { func (cli *DockerCli) CmdSearch(args ...string) error {
cmd := cli.Subcmd("search", "TERM", "Search the docker index for images") cmd := cli.Subcmd("search", "TERM", "Search the Docker Hub for images")
noTrunc := cmd.Bool([]string{"#notrunc", "-no-trunc"}, false, "Don't truncate output") noTrunc := cmd.Bool([]string{"#notrunc", "-no-trunc"}, false, "Don't truncate output")
trusted := cmd.Bool([]string{"#t", "#trusted", "#-trusted"}, false, "Only show trusted builds") trusted := cmd.Bool([]string{"#t", "#trusted", "#-trusted"}, false, "Only show trusted builds")
automated := cmd.Bool([]string{"-automated"}, false, "Only show automated builds") automated := cmd.Bool([]string{"-automated"}, false, "Only show automated builds")
stars := cmd.Int([]string{"s", "#stars", "-stars"}, 0, "Only displays with at least xxx stars") stars := cmd.Int([]string{"s", "#stars", "-stars"}, 0, "Only displays with at least x stars")
if err := cmd.Parse(args); err != nil { if err := cmd.Parse(args); err != nil {
return nil return nil
} }
@ -1938,7 +1938,7 @@ func (cli *DockerCli) CmdRun(args ...string) error {
} }
if cidFileInfo.Size() == 0 { if cidFileInfo.Size() == 0 {
if err := os.Remove(hostConfig.ContainerIDFile); err != nil { if err := os.Remove(hostConfig.ContainerIDFile); err != nil {
fmt.Printf("failed to remove CID file '%s': %s \n", hostConfig.ContainerIDFile, err) fmt.Printf("failed to remove Container ID file '%s': %s \n", hostConfig.ContainerIDFile, err)
} }
} }
}() }()
@ -2188,7 +2188,7 @@ func (cli *DockerCli) CmdCp(args ...string) error {
} }
func (cli *DockerCli) CmdSave(args ...string) error { func (cli *DockerCli) CmdSave(args ...string) error {
cmd := cli.Subcmd("save", "IMAGE", "Save an image to a tar archive (streamed to stdout by default)") cmd := cli.Subcmd("save", "IMAGE", "Save an image to a tar archive (streamed to STDOUT by default)")
outfile := cmd.String([]string{"o", "-output"}, "", "Write to an file, instead of STDOUT") outfile := cmd.String([]string{"o", "-output"}, "", "Write to an file, instead of STDOUT")
if err := cmd.Parse(args); err != nil { if err := cmd.Parse(args); err != nil {

2
contrib/completion/fish/docker.fish
View file

@ -79,7 +79,7 @@ complete -c docker -A -f -n '__fish_seen_subcommand_from build' -s t -l tag -d '
# commit # commit
complete -c docker -f -n '__fish_docker_no_subcommand' -a commit -d "Create a new image from a container's changes" complete -c docker -f -n '__fish_docker_no_subcommand' -a commit -d "Create a new image from a container's changes"
complete -c docker -A -f -n '__fish_seen_subcommand_from commit' -s a -l author -d 'Author (eg. "John Hannibal Smith <hannibal@a-team.com>"' complete -c docker -A -f -n '__fish_seen_subcommand_from commit' -s a -l author -d 'Author (e.g., "John Hannibal Smith <hannibal@a-team.com>"'
complete -c docker -A -f -n '__fish_seen_subcommand_from commit' -s m -l message -d 'Commit message' complete -c docker -A -f -n '__fish_seen_subcommand_from commit' -s m -l message -d 'Commit message'
complete -c docker -A -f -n '__fish_seen_subcommand_from commit' -l run -d 'Config automatically applied when the image is run. (ex: -run=\'{"Cmd": ["cat", "/world"], "PortSpecs": ["22"]}\')' complete -c docker -A -f -n '__fish_seen_subcommand_from commit' -l run -d 'Config automatically applied when the image is run. (ex: -run=\'{"Cmd": ["cat", "/world"], "PortSpecs": ["22"]}\')'
complete -c docker -A -f -n '__fish_seen_subcommand_from commit' -a '(__fish_print_docker_containers all)' -d "Container" complete -c docker -A -f -n '__fish_seen_subcommand_from commit' -a '(__fish_print_docker_containers all)' -d "Container"

214
docs/docs-update.py Executable file
View file

@ -0,0 +1,214 @@
#!/usr/bin/env python
#
# Sven's quick hack script to update the documentation
#
# call with:
# ./docs/update.py /usr/bin/docker
#
import re
from sys import argv
import subprocess
import os
import os.path
script, docker_cmd = argv
def print_usage(outtext, docker_cmd, command):
help = ""
try:
#print "RUN ", "".join((docker_cmd, " ", command, " --help"))
help = subprocess.check_output("".join((docker_cmd, " ", command, " --help")), stderr=subprocess.STDOUT, shell=True)
except subprocess.CalledProcessError, e:
help = e.output
for l in str(help).strip().split("\n"):
l = l.rstrip()
if l == '':
outtext.write("\n")
else:
# `docker --help` tells the user the path they called it with
l = re.sub(docker_cmd, "docker", l)
outtext.write(" "+l+"\n")
outtext.write("\n")
# TODO: look for an complain about any missing commands
def update_cli_reference():
originalFile = "docs/sources/reference/commandline/cli.md"
os.rename(originalFile, originalFile+".bak")
intext = open(originalFile+".bak", "r")
outtext = open(originalFile, "w")
mode = 'p'
space = " "
command = ""
# 2 mode line-by line parser
for line in intext:
if mode=='p':
# Prose
match = re.match("( \s*)Usage: docker ([a-z]+)", line)
if match:
# the begining of a Docker command usage block
space = match.group(1)
command = match.group(2)
mode = 'c'
else:
match = re.match("( \s*)Usage of .*docker.*:", line)
if match:
# the begining of the Docker --help usage block
space = match.group(1)
command = ""
mode = 'c'
else:
outtext.write(line)
else:
# command usage block
match = re.match("("+space+")(.*)|^$", line)
#print "CMD ", command
if not match:
# The end of the current usage block - Shell out to run docker to see the new output
print_usage(outtext, docker_cmd, command)
outtext.write(line)
mode = 'p'
if mode == 'c':
print_usage(outtext, docker_cmd, command)
def update_man_pages():
cmds = []
try:
help = subprocess.check_output("".join((docker_cmd)), stderr=subprocess.STDOUT, shell=True)
except subprocess.CalledProcessError, e:
help = e.output
for l in str(help).strip().split("\n"):
l = l.rstrip()
if l != "":
match = re.match(" (.*?) .*", l)
if match:
cmds.append(match.group(1))
desc_re = re.compile(r".*# DESCRIPTION(.*?)# (OPTIONS|EXAMPLES?).*", re.MULTILINE|re.DOTALL)
example_re = re.compile(r".*# EXAMPLES?(.*)# HISTORY.*", re.MULTILINE|re.DOTALL)
history_re = re.compile(r".*# HISTORY(.*)", re.MULTILINE|re.DOTALL)
for command in cmds:
print "COMMAND: "+command
history = ""
description = ""
examples = ""
if os.path.isfile("docs/man/docker-"+command+".1.md"):
intext = open("docs/man/docker-"+command+".1.md", "r")
txt = intext.read()
intext.close()
match = desc_re.match(txt)
if match:
description = match.group(1)
match = example_re.match(txt)
if match:
examples = match.group(1)
match = history_re.match(txt)
if match:
history = match.group(1).strip()
usage = ""
usage_description = ""
params = {}
key_params = {}
help = ""
try:
help = subprocess.check_output("".join((docker_cmd, " ", command, " --help")), stderr=subprocess.STDOUT, shell=True)
except subprocess.CalledProcessError, e:
help = e.output
last_key = ""
for l in str(help).split("\n"):
l = l.rstrip()
if l != "":
match = re.match("Usage: docker "+command+"(.*)", l)
if match:
usage = match.group(1).strip()
else:
#print ">>>>"+l
match = re.match(" (-+)(.*) \s+(.*)", l)
if match:
last_key = match.group(2).rstrip()
#print " found "+match.group(1)
key_params[last_key] = match.group(1)+last_key
params[last_key] = match.group(3)
else:
if last_key != "":
params[last_key] = params[last_key] + "\n" + l
else:
if usage_description != "":
usage_description = usage_description + "\n"
usage_description = usage_description + l
# replace [OPTIONS] with the list of params
options = ""
match = re.match("\[OPTIONS\](.*)", usage)
if match:
usage = match.group(1)
new_usage = ""
# TODO: sort without the `-`'s
for key in sorted(params.keys(), key=lambda s: s.lower()):
# split on commas, remove --?.*=.*, put in *'s mumble
ps = []
opts = []
for k in key_params[key].split(","):
#print "......"+k
match = re.match("(-+)([A-Za-z-0-9]*)(?:=(.*))?", k.lstrip())
if match:
p = "**"+match.group(1)+match.group(2)+"**"
o = "**"+match.group(1)+match.group(2)+"**"
if match.group(3):
# if ="" then use UPPERCASE(group(2))"
val = match.group(3)
if val == "\"\"":
val = match.group(2).upper()
p = p+"[=*"+val+"*]"
val = match.group(3)
if val in ("true", "false"):
params[key] = params[key].rstrip()
if not params[key].endswith('.'):
params[key] = params[key]+ "."
params[key] = params[key] + " The default is *"+val+"*."
val = "*true*|*false*"
o = o+"="+val
ps.append(p)
opts.append(o)
else:
print "nomatch:"+k
new_usage = new_usage+ "\n["+"|".join(ps)+"]"
options = options + ", ".join(opts) + "\n "+ params[key]+"\n\n"
if new_usage != "":
new_usage = new_usage.strip() + "\n"
usage = new_usage + usage
outtext = open("docs/man/docker-"+command+".1.md", "w")
outtext.write("""% DOCKER(1) Docker User Manuals
% Docker Community
% JUNE 2014
# NAME
""")
outtext.write("docker-"+command+" - "+usage_description+"\n\n")
outtext.write("# SYNOPSIS\n**docker "+command+"**\n"+usage+"\n\n")
if description != "":
outtext.write("# DESCRIPTION"+description)
if options == "":
options = "There are no available options.\n\n"
outtext.write("# OPTIONS\n"+options)
if examples != "":
outtext.write("# EXAMPLES"+examples)
outtext.write("# HISTORY\n")
if history != "":
outtext.write(history+"\n")
recent_history_re = re.compile(".*June 2014.*", re.MULTILINE|re.DOTALL)
if not recent_history_re.match(history):
outtext.write("June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>\n")
outtext.close()
# main
update_cli_reference()
update_man_pages()

17
docs/man/docker-attach.1.md
View file

@ -1,11 +1,14 @@
% DOCKER(1) Docker User Manuals % DOCKER(1) Docker User Manuals
% William Henry % Docker Community
% APRIL 2014 % JUNE 2014
# NAME # NAME
docker-attach - Attach to a running container docker-attach - Attach to a running container
# SYNOPSIS # SYNOPSIS
**docker attach** **--no-stdin**[=*false*] **--sig-proxy**[=*true*] CONTAINER **docker attach**
[**--no-stdin**[=*false*]]
[**--sig-proxy**[=*true*]]
CONTAINER
# DESCRIPTION # DESCRIPTION
If you **docker run** a container in detached mode (**-d**), you can reattach to If you **docker run** a container in detached mode (**-d**), you can reattach to
@ -19,11 +22,10 @@ the client.
# OPTIONS # OPTIONS
**--no-stdin**=*true*|*false* **--no-stdin**=*true*|*false*
When set to true, do not attach to stdin. The default is *false*. Do not attach STDIN. The default is *false*.
**--sig-proxy**=*true*|*false*: **--sig-proxy**=*true*|*false*
When set to true, proxify received signals to the process (even in non-tty Proxify all received signals to the process (even in non-TTY mode). SIGCHLD is not proxied. The default is *true*.
mode). SIGCHLD is not proxied. The default is *true*.
# EXAMPLES # EXAMPLES
@ -56,3 +58,4 @@ attach** command:
# HISTORY # HISTORY
April 2014, Originally compiled by William Henry (whenry at redhat dot com) April 2014, Originally compiled by William Henry (whenry at redhat dot com)
based on docker.io source material and internal work. based on docker.io source material and internal work.
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>

42
docs/man/docker-build.1.md
View file

@ -1,12 +1,17 @@
% DOCKER(1) Docker User Manuals % DOCKER(1) Docker User Manuals
% William Henry % Docker Community
% APRIL 2014 % JUNE 2014
# NAME # NAME
docker-build - Build an image from a Dockerfile source at PATH docker-build - Build a new image from the source code at PATH
# SYNOPSIS # SYNOPSIS
**docker build** [**--no-cache**[=*false*]] [**-q**|**--quiet**[=*false*]] **docker build**
[**--rm**] [**-t**|**--tag**=TAG] PATH | URL | - [**--force-rm**[=*false*]]
[**--no-cache**[=*false*]]
[**-q**|**--quiet**[=*false*]]
[**--rm**[=*true*]]
[**-t**|**--tag**[=*TAG*]]
PATH | URL | -
# DESCRIPTION # DESCRIPTION
This will read the Dockerfile from the directory specified in **PATH**. This will read the Dockerfile from the directory specified in **PATH**.
@ -25,22 +30,20 @@ When a Git repository is set as the **URL**, the repository is used
as context. as context.
# OPTIONS # OPTIONS
**--force-rm**=*true*|*false*
**-q**, **--quiet**=*true*|*false* Always remove intermediate containers, even after unsuccessful builds. The default is *false*.
When set to true, suppress verbose build output. Default is *false*.
**--rm**=*true*|*false*
When true, remove intermediate containers that are created during the
build process. The default is true.
**-t**, **--tag**=*tag*
The name to be applied to the resulting image on successful completion of
the build. `tag` in this context means the entire image name including the
optional TAG after the ':'.
**--no-cache**=*true*|*false* **--no-cache**=*true*|*false*
When set to true, do not use a cache when building the image. The Do not use cache when building the image. The default is *false*.
default is *false*.
**-q**, **--quiet**=*true*|*false*
Suppress the verbose output generated by the containers. The default is *false*.
**--rm**=*true*|*false*
Remove intermediate containers after a successful build. The default is *true*.
**-t**, **--tag**=""
Repository name (and optionally a tag) to be applied to the resulting image in case of success
# EXAMPLES # EXAMPLES
@ -115,3 +118,4 @@ Note: You can set an arbitrary Git repository via the `git://` schema.
# HISTORY # HISTORY
March 2014, Originally compiled by William Henry (whenry at redhat dot com) March 2014, Originally compiled by William Henry (whenry at redhat dot com)
based on docker.io source material and internal work. based on docker.io source material and internal work.
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>

20
docs/man/docker-commit.1.md
View file

@ -1,22 +1,23 @@
% DOCKER(1) Docker User Manuals % DOCKER(1) Docker User Manuals
% William Henry % Docker Community
% APRIL 2014 % JUNE 2014
# NAME # NAME
docker-commit - Create a new image from the changes to an existing docker-commit - Create a new image from a container's changes
container
# SYNOPSIS # SYNOPSIS
**docker commit** **-a**|**--author**[=""] **-m**|**--message**[=""] **docker commit**
CONTAINER [REPOSITORY[:TAG]] [**-a**|**--author**[=*AUTHOR*]]
[**-m**|**--message**[=*MESSAGE*]]
CONTAINER [REPOSITORY[:TAG]]
# DESCRIPTION # DESCRIPTION
Using an existing container's name or ID you can create a new image. Using an existing container's name or ID you can create a new image.
# OPTIONS # OPTIONS
**-a, --author**="" **-a**, **--author**=""
Author name. (e.g., "John Hannibal Smith <hannibal@a-team.com>" Author (e.g., "John Hannibal Smith <hannibal@a-team.com>")
**-m, --message**="" **-m**, **--message**=""
Commit message Commit message
**-p, --pause**=true **-p, --pause**=true
@ -35,3 +36,4 @@ create a new image run docker ps to find the container's ID and then run:
# HISTORY # HISTORY
April 2014, Originally compiled by William Henry (whenry at redhat dot com) April 2014, Originally compiled by William Henry (whenry at redhat dot com)
based on docker.io source material and in based on docker.io source material and in
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>

14
docs/man/docker-cp.1.md
View file

@ -1,18 +1,22 @@
% DOCKER(1) Docker User Manuals % DOCKER(1) Docker User Manuals
% William Henry % Docker Community
% APRIL 2014 % JUNE 2014
# NAME # NAME
docker-cp - Copy files/folders from the PATH to the HOSTPATH docker-cp - Copy files/folders from the PATH to the HOSTPATH
# SYNOPSIS # SYNOPSIS
**docker cp** CONTAINER:PATH HOSTPATH **docker cp**
CONTAINER:PATH HOSTPATH
# DESCRIPTION # DESCRIPTION
Copy files/folders from a container's filesystem to the host Copy files/folders from a container's filesystem to the host
path. Paths are relative to the root of the filesystem. Files path. Paths are relative to the root of the filesystem. Files
can be copied from a running or stopped container. can be copied from a running or stopped container.
# EXAMPLE # OPTIONS
There are no available options.
# EXAMPLES
An important shell script file, created in a bash shell, is copied from An important shell script file, created in a bash shell, is copied from
the exited container to the current dir on the host: the exited container to the current dir on the host:
@ -21,4 +25,4 @@ the exited container to the current dir on the host:
# HISTORY # HISTORY
April 2014, Originally compiled by William Henry (whenry at redhat dot com) April 2014, Originally compiled by William Henry (whenry at redhat dot com)
based on docker.io source material and internal work. based on docker.io source material and internal work.
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>

15
docs/man/docker-diff.1.md
View file

@ -1,18 +1,22 @@
% DOCKER(1) Docker User Manuals % DOCKER(1) Docker User Manuals
% William Henry % Docker Community
% APRIL 2014 % JUNE 2014
# NAME # NAME
docker-diff - Inspect changes on a container's filesystem docker-diff - Inspect changes on a container's filesystem
# SYNOPSIS # SYNOPSIS
**docker diff** CONTAINER **docker diff**
CONTAINER
# DESCRIPTION # DESCRIPTION
Inspect changes on a container's filesystem. You can use the full or Inspect changes on a container's filesystem. You can use the full or
shortened container ID or the container name set using shortened container ID or the container name set using
**docker run --name** option. **docker run --name** option.
# EXAMPLE # OPTIONS
There are no available options.
# EXAMPLES
Inspect the changes to on a nginx container: Inspect the changes to on a nginx container:
# docker diff 1fdfd1f54c1b # docker diff 1fdfd1f54c1b
@ -40,5 +44,4 @@ Inspect the changes to on a nginx container:
# HISTORY # HISTORY
April 2014, Originally compiled by William Henry (whenry at redhat dot com) April 2014, Originally compiled by William Henry (whenry at redhat dot com)
based on docker.io source material and internal work. based on docker.io source material and internal work.
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>

17
docs/man/docker-events.1.md
View file

@ -1,10 +1,14 @@
% DOCKER(1) Docker User Manuals % DOCKER(1) Docker User Manuals
% William Henry % Docker Community
% APRIL 2014 % JUNE 2014
# NAME # NAME
docker-events - Get real time events from the server docker-events - Get real time events from the server
**docker events** **--since**=""|*epoch-time* # SYNOPSIS
**docker events**
[**--since**[=*SINCE*]]
[**--until**[=*UNTIL*]]
# DESCRIPTION # DESCRIPTION
Get event information from the Docker daemon. Information can include historical Get event information from the Docker daemon. Information can include historical
@ -12,8 +16,10 @@ information and real-time information.
# OPTIONS # OPTIONS
**--since**="" **--since**=""
Show previously created events and then stream. This can be in either Show all events created since timestamp
seconds since epoch, or date string.
**--until**=""
Stream events until this timestamp
# EXAMPLES # EXAMPLES
@ -44,3 +50,4 @@ Again the output container IDs have been shortened for the purposes of this docu
# HISTORY # HISTORY
April 2014, Originally compiled by William Henry (whenry at redhat dot com) April 2014, Originally compiled by William Henry (whenry at redhat dot com)
based on docker.io source material and internal work. based on docker.io source material and internal work.
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>

16
docs/man/docker-export.1.md
View file

@ -1,19 +1,22 @@
% DOCKER(1) Docker User Manuals % DOCKER(1) Docker User Manuals
% William Henry % Docker Community
% APRIL 2014 % JUNE 2014
# NAME # NAME
docker-export - Export the contents of a filesystem as a tar archive to docker-export - Export the contents of a filesystem as a tar archive to STDOUT
STDOUT.
# SYNOPSIS # SYNOPSIS
**docker export** CONTAINER **docker export**
CONTAINER
# DESCRIPTION # DESCRIPTION
Export the contents of a container's filesystem using the full or shortened Export the contents of a container's filesystem using the full or shortened
container ID or container name. The output is exported to STDOUT and can be container ID or container name. The output is exported to STDOUT and can be
redirected to a tar file. redirected to a tar file.
# EXAMPLE # OPTIONS
There are no available options.
# EXAMPLES
Export the contents of the container called angry_bell to a tar file Export the contents of the container called angry_bell to a tar file
called test.tar: called test.tar:
@ -24,3 +27,4 @@ called test.tar:
# HISTORY # HISTORY
April 2014, Originally compiled by William Henry (whenry at redhat dot com) April 2014, Originally compiled by William Henry (whenry at redhat dot com)
based on docker.io source material and internal work. based on docker.io source material and internal work.
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>

18
docs/man/docker-history.1.md
View file

@ -1,11 +1,13 @@
% DOCKER(1) Docker User Manuals % DOCKER(1) Docker User Manuals
% William Henry % Docker Community
% APRIL 2014 % JUNE 2014
# NAME # NAME
docker-history - Show the history of an image docker-history - Show the history of an image
# SYNOPSIS # SYNOPSIS
**docker history** **--no-trunc**[=*false*] [**-q**|**--quiet**[=*false*]] **docker history**
[**--no-trunc**[=*false*]]
[**-q**|**--quiet**[=*false*]]
IMAGE IMAGE
# DESCRIPTION # DESCRIPTION
@ -13,14 +15,13 @@ docker-history - Show the history of an image
Show the history of when and how an image was created. Show the history of when and how an image was created.
# OPTIONS # OPTIONS
**--no-trunc**=*true*|*false* **--no-trunc**=*true*|*false*
When true don't truncate output. Default is false Don't truncate output. The default is *false*.
**-q**, **--quiet=*true*|*false* **-q**, **--quiet**=*true*|*false*
When true only show numeric IDs. Default is false. Only show numeric IDs. The default is *false*.
# EXAMPLE # EXAMPLES
$ sudo docker history fedora $ sudo docker history fedora
IMAGE CREATED CREATED BY SIZE IMAGE CREATED CREATED BY SIZE
105182bb5e8b 5 days ago /bin/sh -c #(nop) ADD file:71356d2ad59aa3119d 372.7 MB 105182bb5e8b 5 days ago /bin/sh -c #(nop) ADD file:71356d2ad59aa3119d 372.7 MB
@ -30,3 +31,4 @@ Show the history of when and how an image was created.
# HISTORY # HISTORY
April 2014, Originally compiled by William Henry (whenry at redhat dot com) April 2014, Originally compiled by William Henry (whenry at redhat dot com)
based on docker.io source material and internal work. based on docker.io source material and internal work.
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>

39
docs/man/docker-images.1.md
View file

@ -1,17 +1,16 @@
% DOCKER(1) Docker User Manuals % DOCKER(1) Docker User Manuals
% William Henry % Docker Community
% APRIL 2014 % JUNE 2014
# NAME # NAME
docker-images - List the images in the local repository docker-images - List images
# SYNOPSIS # SYNOPSIS
**docker images** **docker images**
[**-a**|**--all**=*false*] [**-a**|**--all**[=*false*]]
[**--no-trunc**[=*false*] [**-f**|**--filter**[=*[]*]]
[**-q**|**--quiet**[=*false*] [**--no-trunc**[=*false*]]
[**-t**|**--tree**=*false*] [**-q**|**--quiet**[=*false*]]
[**-v**|**--viz**=*false*] [NAME]
[NAME]
# DESCRIPTION # DESCRIPTION
This command lists the images stored in the local Docker repository. This command lists the images stored in the local Docker repository.
@ -30,26 +29,17 @@ called fedora. It may be tagged with 18, 19, or 20, etc. to manage different
versions. versions.
# OPTIONS # OPTIONS
**-a**, **--all**=*true*|*false* **-a**, **--all**=*true*|*false*
When set to true, also include all intermediate images in the list. The Show all images (by default filter out the intermediate image layers). The default is *false*.
default is false.
**-f**, **--filter**=[]
Provide filter values (i.e. 'dangling=true')
**--no-trunc**=*true*|*false* **--no-trunc**=*true*|*false*
When set to true, list the full image ID and not the truncated ID. The Don't truncate output. The default is *false*.
default is false.
**-q**, **--quiet**=*true*|*false* **-q**, **--quiet**=*true*|*false*
When set to true, list the complete image ID as part of the output. The Only show numeric IDs. The default is *false*.
default is false.
**-t**, **--tree**=*true*|*false*
When set to true, list the images in a tree dependency tree (hierarchy)
format. The default is false.
**-v**, **--viz**=*true*|*false*
When set to true, list the graph in graphviz format. The default is
*false*.
# EXAMPLES # EXAMPLES
@ -97,3 +87,4 @@ tools.
# HISTORY # HISTORY
April 2014, Originally compiled by William Henry (whenry at redhat dot com) April 2014, Originally compiled by William Henry (whenry at redhat dot com)
based on docker.io source material and internal work. based on docker.io source material and internal work.
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>

14
docs/man/docker-import.1.md
View file

@ -1,17 +1,20 @@
% DOCKER(1) Docker User Manuals % DOCKER(1) Docker User Manuals
% William Henry % Docker Community
% APRIL 2014 % JUNE 2014
# NAME # NAME
docker-import - Create an empty filesystem image and import the contents docker-import - Create an empty filesystem image and import the contents of the tarball (.tar, .tar.gz, .tgz, .bzip, .tar.xz, .txz) into it, then optionally tag it.
of the tarball into it.
# SYNOPSIS # SYNOPSIS
**docker import** URL|- [REPOSITORY[:TAG]] **docker import**
URL|- [REPOSITORY[:TAG]]
# DESCRIPTION # DESCRIPTION
Create a new filesystem image from the contents of a tarball (`.tar`, Create a new filesystem image from the contents of a tarball (`.tar`,
`.tar.gz`, `.tgz`, `.bzip`, `.tar.xz`, `.txz`) into it, then optionally tag it. `.tar.gz`, `.tgz`, `.bzip`, `.tar.xz`, `.txz`) into it, then optionally tag it.
# OPTIONS
There are no available options.
# EXAMPLES # EXAMPLES
## Import from a remote location ## Import from a remote location
@ -37,3 +40,4 @@ Import to docker via pipe and stdin:
# HISTORY # HISTORY
April 2014, Originally compiled by William Henry (whenry at redhat dot com) April 2014, Originally compiled by William Henry (whenry at redhat dot com)
based on docker.io source material and internal work. based on docker.io source material and internal work.
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>

8
docs/man/docker-info.1.md
View file

@ -1,12 +1,13 @@
% DOCKER(1) Docker User Manuals % DOCKER(1) Docker User Manuals
% William Henry % Docker Community
% APRIL 2014 % JUNE 2014
# NAME # NAME
docker-info - Display system wide information docker-info - Display system-wide information
# SYNOPSIS # SYNOPSIS
**docker info** **docker info**
# DESCRIPTION # DESCRIPTION
This command displays system wide information regarding the Docker installation. This command displays system wide information regarding the Docker installation.
Information displayed includes the number of containers and images, pool name, Information displayed includes the number of containers and images, pool name,
@ -44,3 +45,4 @@ Here is a sample output:
# HISTORY # HISTORY
April 2014, Originally compiled by William Henry (whenry at redhat dot com) April 2014, Originally compiled by William Henry (whenry at redhat dot com)
based on docker.io source material and internal work. based on docker.io source material and internal work.
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>

16
docs/man/docker-inspect.1.md
View file

@ -1,12 +1,13 @@
% DOCKER(1) Docker User Manuals % DOCKER(1) Docker User Manuals
% William Henry % Docker Community
% APRIL 2014 % JUNE 2014
# NAME # NAME
docker-inspect - Return low-level information on a container/image docker-inspect - Return low-level information on a container or image
# SYNOPSIS # SYNOPSIS
**docker inspect** [**-f**|**--format**="" CONTAINER|IMAGE **docker inspect**
[CONTAINER|IMAGE...] [**-f**|**--format**[=*FORMAT*]]
CONTAINER|IMAGE [CONTAINER|IMAGE...]
# DESCRIPTION # DESCRIPTION
@ -17,8 +18,7 @@ each result.
# OPTIONS # OPTIONS
**-f**, **--format**="" **-f**, **--format**=""
The text/template package of Go describes all the details of the Format the output using the given go template.
format. See examples section
# EXAMPLES # EXAMPLES
@ -224,6 +224,6 @@ Use an image's ID or name (e.g., repository/name[:tag]) to get information
}] }]
# HISTORY # HISTORY
April 2014, Originally compiled by William Henry (whenry at redhat dot com) April 2014, Originally compiled by William Henry (whenry at redhat dot com)
based on docker.io source material and internal work. based on docker.io source material and internal work.
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>

13
docs/man/docker-kill.1.md
View file

@ -1,11 +1,13 @@
% DOCKER(1) Docker User Manuals % DOCKER(1) Docker User Manuals
% William Henry % Docker Community
% APRIL 2014 % JUNE 2014
# NAME # NAME
docker-kill - Kill a running container (send SIGKILL, or specified signal) docker-kill - Kill a running container using SIGKILL or a specified signal
# SYNOPSIS # SYNOPSIS
**docker kill** **--signal**[=*"KILL"*] CONTAINER [CONTAINER...] **docker kill**
[**-s**|**--signal**[=*"KILL"*]]
CONTAINER [CONTAINER...]
# DESCRIPTION # DESCRIPTION
@ -13,9 +15,10 @@ The main process inside each container specified will be sent SIGKILL,
or any signal specified with option --signal. or any signal specified with option --signal.
# OPTIONS # OPTIONS
**-s**, **--signal**=*"KILL"* **-s**, **--signal**="KILL"
Signal to send to the container Signal to send to the container
# HISTORY # HISTORY
April 2014, Originally compiled by William Henry (whenry at redhat dot com) April 2014, Originally compiled by William Henry (whenry at redhat dot com)
based on docker.io source material and internal work. based on docker.io source material and internal work.
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>

12
docs/man/docker-load.1.md
View file

@ -1,11 +1,13 @@
% DOCKER(1) Docker User Manuals % DOCKER(1) Docker User Manuals
% William Henry % Docker Community
% APRIL 2014 % JUNE 2014
# NAME # NAME
docker-load - Load an image from a tar archive on STDIN docker-load - Load an image from a tar archive on STDIN
# SYNOPSIS # SYNOPSIS
**docker load** **--input**="" **docker load**
[**-i**|**--input**[=*INPUT*]]
# DESCRIPTION # DESCRIPTION
@ -13,11 +15,10 @@ Loads a tarred repository from a file or the standard input stream.
Restores both images and tags. Restores both images and tags.
# OPTIONS # OPTIONS
**-i**, **--input**="" **-i**, **--input**=""
Read from a tar archive file, instead of STDIN Read from a tar archive file, instead of STDIN
# EXAMPLE # EXAMPLES
$ sudo docker images $ sudo docker images
REPOSITORY TAG IMAGE ID CREATED VIRTUAL SIZE REPOSITORY TAG IMAGE ID CREATED VIRTUAL SIZE
@ -34,3 +35,4 @@ Restores both images and tags.
# HISTORY # HISTORY
April 2014, Originally compiled by William Henry (whenry at redhat dot com) April 2014, Originally compiled by William Henry (whenry at redhat dot com)
based on docker.io source material and internal work. based on docker.io source material and internal work.
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>

19
docs/man/docker-login.1.md
View file

@ -1,12 +1,15 @@
% DOCKER(1) Docker User Manuals % DOCKER(1) Docker User Manuals
% William Henry % Docker Community
% APRIL 2014 % JUNE 2014
# NAME # NAME
docker-login - Register or Login to a docker registry server. docker-login - Register or log in to a Docker registry server, if no server is specified "https://index.docker.io/v1/" is the default.
# SYNOPSIS # SYNOPSIS
**docker login** [**-e**|**-email**=""] [**-p**|**--password**=""] **docker login**
[**-u**|**--username**=""] [SERVER] [**-e**|**--email**[=*EMAIL*]]
[**-p**|**--password**[=*PASSWORD*]]
[**-u**|**--username**[=*USERNAME*]]
[SERVER]
# DESCRIPTION # DESCRIPTION
Register or Login to a docker registry server, if no server is Register or Login to a docker registry server, if no server is
@ -15,7 +18,7 @@ login to a private registry you can specify this by adding the server name.
# OPTIONS # OPTIONS
**-e**, **--email**="" **-e**, **--email**=""
Email address Email
**-p**, **--password**="" **-p**, **--password**=""
Password Password
@ -23,7 +26,7 @@ login to a private registry you can specify this by adding the server name.
**-u**, **--username**="" **-u**, **--username**=""
Username Username
# EXAMPLE # EXAMPLES
## Login to a local registry ## Login to a local registry
@ -32,4 +35,4 @@ login to a private registry you can specify this by adding the server name.
# HISTORY # HISTORY
April 2014, Originally compiled by William Henry (whenry at redhat dot com) April 2014, Originally compiled by William Henry (whenry at redhat dot com)
based on docker.io source material and internal work. based on docker.io source material and internal work.
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>

17
docs/man/docker-logs.1.md
View file

@ -1,11 +1,14 @@
% DOCKER(1) Docker User Manuals % DOCKER(1) Docker User Manuals
% William Henry % Docker Community
% APRIL 2014 % JUNE 2014
# NAME # NAME
docker-logs - Fetch the logs of a container docker-logs - Fetch the logs of a container
# SYNOPSIS # SYNOPSIS
**docker logs** **--follow**[=*false*] CONTAINER **docker logs**
[**-f**|**--follow**[=*false*]]
[**-t**|**--timestamps**[=*false*]]
CONTAINER
# DESCRIPTION # DESCRIPTION
The **docker logs** command batch-retrieves whatever logs are present for The **docker logs** command batch-retrieves whatever logs are present for
@ -18,9 +21,13 @@ The **docker logs --follow** command combines commands **docker logs** and
then continue streaming new output from the container’s stdout and stderr. then continue streaming new output from the container’s stdout and stderr.
# OPTIONS # OPTIONS
**-f, --follow**=*true*|*false* **-f**, **--follow**=*true*|*false*
When *true*, follow log output. The default is false. Follow log output. The default is *false*.
**-t**, **--timestamps**=*true*|*false*
Show timestamps. The default is *false*.
# HISTORY # HISTORY
April 2014, Originally compiled by William Henry (whenry at redhat dot com) April 2014, Originally compiled by William Henry (whenry at redhat dot com)
based on docker.io source material and internal work. based on docker.io source material and internal work.
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>

15
docs/man/docker-pause.1.md Normal file
View file

@ -0,0 +1,15 @@
% DOCKER(1) Docker User Manuals
% Docker Community
% JUNE 2014
# NAME
docker-pause - Pause all processes within a container
# SYNOPSIS
**docker pause**
CONTAINER
# OPTIONS
There are no available options.
# HISTORY
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>

14
docs/man/docker-port.1.md
View file

@ -1,15 +1,17 @@
% DOCKER(1) Docker User Manuals % DOCKER(1) Docker User Manuals
% William Henry % Docker Community
% APRIL 2014 % JUNE 2014
# NAME # NAME
docker-port - Lookup the public-facing port which is NAT-ed to PRIVATE_PORT docker-port - Lookup the public-facing port that is NAT-ed to PRIVATE_PORT
# SYNOPSIS # SYNOPSIS
**docker port** CONTAINER PRIVATE_PORT **docker port**
CONTAINER PRIVATE_PORT
# DESCRIPTION # OPTIONS
Lookup the public-facing port which is NAT-ed to PRIVATE_PORT There are no available options.
# HISTORY # HISTORY
April 2014, Originally compiled by William Henry (whenry at redhat dot com) April 2014, Originally compiled by William Henry (whenry at redhat dot com)
based on docker.io source material and internal work. based on docker.io source material and internal work.
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>

42
docs/man/docker-ps.1.md
View file

@ -1,14 +1,20 @@
% DOCKER(1) Docker User Manuals % DOCKER(1) Docker User Manuals
% William Henry % Docker Community
% APRIL 2014 % JUNE 2014
# NAME # NAME
docker-ps - List containers docker-ps - List containers
# SYNOPSIS # SYNOPSIS
**docker ps** [**-a**|**--all**=*false*] [**--before**=""] **docker ps**
[**-l**|**--latest**=*false*] [**-n**=*-1*] [**--no-trunc**=*false*] [**-a**|**--all**[=*false*]]
[**-q**|**--quiet**=*false*] [**-s**|**--size**=*false*] [**--before**[=*BEFORE*]]
[**--since**=""] [**-l**|**--latest**[=*false*]]
[**-n**[=*-1*]]
[**--no-trunc**[=*false*]]
[**-q**|**--quiet**[=*false*]]
[**-s**|**--size**[=*false*]]
[**--since**[=*SINCE*]]
# DESCRIPTION # DESCRIPTION
@ -16,36 +22,31 @@ List the containers in the local repository. By default this show only
the running containers. the running containers.
# OPTIONS # OPTIONS
**-a**, **--all**=*true*|*false* **-a**, **--all**=*true*|*false*
When true show all containers. Only running containers are shown by Show all containers. Only running containers are shown by default. The default is *false*.
default. Default is false.
**--before**="" **--before**=""
Show only container created before Id or Name, include non-running Show only container created before Id or Name, include non-running ones.
ones.
**-l**, **--latest**=*true*|*false* **-l**, **--latest**=*true*|*false*
When true show only the latest created container, include non-running Show only the latest created container, include non-running ones. The default is *false*.
ones. The default is false.
**-n**=NUM **-n**=-1
Show NUM (integer) last created containers, include non-running ones. Show n last created containers, include non-running ones.
The default is -1 (none)
**--no-trunc**=*true*|*false* **--no-trunc**=*true*|*false*
When true truncate output. Default is false. Don't truncate output. The default is *false*.
**-q**, **--quiet**=*true*|*false* **-q**, **--quiet**=*true*|*false*
When false only display numeric IDs. Default is false. Only display numeric IDs. The default is *false*.
**-s**, **--size**=*true*|*false* **-s**, **--size**=*true*|*false*
When true display container sizes. Default is false. Display sizes. The default is *false*.
**--since**="" **--since**=""
Show only containers created since Id or Name, include non-running ones. Show only containers created since Id or Name, include non-running ones.
# EXAMPLE # EXAMPLES
# Display all containers, including non-running # Display all containers, including non-running
# docker ps -a # docker ps -a
@ -66,3 +67,4 @@ The default is -1 (none)
# HISTORY # HISTORY
April 2014, Originally compiled by William Henry (whenry at redhat dot com) April 2014, Originally compiled by William Henry (whenry at redhat dot com)
based on docker.io source material and internal work. based on docker.io source material and internal work.
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>

12
docs/man/docker-pull.1.md
View file

@ -1,11 +1,12 @@
% DOCKER(1) Docker User Manuals % DOCKER(1) Docker User Manuals
% William Henry % Docker Community
% APRIL 2014 % JUNE 2014
# NAME # NAME
docker-pull - Pull an image or a repository from the registry docker-pull - Pull an image or a repository from the registry
# SYNOPSIS # SYNOPSIS
**docker pull** [REGISTRY_PATH/]NAME[:TAG] **docker pull**
NAME[:TAG]
# DESCRIPTION # DESCRIPTION
@ -14,6 +15,9 @@ there is more than one image for a repository (e.g., fedora) then all
images for that repository name are pulled down including any tags. images for that repository name are pulled down including any tags.
It is also possible to specify a non-default registry to pull from. It is also possible to specify a non-default registry to pull from.
# OPTIONS
There are no available options.
# EXAMPLES # EXAMPLES
# Pull a repository with multiple images # Pull a repository with multiple images
@ -48,4 +52,4 @@ It is also possible to specify a non-default registry to pull from.
# HISTORY # HISTORY
April 2014, Originally compiled by William Henry (whenry at redhat dot com) April 2014, Originally compiled by William Henry (whenry at redhat dot com)
based on docker.io source material and internal work. based on docker.io source material and internal work.
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>

13
docs/man/docker-push.1.md
View file

@ -1,11 +1,12 @@
% DOCKER(1) Docker User Manuals % DOCKER(1) Docker User Manuals
% William Henry % Docker Community
% APRIL 2014 % JUNE 2014
# NAME # NAME
docker-push - Push an image or a repository to the registry docker-push - Push an image or a repository to the registry
# SYNOPSIS # SYNOPSIS
**docker push** NAME[:TAG] **docker push**
NAME[:TAG]
# DESCRIPTION # DESCRIPTION
Push an image or a repository to a registry. The default registry is the Docker Push an image or a repository to a registry. The default registry is the Docker
@ -13,7 +14,10 @@ Index located at [index.docker.io](https://index.docker.io/v1/). However the
image can be pushed to another, perhaps private, registry as demonstrated in image can be pushed to another, perhaps private, registry as demonstrated in
the example below. the example below.
# EXAMPLE # OPTIONS
There are no available options.
# EXAMPLES
# Pushing a new image to a registry # Pushing a new image to a registry
@ -42,3 +46,4 @@ listed.
# HISTORY # HISTORY
April 2014, Originally compiled by William Henry (whenry at redhat dot com) April 2014, Originally compiled by William Henry (whenry at redhat dot com)
based on docker.io source material and internal work. based on docker.io source material and internal work.
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>

15
docs/man/docker-restart.1.md
View file

@ -1,21 +1,22 @@
% DOCKER(1) Docker User Manuals % DOCKER(1) Docker User Manuals
% William Henry % Docker Community
% APRIL 2014 % JUNE 2014
# NAME # NAME
docker-restart - Restart a running container docker-restart - Restart a running container
# SYNOPSIS # SYNOPSIS
**docker restart** [**-t**|**--time**[=*10*]] CONTAINER [CONTAINER...] **docker restart**
[**-t**|**--time**[=*10*]]
CONTAINER [CONTAINER...]
# DESCRIPTION # DESCRIPTION
Restart each container listed. Restart each container listed.
# OPTIONS # OPTIONS
**-t**, **--time**=NUM **-t**, **--time**=10
Number of seconds to try to stop for before killing the container. Once Number of seconds to try to stop for before killing the container. Once killed it will then be restarted. Default is 10 seconds.
killed it will then be restarted. Default=10
# HISTORY # HISTORY
April 2014, Originally compiled by William Henry (whenry at redhat dot com) April 2014, Originally compiled by William Henry (whenry at redhat dot com)
based on docker.io source material and internal work. based on docker.io source material and internal work.
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>

29
docs/man/docker-rm.1.md
View file

@ -1,16 +1,15 @@
% DOCKER(1) Docker User Manuals % DOCKER(1) Docker User Manuals
% William Henry % Docker Community
% APRIL 2014 % JUNE 2014
# NAME # NAME
docker-rm - Remove one or more containers
docker-rm - Remove one or more containers.
# SYNOPSIS # SYNOPSIS
**docker rm**
**docker rm** [**-f**|**--force**[=*false*] [**-l**|**--link**[=*false*] [**-v**| [**-f**|**--force**[=*false*]]
**--volumes**[=*false*] [**-l**|**--link**[=*false*]]
CONTAINER [CONTAINER...] [**-v**|**--volumes**[=*false*]]
CONTAINER [CONTAINER...]
# DESCRIPTION # DESCRIPTION
@ -20,18 +19,14 @@ remove a running container unless you use the \fB-f\fR option. To see all
containers on a host use the **docker ps -a** command. containers on a host use the **docker ps -a** command.
# OPTIONS # OPTIONS
**-f**, **--force**=*true*|*false* **-f**, **--force**=*true*|*false*
When set to true, force the removal of the container. The default is Force removal of running container. The default is *false*.
*false*.
**-l**, **--link**=*true*|*false* **-l**, **--link**=*true*|*false*
When set to true, remove the specified link and not the underlying Remove the specified link and not the underlying container. The default is *false*.
container. The default is *false*.
**-v**, **--volumes**=*true*|*false* **-v**, **--volumes**=*true*|*false*
When set to true, remove the volumes associated to the container. The Remove the volumes associated with the container. The default is *false*.
default is *false*.
# EXAMPLES # EXAMPLES
@ -51,6 +46,6 @@ command. The use that name as follows:
docker rm hopeful_morse docker rm hopeful_morse
# HISTORY # HISTORY
April 2014, Originally compiled by William Henry (whenry at redhat dot com) April 2014, Originally compiled by William Henry (whenry at redhat dot com)
based on docker.io source material and internal work. based on docker.io source material and internal work.
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>

21
docs/man/docker-rmi.1.md
View file

@ -1,12 +1,14 @@
% DOCKER(1) Docker User Manuals % DOCKER(1) Docker User Manuals
% William Henry % Docker Community
% APRIL 2014 % JUNE 2014
# NAME # NAME
docker-rmi \- Remove one or more images. docker-rmi - Remove one or more images
# SYNOPSIS # SYNOPSIS
**docker rmi**
**docker rmi** [**-f**|**--force**[=*false*] IMAGE [IMAGE...] [**-f**|**--force**[=*false*]]
[**--no-prune**[=*false*]]
IMAGE [IMAGE...]
# DESCRIPTION # DESCRIPTION
@ -16,10 +18,11 @@ container unless you use the **-f** option. To see all images on a host
use the **docker images** command. use the **docker images** command.
# OPTIONS # OPTIONS
**-f**, **--force**=*true*|*false* **-f**, **--force**=*true*|*false*
When set to true, force the removal of the image. The default is Force removal of the image. The default is *false*.
*false*.
**--no-prune**=*true*|*false*
Do not delete untagged parents. The default is *false*.
# EXAMPLES # EXAMPLES
@ -30,6 +33,6 @@ Here is an example of removing and image:
docker rmi fedora/httpd docker rmi fedora/httpd
# HISTORY # HISTORY
April 2014, Originally compiled by William Henry (whenry at redhat dot com) April 2014, Originally compiled by William Henry (whenry at redhat dot com)
based on docker.io source material and internal work. based on docker.io source material and internal work.
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>

115
docs/man/docker-run.1.md
View file

@ -1,26 +1,40 @@
% DOCKER(1) Docker User Manuals % DOCKER(1) Docker User Manuals
% William Henry % Docker Community
% APRIL 2014 % JUNE 2014
# NAME # NAME
docker-run - Run a process in an isolated container docker-run - Run a command in a new container
# SYNOPSIS # SYNOPSIS
**docker run** **docker run**
[**-a**|**--attach**[=]] [**-c**|**--cpu-shares**[=0] [**-a**|**--attach**[=*[]*]]
[**-m**|**--memory**=*memory-limit*] [**-c**|**--cpu-shares**[=*0*]]
[**--cidfile**=*file*] [**-d**|**--detach**[=*false*]] [**--dns**=*IP-address*] [**--cidfile**[=*CIDFILE*]]
[**--name**=*name*] [**-u**|**--user**=*username*|*uid*] [**--cpuset**[=*CPUSET*]]
[**--link**=*name*:*alias*] [**-d**|**--detach**[=*false*]]
[**-e**|**--env**=*environment*] [**--entrypoint**=*command*] [**--dns-search**[=*[]*]]
[**--expose**=*port*] [**-P**|**--publish-all**[=*false*]] [**--dns**[=*[]*]]
[**-p**|**--publish**=*port-mapping*] [**-h**|**--hostname**=*hostname*] [**-e**|**--env**[=*[]*]]
[**--rm**[=*false*]] [**--privileged**[=*false*]] [**--entrypoint**[=*ENTRYPOINT*]]
[**--env-file**[=*[]*]]
[**--expose**[=*[]*]]
[**-h**|**--hostname**[=*HOSTNAME*]]
[**-i**|**--interactive**[=*false*]] [**-i**|**--interactive**[=*false*]]
[**-t**|**--tty**[=*false*]] [**--lxc-conf**=*options*] [**--link**[=*[]*]]
[**-n**|**--networking**[=*true*]] [**--lxc-conf**[=*[]*]]
[**-v**|**--volume**=*volume*] [**--volumes-from**=*container-id*] [**-m**|**--memory**[=*MEMORY*]]
[**-w**|**--workdir**=*directory*] [**--sig-proxy**[=*true*]] [**--name**[=*NAME*]]
IMAGE [COMMAND] [ARG...] [**--net**[=*"bridge"*]]
[**-P**|**--publish-all**[=*false*]]
[**-p**|**--publish**[=*[]*]]
[**--privileged**[=*false*]]
[**--rm**[=*false*]]
[**--sig-proxy**[=*true*]]
[**-t**|**--tty**[=*false*]]
[**-u**|**--user**[=*USER*]]
[**-v**|**--volume**[=*[]*]]
[**--volumes-from**[=*[]*]]
[**-w**|**--workdir**[=*WORKDIR*]]
IMAGE [COMMAND] [ARG...]
# DESCRIPTION # DESCRIPTION
@ -56,6 +70,8 @@ run**.
**--cidfile**=*file* **--cidfile**=*file*
Write the container ID to the file specified. Write the container ID to the file specified.
**--cpuset**=""
CPUs in which to allow execution (0-3, 0,1)
**-d**, **-detach**=*true*|*false* **-d**, **-detach**=*true*|*false*
Detached mode. This runs the container in the background. It outputs the new Detached mode. This runs the container in the background. It outputs the new
@ -67,6 +83,8 @@ the detached mode, then you cannot use the **-rm** option.
When attached in the tty mode, you can detach from a running container without When attached in the tty mode, you can detach from a running container without
stopping the process by pressing the keys CTRL-P CTRL-Q. stopping the process by pressing the keys CTRL-P CTRL-Q.
**--dns-search**=[]
Set custom dns search domains
**--dns**=*IP-address* **--dns**=*IP-address*
Set custom DNS servers. This option can be used to override the DNS Set custom DNS servers. This option can be used to override the DNS
@ -92,6 +110,8 @@ pass in more options via the COMMAND. But, sometimes an operator may want to run
something else inside the container, so you can override the default ENTRYPOINT something else inside the container, so you can override the default ENTRYPOINT
at runtime by using a **--entrypoint** and a string to specify the new at runtime by using a **--entrypoint** and a string to specify the new
ENTRYPOINT. ENTRYPOINT.
**--env-file**=[]
Read in a line delimited file of ENV variables
**--expose**=*port* **--expose**=*port*
Expose a port from the container without publishing it to your host. A Expose a port from the container without publishing it to your host. A
@ -100,36 +120,12 @@ developer can expose the port using the EXPOSE parameter of the Dockerfile, 2)
the operator can use the **--expose** option with **docker run**, or 3) the the operator can use the **--expose** option with **docker run**, or 3) the
container can be started with the **--link**. container can be started with the **--link**.
**-m**, **-memory**=*memory-limit*
Allows you to constrain the memory available to a container. If the host
supports swap memory, then the -m memory setting can be larger than physical
RAM. If a limit of 0 is specified, the container's memory is not limited. The
actual limit may be rounded up to a multiple of the operating system's page
size, if it is not already. The memory limit should be formatted as follows:
`<number><optional unit>`, where unit = b, k, m or g.
**-P**, **-publish-all**=*true*|*false*
When set to true publish all exposed ports to the host interfaces. The
default is false. If the operator uses -P (or -p) then Docker will make the
exposed port accessible on the host and the ports will be available to any
client that can reach the host. To find the map between the host ports and the
exposed ports, use **docker port**.
**-p**, **-publish**=[]
Publish a container's port to the host (format: ip:hostPort:containerPort |
ip::containerPort | hostPort:containerPort) (use **docker port** to see the
actual mapping)
**-h**, **-hostname**=*hostname* **-h**, **-hostname**=*hostname*
Sets the container host name that is available inside the container. Sets the container host name that is available inside the container.
**-i**, **-interactive**=*true*|*false* **-i**, **-interactive**=*true*|*false*
When set to true, keep stdin open even if not attached. The default is false. When set to true, keep stdin open even if not attached. The default is false.
**--link**=*name*:*alias* **--link**=*name*:*alias*
Add link to another container. The format is name:alias. If the operator Add link to another container. The format is name:alias. If the operator
uses **--link** when starting the new client container, then the client uses **--link** when starting the new client container, then the client
@ -137,16 +133,16 @@ container can access the exposed port via a private networking interface. Docker
will set some environment variables in the client container to help indicate will set some environment variables in the client container to help indicate
which interface and port to use. which interface and port to use.
**--lxc-conf**=[]
(lxc exec-driver only) Add custom lxc options --lxc-conf="lxc.cgroup.cpuset.cpus = 0,1"
**-n**, **-networking**=*true*|*false* **-m**, **-memory**=*memory-limit*
By default, all containers have networking enabled (true) and can make Allows you to constrain the memory available to a container. If the host
outgoing connections. The operator can disable networking with **--networking** supports swap memory, then the -m memory setting can be larger than physical
to false. This disables all incoming and outgoing networking. In cases like this RAM. If a limit of 0 is specified, the container's memory is not limited. The
, I/O can only be performed through files or by using STDIN/STDOUT. actual limit may be rounded up to a multiple of the operating system's page
size, if it is not already. The memory limit should be formatted as follows:
Also by default, the container will use the same DNS servers as the host. The `<number><optional unit>`, where unit = b, k, m or g.
operator may override this with **-dns**.
**--name**=*name* **--name**=*name*
Assign a name to the container. The operator can identify a container in Assign a name to the container. The operator can identify a container in
@ -162,6 +158,24 @@ string name. The name is useful when defining links (see **--link**) (or any
other place you need to identify a container). This works for both background other place you need to identify a container). This works for both background
and foreground Docker containers. and foreground Docker containers.
**--net**="bridge"
Set the Network mode for the container
'bridge': creates a new network stack for the container on the docker bridge
'none': no networking for this container
'container:<name|id>': reuses another container network stack
'host': use the host network stack inside the container. Note: the host mode gives the container full access to local system services such as D-bus and is therefore considered insecure.
**-P**, **-publish-all**=*true*|*false*
When set to true publish all exposed ports to the host interfaces. The
default is false. If the operator uses -P (or -p) then Docker will make the
exposed port accessible on the host and the ports will be available to any
client that can reach the host. To find the map between the host ports and the
exposed ports, use **docker port**.
**-p**, **-publish**=[]
Publish a container's port to the host (format: ip:hostPort:containerPort |
ip::containerPort | hostPort:containerPort) (use **docker port** to see the
actual mapping)
**--privileged**=*true*|*false* **--privileged**=*true*|*false*
Give extended privileges to this container. By default, Docker containers are Give extended privileges to this container. By default, Docker containers are
@ -356,3 +370,4 @@ changes will also be reflected on the host in /var/db.
# HISTORY # HISTORY
April 2014, Originally compiled by William Henry (whenry at redhat dot com) April 2014, Originally compiled by William Henry (whenry at redhat dot com)
based on docker.io source material and internal work. based on docker.io source material and internal work.
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>

12
docs/man/docker-save.1.md
View file

@ -1,11 +1,13 @@
% DOCKER(1) Docker User Manuals % DOCKER(1) Docker User Manuals
% William Henry % Docker Community
% APRIL 2014 % JUNE 2014
# NAME # NAME
docker-save - Save an image to a tar archive (streamed to STDOUT by default) docker-save - Save an image to a tar archive (streamed to STDOUT by default)
# SYNOPSIS # SYNOPSIS
**docker save** [**-o**|**--output**=""] IMAGE **docker save**
[**-o**|**--output**[=*OUTPUT*]]
IMAGE
# DESCRIPTION # DESCRIPTION
Produces a tarred repository to the standard output stream. Contains all Produces a tarred repository to the standard output stream. Contains all
@ -17,7 +19,7 @@ Stream to a file instead of STDOUT by using **-o**.
**-o**, **--output**="" **-o**, **--output**=""
Write to an file, instead of STDOUT Write to an file, instead of STDOUT
# EXAMPLE # EXAMPLES
Save all fedora repository images to a fedora-all.tar and save the latest Save all fedora repository images to a fedora-all.tar and save the latest
fedora image to a fedora-latest.tar: fedora image to a fedora-latest.tar:
@ -32,4 +34,4 @@ fedora image to a fedora-latest.tar:
# HISTORY # HISTORY
April 2014, Originally compiled by William Henry (whenry at redhat dot com) April 2014, Originally compiled by William Henry (whenry at redhat dot com)
based on docker.io source material and internal work. based on docker.io source material and internal work.
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>

31
docs/man/docker-search.1.md
View file

@ -1,12 +1,15 @@
% DOCKER(1) Docker User Manuals % DOCKER(1) Docker User Manuals
% William Henry % Docker Community
% APRIL 2014 % JUNE 2014
# NAME # NAME
docker-search - Search the docker index for images docker-search - Search the Docker Hub for images
# SYNOPSIS # SYNOPSIS
**docker search** **--no-trunc**[=*false*] **--automated**[=*false*] **docker search**
**-s**|**--stars**[=*0*] TERM [**--automated**[=*false*]]
[**--no-trunc**[=*false*]]
[**-s**|**--stars**[=*0*]]
TERM
# DESCRIPTION # DESCRIPTION
@ -16,17 +19,16 @@ number of stars awarded, whether the image is official, and whether it
is automated. is automated.
# OPTIONS # OPTIONS
**--no-trunc**=*true*|*false*
When true display the complete description. The default is false.
**-s**, **--stars**=NUM
Only displays with at least NUM (integer) stars. I.e. only those images
ranked >=NUM.
**--automated**=*true*|*false* **--automated**=*true*|*false*
When true only show automated builds. The default is false. Only show automated builds. The default is *false*.
# EXAMPLE **--no-trunc**=*true*|*false*
Don't truncate output. The default is *false*.
**-s**, **--stars**=0
Only displays with at least x stars
# EXAMPLES
## Search the registry for ranked images ## Search the registry for ranked images
@ -53,3 +55,4 @@ ranked 1 or higher:
# HISTORY # HISTORY
April 2014, Originally compiled by William Henry (whenry at redhat dot com) April 2014, Originally compiled by William Henry (whenry at redhat dot com)
based on docker.io source material and internal work. based on docker.io source material and internal work.
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>

22
docs/man/docker-start.1.md
View file

@ -1,29 +1,27 @@
% DOCKER(1) Docker User Manuals % DOCKER(1) Docker User Manuals
% William Henry % Docker Community
% APRIL 2014 % JUNE 2014
# NAME # NAME
docker-start - Restart a stopped container docker-start - Restart a stopped container
# SYNOPSIS # SYNOPSIS
**docker start** [**a**|**--attach**[=*false*]] [**-i**|**--interactive** **docker start**
[=*true*] CONTAINER [CONTAINER...] [**-a**|**--attach**[=*false*]]
[**-i**|**--interactive**[=*false*]]
CONTAINER [CONTAINER...]
# DESCRIPTION # DESCRIPTION
Start a stopped container. Start a stopped container.
# OPTION # OPTIONS
**-a**, **--attach**=*true*|*false* **-a**, **--attach**=*true*|*false*
When true attach to container's stdout/stderr and forward all signals to Attach container's STDOUT and STDERR and forward all signals to the process. The default is *false*.
the process
**-i**, **--interactive**=*true*|*false* **-i**, **--interactive**=*true*|*false*
When true attach to container's stdin Attach container's STDIN. The default is *false*.
# NOTES
If run on a started container, start takes no action and succeeds
unconditionally.
# HISTORY # HISTORY
April 2014, Originally compiled by William Henry (whenry at redhat dot com) April 2014, Originally compiled by William Henry (whenry at redhat dot com)
based on docker.io source material and internal work. based on docker.io source material and internal work.
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>

17
docs/man/docker-stop.1.md
View file

@ -1,22 +1,23 @@
% DOCKER(1) Docker User Manuals % DOCKER(1) Docker User Manuals
% William Henry % Docker Community
% APRIL 2014 % JUNE 2014
# NAME # NAME
docker-stop - Stop a running container docker-stop - Stop a running container by sending SIGTERM and then SIGKILL after a grace period
grace period)
# SYNOPSIS # SYNOPSIS
**docker stop** [**-t**|**--time**[=*10*]] CONTAINER [CONTAINER...] **docker stop**
[**-t**|**--time**[=*10*]]
CONTAINER [CONTAINER...]
# DESCRIPTION # DESCRIPTION
Stop a running container (Send SIGTERM, and then SIGKILL after Stop a running container (Send SIGTERM, and then SIGKILL after
grace period) grace period)
# OPTIONS # OPTIONS
**-t**, **--time**=NUM **-t**, **--time**=10
Wait NUM number of seconds for the container to stop before killing it. Number of seconds to wait for the container to stop before killing it. Default is 10 seconds.
The default is 10 seconds.
# HISTORY # HISTORY
April 2014, Originally compiled by William Henry (whenry at redhat dot com) April 2014, Originally compiled by William Henry (whenry at redhat dot com)
based on docker.io source material and internal work. based on docker.io source material and internal work.
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>

16
docs/man/docker-tag.1.md
View file

@ -1,12 +1,13 @@
% DOCKER(1) Docker User Manuals % DOCKER(1) Docker User Manuals
% William Henry % Docker Community
% APRIL 2014 % JUNE 2014
# NAME # NAME
docker-tag - Tag an image in the repository docker-tag - Tag an image into a repository
# SYNOPSIS # SYNOPSIS
**docker tag** [**-f**|**--force**[=*false*] **docker tag**
IMAGE [REGISTRYHOST/][USERNAME/]NAME[:TAG] [**-f**|**--force**[=*false*]]
IMAGE [REGISTRYHOST/][USERNAME/]NAME[:TAG]
# DESCRIPTION # DESCRIPTION
This will give a new alias to an image in the repository. This refers to the This will give a new alias to an image in the repository. This refers to the
@ -31,6 +32,10 @@ separated by a ':'
recommended to be used for a version to disinguish images with the same name. recommended to be used for a version to disinguish images with the same name.
Note that here TAG is a part of the overall name or "tag". Note that here TAG is a part of the overall name or "tag".
# OPTIONS
**-f**, **--force**=*true*|*false*
Force. The default is *false*.
# EXAMPLES # EXAMPLES
## Giving an image a new alias ## Giving an image a new alias
@ -50,3 +55,4 @@ registry you must tag it with the registry hostname and port (if needed).
# HISTORY # HISTORY
April 2014, Originally compiled by William Henry (whenry at redhat dot com) April 2014, Originally compiled by William Henry (whenry at redhat dot com)
based on docker.io source material and internal work. based on docker.io source material and internal work.
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>

16
docs/man/docker-top.1.md
View file

@ -1,18 +1,22 @@
% DOCKER(1) Docker User Manuals % DOCKER(1) Docker User Manuals
% William Henry % Docker Community
% APRIL 2014 % JUNE 2014
# NAME # NAME
docker-top - Lookup the running processes of a container docker-top - Display the running processes of a container
# SYNOPSIS # SYNOPSIS
**docker top** CONTAINER [ps-OPTION] **docker top**
CONTAINER [ps OPTIONS]
# DESCRIPTION # DESCRIPTION
Look up the running process of the container. ps-OPTION can be any of the Look up the running process of the container. ps-OPTION can be any of the
options you would pass to a Linux ps command. options you would pass to a Linux ps command.
# EXAMPLE # OPTIONS
There are no available options.
# EXAMPLES
Run **docker top** with the ps option of -x: Run **docker top** with the ps option of -x:
@ -24,4 +28,4 @@ Run **docker top** with the ps option of -x:
# HISTORY # HISTORY
April 2014, Originally compiled by William Henry (whenry at redhat dot com) April 2014, Originally compiled by William Henry (whenry at redhat dot com)
based on docker.io source material and internal work. based on docker.io source material and internal work.
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>

15
docs/man/docker-unpause.1.md Normal file
View file

@ -0,0 +1,15 @@
% DOCKER(1) Docker User Manuals
% Docker Community
% JUNE 2014
# NAME
docker-unpause - Unpause all processes within a container
# SYNOPSIS
**docker unpause**
CONTAINER
# OPTIONS
There are no available options.
# HISTORY
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>

15
docs/man/docker-version.1.md Normal file
View file

@ -0,0 +1,15 @@
% DOCKER(1) Docker User Manuals
% Docker Community
% JUNE 2014
# NAME
docker-version - Show the Docker version information.
# SYNOPSIS
**docker version**
# OPTIONS
There are no available options.
# HISTORY
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>

15
docs/man/docker-wait.1.md
View file

@ -1,16 +1,21 @@
% DOCKER(1) Docker User Manuals % DOCKER(1) Docker User Manuals
% William Henry % Docker Community
% APRIL 2014 % JUNE 2014
# NAME # NAME
docker-wait - Block until a container stops, then print its exit code. docker-wait - Block until a container stops, then print its exit code.
# SYNOPSIS # SYNOPSIS
**docker wait** CONTAINER [CONTAINER...] **docker wait**
CONTAINER [CONTAINER...]
# DESCRIPTION # DESCRIPTION
Block until a container stops, then print its exit code. Block until a container stops, then print its exit code.
#EXAMPLE # OPTIONS
There are no available options.
# EXAMPLES
$ sudo docker run -d fedora sleep 99 $ sudo docker run -d fedora sleep 99
079b83f558a2bc52ecad6b2a5de13622d584e6bb1aea058c11b36511e85e7622 079b83f558a2bc52ecad6b2a5de13622d584e6bb1aea058c11b36511e85e7622
@ -20,4 +25,4 @@ Block until a container stops, then print its exit code.
# HISTORY # HISTORY
April 2014, Originally compiled by William Henry (whenry at redhat dot com) April 2014, Originally compiled by William Henry (whenry at redhat dot com)
based on docker.io source material and internal work. based on docker.io source material and internal work.
June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>

8
docs/man/docker.1.md
View file

@ -127,6 +127,9 @@ inside it)
**docker-logs(1)** **docker-logs(1)**
Fetch the logs of a container Fetch the logs of a container
**docker-pause(1)**
Pause all processes within a container
**docker-port(1)** **docker-port(1)**
Lookup the public-facing port which is NAT-ed to PRIVATE_PORT Lookup the public-facing port which is NAT-ed to PRIVATE_PORT
@ -169,7 +172,10 @@ inside it)
**docker-top(1)** **docker-top(1)**
Lookup the running processes of a container Lookup the running processes of a container
**version** **docker-unpause(1)**
Unpause all processes within a container
**docker-version(1)**
Show the Docker version information Show the Docker version information
**docker-wait(1)** **docker-wait(1)**

56
docs/sources/reference/commandline/cli.md
View file

@ -54,9 +54,9 @@ expect an integer, and they can only be specified once.
-b, --bridge="" Attach containers to a pre-existing network bridge -b, --bridge="" Attach containers to a pre-existing network bridge
use 'none' to disable container networking use 'none' to disable container networking
--bip="" Use this CIDR notation address for the network bridge's IP, not compatible with -b --bip="" Use this CIDR notation address for the network bridge's IP, not compatible with -b
-d, --daemon=false Enable daemon mode
-D, --debug=false Enable debug mode -D, --debug=false Enable debug mode
--dns=[] Force docker to use specific DNS servers -d, --daemon=false Enable daemon mode
--dns=[] Force Docker to use specific DNS servers
--dns-search=[] Force Docker to use specific DNS search domains --dns-search=[] Force Docker to use specific DNS search domains
-e, --exec-driver="native" Force the Docker runtime to use a specific exec driver -e, --exec-driver="native" Force the Docker runtime to use a specific exec driver
-G, --group="docker" Group to assign the unix socket specified by -H when running in daemon mode -G, --group="docker" Group to assign the unix socket specified by -H when running in daemon mode
@ -73,8 +73,8 @@ expect an integer, and they can only be specified once.
-p, --pidfile="/var/run/docker.pid" Path to use for daemon PID file -p, --pidfile="/var/run/docker.pid" Path to use for daemon PID file
-r, --restart=true Restart previously running containers -r, --restart=true Restart previously running containers
-s, --storage-driver="" Force the Docker runtime to use a specific storage driver -s, --storage-driver="" Force the Docker runtime to use a specific storage driver
--storage-opt=[] Set storage driver options
--selinux-enabled=false Enable selinux support --selinux-enabled=false Enable selinux support
--storage-opt=[] Set storage driver options
--tls=false Use TLS; implied by tls-verify flags --tls=false Use TLS; implied by tls-verify flags
--tlscacert="/home/sven/.docker/ca.pem" Trust only remotes providing a certificate signed by the CA given here --tlscacert="/home/sven/.docker/ca.pem" Trust only remotes providing a certificate signed by the CA given here
--tlscert="/home/sven/.docker/cert.pem" Path to TLS certificate file --tlscert="/home/sven/.docker/cert.pem" Path to TLS certificate file
@ -134,8 +134,8 @@ like this:
Attach to a running container Attach to a running container
--no-stdin=false Do not attach stdin --no-stdin=false Do not attach STDIN
--sig-proxy=true Proxify received signals to the process (even in non-tty mode). SIGCHLD is not proxied. --sig-proxy=true Proxify all received signals to the process (even in non-TTY mode). SIGCHLD is not proxied.
The `attach` command will allow you to view or The `attach` command will allow you to view or
interact with any running container, detached (`-d`) interact with any running container, detached (`-d`)
@ -481,7 +481,7 @@ To see how the `docker:latest` image was built:
List images List images
-a, --all=false Show all images (by default filter out the intermediate image layers) -a, --all=false Show all images (by default filter out the intermediate image layers)
-f, --filter=[]: Provide filter values (i.e. 'dangling=true') -f, --filter=[] Provide filter values (i.e. 'dangling=true')
--no-trunc=false Don't truncate output --no-trunc=false Don't truncate output
-q, --quiet=false Only show numeric IDs -q, --quiet=false Only show numeric IDs
@ -600,6 +600,8 @@ tar, then the ownerships might not get preserved.
Usage: docker info Usage: docker info
Display system-wide information
For example: For example:
$ sudo docker -D info $ sudo docker -D info
@ -627,7 +629,7 @@ ensure we know how your setup is configured.
Usage: docker inspect CONTAINER|IMAGE [CONTAINER|IMAGE...] Usage: docker inspect CONTAINER|IMAGE [CONTAINER|IMAGE...]
Return low-level information on a container/image Return low-level information on a container or image
-f, --format="" Format the output using the given go template. -f, --format="" Format the output using the given go template.
@ -681,7 +683,7 @@ contains complex json object, so to grab it as JSON, you use
Usage: docker kill [OPTIONS] CONTAINER [CONTAINER...] Usage: docker kill [OPTIONS] CONTAINER [CONTAINER...]
Kill a running container (send SIGKILL, or specified signal) Kill a running container using SIGKILL or a specified signal
-s, --signal="KILL" Signal to send to the container -s, --signal="KILL" Signal to send to the container
@ -718,7 +720,7 @@ Restores both images and tags.
Usage: docker login [OPTIONS] [SERVER] Usage: docker login [OPTIONS] [SERVER]
Register or Login to a docker registry server, if no server is specified "https://index.docker.io/v1/" is the default. Register or log in to a Docker registry server, if no server is specified "https://index.docker.io/v1/" is the default.
-e, --email="" Email -e, --email="" Email
-p, --password="" Password -p, --password="" Password
@ -752,7 +754,7 @@ value is set to `all` in that case. This behavior may change in the future.
Usage: docker port CONTAINER PRIVATE_PORT Usage: docker port CONTAINER PRIVATE_PORT
Lookup the public-facing port which is NAT-ed to PRIVATE_PORT Lookup the public-facing port that is NAT-ed to PRIVATE_PORT
## ps ## ps
@ -781,7 +783,7 @@ Running `docker ps` showing 2 linked containers.
## pull ## pull
Usage: docker pull [REGISTRY_PATH/]NAME[:TAG] Usage: docker pull NAME[:TAG]
Pull an image or a repository from the registry Pull an image or a repository from the registry
@ -824,7 +826,7 @@ registry or to a self-hosted one.
Restart a running container Restart a running container
-t, --time=10 Number of seconds to try to stop for before killing the container. Once killed it will then be restarted. Default=10 -t, --time=10 Number of seconds to try to stop for before killing the container. Once killed it will then be restarted. Default is 10 seconds.
## rm ## rm
@ -834,7 +836,7 @@ registry or to a self-hosted one.
-f, --force=false Force removal of running container -f, --force=false Force removal of running container
-l, --link=false Remove the specified link and not the underlying container -l, --link=false Remove the specified link and not the underlying container
-v, --volumes=false Remove the volumes associated to the container -v, --volumes=false Remove the volumes associated with the container
### Known Issues (rm) ### Known Issues (rm)
@ -870,7 +872,7 @@ delete them. Any running containers will not be deleted.
Remove one or more images Remove one or more images
-f, --force=false Force -f, --force=false Force removal of the image
--no-prune=false Do not delete untagged parents --no-prune=false Do not delete untagged parents
### Removing tagged images ### Removing tagged images
@ -910,6 +912,7 @@ removed before the image is removed.
-a, --attach=[] Attach to stdin, stdout or stderr. -a, --attach=[] Attach to stdin, stdout or stderr.
-c, --cpu-shares=0 CPU shares (relative weight) -c, --cpu-shares=0 CPU shares (relative weight)
--cidfile="" Write the container ID to the file --cidfile="" Write the container ID to the file
--cpuset="" CPUs in which to allow execution (0-3, 0,1)
-d, --detach=false Detached mode: Run container in the background, print new container id -d, --detach=false Detached mode: Run container in the background, print new container id
--dns=[] Set custom dns servers --dns=[] Set custom dns servers
--dns-search=[] Set custom dns search domains --dns-search=[] Set custom dns search domains
@ -927,11 +930,11 @@ removed before the image is removed.
'bridge': creates a new network stack for the container on the docker bridge 'bridge': creates a new network stack for the container on the docker bridge
'none': no networking for this container 'none': no networking for this container
'container:<name|id>': reuses another container network stack 'container:<name|id>': reuses another container network stack
'host': use the host network stack inside the container 'host': use the host network stack inside the container. Note: the host mode gives the container full access to local system services such as D-bus and is therefore considered insecure.
-P, --publish-all=false Publish all exposed ports to the host interfaces
-p, --publish=[] Publish a container's port to the host -p, --publish=[] Publish a container's port to the host
format: ip:hostPort:containerPort | ip::containerPort | hostPort:containerPort format: ip:hostPort:containerPort | ip::containerPort | hostPort:containerPort
(use 'docker port' to see the actual mapping) (use 'docker port' to see the actual mapping)
-P, --publish-all=false Publish all exposed ports to the host interfaces
--privileged=false Give extended privileges to this container --privileged=false Give extended privileges to this container
--rm=false Automatically remove the container when it exits (incompatible with -d) --rm=false Automatically remove the container when it exits (incompatible with -d)
--sig-proxy=true Proxify received signals to the process (even in non-tty mode). SIGCHLD is not proxied. --sig-proxy=true Proxify received signals to the process (even in non-tty mode). SIGCHLD is not proxied.
@ -1150,7 +1153,7 @@ application change:
Usage: docker save IMAGE Usage: docker save IMAGE
Save an image to a tar archive (streamed to stdout by default) Save an image to a tar archive (streamed to STDOUT by default)
-o, --output="" Write to an file, instead of STDOUT -o, --output="" Write to an file, instead of STDOUT
@ -1175,11 +1178,11 @@ Search [Docker Hub](https://hub.docker.com) for images
Usage: docker search TERM Usage: docker search TERM
Search the docker index for images Search the Docker Hub for images
--no-trunc=false Don't truncate output
-s, --stars=0 Only displays with at least xxx stars
--automated=false Only show automated builds --automated=false Only show automated builds
--no-trunc=false Don't truncate output
-s, --stars=0 Only displays with at least x stars
See [*Find Public Images on Docker Hub*]( See [*Find Public Images on Docker Hub*](
/userguide/dockerrepos/#find-public-images-on-docker-hub) for /userguide/dockerrepos/#find-public-images-on-docker-hub) for
@ -1191,8 +1194,8 @@ more details on finding shared images from the command line.
Restart a stopped container Restart a stopped container
-a, --attach=false Attach container's stdout/stderr and forward all signals to the process -a, --attach=false Attach container's STDOUT and STDERR and forward all signals to the process
-i, --interactive=false Attach container's stdin -i, --interactive=false Attach container's STDIN
When run on a container that has already been started, When run on a container that has already been started,
takes no action and succeeds unconditionally. takes no action and succeeds unconditionally.
@ -1201,9 +1204,9 @@ takes no action and succeeds unconditionally.
Usage: docker stop [OPTIONS] CONTAINER [CONTAINER...] Usage: docker stop [OPTIONS] CONTAINER [CONTAINER...]
Stop a running container (Send SIGTERM, and then SIGKILL after grace period) Stop a running container by sending SIGTERM and then SIGKILL after a grace period
-t, --time=10 Number of seconds to wait for the container to stop before killing it. -t, --time=10 Number of seconds to wait for the container to stop before killing it. Default is 10 seconds.
The main process inside the container will receive SIGTERM, and after a The main process inside the container will receive SIGTERM, and after a
grace period, SIGKILL grace period, SIGKILL
@ -1224,13 +1227,13 @@ them to [*Share Images via Repositories*](
Usage: docker top CONTAINER [ps OPTIONS] Usage: docker top CONTAINER [ps OPTIONS]
Lookup the running processes of a container Display the running processes of a container
## version ## version
Usage: docker version Usage: docker version
Show the docker version information. Show the Docker version information.
Show the Docker version, API version, Git commit, and Go version of Show the Docker version, API version, Git commit, and Go version of
both Docker client and daemon. both Docker client and daemon.
@ -1240,3 +1243,4 @@ both Docker client and daemon.
Usage: docker wait CONTAINER [CONTAINER...] Usage: docker wait CONTAINER [CONTAINER...]
Block until a container stops, then print its exit code. Block until a container stops, then print its exit code.

2
runconfig/parse.go
View file

@ -72,7 +72,7 @@ func parseRun(cmd *flag.FlagSet, args []string, sysInfo *sysinfo.SysInfo) (*Conf
) )
cmd.Var(&flAttach, []string{"a", "-attach"}, "Attach to stdin, stdout or stderr.") cmd.Var(&flAttach, []string{"a", "-attach"}, "Attach to stdin, stdout or stderr.")
cmd.Var(&flVolumes, []string{"v", "-volume"}, "Bind mount a volume (e.g. from the host: -v /host:/container, from docker: -v /container)") cmd.Var(&flVolumes, []string{"v", "-volume"}, "Bind mount a volume (e.g., from the host: -v /host:/container, from docker: -v /container)")
cmd.Var(&flLinks, []string{"#link", "-link"}, "Add link to another container (name:alias)") cmd.Var(&flLinks, []string{"#link", "-link"}, "Add link to another container (name:alias)")
cmd.Var(&flEnv, []string{"e", "-env"}, "Set environment variables") cmd.Var(&flEnv, []string{"e", "-env"}, "Set environment variables")
cmd.Var(&flEnvFile, []string{"-env-file"}, "Read in a line delimited file of ENV variables") cmd.Var(&flEnvFile, []string{"-env-file"}, "Read in a line delimited file of ENV variables")