aboutsummaryrefslogtreecommitdiffstats
path: root/Library/Homebrew/cmd/help.rb
AgeCommit message (Collapse)Author
2018-02-22Use more docs.brew.sh short linksMike McQuaid
These are nicer on the eyes.
2017-10-18Use “squiggly” heredocs.Markus Reiter
2017-07-27Use https for all docs.brew.sh links.Mike McQuaid
May as well use the more secure link when possible.
2017-05-29Fixup all RuboCop warnings.Mike McQuaid
2017-01-04Use docs.brew.sh links.Mike McQuaid
2016-10-04Merge pull request #1145 from reitermarkus/module-functionMarkus Reiter
Use `module_function` for `Homebrew` module.
2016-10-02Merge pull request #1205 from MikeMcQuaid/help-external-commandsMike McQuaid
help: support `#:` help in external commands.
2016-10-02Remove `private_class_method` from commands.Markus Reiter
2016-10-02Use `module_function` for commands.Markus Reiter
2016-10-01Use Formatter for all URLs.Markus Reiter
2016-10-01Refactor Tty.Markus Reiter
2016-10-01help: support `#:` help in external commands.Mike McQuaid
Fixes https://github.com/Homebrew/homebrew-test-bot/issues/3
2016-09-20Update documentation links.Mike McQuaid
2016-09-11cmd/help: fix Rubocop warnings.Mike McQuaid
2016-09-08help: rename help section for developers.Mike McQuaid
2016-09-08help: use Commands module.Mike McQuaid
2016-09-08cmd/*: don't restrict dev-cmd to Homebrew developers.Mike McQuaid
2016-06-29Add magic token to hide commands from man pageTim D. Smith
Closes #402.
2016-05-05Reorder usage examples for brew helpMartin Afanasjew
- Reorder listed commands to better reflect a typical workflow (search, then query for details via `info` and friends, then install, later update and upgrade, at last maybe uninstall). - Remove niche `pin` and `unpin` commands. - Drop `--env` in the Troubleshooting section. And use `/REGEX/` instead of `/PATTERN/` to be clearer what is expected. Closes #177. Signed-off-by: Martin Afanasjew <martin@afanasjew.de>
2016-04-20help: show command-specific help for invalid usageMartin Afanasjew
Instead of always printing the generic help text, print command-specific help if it is available and a command raised the `UsageError` exception. Put the error message underneath the help text (was above) to avoid that it scrolls off the screen. Thereby fix a regression where handling the invalid usage would fail to access `ARGV.usage` removed in c6536066dc39da653d265640c6ba6046bb5def98.
2016-04-20help: refactor (again) and fix code style issuesMartin Afanasjew
Turns out making `empty_argv` a boolean argument for `Homebrew.help` was not the best idea and having command-to-path mapping and help extraction in a single method is not flexible enough. Also only complain about missing help text when `HOMEBREW_DEVELOPER=1` and otherwise just print the generic help text.
2016-04-20help: improve styling of generic help textMartin Afanasjew
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>
2016-04-18ARGV: remove unused 'usage' methodMartin Afanasjew
Also remove related helper method `Homebrew.help_s`.
2016-04-18help: handle help output (move from 'brew.rb')Martin Afanasjew
Keep the footprint of `brew.rb` small. Handle fetching/displaying an appropriate help text (taking into account various external conditions) in the `help` command.
2016-04-12help: support highlighted outputXu Cheng
Closes #68. Signed-off-by: Xu Cheng <xucheng@me.com>
2016-04-12help: handle aliasXu Cheng
Before this fix ``` $ brew --help ls Error: Unknown command: ls ``` After this fix ``` $ brew --help ls brew list, ls <snip> ```
2016-04-10Implement the `brew help` commandMax Nordlund
This is also used by `brew <cmd> --help`. The basic idea is to have the documentation as a top level comment in each command file. To find these comments, they have to be like this `#:`. This is also used by the `brew man` command to keep the documentation DRY, and for that there are now a header and footer for the man page.
2016-04-03Update documentation after repository split.Mike McQuaid
2015-08-07help: remove obsoleted argumentXu Cheng
2015-08-03Core files style updates.BrewTestBot
Closes Homebrew/homebrew#42354. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-06-15Remove reference to "open" commandJack Nagel
Closes Homebrew/homebrew#40706.
2015-05-06replace `brew upgrade` with `brew upgrade --all`.Xu Cheng
2014-10-26Import docs from wiki.Mike McQuaid
Closes Homebrew/homebrew#33211.
2014-06-19Only "extend self" once on the Homebrew moduleJack Nagel
2014-04-30--config -> configAdam Vandenberg
2013-12-14Update string references to mxcl/homebrew.Mike McQuaid
2013-10-16add pin/unpin to helpStan
Closes Homebrew/homebrew#23267. Signed-off-by: Adam Vandenberg <flangy@gmail.com>
2013-01-30brew-help: Add options to example usageCharlie Sharpsteen
Also, move the line containing `info`, `home` and `options` to the top of the list as users should be running these before installation. Ref. Homebrew/homebrew#13224.
2011-08-24`brew upgrade`Max Howell
Consequence: you can no longer install when something is already installed, you must upgrade it. This doesn't apply if the formula in question was unlinked. You can still --force installs though. Rationale: the old way of installing over the top would leave symlinks to multiple versions in /usr/local if the old version had a file the newer version didn't. The new upgrade command handles everything properly.
2011-03-13Optimise/simplify `brew help`Max Howell
Be more useful by being more concise. I referenced dozens of other mature commands’ usage to figure out what to do here. Also separated out the help into its own command for consistency.
generated by cgit v1.2.3 (git 2.25.1) at 2025-10-31 20:18:23 +0000