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

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.