15 Commits

Author SHA1 Message Date
Xu Cheng
af1eb007e2 help: handle alias
Before this fix
```
$ brew --help ls
Error: Unknown command: ls
```

After this fix
```
$ brew --help ls
brew list, ls
<snip>
```
2016-04-12 14:29:49 +08:00
Max Nordlund
b21f699ff2 Implement the brew help command
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-10 22:59:24 +02:00
Mike McQuaid
276a797d37 Update documentation after repository split. 2016-04-03 14:03:33 +01:00
Xu Cheng
8fecd4c198 help: remove obsoleted argument 2015-08-07 19:36:29 +08:00
BrewTestBot
13d544e11e Core files style updates.
Closes Homebrew/homebrew#42354.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-08-03 13:22:35 +01:00
Jack Nagel
621a7ada95 Remove reference to "open" command
Closes Homebrew/homebrew#40706.
2015-06-15 20:08:46 -04:00
Xu Cheng
1f7c4ee644 replace brew upgrade with brew upgrade --all. 2015-05-06 16:19:07 +08:00
Mike McQuaid
19d12aee45 Import docs from wiki.
Closes Homebrew/homebrew#33211.
2014-10-26 14:57:36 +00:00
Jack Nagel
10a1952d2c Only "extend self" once on the Homebrew module 2014-06-19 13:10:36 -05:00
Adam Vandenberg
d4b0599a86 --config -> config 2014-04-30 19:09:29 -07:00
Mike McQuaid
d7c13f84b6 Update string references to mxcl/homebrew. 2013-12-14 18:18:35 +00:00
Stan
4d086e8394 add pin/unpin to help
Closes Homebrew/homebrew#23267.

Signed-off-by: Adam Vandenberg <flangy@gmail.com>
2013-10-16 06:08:19 -07:00
Charlie Sharpsteen
1fbc32d842 brew-help: Add options to example usage
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.
2013-01-30 09:31:42 -08:00
Max Howell
19e387d92e brew upgrade
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-08-24 22:30:43 +01:00
Max Howell
ec9cbc6466 Optimise/simplify brew help
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.
2011-03-13 12:54:30 +00:00