aboutsummaryrefslogtreecommitdiffstats
path: root/Library/Homebrew/cmd/help.rb
diff options
context:
space:
mode:
authorMartin Afanasjew2016-04-19 03:17:45 +0200
committerMartin Afanasjew2016-04-20 13:45:26 +0200
commit4f8e3cae5e05c05b3681b3afd2f7ac480c522eb1 (patch)
treebc707bca1ad8586c6058d5e5c06b403c4a99c9ee /Library/Homebrew/cmd/help.rb
parent312fdaa892bce745f909215f81f3257d170c0f5a (diff)
downloadbrew-4f8e3cae5e05c05b3681b3afd2f7ac480c522eb1.tar.bz2
help: improve styling of generic help text
Format the usage examples more consistently (particularly parentheses instead of square brackets where one of several alternatives has to be picked). And add the now much more useful `brew help <command>`. Closes #113. Signed-off-by: Martin Afanasjew <martin@afanasjew.de>
Diffstat (limited to 'Library/Homebrew/cmd/help.rb')
-rw-r--r--Library/Homebrew/cmd/help.rb9
1 files changed, 5 insertions, 4 deletions
diff --git a/Library/Homebrew/cmd/help.rb b/Library/Homebrew/cmd/help.rb
index 7b7919e80..f8524121c 100644
--- a/Library/Homebrew/cmd/help.rb
+++ b/Library/Homebrew/cmd/help.rb
@@ -1,18 +1,18 @@
HOMEBREW_HELP = <<-EOS
Example usage:
- brew [info | home | options ] [FORMULA...]
+ brew (info|home|options) [FORMULA...]
brew install FORMULA...
brew uninstall FORMULA...
- brew search [foo]
+ brew search [TEXT|/PATTERN/]
brew list [FORMULA...]
brew update
brew upgrade [FORMULA...]
- brew pin/unpin [FORMULA...]
+ brew (pin|unpin) [FORMULA...]
Troubleshooting:
brew doctor
brew install -vd FORMULA
- brew [--env | config]
+ brew (--env|config)
Brewing:
brew create [URL [--no-fetch]]
@@ -21,6 +21,7 @@ Brewing:
Further help:
man brew
+ brew help [COMMAND]
brew home
EOS