From 2406a3936aa88ed6732eb0c66089bbe8c9df25de Mon Sep 17 00:00:00 2001 From: Harald Albers Date: Thu, 25 Dec 2014 11:16:45 +0100 Subject: [PATCH] Documentation for bash completion Signed-off-by: Harald Albers --- docs/completion.md | 33 +++++++++++++++++++++++++++++++++ docs/install.md | 2 ++ 2 files changed, 35 insertions(+) create mode 100644 docs/completion.md diff --git a/docs/completion.md b/docs/completion.md new file mode 100644 index 0000000000..ec8d7766af --- /dev/null +++ b/docs/completion.md @@ -0,0 +1,33 @@ +--- +layout: default +title: Command Completion +--- + +Command Completion +================== + +Fig comes with [command completion](http://en.wikipedia.org/wiki/Command-line_completion) +for the bash shell. + +Installing Command Completion +----------------------------- + +Make sure bash completion is installed. If you use a current Linux in a non-minimal installation, bash completion should be available. +On a Mac, install with `brew install bash-completion` + +Place the completion script in `/etc/bash_completion.d/` (`/usr/local/etc/bash_completion.d/` on a Mac), using e.g. + + curl -L https://raw.githubusercontent.com/docker/fig/master/contrib/completion/bash/fig > /etc/bash_completion.d/fig + +Completion will be available upon next login. + +Available completions +--------------------- +Depending on what you typed on the command line so far, it will complete + + - available fig commands + - options that are available for a particular command + - service names that make sense in a given context (e.g. services with running or stopped instances or services based on images vs. services based on Dockerfiles). For `fig scale`, completed service names will automatically have "=" appended. + - arguments for selected options, e.g. `fig kill -s` will complete some signals like SIGHUP and SIGUSR1. + +Enjoy working with fig faster and with less typos! diff --git a/docs/install.md b/docs/install.md index 14fd64c8c5..c91c3db0d9 100644 --- a/docs/install.md +++ b/docs/install.md @@ -20,6 +20,8 @@ Next, install Fig: curl -L https://github.com/docker/fig/releases/download/1.0.1/fig-`uname -s`-`uname -m` > /usr/local/bin/fig; chmod +x /usr/local/bin/fig +Optionally, install [command completion](completion.html) for the bash shell. + Releases are available for OS X and 64-bit Linux. Fig is also available as a Python package if you're on another platform (or if you prefer that sort of thing): $ sudo pip install -U fig