History

…
..
README.md	…
attach.md	…
build.md	…
checkpoint.md	…
checkpoint_create.md	…
checkpoint_ls.md	…
checkpoint_rm.md	…
commit.md	…
container.md	…
container_attach.md	…
container_commit.md	…
container_cp.md	…
container_create.md	…
container_diff.md	…
container_exec.md	…
container_export.md	…
container_inspect.md	…
container_kill.md	…
container_logs.md	…
container_ls.md	…
container_pause.md	…
container_port.md	…
container_prune.md	…
container_rename.md	…
container_restart.md	…
container_rm.md	…
container_run.md	…
container_start.md	…
container_stats.md	…
container_stop.md	…
container_top.md	…
container_unpause.md	…
container_update.md	…
container_wait.md	…
cp.md	…
create.md	…
deploy.md	…
diff.md	…
docker.md	…
dockerd.md	…
events.md	…
exec.md	…
export.md	…
history.md	…
image.md	…
image_build.md	…
image_history.md	…
image_import.md	…
image_inspect.md	…
image_load.md	…
image_ls.md	…
image_prune.md	…
image_pull.md	…
image_push.md	…
image_rm.md	…
image_save.md	…
image_tag.md	…
images.md	…
import.md	…
info.md	…
inspect.md	…
kill.md	…
load.md	…
login.md	…
logout.md	…
logs.md	…
network.md	…
network_connect.md	…
network_create.md	…
network_disconnect.md	…
network_inspect.md	…
network_ls.md	…
network_prune.md	…
network_rm.md	…
node.md	…
node_demote.md	…
node_inspect.md	…
node_ls.md	…
node_promote.md	…
node_ps.md	…
node_rm.md	…
node_update.md	…
pause.md	…
plugin.md	…
plugin_create.md	…
plugin_disable.md	…
plugin_enable.md	…
plugin_inspect.md	…
plugin_install.md	…
plugin_ls.md	…
plugin_push.md	…
plugin_rm.md	…
plugin_set.md	…
plugin_upgrade.md	…
port.md	…
ps.md	…
pull.md	…
push.md	…
rename.md	…
restart.md	…
rm.md	…
rmi.md	…
run.md	…
save.md	…
search.md	…
secret.md	…
secret_create.md	…
secret_inspect.md	…
secret_ls.md	…
secret_rm.md	…
service.md	…
service_create.md	…
service_inspect.md	…
service_logs.md	…
service_ls.md	…
service_ps.md	…
service_rm.md	…
service_scale.md	…
service_update.md	…
stack.md	…
stack_deploy.md	…
stack_ls.md	…
stack_ps.md	…
stack_rm.md	…
stack_services.md	…
start.md	…
stats.md	…
stop.md	…
swarm.md	…
swarm_init.md	…
swarm_join-token.md	…
swarm_join.md	…
swarm_leave.md	…
swarm_unlock-key.md	…
swarm_unlock.md	…
swarm_update.md	…
system.md	…
system_df.md	…
system_events.md	…
system_info.md	…
system_prune.md	…
tag.md	…
top.md	…
unpause.md	…
update.md	…
version.md	…
volume.md	…
volume_create.md	…
volume_inspect.md	…
volume_ls.md	…
volume_prune.md	…
volume_rm.md	…
wait.md	…

README.md

About these files

The files in this directory are stub files which include the file /_includes/cli.md, which parses YAML files generated from the docker/docker repository. The YAML files are parsed into output files like https://docs.docker.com/engine/reference/commandline/build/.

How the output is generated

The output files are composed from two sources:

The Description and Usage sections comes directly from the CLI source code in that repository.
The Extended Description and Examples sections are pulled into the YAML from the files in https://github.com/moby/moby/tree/master/docs/reference/commandline Specifically, the Markdown inside the ## Description and ## Examples headings are parsed. Please submit corrections to the text in that repository.

Updating the YAML files

The process for generating the YAML files is still in flux. Check with @thajestah or @frenchben. Be sure to generate the YAML files with the correct branch of docker/docker checked out (probably not master).

After generating the YAML files, replace the YAML files in https://github.com/docker/docker.github.io/tree/master/_data/engine-cli with the newly-generated files. Submit a pull request.