diff options
68 files changed, 835 insertions, 424 deletions
diff --git a/.gitignore b/.gitignore index 4f8f09c775..2a86e41caf 100644 --- a/.gitignore +++ b/.gitignore @@ -26,3 +26,4 @@ Vagrantfile docs/AWS_S3_BUCKET docs/GIT_BRANCH docs/VERSION +docs/GITCOMMIT diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f3df8619f7..d07b972eb7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,7 +17,7 @@ This information will help us review and fix your issue faster. For instructions on setting up your development environment, please see our dedicated [dev environment setup -docs](http://docs.docker.io/en/latest/contributing/devenvironment/). +docs](http://docs.docker.com/contributing/devenvironment/). ## Contribution guidelines @@ -190,7 +190,7 @@ There are several exceptions to the signing requirement. Currently these are: * Your patch fixes Markdown formatting or syntax errors in the documentation contained in the `docs` directory. -If you have any questions, please refer to the FAQ in the [docs](http://docs.docker.io) +If you have any questions, please refer to the FAQ in the [docs](http://docs.docker.com) ### How can I become a maintainer? @@ -160,7 +160,7 @@ Docker can be used to run short-lived commands, long-running daemons (app servers, databases etc.), interactive shell sessions, etc. You can find a [list of real-world -examples](http://docs.docker.io/en/latest/examples/) in the +examples](http://docs.docker.com/examples/) in the documentation. Under the hood diff --git a/api/client/commands.go b/api/client/commands.go index 2d9c74f432..df2125f5f3 100644 --- a/api/client/commands.go +++ b/api/client/commands.go @@ -67,25 +67,25 @@ func (cli *DockerCli) CmdHelp(args ...string) error { {"inspect", "Return low-level information on a container"}, {"kill", "Kill a running container"}, {"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"}, - {"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"}, {"ps", "List containers"}, - {"pull", "Pull an image or a repository from the docker registry server"}, - {"push", "Push an image or a repository to the docker registry server"}, + {"pull", "Pull an image or a repository from a Docker registry server"}, + {"push", "Push an image or a repository to a Docker registry server"}, {"restart", "Restart a running container"}, {"rm", "Remove one or more containers"}, {"rmi", "Remove one or more images"}, {"run", "Run a command in a new container"}, {"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"}, {"stop", "Stop a running container"}, {"tag", "Tag an image into a repository"}, {"top", "Lookup the running processes of a 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"}, } { 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) magic, err := buf.Peek(tarHeaderSize) 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) { dockerfile, err := ioutil.ReadAll(buf) 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)) } else { @@ -248,7 +248,7 @@ func (cli *DockerCli) CmdBuild(args ...string) error { // 'docker login': login / register a user to registry service. 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 @@ -374,7 +374,7 @@ func (cli *DockerCli) CmdWait(args ...string) error { // 'docker version': show version information 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 { return nil } @@ -497,8 +497,8 @@ func (cli *DockerCli) CmdInfo(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)") - nSeconds := cmd.Int([]string{"t", "-time"}, 10, "Number of seconds to wait for the container to stop before killing it.") + 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. Default is 10 seconds.") if err := cmd.Parse(args); err != nil { return nil } @@ -525,7 +525,7 @@ func (cli *DockerCli) CmdStop(args ...string) error { func (cli *DockerCli) CmdRestart(args ...string) error { 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 { return nil } @@ -582,8 +582,8 @@ func (cli *DockerCli) CmdStart(args ...string) error { tty bool 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") - openStdin = cmd.Bool([]string{"i", "-interactive"}, false, "Attach container's stdin") + 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") ) 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 { - 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.") if err := cmd.Parse(args); err != nil { return nil @@ -794,7 +794,7 @@ func (cli *DockerCli) CmdInspect(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 { return nil } @@ -829,7 +829,7 @@ func (cli *DockerCli) CmdTop(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 { return nil } @@ -877,7 +877,7 @@ func (cli *DockerCli) CmdPort(args ...string) error { func (cli *DockerCli) CmdRmi(args ...string) error { var ( 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") ) 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 { 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") 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 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") 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 { 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 { 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") flPause := cmd.Bool([]string{"p", "-pause"}, true, "Pause container during commit") 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. - 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 { return nil } @@ -1735,8 +1735,8 @@ func (cli *DockerCli) CmdLogs(args ...string) error { func (cli *DockerCli) CmdAttach(args ...string) error { var ( cmd = cli.Subcmd("attach", "[OPTIONS] CONTAINER", "Attach to a running container") - 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") + noStdin = cmd.Bool([]string{"#nostdin", "-no-stdin"}, false, "Do not attach STDIN") + 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 { @@ -1807,11 +1807,11 @@ func (cli *DockerCli) CmdAttach(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") trusted := cmd.Bool([]string{"#t", "#trusted", "#-trusted"}, false, "Only show trusted 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 { return nil } @@ -1938,7 +1938,7 @@ func (cli *DockerCli) CmdRun(args ...string) error { } if cidFileInfo.Size() == 0 { 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 { - 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") if err := cmd.Parse(args); err != nil { diff --git a/contrib/completion/fish/docker.fish b/contrib/completion/fish/docker.fish index a1eac31df7..a4a9365f92 100644 --- a/contrib/completion/fish/docker.fish +++ b/contrib/completion/fish/docker.fish @@ -79,7 +79,7 @@ complete -c docker -A -f -n '__fish_seen_subcommand_from build' -s t -l tag -d ' # 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 -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' -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" diff --git a/contrib/completion/zsh/_docker b/contrib/completion/zsh/_docker index 4578d1eda7..3f96f00ef7 100644 --- a/contrib/completion/zsh/_docker +++ b/contrib/completion/zsh/_docker @@ -1,6 +1,6 @@ #compdef docker # -# zsh completion for docker (http://docker.io) +# zsh completion for docker (http://docker.com) # # version: 0.2.2 # author: Felix Riedel diff --git a/contrib/init/systemd/docker.service b/contrib/init/systemd/docker.service index 1bc4d1f569..6f3cc33c36 100644 --- a/contrib/init/systemd/docker.service +++ b/contrib/init/systemd/docker.service @@ -1,6 +1,6 @@ [Unit] Description=Docker Application Container Engine -Documentation=http://docs.docker.io +Documentation=http://docs.docker.com After=network.target [Service] diff --git a/contrib/init/systemd/socket-activation/docker.service b/contrib/init/systemd/socket-activation/docker.service index a3382ab414..4af71378c8 100644 --- a/contrib/init/systemd/socket-activation/docker.service +++ b/contrib/init/systemd/socket-activation/docker.service @@ -1,6 +1,6 @@ [Unit] Description=Docker Application Container Engine -Documentation=http://docs.docker.io +Documentation=http://docs.docker.com After=network.target [Service] diff --git a/contrib/init/sysvinit-redhat/docker b/contrib/init/sysvinit-redhat/docker index 06699f6ab1..aa94c04811 100755 --- a/contrib/init/sysvinit-redhat/docker +++ b/contrib/init/sysvinit-redhat/docker @@ -2,10 +2,10 @@ # # /etc/rc.d/init.d/docker # -# Daemon for docker.io +# Daemon for docker.com # # chkconfig: 2345 95 95 -# description: Daemon for docker.io +# description: Daemon for docker.com ### BEGIN INIT INFO # Provides: docker @@ -16,7 +16,7 @@ # Default-Start: 2 3 4 5 # Default-Stop: 0 1 6 # Short-Description: start and stop docker -# Description: Daemon for docker.io +# Description: Daemon for docker.com ### END INIT INFO # Source function library. diff --git a/daemon/daemon.go b/daemon/daemon.go index 9500526f9e..23402d9518 100644 --- a/daemon/daemon.go +++ b/daemon/daemon.go @@ -836,7 +836,7 @@ func NewDaemonFromDirectory(config *daemonconfig.Config, eng *engine.Engine) (*D localCopy := path.Join(config.Root, "init", fmt.Sprintf("dockerinit-%s", dockerversion.VERSION)) sysInitPath := utils.DockerInitPath(localCopy) if sysInitPath == "" { - return nil, fmt.Errorf("Could not locate dockerinit: This usually means docker was built incorrectly. See http://docs.docker.io/en/latest/contributing/devenvironment for official build instructions.") + return nil, fmt.Errorf("Could not locate dockerinit: This usually means docker was built incorrectly. See http://docs.docker.com/contributing/devenvironment for official build instructions.") } if sysInitPath != localCopy { diff --git a/docs/README.md b/docs/README.md index 99dc8712c9..17299401e7 100755 --- a/docs/README.md +++ b/docs/README.md @@ -3,7 +3,7 @@ The source for Docker documentation is here under `sources/` and uses extended Markdown, as implemented by [MkDocs](http://mkdocs.org). -The HTML files are built and hosted on `https://docs.docker.io`, and update +The HTML files are built and hosted on `https://docs.docker.com`, and update automatically after each change to the master or release branch of [Docker on GitHub](https://github.com/dotcloud/docker) thanks to post-commit hooks. The `docs` branch maps to the "latest" documentation and the `master` (unreleased @@ -21,14 +21,14 @@ In the rare case where your change is not forward-compatible, you may need to base your changes on the `docs` branch. Also, now that we have a `docs` branch, we can keep the -[http://docs.docker.io](http://docs.docker.io) docs up to date with any bugs +[http://docs.docker.com](http://docs.docker.com) docs up to date with any bugs found between Docker code releases. **Warning**: When *reading* the docs, the -[http://beta-docs.docker.io](http://beta-docs.docker.io) documentation may +[http://docs-stage.docker.com](http://docs-stage.docker.com) documentation may include features not yet part of any official Docker release. The `beta-docs` site should be used only for understanding bleeding-edge development and -`docs.docker.io` (which points to the `docs` branch`) should be used for the +`docs.docker.com` (which points to the `docs` branch`) should be used for the latest official release. ## Contributing diff --git a/docs/docs-update.py b/docs/docs-update.py new file mode 100755 index 0000000000..31bb47db3b --- /dev/null +++ b/docs/docs-update.py @@ -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() diff --git a/docs/man/Dockerfile.5.md b/docs/man/Dockerfile.5.md index 73c1312b87..b0a863f657 100644 --- a/docs/man/Dockerfile.5.md +++ b/docs/man/Dockerfile.5.md @@ -203,4 +203,4 @@ or run later, during the next build stage. # HISTORY -*May 2014, Compiled by Zac Dover (zdover at redhat dot com) based on docker.io Dockerfile documentation. +*May 2014, Compiled by Zac Dover (zdover at redhat dot com) based on docker.com Dockerfile documentation. diff --git a/docs/man/README.md b/docs/man/README.md index d04d82454f..45f1a91c00 100644 --- a/docs/man/README.md +++ b/docs/man/README.md @@ -68,4 +68,4 @@ The Pandoc Docker container will process the Markdown files and generate the man pages inside the `docker/docs/man/man1` directory using Docker volumes. For more information on Docker volumes see the man page for `docker run` and also look at the article [Sharing Directories via Volumes] -(http://docs.docker.io/use/working_with_volumes/). +(http://docs.docker.com/use/working_with_volumes/). diff --git a/docs/man/docker-attach.1.md b/docs/man/docker-attach.1.md index 91188aaaef..1b4e68b65f 100644 --- a/docs/man/docker-attach.1.md +++ b/docs/man/docker-attach.1.md @@ -1,11 +1,14 @@ % DOCKER(1) Docker User Manuals -% William Henry -% APRIL 2014 +% Docker Community +% JUNE 2014 # NAME docker-attach - Attach to a running container # SYNOPSIS -**docker attach** **--no-stdin**[=*false*] **--sig-proxy**[=*true*] CONTAINER +**docker attach** +[**--no-stdin**[=*false*]] +[**--sig-proxy**[=*true*]] + CONTAINER # DESCRIPTION If you **docker run** a container in detached mode (**-d**), you can reattach to @@ -19,11 +22,10 @@ the client. # OPTIONS **--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*: -When set to true, proxify received signals to the process (even in non-tty -mode). SIGCHLD is not proxied. The default is *true*. +**--sig-proxy**=*true*|*false* + Proxify all received signals to the process (even in non-TTY mode). SIGCHLD is not proxied. The default is *true*. # EXAMPLES @@ -55,4 +57,5 @@ attach** command: # HISTORY April 2014, Originally compiled by William Henry (whenry at redhat dot com) -based on docker.io source material and internal work. +based on docker.com source material and internal work. +June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> diff --git a/docs/man/docker-build.1.md b/docs/man/docker-build.1.md index 3c031445aa..c562660b6f 100644 --- a/docs/man/docker-build.1.md +++ b/docs/man/docker-build.1.md @@ -1,12 +1,17 @@ % DOCKER(1) Docker User Manuals -% William Henry -% APRIL 2014 +% Docker Community +% JUNE 2014 # 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 -**docker build** [**--no-cache**[=*false*]] [**-q**|**--quiet**[=*false*]] - [**--rm**] [**-t**|**--tag**=TAG] PATH | URL | - +**docker build** +[**--force-rm**[=*false*]] +[**--no-cache**[=*false*]] +[**-q**|**--quiet**[=*false*]] +[**--rm**[=*true*]] +[**-t**|**--tag**[=*TAG*]] + PATH | URL | - # DESCRIPTION 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. # OPTIONS +**--force-rm**=*true*|*false* + Always remove intermediate containers, even after unsuccessful builds. The default is *false*. + +**--no-cache**=*true*|*false* + Do not use cache when building the image. The default is *false*. **-q**, **--quiet**=*true*|*false* - When set to true, suppress verbose build output. Default is *false*. + Suppress the verbose output generated by the containers. The default is *false*. **--rm**=*true*|*false* - When true, remove intermediate containers that are created during the -build process. The default is true. + Remove intermediate containers after a successful build. 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* - When set to true, do not use a cache when building the image. The -default is *false*. +**-t**, **--tag**="" + Repository name (and optionally a tag) to be applied to the resulting image in case of success # EXAMPLES @@ -114,4 +117,5 @@ Note: You can set an arbitrary Git repository via the `git://` schema. # HISTORY March 2014, Originally compiled by William Henry (whenry at redhat dot com) -based on docker.io source material and internal work. +based on docker.com source material and internal work. +June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> diff --git a/docs/man/docker-commit.1.md b/docs/man/docker-commit.1.md index c0f2c734c5..bbd1db21b0 100644 --- a/docs/man/docker-commit.1.md +++ b/docs/man/docker-commit.1.md @@ -1,22 +1,23 @@ % DOCKER(1) Docker User Manuals -% William Henry -% APRIL 2014 +% Docker Community +% JUNE 2014 # NAME -docker-commit - Create a new image from the changes to an existing -container +docker-commit - Create a new image from a container's changes # SYNOPSIS -**docker commit** **-a**|**--author**[=""] **-m**|**--message**[=""] -CONTAINER [REPOSITORY[:TAG]] +**docker commit** +[**-a**|**--author**[=*AUTHOR*]] +[**-m**|**--message**[=*MESSAGE*]] + CONTAINER [REPOSITORY[:TAG]] # DESCRIPTION Using an existing container's name or ID you can create a new image. # OPTIONS -**-a, --author**="" - Author name. (e.g., "John Hannibal Smith <hannibal@a-team.com>" +**-a**, **--author**="" + Author (e.g., "John Hannibal Smith <hannibal@a-team.com>") -**-m, --message**="" +**-m**, **--message**="" Commit message **-p, --pause**=true @@ -34,4 +35,5 @@ create a new image run docker ps to find the container's ID and then run: # HISTORY April 2014, Originally compiled by William Henry (whenry at redhat dot com) -based on docker.io source material and in +based on docker.com source material and in +June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> diff --git a/docs/man/docker-cp.1.md b/docs/man/docker-cp.1.md index 1801e7318d..dc8f295bbe 100644 --- a/docs/man/docker-cp.1.md +++ b/docs/man/docker-cp.1.md @@ -1,18 +1,22 @@ % DOCKER(1) Docker User Manuals -% William Henry -% APRIL 2014 +% Docker Community +% JUNE 2014 # NAME docker-cp - Copy files/folders from the PATH to the HOSTPATH # SYNOPSIS -**docker cp** CONTAINER:PATH HOSTPATH +**docker cp** +CONTAINER:PATH HOSTPATH # DESCRIPTION Copy files/folders from a container's filesystem to the host path. Paths are relative to the root of the filesystem. Files 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 the exited container to the current dir on the host: @@ -20,5 +24,5 @@ the exited container to the current dir on the host: # HISTORY April 2014, Originally compiled by William Henry (whenry at redhat dot com) -based on docker.io source material and internal work. - +based on docker.com source material and internal work. +June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> diff --git a/docs/man/docker-diff.1.md b/docs/man/docker-diff.1.md index 2053f2c3d2..acf0911b04 100644 --- a/docs/man/docker-diff.1.md +++ b/docs/man/docker-diff.1.md @@ -1,18 +1,22 @@ % DOCKER(1) Docker User Manuals -% William Henry -% APRIL 2014 +% Docker Community +% JUNE 2014 # NAME docker-diff - Inspect changes on a container's filesystem # SYNOPSIS -**docker diff** CONTAINER +**docker diff** +CONTAINER # DESCRIPTION Inspect changes on a container's filesystem. You can use the full or shortened container ID or the container name set using **docker run --name** option. -# EXAMPLE +# OPTIONS +There are no available options. + +# EXAMPLES Inspect the changes to on a nginx container: # docker diff 1fdfd1f54c1b @@ -39,6 +43,5 @@ Inspect the changes to on a nginx container: # HISTORY April 2014, Originally compiled by William Henry (whenry at redhat dot com) -based on docker.io source material and internal work. - - +based on docker.com source material and internal work. +June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> diff --git a/docs/man/docker-events.1.md b/docs/man/docker-events.1.md index 2ebe9247d4..8fa85871a8 100644 --- a/docs/man/docker-events.1.md +++ b/docs/man/docker-events.1.md @@ -1,10 +1,14 @@ % DOCKER(1) Docker User Manuals -% William Henry -% APRIL 2014 +% Docker Community +% JUNE 2014 # NAME docker-events - Get real time events from the server -**docker events** **--since**=""|*epoch-time* +# SYNOPSIS +**docker events** +[**--since**[=*SINCE*]] +[**--until**[=*UNTIL*]] + # DESCRIPTION Get event information from the Docker daemon. Information can include historical @@ -12,8 +16,10 @@ information and real-time information. # OPTIONS **--since**="" -Show previously created events and then stream. This can be in either -seconds since epoch, or date string. + Show all events created since timestamp + +**--until**="" + Stream events until this timestamp # EXAMPLES @@ -43,4 +49,5 @@ Again the output container IDs have been shortened for the purposes of this docu # HISTORY April 2014, Originally compiled by William Henry (whenry at redhat dot com) -based on docker.io source material and internal work. +based on docker.com source material and internal work. +June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> diff --git a/docs/man/docker-export.1.md b/docs/man/docker-export.1.md index ab11aa1266..8fd7834a15 100644 --- a/docs/man/docker-export.1.md +++ b/docs/man/docker-export.1.md @@ -1,19 +1,22 @@ % DOCKER(1) Docker User Manuals -% William Henry -% APRIL 2014 +% Docker Community +% JUNE 2014 # NAME -docker-export - Export the contents of a filesystem as a tar archive to -STDOUT. +docker-export - Export the contents of a filesystem as a tar archive to STDOUT # SYNOPSIS -**docker export** CONTAINER +**docker export** +CONTAINER # DESCRIPTION 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 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 called test.tar: @@ -23,4 +26,5 @@ called test.tar: # HISTORY April 2014, Originally compiled by William Henry (whenry at redhat dot com) -based on docker.io source material and internal work. +based on docker.com source material and internal work. +June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> diff --git a/docs/man/docker-history.1.md b/docs/man/docker-history.1.md index 1b3a9858b5..ddb164e50b 100644 --- a/docs/man/docker-history.1.md +++ b/docs/man/docker-history.1.md @@ -1,11 +1,13 @@ % DOCKER(1) Docker User Manuals -% William Henry -% APRIL 2014 +% Docker Community +% JUNE 2014 # NAME docker-history - Show the history of an image # SYNOPSIS -**docker history** **--no-trunc**[=*false*] [**-q**|**--quiet**[=*false*]] +**docker history** +[**--no-trunc**[=*false*]] +[**-q**|**--quiet**[=*false*]] IMAGE # DESCRIPTION @@ -13,14 +15,13 @@ docker-history - Show the history of an image Show the history of when and how an image was created. # OPTIONS - **--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* - When true only show numeric IDs. Default is false. +**-q**, **--quiet**=*true*|*false* + Only show numeric IDs. The default is *false*. -# EXAMPLE +# EXAMPLES $ sudo docker history fedora IMAGE CREATED CREATED BY SIZE 105182bb5e8b 5 days ago /bin/sh -c #(nop) ADD file:71356d2ad59aa3119d 372.7 MB @@ -29,4 +30,5 @@ Show the history of when and how an image was created. # HISTORY April 2014, Originally compiled by William Henry (whenry at redhat dot com) -based on docker.io source material and internal work. +based on docker.com source material and internal work. +June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> diff --git a/docs/man/docker-images.1.md b/docs/man/docker-images.1.md index 602ccf7c90..c572ee674b 100644 --- a/docs/man/docker-images.1.md +++ b/docs/man/docker-images.1.md @@ -1,17 +1,16 @@ % DOCKER(1) Docker User Manuals -% William Henry -% APRIL 2014 +% Docker Community +% JUNE 2014 # NAME -docker-images - List the images in the local repository +docker-images - List images # SYNOPSIS **docker images** -[**-a**|**--all**=*false*] -[**--no-trunc**[=*false*] -[**-q**|**--quiet**[=*false*] -[**-t**|**--tree**=*false*] -[**-v**|**--viz**=*false*] -[NAME] +[**-a**|**--all**[=*false*]] +[**-f**|**--filter**[=*[]*]] +[**--no-trunc**[=*false*]] +[**-q**|**--quiet**[=*false*]] + [NAME] # DESCRIPTION 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. # OPTIONS - **-a**, **--all**=*true*|*false* - When set to true, also include all intermediate images in the list. The -default is false. + Show all images (by default filter out the intermediate image layers). The default is *false*. + +**-f**, **--filter**=[] + Provide filter values (i.e. 'dangling=true') **--no-trunc**=*true*|*false* - When set to true, list the full image ID and not the truncated ID. The -default is false. + Don't truncate output. The default is *false*. **-q**, **--quiet**=*true*|*false* - When set to true, list the complete image ID as part of the output. The -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*. + Only show numeric IDs. The default is *false*. # EXAMPLES @@ -96,4 +86,5 @@ tools. # HISTORY April 2014, Originally compiled by William Henry (whenry at redhat dot com) -based on docker.io source material and internal work. +based on docker.com source material and internal work. +June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> diff --git a/docs/man/docker-import.1.md b/docs/man/docker-import.1.md index 6b76d191fa..2d67b8bc78 100644 --- a/docs/man/docker-import.1.md +++ b/docs/man/docker-import.1.md @@ -1,17 +1,20 @@ % DOCKER(1) Docker User Manuals -% William Henry -% APRIL 2014 +% Docker Community +% JUNE 2014 # NAME -docker-import - Create an empty filesystem image and import the contents -of the tarball into it. +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. # SYNOPSIS -**docker import** URL|- [REPOSITORY[:TAG]] +**docker import** +URL|- [REPOSITORY[:TAG]] # DESCRIPTION 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. +# OPTIONS +There are no available options. + # EXAMPLES ## Import from a remote location @@ -36,4 +39,5 @@ Import to docker via pipe and stdin: # HISTORY April 2014, Originally compiled by William Henry (whenry at redhat dot com) -based on docker.io source material and internal work. +based on docker.com source material and internal work. +June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> diff --git a/docs/man/docker-info.1.md b/docs/man/docker-info.1.md index 8c03945dbe..2945d61dfe 100644 --- a/docs/man/docker-info.1.md +++ b/docs/man/docker-info.1.md @@ -1,12 +1,13 @@ % DOCKER(1) Docker User Manuals -% William Henry -% APRIL 2014 +% Docker Community +% JUNE 2014 # NAME -docker-info - Display system wide information +docker-info - Display system-wide information # SYNOPSIS **docker info** + # DESCRIPTION This command displays system wide information regarding the Docker installation. Information displayed includes the number of containers and images, pool name, @@ -43,4 +44,5 @@ Here is a sample output: # HISTORY April 2014, Originally compiled by William Henry (whenry at redhat dot com) -based on docker.io source material and internal work. +based on docker.com source material and internal work. +June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> diff --git a/docs/man/docker-inspect.1.md b/docs/man/docker-inspect.1.md index a82c76a625..a52d57c974 100644 --- a/docs/man/docker-inspect.1.md +++ b/docs/man/docker-inspect.1.md @@ -1,12 +1,13 @@ % DOCKER(1) Docker User Manuals -% William Henry -% APRIL 2014 +% Docker Community +% JUNE 2014 # NAME -docker-inspect - Return low-level information on a container/image +docker-inspect - Return low-level information on a container or image # SYNOPSIS -**docker inspect** [**-f**|**--format**="" CONTAINER|IMAGE -[CONTAINER|IMAGE...] +**docker inspect** +[**-f**|**--format**[=*FORMAT*]] +CONTAINER|IMAGE [CONTAINER|IMAGE...] # DESCRIPTION @@ -17,8 +18,7 @@ each result. # OPTIONS **-f**, **--format**="" - The text/template package of Go describes all the details of the -format. See examples section + Format the output using the given go template. # EXAMPLES @@ -224,6 +224,6 @@ Use an image's ID or name (e.g., repository/name[:tag]) to get information }] # HISTORY - April 2014, Originally compiled by William Henry (whenry at redhat dot com) -based on docker.io source material and internal work. +based on docker.com source material and internal work. +June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> diff --git a/docs/man/docker-kill.1.md b/docs/man/docker-kill.1.md index 8175002d33..3c8d59e6d5 100644 --- a/docs/man/docker-kill.1.md +++ b/docs/man/docker-kill.1.md @@ -1,11 +1,13 @@ % DOCKER(1) Docker User Manuals -% William Henry -% APRIL 2014 +% Docker Community +% JUNE 2014 # 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 -**docker kill** **--signal**[=*"KILL"*] CONTAINER [CONTAINER...] +**docker kill** +[**-s**|**--signal**[=*"KILL"*]] + CONTAINER [CONTAINER...] # DESCRIPTION @@ -13,9 +15,10 @@ The main process inside each container specified will be sent SIGKILL, or any signal specified with option --signal. # OPTIONS -**-s**, **--signal**=*"KILL"* +**-s**, **--signal**="KILL" Signal to send to the container # HISTORY April 2014, Originally compiled by William Henry (whenry at redhat dot com) - based on docker.io source material and internal work. + based on docker.com source material and internal work. +June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> diff --git a/docs/man/docker-load.1.md b/docs/man/docker-load.1.md index 535b701cca..07dac46138 100644 --- a/docs/man/docker-load.1.md +++ b/docs/man/docker-load.1.md @@ -1,11 +1,13 @@ % DOCKER(1) Docker User Manuals -% William Henry -% APRIL 2014 +% Docker Community +% JUNE 2014 # NAME docker-load - Load an image from a tar archive on STDIN # SYNOPSIS -**docker load** **--input**="" +**docker load** +[**-i**|**--input**[=*INPUT*]] + # DESCRIPTION @@ -13,11 +15,10 @@ Loads a tarred repository from a file or the standard input stream. Restores both images and tags. # OPTIONS - **-i**, **--input**="" Read from a tar archive file, instead of STDIN -# EXAMPLE +# EXAMPLES $ sudo docker images REPOSITORY TAG IMAGE ID CREATED VIRTUAL SIZE @@ -33,4 +34,5 @@ Restores both images and tags. # HISTORY April 2014, Originally compiled by William Henry (whenry at redhat dot com) -based on docker.io source material and internal work. +based on docker.com source material and internal work. +June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> diff --git a/docs/man/docker-login.1.md b/docs/man/docker-login.1.md index 0a9cb283dd..c269353079 100644 --- a/docs/man/docker-login.1.md +++ b/docs/man/docker-login.1.md @@ -1,12 +1,15 @@ % DOCKER(1) Docker User Manuals -% William Henry -% APRIL 2014 +% Docker Community +% JUNE 2014 # 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 -**docker login** [**-e**|**-email**=""] [**-p**|**--password**=""] - [**-u**|**--username**=""] [SERVER] +**docker login** +[**-e**|**--email**[=*EMAIL*]] +[**-p**|**--password**[=*PASSWORD*]] +[**-u**|**--username**[=*USERNAME*]] + [SERVER] # DESCRIPTION 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 **-e**, **--email**="" - Email address + Email **-p**, **--password**="" Password @@ -23,7 +26,7 @@ login to a private registry you can specify this by adding the server name. **-u**, **--username**="" Username -# EXAMPLE +# EXAMPLES ## Login to a local registry @@ -31,5 +34,5 @@ login to a private registry you can specify this by adding the server name. # HISTORY April 2014, Originally compiled by William Henry (whenry at redhat dot com) -based on docker.io source material and internal work. - +based on docker.com source material and internal work. +June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> diff --git a/docs/man/docker-logs.1.md b/docs/man/docker-logs.1.md index 0b9ce867e9..5c3df75b9e 100644 --- a/docs/man/docker-logs.1.md +++ b/docs/man/docker-logs.1.md @@ -1,11 +1,14 @@ % DOCKER(1) Docker User Manuals -% William Henry -% APRIL 2014 +% Docker Community +% JUNE 2014 # NAME docker-logs - Fetch the logs of a container # SYNOPSIS -**docker logs** **--follow**[=*false*] CONTAINER +**docker logs** +[**-f**|**--follow**[=*false*]] +[**-t**|**--timestamps**[=*false*]] +CONTAINER # DESCRIPTION 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. # OPTIONS -**-f, --follow**=*true*|*false* - When *true*, follow log output. The default is false. +**-f**, **--follow**=*true*|*false* + Follow log output. The default is *false*. + +**-t**, **--timestamps**=*true*|*false* + Show timestamps. The default is *false*. # HISTORY April 2014, Originally compiled by William Henry (whenry at redhat dot com) -based on docker.io source material and internal work. +based on docker.com source material and internal work. +June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> diff --git a/docs/man/docker-pause.1.md b/docs/man/docker-pause.1.md new file mode 100644 index 0000000000..e6c0c2455d --- /dev/null +++ b/docs/man/docker-pause.1.md @@ -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> diff --git a/docs/man/docker-port.1.md b/docs/man/docker-port.1.md index 9773e4d80c..07b84b12d9 100644 --- a/docs/man/docker-port.1.md +++ b/docs/man/docker-port.1.md @@ -1,15 +1,16 @@ % DOCKER(1) Docker User Manuals -% William Henry -% APRIL 2014 +% Docker Community +% JUNE 2014 # 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 -**docker port** CONTAINER PRIVATE_PORT +**docker port** +CONTAINER PRIVATE_PORT -# DESCRIPTION -Lookup the public-facing port which is NAT-ed to PRIVATE_PORT +# OPTIONS +There are no available options. # HISTORY April 2014, Originally compiled by William Henry (whenry at redhat dot com) -based on docker.io source material and internal work. +June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> diff --git a/docs/man/docker-ps.1.md b/docs/man/docker-ps.1.md index 60fce0213a..9264d53a66 100644 --- a/docs/man/docker-ps.1.md +++ b/docs/man/docker-ps.1.md @@ -1,14 +1,20 @@ % DOCKER(1) Docker User Manuals -% William Henry -% APRIL 2014 +% Docker Community +% JUNE 2014 # NAME docker-ps - List containers # SYNOPSIS -**docker ps** [**-a**|**--all**=*false*] [**--before**=""] -[**-l**|**--latest**=*false*] [**-n**=*-1*] [**--no-trunc**=*false*] -[**-q**|**--quiet**=*false*] [**-s**|**--size**=*false*] -[**--since**=""] +**docker ps** +[**-a**|**--all**[=*false*]] +[**--before**[=*BEFORE*]] +[**-l**|**--latest**[=*false*]] +[**-n**[=*-1*]] +[**--no-trunc**[=*false*]] +[**-q**|**--quiet**[=*false*]] +[**-s**|**--size**[=*false*]] +[**--since**[=*SINCE*]] + # DESCRIPTION @@ -16,36 +22,31 @@ List the containers in the local repository. By default this show only the running containers. # OPTIONS - **-a**, **--all**=*true*|*false* - When true show all containers. Only running containers are shown by -default. Default is false. + Show all containers. Only running containers are shown by default. The default is *false*. **--before**="" - Show only container created before Id or Name, include non-running -ones. + Show only container created before Id or Name, include non-running ones. **-l**, **--latest**=*true*|*false* - When true show only the latest created container, include non-running -ones. The default is false. + Show only the latest created container, include non-running ones. The default is *false*. -**-n**=NUM - Show NUM (integer) last created containers, include non-running ones. -The default is -1 (none) +**-n**=-1 + Show n last created containers, include non-running ones. **--no-trunc**=*true*|*false* - When true truncate output. Default is false. + Don't truncate output. The default is *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* - When true display container sizes. Default is false. + Display sizes. The default is *false*. **--since**="" Show only containers created since Id or Name, include non-running ones. -# EXAMPLE +# EXAMPLES # Display all containers, including non-running # docker ps -a @@ -65,4 +66,5 @@ The default is -1 (none) # HISTORY April 2014, Originally compiled by William Henry (whenry at redhat dot com) -based on docker.io source material and internal work. +based on docker.com source material and internal work. +June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> diff --git a/docs/man/docker-pull.1.md b/docs/man/docker-pull.1.md index d8e177b2b2..6fb0dc1000 100644 --- a/docs/man/docker-pull.1.md +++ b/docs/man/docker-pull.1.md @@ -1,11 +1,12 @@ % DOCKER(1) Docker User Manuals -% William Henry -% APRIL 2014 +% Docker Community +% JUNE 2014 # NAME docker-pull - Pull an image or a repository from the registry # SYNOPSIS -**docker pull** [REGISTRY_PATH/]NAME[:TAG] +**docker pull** +NAME[:TAG] # 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. It is also possible to specify a non-default registry to pull from. +# OPTIONS +There are no available options. + # EXAMPLES # Pull a repository with multiple images @@ -47,5 +51,10 @@ It is also possible to specify a non-default registry to pull from. # HISTORY April 2014, Originally compiled by William Henry (whenry at redhat dot com) +<<<<<<< HEAD based on docker.io source material and internal work. +June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> +======= +based on docker.com source material and internal work. +>>>>>>> 834ef8a... I'm going to wish I didn't do this diff --git a/docs/man/docker-push.1.md b/docs/man/docker-push.1.md index dbb6e7d1b1..56d814181d 100644 --- a/docs/man/docker-push.1.md +++ b/docs/man/docker-push.1.md @@ -1,19 +1,23 @@ % DOCKER(1) Docker User Manuals -% William Henry -% APRIL 2014 +% Docker Community +% JUNE 2014 # NAME docker-push - Push an image or a repository to the registry # SYNOPSIS -**docker push** NAME[:TAG] +**docker push** +NAME[:TAG] # DESCRIPTION Push an image or a repository to a registry. The default registry is the Docker -Index located at [index.docker.io](https://index.docker.io/v1/). However the +Hub located at [hub.docker.com](https://hub.docker.com/). However the image can be pushed to another, perhaps private, registry as demonstrated in the example below. -# EXAMPLE +# OPTIONS +There are no available options. + +# EXAMPLES # Pushing a new image to a registry @@ -24,7 +28,7 @@ and then committing it to a new image name: Now push the image to the registry using the image ID. In this example the registry is on host named registry-host and listening on port 5000. -Default Docker commands will push to the default `index.docker.io` +Default Docker commands will push to the default `hub.docker.com` registry. Instead, push to the local registry, which is on a host called registry-host*. To do this, tag the image with the host name or IP address, and the port of the registry: @@ -41,4 +45,9 @@ listed. # HISTORY April 2014, Originally compiled by William Henry (whenry at redhat dot com) +<<<<<<< HEAD based on docker.io source material and internal work. +June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> +======= +based on docker.com source material and internal work. +>>>>>>> 834ef8a... I'm going to wish I didn't do this diff --git a/docs/man/docker-restart.1.md b/docs/man/docker-restart.1.md index 44634f6613..6f93858ba1 100644 --- a/docs/man/docker-restart.1.md +++ b/docs/man/docker-restart.1.md @@ -1,21 +1,27 @@ % DOCKER(1) Docker User Manuals -% William Henry -% APRIL 2014 +% Docker Community +% JUNE 2014 # NAME docker-restart - Restart a running container # SYNOPSIS -**docker restart** [**-t**|**--time**[=*10*]] CONTAINER [CONTAINER...] +**docker restart** +[**-t**|**--time**[=*10*]] + CONTAINER [CONTAINER...] # DESCRIPTION Restart each container listed. # OPTIONS -**-t**, **--time**=NUM - 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. # HISTORY April 2014, Originally compiled by William Henry (whenry at redhat dot com) +<<<<<<< HEAD based on docker.io source material and internal work. +June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> +======= +based on docker.com source material and internal work. +>>>>>>> 834ef8a... I'm going to wish I didn't do this diff --git a/docs/man/docker-rm.1.md b/docs/man/docker-rm.1.md index ae85af5277..9195137ec1 100644 --- a/docs/man/docker-rm.1.md +++ b/docs/man/docker-rm.1.md @@ -1,16 +1,15 @@ % DOCKER(1) Docker User Manuals -% William Henry -% APRIL 2014 - +% Docker Community +% JUNE 2014 # NAME - -docker-rm - Remove one or more containers. +docker-rm - Remove one or more containers # SYNOPSIS - -**docker rm** [**-f**|**--force**[=*false*] [**-l**|**--link**[=*false*] [**-v**| -**--volumes**[=*false*] -CONTAINER [CONTAINER...] +**docker rm** +[**-f**|**--force**[=*false*]] +[**-l**|**--link**[=*false*]] +[**-v**|**--volumes**[=*false*]] + CONTAINER [CONTAINER...] # 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. # OPTIONS - **-f**, **--force**=*true*|*false* - When set to true, force the removal of the container. The default is -*false*. + Force removal of running container. The default is *false*. **-l**, **--link**=*true*|*false* - When set to true, remove the specified link and not the underlying -container. The default is *false*. + Remove the specified link and not the underlying container. The default is *false*. **-v**, **--volumes**=*true*|*false* - When set to true, remove the volumes associated to the container. The -default is *false*. + Remove the volumes associated with the container. The default is *false*. # EXAMPLES @@ -51,6 +46,10 @@ command. The use that name as follows: docker rm hopeful_morse # HISTORY - April 2014, Originally compiled by William Henry (whenry at redhat dot com) +<<<<<<< HEAD based on docker.io source material and internal work. +June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> +======= +based on docker.com source material and internal work. +>>>>>>> 834ef8a... I'm going to wish I didn't do this diff --git a/docs/man/docker-rmi.1.md b/docs/man/docker-rmi.1.md index b728dc16a9..7a2973f873 100644 --- a/docs/man/docker-rmi.1.md +++ b/docs/man/docker-rmi.1.md @@ -1,12 +1,14 @@ % DOCKER(1) Docker User Manuals -% William Henry -% APRIL 2014 +% Docker Community +% JUNE 2014 # NAME -docker-rmi \- Remove one or more images. +docker-rmi - Remove one or more images # SYNOPSIS - -**docker rmi** [**-f**|**--force**[=*false*] IMAGE [IMAGE...] +**docker rmi** +[**-f**|**--force**[=*false*]] +[**--no-prune**[=*false*]] +IMAGE [IMAGE...] # DESCRIPTION @@ -16,10 +18,11 @@ container unless you use the **-f** option. To see all images on a host use the **docker images** command. # OPTIONS - **-f**, **--force**=*true*|*false* - When set to true, force the removal of the image. The default is -*false*. + Force removal of the image. The default is *false*. + +**--no-prune**=*true*|*false* + Do not delete untagged parents. The default is *false*. # EXAMPLES @@ -30,6 +33,10 @@ Here is an example of removing and image: docker rmi fedora/httpd # HISTORY - April 2014, Originally compiled by William Henry (whenry at redhat dot com) +<<<<<<< HEAD based on docker.io source material and internal work. +June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> +======= +based on docker.com source material and internal work. +>>>>>>> 834ef8a... I'm going to wish I didn't do this diff --git a/docs/man/docker-run.1.md b/docs/man/docker-run.1.md index ec9db8fd08..fa73d8eee4 100644 --- a/docs/man/docker-run.1.md +++ b/docs/man/docker-run.1.md @@ -1,26 +1,40 @@ % DOCKER(1) Docker User Manuals -% William Henry -% APRIL 2014 +% Docker Community +% JUNE 2014 # NAME -docker-run - Run a process in an isolated container +docker-run - Run a command in a new container # SYNOPSIS **docker run** -[**-a**|**--attach**[=]] [**-c**|**--cpu-shares**[=0] -[**-m**|**--memory**=*memory-limit*] -[**--cidfile**=*file*] [**-d**|**--detach**[=*false*]] [**--dns**=*IP-address*] -[**--name**=*name*] [**-u**|**--user**=*username*|*uid*] -[**--link**=*name*:*alias*] -[**-e**|**--env**=*environment*] [**--entrypoint**=*command*] -[**--expose**=*port*] [**-P**|**--publish-all**[=*false*]] -[**-p**|**--publish**=*port-mapping*] [**-h**|**--hostname**=*hostname*] -[**--rm**[=*false*]] [**--privileged**[=*false*]] +[**-a**|**--attach**[=*[]*]] +[**-c**|**--cpu-shares**[=*0*]] +[**--cidfile**[=*CIDFILE*]] +[**--cpuset**[=*CPUSET*]] +[**-d**|**--detach**[=*false*]] +[**--dns-search**[=*[]*]] +[**--dns**[=*[]*]] +[**-e**|**--env**[=*[]*]] +[**--entrypoint**[=*ENTRYPOINT*]] +[**--env-file**[=*[]*]] +[**--expose**[=*[]*]] +[**-h**|**--hostname**[=*HOSTNAME*]] [**-i**|**--interactive**[=*false*]] -[**-t**|**--tty**[=*false*]] [**--lxc-conf**=*options*] -[**-n**|**--networking**[=*true*]] -[**-v**|**--volume**=*volume*] [**--volumes-from**=*container-id*] -[**-w**|**--workdir**=*directory*] [**--sig-proxy**[=*true*]] -IMAGE [COMMAND] [ARG...] +[**--link**[=*[]*]] +[**--lxc-conf**[=*[]*]] +[**-m**|**--memory**[=*MEMORY*]] +[**--name**[=*NAME*]] +[**--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 @@ -56,6 +70,8 @@ run**. **--cidfile**=*file* Write the container ID to the file specified. +**--cpuset**="" + CPUs in which to allow execution (0-3, 0,1) **-d**, **-detach**=*true*|*false* 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 stopping the process by pressing the keys CTRL-P CTRL-Q. +**--dns-search**=[] + Set custom dns search domains **--dns**=*IP-address* 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 at runtime by using a **--entrypoint** and a string to specify the new ENTRYPOINT. +**--env-file**=[] + Read in a line delimited file of ENV variables **--expose**=*port* 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 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* Sets the container host name that is available inside the container. - **-i**, **-interactive**=*true*|*false* When set to true, keep stdin open even if not attached. The default is false. - **--link**=*name*:*alias* Add link to another container. The format is name:alias. If the operator 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 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* - By default, all containers have networking enabled (true) and can make -outgoing connections. The operator can disable networking with **--networking** -to false. This disables all incoming and outgoing networking. In cases like this -, I/O can only be performed through files or by using STDIN/STDOUT. - -Also by default, the container will use the same DNS servers as the host. The -operator may override this with **-dns**. - +**-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. **--name**=*name* 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 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* Give extended privileges to this container. By default, Docker containers are @@ -355,4 +369,9 @@ changes will also be reflected on the host in /var/db. # HISTORY April 2014, Originally compiled by William Henry (whenry at redhat dot com) +<<<<<<< HEAD based on docker.io source material and internal work. +June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> +======= +based on docker.com source material and internal work. +>>>>>>> 834ef8a... I'm going to wish I didn't do this diff --git a/docs/man/docker-save.1.md b/docs/man/docker-save.1.md index 126af6b154..403c3fb614 100644 --- a/docs/man/docker-save.1.md +++ b/docs/man/docker-save.1.md @@ -1,11 +1,13 @@ % DOCKER(1) Docker User Manuals -% William Henry -% APRIL 2014 +% Docker Community +% JUNE 2014 # NAME docker-save - Save an image to a tar archive (streamed to STDOUT by default) # SYNOPSIS -**docker save** [**-o**|**--output**=""] IMAGE +**docker save** +[**-o**|**--output**[=*OUTPUT*]] +IMAGE # DESCRIPTION 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**="" Write to an file, instead of STDOUT -# EXAMPLE +# EXAMPLES Save all fedora repository images to a fedora-all.tar and save the latest fedora image to a fedora-latest.tar: @@ -31,5 +33,10 @@ fedora image to a fedora-latest.tar: # HISTORY April 2014, Originally compiled by William Henry (whenry at redhat dot com) +<<<<<<< HEAD based on docker.io source material and internal work. +June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> +======= +based on docker.com source material and internal work. +>>>>>>> 834ef8a... I'm going to wish I didn't do this diff --git a/docs/man/docker-search.1.md b/docs/man/docker-search.1.md index 945dd34e59..061042c7ac 100644 --- a/docs/man/docker-search.1.md +++ b/docs/man/docker-search.1.md @@ -1,12 +1,15 @@ % DOCKER(1) Docker User Manuals -% William Henry -% APRIL 2014 +% Docker Community +% JUNE 2014 # NAME -docker-search - Search the docker index for images +docker-search - Search the Docker Hub for images # SYNOPSIS -**docker search** **--no-trunc**[=*false*] **--automated**[=*false*] - **-s**|**--stars**[=*0*] TERM +**docker search** +[**--automated**[=*false*]] +[**--no-trunc**[=*false*]] +[**-s**|**--stars**[=*0*]] +TERM # DESCRIPTION @@ -16,17 +19,16 @@ number of stars awarded, whether the image is official, and whether it is automated. # OPTIONS -**--no-trunc**=*true*|*false* - When true display the complete description. The default is false. +**--automated**=*true*|*false* + Only show automated builds. The default is *false*. -**-s**, **--stars**=NUM - Only displays with at least NUM (integer) stars. I.e. only those images -ranked >=NUM. +**--no-trunc**=*true*|*false* + Don't truncate output. The default is *false*. -**--automated**=*true*|*false* - When true only show automated builds. The default is false. +**-s**, **--stars**=0 + Only displays with at least x stars -# EXAMPLE +# EXAMPLES ## Search the registry for ranked images @@ -52,4 +54,9 @@ ranked 1 or higher: # HISTORY April 2014, Originally compiled by William Henry (whenry at redhat dot com) +<<<<<<< HEAD based on docker.io source material and internal work. +June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> +======= +based on docker.com source material and internal work. +>>>>>>> 834ef8a... I'm going to wish I didn't do this diff --git a/docs/man/docker-start.1.md b/docs/man/docker-start.1.md index 2815f1b07f..ed9f77b43e 100644 --- a/docs/man/docker-start.1.md +++ b/docs/man/docker-start.1.md @@ -1,29 +1,31 @@ % DOCKER(1) Docker User Manuals -% William Henry -% APRIL 2014 +% Docker Community +% JUNE 2014 # NAME docker-start - Restart a stopped container # SYNOPSIS -**docker start** [**a**|**--attach**[=*false*]] [**-i**|**--interactive** -[=*true*] CONTAINER [CONTAINER...] +**docker start** +[**-a**|**--attach**[=*false*]] +[**-i**|**--interactive**[=*false*]] +CONTAINER [CONTAINER...] # DESCRIPTION Start a stopped container. -# OPTION +# OPTIONS **-a**, **--attach**=*true*|*false* - When true attach to container's stdout/stderr and forward all signals to -the process + Attach container's STDOUT and STDERR and forward all signals to the process. The default is *false*. **-i**, **--interactive**=*true*|*false* - When true attach to container's stdin - -# NOTES -If run on a started container, start takes no action and succeeds -unconditionally. + Attach container's STDIN. The default is *false*. # HISTORY April 2014, Originally compiled by William Henry (whenry at redhat dot com) +<<<<<<< HEAD based on docker.io source material and internal work. +June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> +======= +based on docker.com source material and internal work. +>>>>>>> 834ef8a... I'm going to wish I didn't do this diff --git a/docs/man/docker-stop.1.md b/docs/man/docker-stop.1.md index 6ec81cd472..14bd7b30e6 100644 --- a/docs/man/docker-stop.1.md +++ b/docs/man/docker-stop.1.md @@ -1,22 +1,27 @@ % DOCKER(1) Docker User Manuals -% William Henry -% APRIL 2014 +% Docker Community +% JUNE 2014 # NAME -docker-stop - Stop a running container - grace period) +docker-stop - Stop a running container by sending SIGTERM and then SIGKILL after a grace period # SYNOPSIS -**docker stop** [**-t**|**--time**[=*10*]] CONTAINER [CONTAINER...] +**docker stop** +[**-t**|**--time**[=*10*]] + CONTAINER [CONTAINER...] # DESCRIPTION Stop a running container (Send SIGTERM, and then SIGKILL after grace period) # OPTIONS -**-t**, **--time**=NUM - Wait NUM number of seconds for the container to stop before killing it. -The default is 10 seconds. +**-t**, **--time**=10 + Number of seconds to wait for the container to stop before killing it. Default is 10 seconds. # HISTORY April 2014, Originally compiled by William Henry (whenry at redhat dot com) +<<<<<<< HEAD based on docker.io source material and internal work. +June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> +======= +based on docker.com source material and internal work. +>>>>>>> 834ef8a... I'm going to wish I didn't do this diff --git a/docs/man/docker-tag.1.md b/docs/man/docker-tag.1.md index 01b5b9137c..aae222085f 100644 --- a/docs/man/docker-tag.1.md +++ b/docs/man/docker-tag.1.md @@ -1,12 +1,13 @@ % DOCKER(1) Docker User Manuals -% William Henry -% APRIL 2014 +% Docker Community +% JUNE 2014 # NAME -docker-tag - Tag an image in the repository +docker-tag - Tag an image into a repository # SYNOPSIS -**docker tag** [**-f**|**--force**[=*false*] -IMAGE [REGISTRYHOST/][USERNAME/]NAME[:TAG] +**docker tag** +[**-f**|**--force**[=*false*]] + IMAGE [REGISTRYHOST/][USERNAME/]NAME[:TAG] # DESCRIPTION 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. Note that here TAG is a part of the overall name or "tag". +# OPTIONS +**-f**, **--force**=*true*|*false* + Force. The default is *false*. + # EXAMPLES ## Giving an image a new alias @@ -49,4 +54,9 @@ registry you must tag it with the registry hostname and port (if needed). # HISTORY April 2014, Originally compiled by William Henry (whenry at redhat dot com) +<<<<<<< HEAD based on docker.io source material and internal work. +June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> +======= +based on docker.com source material and internal work. +>>>>>>> 834ef8a... I'm going to wish I didn't do this diff --git a/docs/man/docker-top.1.md b/docs/man/docker-top.1.md index 2c00c527a5..5ba44d697d 100644 --- a/docs/man/docker-top.1.md +++ b/docs/man/docker-top.1.md @@ -1,18 +1,22 @@ % DOCKER(1) Docker User Manuals -% William Henry -% APRIL 2014 +% Docker Community +% JUNE 2014 # NAME -docker-top - Lookup the running processes of a container +docker-top - Display the running processes of a container # SYNOPSIS -**docker top** CONTAINER [ps-OPTION] +**docker top** +CONTAINER [ps OPTIONS] # DESCRIPTION Look up the running process of the container. ps-OPTION can be any of the 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: @@ -23,5 +27,10 @@ Run **docker top** with the ps option of -x: # HISTORY April 2014, Originally compiled by William Henry (whenry at redhat dot com) +<<<<<<< HEAD based on docker.io source material and internal work. +June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> +======= +based on docker.com source material and internal work. +>>>>>>> 834ef8a... I'm going to wish I didn't do this diff --git a/docs/man/docker-unpause.1.md b/docs/man/docker-unpause.1.md new file mode 100644 index 0000000000..8949548b67 --- /dev/null +++ b/docs/man/docker-unpause.1.md @@ -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> diff --git a/docs/man/docker-version.1.md b/docs/man/docker-version.1.md new file mode 100644 index 0000000000..9c029b239d --- /dev/null +++ b/docs/man/docker-version.1.md @@ -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> diff --git a/docs/man/docker-wait.1.md b/docs/man/docker-wait.1.md index 6754151f09..cfa19ef861 100644 --- a/docs/man/docker-wait.1.md +++ b/docs/man/docker-wait.1.md @@ -1,16 +1,21 @@ % DOCKER(1) Docker User Manuals -% William Henry -% APRIL 2014 +% Docker Community +% JUNE 2014 # NAME docker-wait - Block until a container stops, then print its exit code. # SYNOPSIS -**docker wait** CONTAINER [CONTAINER...] +**docker wait** +CONTAINER [CONTAINER...] # DESCRIPTION + 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 079b83f558a2bc52ecad6b2a5de13622d584e6bb1aea058c11b36511e85e7622 @@ -19,5 +24,10 @@ Block until a container stops, then print its exit code. # HISTORY April 2014, Originally compiled by William Henry (whenry at redhat dot com) +<<<<<<< HEAD based on docker.io source material and internal work. +June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au> +======= +based on docker.com source material and internal work. +>>>>>>> 834ef8a... I'm going to wish I didn't do this diff --git a/docs/man/docker.1.md b/docs/man/docker.1.md index ae5efff87e..a7a826ed9f 100644 --- a/docs/man/docker.1.md +++ b/docs/man/docker.1.md @@ -127,6 +127,9 @@ inside it) **docker-logs(1)** Fetch the logs of a container +**docker-pause(1)** + Pause all processes within a container + **docker-port(1)** Lookup the public-facing port which is NAT-ed to PRIVATE_PORT @@ -169,7 +172,10 @@ inside it) **docker-top(1)** 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 **docker-wait(1)** @@ -184,4 +190,4 @@ For example: # HISTORY April 2014, Originally compiled by William Henry (whenry at redhat dot com) based - on docker.io source material and internal work. + on docker.com source material and internal work. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 97dc8fc36b..f4ebcb68fe 100755 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -1,5 +1,5 @@ site_name: Docker Documentation -#site_url: http://docs.docker.io/ +#site_url: http://docs.docker.com/ site_url: / site_description: Documentation for fast and lightweight Docker container based virtualization framework. site_favicon: img/favicon.png diff --git a/docs/release.sh b/docs/release.sh index d579a307ba..f6dc2ec59f 100755 --- a/docs/release.sh +++ b/docs/release.sh @@ -9,7 +9,7 @@ To publish the Docker documentation you need to set your access_key and secret_k (with the keys in a [profile $AWS_S3_BUCKET] section - so you can have more than one set of keys in your file) and set the AWS_S3_BUCKET env var to the name of your bucket. -make AWS_S3_BUCKET=beta-docs.docker.io docs-release +make AWS_S3_BUCKET=docs-stage.docker.com docs-release will then push the documentation site to your s3 bucket. EOF diff --git a/docs/sources/articles/security.md b/docs/sources/articles/security.md index 4c39c18a69..dcc61f386c 100644 --- a/docs/sources/articles/security.md +++ b/docs/sources/articles/security.md @@ -5,7 +5,7 @@ page_keywords: Docker, Docker documentation, security # Docker Security > *Adapted from* [Containers & Docker: How Secure are -> They?](http://blog.docker.io/2013/08/containers-docker-how-secure-are-they/) +> They?](http://blog.docker.com/2013/08/containers-docker-how-secure-are-they/) There are three major areas to consider when reviewing Docker security: @@ -251,4 +251,4 @@ with Docker, since everything is provided by the kernel anyway. For more context and especially for comparisons with VMs and other container systems, please also see the [original blog post]( -http://blog.docker.io/2013/08/containers-docker-how-secure-are-they/). +http://blog.docker.com/2013/08/containers-docker-how-secure-are-they/). diff --git a/docs/sources/articles/using_supervisord.md b/docs/sources/articles/using_supervisord.md index fd7c07cabf..91b8976d78 100644 --- a/docs/sources/articles/using_supervisord.md +++ b/docs/sources/articles/using_supervisord.md @@ -27,7 +27,7 @@ Let's start by creating a basic `Dockerfile` for our new image. FROM ubuntu:13.04 - MAINTAINER examples@docker.io + MAINTAINER examples@docker.com RUN echo "deb http://archive.ubuntu.com/ubuntu precise main universe" > /etc/apt/sources.list RUN apt-get update RUN apt-get upgrade -y diff --git a/docs/sources/contributing/devenvironment.md b/docs/sources/contributing/devenvironment.md index 9188031e3f..606f9302fc 100644 --- a/docs/sources/contributing/devenvironment.md +++ b/docs/sources/contributing/devenvironment.md @@ -16,7 +16,7 @@ Docker's build environment itself is a Docker container, so the first step is to install Docker on your system. You can follow the [install instructions most relevant to your -system](https://docs.docker.io/installation/). Make sure you +system](https://docs.docker.com/installation/). Make sure you have a working, up-to-date docker installation, then continue to the next step. diff --git a/docs/sources/examples/postgresql_service.Dockerfile b/docs/sources/examples/postgresql_service.Dockerfile index 219a537882..364a18a81d 100644 --- a/docs/sources/examples/postgresql_service.Dockerfile +++ b/docs/sources/examples/postgresql_service.Dockerfile @@ -1,5 +1,5 @@ # -# example Dockerfile for http://docs.docker.io/en/latest/examples/postgresql_service/ +# example Dockerfile for http://docs.docker.com/examples/postgresql_service/ # FROM ubuntu diff --git a/docs/sources/examples/postgresql_service.md b/docs/sources/examples/postgresql_service.md index b9fae49d99..5265935e3d 100644 --- a/docs/sources/examples/postgresql_service.md +++ b/docs/sources/examples/postgresql_service.md @@ -21,7 +21,7 @@ Start by creating a new `Dockerfile`: > suitably secure. # - # example Dockerfile for http://docs.docker.io/examples/postgresql_service/ + # example Dockerfile for http://docs.docker.com/examples/postgresql_service/ # FROM ubuntu diff --git a/docs/sources/faq.md b/docs/sources/faq.md index 635caac89f..667058c86f 100644 --- a/docs/sources/faq.md +++ b/docs/sources/faq.md @@ -178,13 +178,13 @@ Cloud: ### How do I report a security issue with Docker? You can learn about the project's security policy -[here](https://www.docker.io/security/) and report security issues to +[here](https://www.docker.com/security/) and report security issues to this [mailbox](mailto:security@docker.com). ### Why do I need to sign my commits to Docker with the DCO? Please read [our blog post]( -http://blog.docker.io/2014/01/docker-code-contributions-require-developer-certificate-of-origin/) +http://blog.docker.com/2014/01/docker-code-contributions-require-developer-certificate-of-origin/) on the introduction of the DCO. ### When building an image, should I prefer system libraries or bundled ones? diff --git a/docs/sources/introduction/understanding-docker.md b/docs/sources/introduction/understanding-docker.md index 3a7615ebc8..c79573a635 100644 --- a/docs/sources/introduction/understanding-docker.md +++ b/docs/sources/introduction/understanding-docker.md @@ -112,7 +112,7 @@ Docker images are the **build** component of Docker. #### Docker Registries Docker registries hold images. These are public or private stores from which you upload or download images. The public Docker registry is called -[Docker Hub](http://index.docker.io). It provides a huge collection of existing +[Docker Hub](http://hub.docker.com). It provides a huge collection of existing images for your use. These can be images you create yourself or you can use images that others have previously created. Docker registries are the **distribution** component of Docker. @@ -156,7 +156,7 @@ basis for a new image, for example if you have a base Apache image you could use this as the base of all your web application images. > **Note:** Docker usually gets these base images from -> [Docker Hub](https://index.docker.io). +> [Docker Hub](https://hub.docker.com). > Docker images are then built from these base images using a simple, descriptive set of steps we call *instructions*. Each instruction creates a new layer in our @@ -173,17 +173,17 @@ returns a final image. ### How does a Docker registry work? The Docker registry is the store for your Docker images. Once you build a Docker -image you can *push* it to a public registry [Docker Hub](https://index.docker.io) or to +image you can *push* it to a public registry [Docker Hub](https://hub.docker.com) or to your own registry running behind your firewall. Using the Docker client, you can search for already published images and then pull them down to your Docker host to build containers from them. -[Docker Hub](https://index.docker.io) provides both public and private storage +[Docker Hub](https://hub.docker.com) provides both public and private storage for images. Public storage is searchable and can be downloaded by anyone. Private storage is excluded from search results and only you and your users can pull images down and use them to build containers. You can [sign up for a storage plan -here](https://index.docker.io/plans). +here](https://hub.docker.com/plans). ### How does a container work? A container consists of an operating system, user-added files, and meta-data. As @@ -216,7 +216,7 @@ In order, Docker does the following: - **Pulls the `ubuntu` image:** Docker checks for the presence of the `ubuntu` image and, if it doesn't exist locally on the host, then Docker downloads it from -[Docker Hub](https://index.docker.io). If the image already exists, then Docker +[Docker Hub](https://hub.docker.com). If the image already exists, then Docker uses it for the new container. - **Creates a new container:** Once Docker has the image, it uses it to create a container. diff --git a/docs/sources/reference/commandline/cli.md b/docs/sources/reference/commandline/cli.md index d7f9724231..301593f2f1 100644 --- a/docs/sources/reference/commandline/cli.md +++ b/docs/sources/reference/commandline/cli.md @@ -54,9 +54,9 @@ expect an integer, and they can only be specified once. -b, --bridge="" Attach containers to a pre-existing network bridge use 'none' to disable container networking --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 - --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 -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 @@ -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 -r, --restart=true Restart previously running containers -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 + --storage-opt=[] Set storage driver options --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 --tlscert="/home/sven/.docker/cert.pem" Path to TLS certificate file @@ -134,8 +134,8 @@ like this: Attach to a running container - --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. + --no-stdin=false Do not attach STDIN + --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 interact with any running container, detached (`-d`) @@ -481,7 +481,7 @@ To see how the `docker:latest` image was built: List images -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 -q, --quiet=false Only show numeric IDs @@ -600,6 +600,8 @@ tar, then the ownerships might not get preserved. Usage: docker info + Display system-wide information + For example: $ sudo docker -D info @@ -627,7 +629,7 @@ ensure we know how your setup is configured. 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. @@ -681,7 +683,7 @@ contains complex json object, so to grab it as JSON, you use 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 @@ -718,7 +720,7 @@ Restores both images and tags. 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 -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 - 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 @@ -781,7 +783,7 @@ Running `docker ps` showing 2 linked containers. ## pull - Usage: docker pull [REGISTRY_PATH/]NAME[:TAG] + Usage: docker pull NAME[:TAG] Pull an image or a repository from the registry @@ -824,7 +826,7 @@ registry or to a self-hosted one. 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 @@ -834,7 +836,7 @@ registry or to a self-hosted one. -f, --force=false Force removal of running 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) @@ -870,7 +872,7 @@ delete them. Any running containers will not be deleted. 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 ### Removing tagged images @@ -910,6 +912,7 @@ removed before the image is removed. -a, --attach=[] Attach to stdin, stdout or stderr. -c, --cpu-shares=0 CPU shares (relative weight) --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 --dns=[] Set custom dns servers --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 'none': no networking for this container '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 format: ip:hostPort:containerPort | ip::containerPort | hostPort:containerPort (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 --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. @@ -1150,7 +1153,7 @@ application change: 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 @@ -1175,11 +1178,11 @@ Search [Docker Hub](https://hub.docker.com) for images 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*]( /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 - -a, --attach=false Attach container's stdout/stderr and forward all signals to the process - -i, --interactive=false Attach container's stdin + -a, --attach=false Attach container's STDOUT and STDERR and forward all signals to the process + -i, --interactive=false Attach container's STDIN When run on a container that has already been started, takes no action and succeeds unconditionally. @@ -1201,9 +1204,9 @@ takes no action and succeeds unconditionally. 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 grace period, SIGKILL @@ -1224,13 +1227,13 @@ them to [*Share Images via Repositories*]( Usage: docker top CONTAINER [ps OPTIONS] - Lookup the running processes of a container + Display the running processes of a container ## 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 both Docker client and daemon. @@ -1240,3 +1243,4 @@ both Docker client and daemon. Usage: docker wait CONTAINER [CONTAINER...] Block until a container stops, then print its exit code. + diff --git a/docs/sources/reference/run.md b/docs/sources/reference/run.md index 37dba587b6..a539ab0d18 100644 --- a/docs/sources/reference/run.md +++ b/docs/sources/reference/run.md @@ -240,7 +240,7 @@ to access to all devices on the host as well as set some configuration in AppArmor to allow the container nearly all the same access to the host as processes running outside containers on the host. Additional information about running with `--privileged` is available on the -[Docker Blog](http://blog.docker.io/2013/09/docker-can-now-run-within-docker/). +[Docker Blog](http://blog.docker.com/2013/09/docker-can-now-run-within-docker/). If the Docker daemon was started using the `lxc` exec-driver (`docker -d --exec-driver=lxc`) then the operator can also specify LXC options diff --git a/docs/sources/userguide/index.md b/docs/sources/userguide/index.md index e5c9ec272a..eef59c000b 100644 --- a/docs/sources/userguide/index.md +++ b/docs/sources/userguide/index.md @@ -82,11 +82,11 @@ Go to [Working with Docker Hub](/userguide/dockerrepos). ## Getting help -* [Docker homepage](http://www.docker.io/) +* [Docker homepage](http://www.docker.com/) * [Docker Hub](https://hub.docker.com) -* [Docker blog](http://blog.docker.io/) -* [Docker documentation](http://docs.docker.io/) -* [Docker Getting Started Guide](http://www.docker.io/gettingstarted/) +* [Docker blog](http://blog.docker.com/) +* [Docker documentation](http://docs.docker.com/) +* [Docker Getting Started Guide](http://www.docker.com/gettingstarted/) * [Docker code on GitHub](https://github.com/dotcloud/docker) * [Docker mailing list](https://groups.google.com/forum/#!forum/docker-user) diff --git a/docs/sources/userguide/usingdocker.md b/docs/sources/userguide/usingdocker.md index 7080e3ed43..857eac5e56 100644 --- a/docs/sources/userguide/usingdocker.md +++ b/docs/sources/userguide/usingdocker.md @@ -19,7 +19,7 @@ In the process we learned about several Docker commands: > **Tip:** > Another way to learn about `docker` commands is our -> [interactive tutorial](https://www.docker.io/gettingstarted). +> [interactive tutorial](https://www.docker.com/tryit/). The `docker` client is pretty simple. Each action you can take with Docker is a command and each command can take a series of diff --git a/docs/theme/mkdocs/css/main.css b/docs/theme/mkdocs/css/main.css index 42a7a18a56..18e65ebd3f 100644 --- a/docs/theme/mkdocs/css/main.css +++ b/docs/theme/mkdocs/css/main.css @@ -4,7 +4,7 @@ Core Docker style file used on - www.docker.io + www.docker.com docker-index ****************************** */ /* this is about 10% darker, but slightly different */ @@ -2146,4 +2146,4 @@ a:hover { background: url("../img/homepage/docker-whale-home-logo+@2x.png"); background-size: 459px 261px; } -}
\ No newline at end of file +} diff --git a/hack/RELEASE-CHECKLIST.md b/hack/RELEASE-CHECKLIST.md index 6d7ed15297..2fe1a3ce96 100644 --- a/hack/RELEASE-CHECKLIST.md +++ b/hack/RELEASE-CHECKLIST.md @@ -138,11 +138,10 @@ make AWS_S3_BUCKET=beta-docs.docker.io docs-release ### 5. Commit and create a pull request to the "release" branch ```bash -export GITHUBUSER="YOUR_GITHUB_USER" git add VERSION CHANGELOG.md git commit -m "Bump version to $VERSION" git push $GITHUBUSER bump_$VERSION -echo "https://github.com/$GITHUBUSER/docker/compare/dotcloud:master...$GITHUBUSER:bump_$VERSION?expand=1" +echo "https://github.com/$GITHUBUSER/docker/compare/dotcloud:release...$GITHUBUSER:bump_$VERSION?expand=1" ``` That last command will give you the proper link to visit to ensure that you @@ -3,7 +3,7 @@ set -e # DinD: a wrapper script which allows docker to be run inside a docker container. # Original version by Jerome Petazzoni <jerome@dotcloud.com> -# See the blog post: http://blog.docker.io/2013/09/docker-can-now-run-within-docker/ +# See the blog post: http://blog.docker.com/2013/09/docker-can-now-run-within-docker/ # # This script should be executed inside a docker container in privilieged mode # ('docker run --privileged', introduced in docker 0.6). diff --git a/hack/infrastructure/README.md b/hack/infrastructure/README.md index 9b2ffda956..d12fc4c63e 100644 --- a/hack/infrastructure/README.md +++ b/hack/infrastructure/README.md @@ -20,7 +20,7 @@ AWS | packages (S3 bucket), dotCloud PAAS, dev-env, ci CloudFlare | cdn Digital Ocean | ci dotCloud PAAS | website, index, registry, ssl, blog -DynECT | dns (docker.io) +DynECT | dns (docker.com) GitHub | repository Linode | stackbrew Mailgun | outgoing e-mail @@ -36,20 +36,19 @@ and which service is handling them. URL | Service ---------------------------------------------|--------------------------------- - http://blog.docker.io/ | blog + http://blog.docker.com/ | blog *http://cdn-registry-1.docker.io/ | registry (pull) http://debug.docker.io/ | debug tool - http://docs.docker.io/ | docsproxy (proxy to readthedocs) + http://docs.docker.com/ | documentation served from an S3 bucket http://docker-ci.dotcloud.com/ | ci - http://docker.io/ | redirect to www.docker.io (dynect) - http://docker.readthedocs.org/ | docs + http://docker.com/ | redirect to www.docker.com (dynect) *http://get.docker.io/ | packages https://github.com/dotcloud/docker | repository -*https://index.docker.io/ | index +*https://hub.docker.com/ | Docker Hub http://registry-1.docker.io/ | registry (push) http://staging-docker-ci.dotcloud.com/ | ci *http://test.docker.io/ | packages -*http://www.docker.io/ | website +*http://www.docker.com/ | website http://? (internal URL, not for public use) | stackbrew *Ordered-by: lexicographic* diff --git a/hack/make/ubuntu b/hack/make/ubuntu index c55123fb7a..0d19d7528b 100644 --- a/hack/make/ubuntu +++ b/hack/make/ubuntu @@ -8,8 +8,8 @@ if [ -n "$(git status --porcelain)" ]; then fi PACKAGE_ARCHITECTURE="$(dpkg-architecture -qDEB_HOST_ARCH)" -PACKAGE_URL="http://www.docker.io/" -PACKAGE_MAINTAINER="docker@dotcloud.com" +PACKAGE_URL="http://www.docker.com/" +PACKAGE_MAINTAINER="support@docker.com" PACKAGE_DESCRIPTION="Linux container runtime Docker complements LXC with a high-level API which operates at the process level. It runs unix processes with strong guarantees of isolation and diff --git a/runconfig/parse.go b/runconfig/parse.go index 2f2ca9b163..dfd9f4ddd3 100644 --- a/runconfig/parse.go +++ b/runconfig/parse.go @@ -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(&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(&flEnv, []string{"e", "-env"}, "Set environment variables") cmd.Var(&flEnvFile, []string{"-env-file"}, "Read in a line delimited file of ENV variables") |