Przeglądaj źródła

add 'docker create' man page

Docker-DCO-1.1-Signed-off-by: SvenDowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
SvenDowideit 11 lat temu
rodzic
commit
22eb3a3a50
2 zmienionych plików z 134 dodań i 1 usunięć
  1. 131 0
      docs/man/docker-create.1.md
  2. 3 1
      docs/man/docker.1.md

+ 131 - 0
docs/man/docker-create.1.md

@@ -0,0 +1,131 @@
+% DOCKER(1) Docker User Manuals
+% Docker Community
+% JUNE 2014
+# NAME
+docker-create - Create a new container
+
+# SYNOPSIS
+**docker create**
+[**-a**|**--attach**[=*[]*]]
+[**-c**|**--cpu-shares**[=*0*]]
+[**--cap-add**[=*[]*]]
+[**--cap-drop**[=*[]*]]
+[**--cidfile**[=*CIDFILE*]]
+[**--cpuset**[=*CPUSET*]]
+[**--device**[=*[]*]]
+[**--dns-search**[=*[]*]]
+[**--dns**[=*[]*]]
+[**-e**|**--env**[=*[]*]]
+[**--entrypoint**[=*ENTRYPOINT*]]
+[**--env-file**[=*[]*]]
+[**--expose**[=*[]*]]
+[**-h**|**--hostname**[=*HOSTNAME*]]
+[**-i**|**--interactive**[=*false*]]
+[**--link**[=*[]*]]
+[**--lxc-conf**[=*[]*]]
+[**-m**|**--memory**[=*MEMORY*]]
+[**--name**[=*NAME*]]
+[**--net**[=*"bridge"*]]
+[**-P**|**--publish-all**[=*false*]]
+[**-p**|**--publish**[=*[]*]]
+[**--privileged**[=*false*]]
+[**-t**|**--tty**[=*false*]]
+[**-u**|**--user**[=*USER*]]
+[**-v**|**--volume**[=*[]*]]
+[**--volumes-from**[=*[]*]]
+[**-w**|**--workdir**[=*WORKDIR*]]
+ IMAGE [COMMAND] [ARG...]
+
+# OPTIONS
+**-a**, **--attach**=[]
+   Attach to STDIN, STDOUT or STDERR.
+
+**-c**, **--cpu-shares**=0
+   CPU shares (relative weight)
+
+**--cap-add**=[]
+   Add Linux capabilities
+
+**--cap-drop**=[]
+   Drop Linux capabilities
+
+**--cidfile**=""
+   Write the container ID to the file
+
+**--cpuset**=""
+   CPUs in which to allow execution (0-3, 0,1)
+
+**--device**=[]
+   Add a host device to the container (e.g. --device=/dev/sdc:/dev/xvdc)
+
+**--dns-search**=[]
+   Set custom DNS search domains
+
+**--dns**=[]
+   Set custom DNS servers
+
+**-e**, **--env**=[]
+   Set environment variables
+
+**--entrypoint**=""
+   Overwrite the default ENTRYPOINT of the image
+
+**--env-file**=[]
+   Read in a line delimited file of environment variables
+
+**--expose**=[]
+   Expose a port from the container without publishing it to your host
+
+**-h**, **--hostname**=""
+   Container host name
+
+**-i**, **--interactive**=*true*|*false*
+   Keep STDIN open even if not attached. The default is *false*.
+
+**--link**=[]
+   Add link to another container in the form of name:alias
+
+**--lxc-conf**=[]
+   (lxc exec-driver only) Add custom lxc options --lxc-conf="lxc.cgroup.cpuset.cpus = 0,1"
+
+**-m**, **--memory**=""
+   Memory limit (format: <number><optional unit>, where unit = b, k, m or g)
+
+**--name**=""
+   Assign a name to the container
+
+**--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*
+   Publish all exposed ports to the host interfaces. The default is *false*.
+
+**-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. The default is *false*.
+
+**-t**, **--tty**=*true*|*false*
+   Allocate a pseudo-TTY. The default is *false*.
+
+**-u**, **--user**=""
+   Username or UID
+
+**-v**, **--volume**=[]
+   Bind mount a volume (e.g., from the host: -v /host:/container, from Docker: -v /container)
+
+**--volumes-from**=[]
+   Mount volumes from the specified container(s)
+
+**-w**, **--workdir**=""
+   Working directory inside the container
+
+# HISTORY
+August 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>

+ 3 - 1
docs/man/docker.1.md

@@ -89,10 +89,12 @@ unix://[/path/to/socket] to use.
 **docker-cp(1)**
   Copy files/folders from a container's filesystem to the host at path
 
+**docker-create(1)**
+  Create a new container
+
 **docker-diff(1)**
   Inspect changes on a container's filesystem
 
-
 **docker-events(1)**
   Get real time events from the server