aboutsummaryrefslogtreecommitdiffstats
path: root/Library
diff options
context:
space:
mode:
authorPeter Aronoff2015-06-14 14:34:31 +0100
committerMike McQuaid2015-06-14 14:35:13 +0100
commit5e3a1a7b218fe38cea0c66fce02048169cc80c2b (patch)
treefa4e81e41b9bce7627e486577dab2bc2b674cf41 /Library
parent4564ea899e7d1051c526cac67a96946d14b52f6a (diff)
downloadbrew-5e3a1a7b218fe38cea0c66fce02048169cc80c2b.tar.bz2
Update tap documentation.
Closes Homebrew/homebrew#40481. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
Diffstat (limited to 'Library')
-rw-r--r--Library/Homebrew/manpages/brew.1.md20
1 files changed, 16 insertions, 4 deletions
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` <name> <version>:
Symlink all of the specific <version> of <name>'s install to Homebrew prefix.
- * `tap` [--full] [<tap>]:
- Tap a new formula repository from GitHub, or list existing taps.
+ * `tap` [--full] [<user/repo>] [<URL>]:
+ Tap a formula repository or list existing taps. This command can be invoked
+ in three ways.
- <tap> is of the form <user>/<repo>, e.g. `brew tap homebrew/dupes`.
+ + `tap` without arguments displays existing taps.
- If `--full` is passed, a full clone will be used.
+ + `tap <user/repo>` 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 <user/repo> <URL>` 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.