254 Commits

Author SHA1 Message Date
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
Mike McQuaid
c38efcef16 Fix brew-bottle output for new bottle syntax. 2012-01-29 20:35:40 +00:00
Cameron Barrie
6b669981de Add beer recipe. This is homebrew after all.
Signed-off-by: Adam Vandenberg <flangy@gmail.com>
2012-01-27 21:13:44 -08:00
Jack Nagel
ba69e17073 Refactor the bash completion script
The script was lacking structure and had grown a number of one-off hacks
that would be better as reusable functions. So,

 - give each subcommand that has completions it's own function
 - move completion of formulae, installed brews, and outdated brews into
   reusable functions
 - introduce a general __brewcomp() function that takes a string of tab,
   space, and/or newline separated items and converts all seperators to
   newlines, and then generates a reply with compgen().

These changes should allow for easier addition of new features in the
future.

As a bonus, completion for `brew log` will include git-log options if
the git completion script is also loaded.

_brew_to_completion() is kept around for compatiblity.

Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2012-01-25 23:04:08 -06:00
Mike McQuaid
38b4a06207 Don't bottle unless built with correct flag.
Closes Homebrew/homebrew#9350.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2012-01-16 21:05:00 +00:00
Jack Nagel
7423b79f3a Complete options for brew -S
Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2012-01-08 13:24:35 -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
3f76af69d3 completion: audit takes formula arguments
- Also remove `--strict` completion since that option was removed.

Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2011-12-11 01:49:47 -06:00
Jack Nagel
e4bed29e99 completion: complete multiple formula arguments
We make the assumption that the first non-option word is the command
being invoked.

Originally I was trying to allow command completion for non-standard
command lines like

    $ brew --verbose inst<TAB>

but right now executing something like that doesn't actually work. Which
is interesting, because the man page implies that it should. Either the
man page is incorrect, or something was broken between then and now.

Anyway, it would probably be safe to just assume that COMP_WORDS[1] is
the command, and we do make that assumption in other places. But if we
ever do allow things like "brew --option command", this will be useful.

Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2011-12-11 01:49:47 -06: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
0474fa11cd completion: add __brew_ps1 to annotate $PS1
It is often useful to be reminded that you are, in fact, in the middle
of a debug or interactive install. We provided this reminder in the form
of HOMEBREW_DEBUG_INSTALL, but we can make this even easier for the end
user to consume by exposing it in the form of a shell function.

When HOMEBREW_DEBUG_INSTALL is set, the __brew_ps1() function returns
the string "(formula_name|DEBUG)" by default (much like the __git_ps1()
output when performing some long-running operation, e.g.
"(branch|REBASE-i)". The formatting around "formula_name|DEBUG" can be
customized by passing a format string to the function.

Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2011-11-11 00:01:05 -06: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
Charlie Sharpsteen
a6877c02b0 brew-pull: Clarify comment concerning whitespace 2011-10-24 19:07:59 -07:00
Charlie Sharpsteen
d54e7fb4de brew-pull: Add flag to suppress whitespace fixes
When the pull request includes a patch, fixing whitespace can break the patch.
2011-10-24 18:55:43 -07:00
Jack Nagel
85b17ecb4e brew-unpack: define fails_with_llvm? as false
brew-unpack was failing for formulae that satisfy fails_with_llvm? as
handle_llvm_failure() requires our ENV extension to get ENV.compiler.

Rather than requiring extend/ENV, just define fails_with_llvm? as false
since we don't really care about that when just unpacking a formula.

Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2011-10-14 23:55:45 -05:00
Jack Nagel
4da0b506f4 Add bash completion for subcommand options
We already have option completion for `brew install`; now we have it for
all core commands, and the --cache, --cellar, and --prefix flags now
have appropriate formula completion.

Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2011-10-12 02:57:28 -05: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
017d8690d3 Ensure cache folder exists 2011-10-11 10:13:19 -07:00
Jack Nagel
558ce2dd3d Fix syntax error in the bash-completion script
My bad.

Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2011-10-09 13:40:49 -05:00
Jack Nagel
cc7efdc94d Make bash completion for upgrade smarter
Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2011-10-08 20:30:10 -05:00
Motonori Iwata
a8437a62ca Make zsh completion for upgrade smarter
Closes Homebrew/homebrew#7889.

Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2011-10-08 20:24:59 -05:00
Bertrand Marron
744ab8fc8c Add upgrade to the zsh completion script
Closes Homebrew/homebrew#7923.

Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2011-10-08 20:15:40 -05:00
Adam Vandenberg
51ab8c3b56 Add FileVault use case to manual. 2011-10-04 14:01:42 -07:00
Adam Vandenberg
0aa9fe73f8 Fix gem install help for brew-server
Sinatra gem must be installed for the system ruby.
2011-09-30 08:05:28 -07:00
at@an-ti.eu
4cf74bc972 List all local installed packages in brew server
Signed-off-by: Adam Vandenberg <flangy@gmail.com>
2011-09-30 08:02:33 -07:00
Adam Vandenberg
1ff01a872e missing should not error if Cellar does not exist 2011-09-26 10:46:50 -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
Jack Nagel
2be915db99 Remove brew-man documentation
It was extraneous, and useful only for maintainers and contributors. It
is currently documented on the External Commands page of the wiki.

Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2011-09-19 18:27:19 -05:00
Jack Nagel
783b71fa5a Improve external command documentation
In addition to a brief overview of what external commands are, add a
link to the wiki page where the real documentation resides.

Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2011-09-19 18:24:03 -05:00
Charlie Sharpsteen
aa6f96003b mirror support: External command for mirror tests
`brew mirror-check <formula...>` will process a list of Formulae and check
their mirrors to see if they are reachable and the MD5 sums are valid.
2011-09-19 09:25:02 -07:00
Jack Nagel
560fb2dbcb brew-missing: use name accessor on Formula objects
Commit 00cd16f changed oudated_brews to return a list of Formula
objects rather than a list of lists containing formula information.

Now we must access the formula name by using the 'name' accessor rather
than an array index.

Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2011-09-18 15:03:37 -05:00
Charlie Sharpsteen
5790935b12 brew-unpack: Apply patches and use formula options
`brew-unpack` now runs `Formula.brew` and copies the stage directory to the
unpack location. This provides two improvements:

  - Patches may be applied. The `patch` metho of the Formula class is
    overloaded such that patches are only applied if the `--patch` option is
    passed to `brew unpack`.

  - Formula can respond better to flags passed by `ARGV`.

Some trickery is pulled to ensure `DATA` is correctly set for each unpacked
formula.
2011-09-12 23:32:01 -07:00
Jack Nagel
b0f5566566 brew-options: add --installed flag
`brew options --installed` will print options for formulae that are
already installed.

Closes Homebrew/homebrew#7565.

Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2011-09-12 15:43:18 -05:00
Jack Nagel
2183372f65 Man page: clarify list command
Document the '--versions' option for `brew list`.
The two forms of the `list` command as previously documented clearly do
different things, but after documenting '--versions', their functions do
overlap a bit, so we combine them and clarify the different invocations.

Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2011-09-08 21:10:44 -05:00
Jack Nagel
16faf0684a Man page fixes
- Remove unnecessary linefeeds above "ENVIRONMENT"

 - Use the word "example" rather than "sample" to be more consistent
   throughout the documentation

Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2011-09-08 20:53:07 -05:00
Filipe David Manana
fa43ec5b5e Fix default cache dir in man page
Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2011-09-08 20:50:36 -05:00
Jack Nagel
883c58f751 Add the upgrade command to the man page
Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2011-09-01 22:50:17 -05:00
Jack Nagel
b70b14dea1 Document brew outdated --quiet
Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2011-09-01 22:50:17 -05:00