aboutsummaryrefslogtreecommitdiffstats
path: root/Library/Homebrew/cmd/unlink.rb
diff options
context:
space:
mode:
Diffstat (limited to 'Library/Homebrew/cmd/unlink.rb')
-rw-r--r--Library/Homebrew/cmd/unlink.rb8
1 files changed, 8 insertions, 0 deletions
diff --git a/Library/Homebrew/cmd/unlink.rb b/Library/Homebrew/cmd/unlink.rb
index 8779b2099..adf091709 100644
--- a/Library/Homebrew/cmd/unlink.rb
+++ b/Library/Homebrew/cmd/unlink.rb
@@ -1,3 +1,11 @@
+#: * `unlink` [`--dry-run`] <formula>:
+#: Remove symlinks for <formula> from the Homebrew prefix. This can be useful
+#: for temporarily disabling a formula:
+#: `brew unlink foo && commands && brew link foo`.
+#:
+#: If `--dry-run` or `-n` is passed, Homebrew will list all files which would
+#: be unlinked, but will not actually unlink or delete any files.
+
require "ostruct"
module Homebrew