170 Commits

Author SHA1 Message Date
Adam Vandenberg
070758689b Update HOMEBREW_DEBUG in man page.
Closes Homebrew/homebrew#17344.
2013-04-30 13:46:57 -07:00
Jack Nagel
3c294c9cd6 Document brew --env
Closes Homebrew/homebrew#19083.
2013-04-13 14:18:53 -05:00
Jack Nagel
2ca59ca5bd Document --env=std 2013-04-13 14:17:17 -05:00
Jack Nagel
e0ea3f0090 Document brew link --force 2013-04-13 14:10:08 -05:00
Jack Nagel
a53e8296bc Fix man page formatting 2013-04-09 16:47:00 -05:00
Max Howell
c902190c3b Add brew sh to the manpage 2013-04-09 14:16:10 -04:00
Jack Nagel
36cc8ee361 Document brew deps --installed 2013-04-03 11:24:38 -05:00
Simon Sigurdhsson
f8a88b5f28 brew-pin: prevent selected formulae from upgrade.
* Added `pin` et. al. to manpage.
* Added `brew pin` to `brew.1` * Added `brew unpin` to `brew.1`
* Added `brew list --pinned` to `brew.1`
* Added information about frozen formulae to `brew upgrade` in `brew.1`
* Added `pin` et.al. to completion scripts.
* Unpin formulae when uninstalling them
* Unpin and re-pin formulae when upgrading (avoids stale symlink)

References Homebrew/homebrew#18386.
Closes Homebrew/homebrew#18515.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2013-03-30 19:50:47 +00:00
Matt Torok
5f2f6a35dd Added '--installed' option to deps command.
When deps command is passed this option, it will only show the dependencies
for the installed forumas. This option overrides the '--all' option.

Closes Homebrew/homebrew#18276.

Signed-off-by: Adam Vandenberg <flangy@gmail.com>
2013-03-05 19:43:12 -08:00
Mike McQuaid
4a281cd5cf Rename Library/Contributions/cmds -> cmd. 2013-02-18 10:42:44 +00:00
Adam Vandenberg
456523fc3f Manpage: remove brew install --force.
Closes Homebrew/homebrew#17654.
2013-02-07 16:34:38 -08:00
Mike McQuaid
161b89ddf0 Add SourceForge bottle mirror selection.
Use ENV['HOMEBREW_SOURCEFORGE_MIRROR'].

Closes Homebrew/homebrew#15642.
Closes Homebrew/homebrew#17368.
2013-01-30 21:29:19 -08:00
Mike McQuaid
8ccda70344 Improve the explanation of the verbose flags.
Closes Homebrew/homebrew#17181.
2013-01-29 17:14:11 -08:00
Mike McQuaid
21f1efcba6 We use formulae as the plural of formula. 2013-01-26 13:16:55 +00:00
Mike McQuaid
de8d5cfc92 manpage: remove outdated MD5 references. 2013-01-26 13:02:21 +00:00
Misty De Meo
7f9fbe2636 Document HOMEBREW_NO_EMOJI in manpage 2013-01-19 17:29:09 -06:00
Adam Vandenberg
896f53d78b Document HOMEBREW_BROWSER and BROWSER 2013-01-06 17:33:52 -08:00
Mike McQuaid
f25e7de43b Add --homebrew-developer flag 2013-01-01 16:39:06 +00:00
Adam Vandenberg
5327492482 Update manpage. Fixes Homebrew/homebrew#16206. 2012-11-23 11:48:10 -08:00
Jack Nagel
aaf2a397f0 Document some recently added options 2012-11-13 16:56:49 -06:00
Misty De Meo
447f78c0d2 brew ln --force is now brew ln --overwrite
* Renames --force to --overwrite, freeing up brew ln --force for Homebrew/homebrew#13349
* Changes --dry-run to preview linking by default, rather than
  overwriting. An overwrite dry-run can be simulated via both
  --dry-run --overwrite
* Adds some basic Keg tests
2012-10-20 21:00:46 -05:00
Adam Vandenberg
b104623f43 Honor GIT env var 2012-08-22 09:43:30 -07:00
Max Howell
adccbf893e Document brew tap --repair 2012-08-07 14:24:09 -04:00
Adam Vandenberg
7a7e3b5f7c Make --version/--verbose slightly less confusing. 2012-07-23 14:27:50 -07:00
Misty De Meo
743b5e6feb link: add --force and --dry-run options
`brew link` can now be made to delete any conflicting files using
the --force argument. It also has a --dry-run option, similar to
git clean -n, which will list any files which would be deleted
without touching the filesystem.

Closes Homebrew/homebrew#11811.

Signed-off-by: Misty De Meo <mistydemeo@gmail.com>
2012-07-09 12:01:09 -05:00
Jack Nagel
4360342947 Document how formula arguments can be specified
Closes Homebrew/homebrew#11037.

Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2012-03-25 16:21:13 -05:00
Jack Nagel
8088f6c17b Document brew tap and brew untap
Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2012-03-18 16:04:05 -05:00
Jack Nagel
2852b2836d Clarify install --force
Since 5bddaf2e ("Stop supportinb `brew install --force`), the --force
argument is still useful but only to overcome the blacklist
restrictions. Document this.

Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2012-03-18 16:04:04 -05:00
Mike McQuaid
e33937a1e3 Rename external commands directory from examples.
Fixes Homebrew/homebrew#10829.
2012-03-18 15:34:41 +13:00
Max Howell
158efd8c9a brew cleanup cleans up the download-cache
Manpage updated.

The -s switch is "scrub" and removes downloads for uninstall formula which are downloads for the latest version of that formula still.

Please NOTE cache is NOT cleaned if a formula argument is provided. I couldn't be bothered. Patches welcome :)

Closes Homebrew/homebrew#2923.
2012-03-06 20:28:06 +00:00
Jack Nagel
63c9193bb2 man page: s/folder/directory/g
Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2012-02-24 19:49:48 -06:00
Jack Nagel
86b4d9ac7c Man page grammar
Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2012-02-03 20:19:50 -06:00
Nicolas Despres
d0be4d692b keg: handle the info directory file properly
If HOMEBREW_KEEP_INFO environment variable is set:
 - Do not symlink the info directory file (aka 'share/info/dir')
   otherwise it gets overwritten by next installed brew.
 - Install an entry in the directory for each linked info file when the
   brew is linked.
 - Uninstall the entry when the brew is unlinked.

Closes Homebrew/homebrew#9700.

Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2012-02-01 22:52:14 -06:00
Jack Nagel
f3f04e595d versions: enable '--compact' output
This will be useful for shell tab completion when something like `brew
install <formula> --version <version>` is implemented.

Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2012-01-06 14:51:15 -06:00
Jack Nagel
3b29fbdbba Fix man page formatting error
Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2012-01-05 21:51:19 -06:00
Jack Nagel
0a5592d203 man page: normalize env variable formatting
Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2011-12-16 20:34:31 -06:00
Adam Vandenberg
62e1dd8bd5 Enable 'brew edit' for non-Textmate editors. 2011-12-16 14:27:58 -08:00
Jack Nagel
901406e3a0 Introduce HOMEBREW_CURL_VERBOSE
When investigating issues, one might want to see exactly what curl is
doing behind the scenes. Setting HOMEBREW_CURL_VERBOSE will cause the
'--verbose' flag to be passed to all invocations of curl.

Prompted by Homebrew/homebrew#8992.

Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2011-12-08 21:04:28 -06:00
Jack Nagel
093974f200 Document 'install --devel'
Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2011-11-28 14:43:54 -06:00
Jack Nagel
8b88ea3eae Move brew-depstree into brew deps --tree
Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2011-11-27 23:29:41 -06:00
Jack Nagel
9ecb2ceb29 manpage: remove audit's '--strict' option
Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2011-11-27 12:08:13 -06:00
Charlie Sharpsteen
33a61d1897 Add --fresh option to brew install
When invoked, this option will ensure brew doesn't re-use any options from
previous installs of a formula.
2011-11-14 10:44:18 -08:00
Jack Nagel
0cc3eb296d cleanup: add an option to perform a 'dry run'
Sometimes you want to know what `brew cleanup` will do before it
actually removes anything. Introduce a '-n' option (chosen to match
other UNIX tools) to do this.

Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2011-11-07 22:46:36 -06:00
Jack Nagel
15706ec7d4 Redocument brew missing in the man page
Per mxcl/homebrew@6b0c44d, @mxcl:

  "And in that mind, brew missing is some cases an essential tool and
   should absolutely be in the manpage."

Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2011-10-12 02:53:41 -05:00
Jack Nagel
b8b7ad7ef2 Document brew diy in the man page
The documentation on this is hard to find, and awareness of the command
itself is pretty low. Which is too bad, because it's really handy and I
use it all the time myself.

Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2011-10-12 02:53:40 -05:00
Jack Nagel
203b0df596 man page: add some undocumented options
While updating the bash completion script, I encountered some options
that were previously undocumented.

I purposely did not document the --macports and --fink flags for `brew
create`, because the exact same functionality exists in `brew search`.
Perhaps we should remove it from create.

Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2011-10-12 02:53:40 -05:00
Adam Vandenberg
51ab8c3b56 Add FileVault use case to manual. 2011-10-04 14:01:42 -07:00
Charlie Sharpsteen
e49dc46bf3 manpage: Remove missing, server and which
These are external commands---documentation has been moved to the wiki.
2011-09-23 11:53:44 -07:00
Jack Nagel
ea30b66ced manpage: boldface --rebase option
This is consistent with how other options are displayed.

Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2011-09-19 20:50:39 -05:00
Max Howell
e26797f471 Allow brew update --rebase 2011-09-20 02:30:31 +01:00