From 5e3a1a7b218fe38cea0c66fce02048169cc80c2b Mon Sep 17 00:00:00 2001 From: Peter Aronoff Date: Sun, 14 Jun 2015 14:34:31 +0100 Subject: Update tap documentation. Closes Homebrew/homebrew#40481. Signed-off-by: Mike McQuaid --- Library/Homebrew/manpages/brew.1.md | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) (limited to 'Library') diff --git a/Library/Homebrew/manpages/brew.1.md b/Library/Homebrew/manpages/brew.1.md index 553e24619..6414511e9 100644 --- a/Library/Homebrew/manpages/brew.1.md +++ b/Library/Homebrew/manpages/brew.1.md @@ -345,12 +345,24 @@ Note that these flags should only appear after a command. * `switch` : Symlink all of the specific of 's install to Homebrew prefix. - * `tap` [--full] []: - Tap a new formula repository from GitHub, or list existing taps. + * `tap` [--full] [] []: + Tap a formula repository or list existing taps. This command can be invoked + in three ways. - is of the form /, e.g. `brew tap homebrew/dupes`. + + `tap` without arguments displays existing taps. - If `--full` is passed, a full clone will be used. + + `tap ` taps a formula repository from GitHub using HTTPS. + Since so many taps are hosted on GitHub, this command is a shortcut for + `tap user/repo https://github.com/#{user}/homebrew-#{repo}`. + + + `tap ` taps a formula repository from anywhere, using + any transport protocol that `git` handles. The one-argument form of `tap` + simplifies but also limits. This two-argument command makes no + assumptions, so taps can be cloned from places other than GitHub and + using protocols other than HTTPS, e.g. SSH, GIT, HTTP(S), FTP(S), RSYNC. + + By default, the repository is cloned as a shallow copy (`--depth=1`), but + if `--full` is passed, a full clone will be used. * `tap --repair`: Migrate tapped formulae from symlink-based to directory-based structure. -- cgit v1.2.3