mirrors/brew
1
0
Fork 0
mirror of https://github.com/Homebrew/brew.git synced 2025-07-14 16:09:03 +08:00
Code Issues Packages Projects Releases Wiki Activity

More API documentation.

Browse Source 
And remove the documented stuff from the `example-formula.rb`.

Closes Homebrew/homebrew#43241.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
This commit is contained in:
Mike McQuaid 2015-08-29 10:56:24 +01:00
parent 77536e39de
commit 2c959a7d58
20 changed files with 1237 additions and 555 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.yardopts
View File

@ -7,7 +7,7 @@
--exclude Library/Homebrew/compat/
Library/Homebrew/**/*.rb
-
share/doc/homebrew/*.html
Library/Homebrew/*.md
Library/Homebrew/manpages/*.md
share/doc/homebrew/*.md
*.md

488
Library/Contributions/example-formula.rb
View File

@ -1,488 +0,0 @@
# This is a non-functional example formula to showcase all features and
# therefore, it's overly complex and dupes stuff just to comment on it.
# You may want to use `brew create` to start your own new formula!
# Documentation: https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Formula-Cookbook.md
## Naming -- Every Homebrew formula is a class of the type `Formula`.
# Ruby classes have to start Upper case and dashes are not allowed.
# So we transform: `example-formula.rb` into `ExampleFormula`. Further,
# Homebrew does enforce that the name of the file and the class correspond.
# Check with `brew search` that the name is free.
class ExampleFormula < Formula
desc "Example formula" # shows up in `brew info`, and can be searched with `brew search --desc`.
homepage "https://www.example.com" # used by `brew home example-formula`.
revision 1 # This is used when there's no new version but it needs recompiling for another reason.
# 0 is default & unwritten.
# The URL of the archive. Prefer https (security and proxy issues):
url "https://packed.sources.and.we.prefer.https.example.com/archive-1.2.3.tar.bz2"
mirror "https://in.case.the.host.is.down.example.com" # `mirror` is optional.
mirror "https://in.case.the.mirror.is.down.example.com" # Mirrors are limitless, but don't go too wild.
# Optionally specify the download strategy `:using => ...`
# `:git`, `:hg`, `:svn`, `:bzr`, `:cvs`,
# `:curl` (normal file download. Will also extract.)
# `:nounzip` (without extracting)
# `:post` (download via an HTTP POST)
# `S3DownloadStrategy` (download from S3 using signed request)
url "https://some.dont.provide.archives.example.com", :using => :git, :tag => "1.2.3"
# version is seldom needed, because it's usually autodetected from the URL/tag.
version "1.2-final"
# For integrity and security, we verify the hash (`openssl dgst -sha256 <FILE>`)
# You should use SHA256. Never use md5.
# Either generate the sha locally or leave it empty & `brew install` will tell you the expected.
sha256 "2a2ba417eebaadcb4418ee7b12fe2998f26d6e6f7fda7983412ff66a741ab6f7"
# Stable-only dependencies should be nested inside a `stable` block rather than
# using a conditional. It is preferrable to also pull the URL and checksum into
# the block if one is necessary.
stable do
url "https://example.com/foo-1.0.tar.gz"
sha256 "2a2ba417eebaadcb4418ee7b12fe2998f26d6e6f7fda7983412ff66a741ab6f7"
depends_on "libxml2"
depends_on "libffi"
end
# Optionally, specify a repository to be used. Brew then generates a
# `--HEAD` option. Remember to also test it.
# The download strategies (:using =>) are the same as for `url`.
# "master" is the default branch and doesn't need stating with a :branch conditional
head "https://we.prefer.https.over.git.example.com/.git"
head "https://example.com/.git", :branch => "name_of_branch", :revision => "abc123"
head "https://hg.is.awesome.but.git.has.won.example.com/", :using => :hg # If autodetect fails.
head do
url "https://example.com/repo.git"
depends_on "autoconf" => :build
depends_on "automake" => :build
depends_on "libtool" => :build
end
# The optional devel block is only executed if the user passes `--devel`.
# Use this to specify a not-yet-released version of a software.
devel do
url "https://example.com/archive-2.0-beta.tar.gz"
sha256 "2a2ba417eebaadcb4418ee7b12fe2998f26d6e6f7fda7983412ff66a741ab6f7"
depends_on "cairo"
depends_on "pixman"
end
## Options
# Options can be used as arguments to `brew install`.
# To switch features on/off: `"with-something"` or `"with-otherthing"`.
# To use another software: `"with-other-software"` or `"without-foo"`
# Note, that for dependencies that are `:optional` or `:recommended`, options
# are generated automatically.
# Build a universal (On newer Intel Macs this means a combined 32-bit and
# 64-bit binary/library). LATER: better explain what this means for PPC.
option :universal
option "with-spam", "The description goes here without a dot at the end"
option "with-qt", "Text here overwrites the autogenerated one from `depends_on 'qt'`"
## Bottles
# Bottles are pre-built and added by the Homebrew maintainers for you.
# If you maintain your own repository, you can add your own bottle links.
# https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Bottles.md
# You can ignore this block entirely if submitting to Homebrew/Homebrew, It'll be
# handled for you by the Brew Test Bot.
bottle do
root_url "http://mikemcquaid.com" # Optional root to calculate bottle URLs
prefix "/opt/homebrew" # Optional HOMEBREW_PREFIX in which the bottles were built.
cellar "/opt/homebrew/Cellar" # Optional HOMEBREW_CELLAR in which the bottles were built.
revision 1 # Making the old bottle outdated without bumping the version of the formula.
sha256 "2a2ba417eebaadcb4418ee7b12fe2998f26d6e6f7fda7983412ff66a741ab6f7" => :yosemite
sha256 "2a2ba417eebaadcb4418ee7b12fe2998f26d6e6f7fda7983412ff66a741ab6f7" => :mavericks
sha256 "2a2ba417eebaadcb4418ee7b12fe2998f26d6e6f7fda7983412ff66a741ab6f7" => :mountain_lion
end
def pour_bottle?
# Only needed if this formula has to check if using the pre-built
# bottle is fine.
true
end
## keg_only
# Software that will not be sym-linked into the `brew --prefix` will only
# live in its Cellar. Other formulae can depend on it and then brew will
# add the necessary includes and libs (etc.) during the brewing of that
# other formula. But generally, keg_only formulae are not in your PATH
# and not seen by compilers if you build your own software outside of
# Homebrew. This way, we don't shadow software provided by OS X.
keg_only :provided_by_osx
keg_only "because I want it so"
## Dependencies
# The dependencies for this formula. Use strings for the names of other
# formulae. Homebrew provides some :special dependencies for stuff that
# requires certain extra handling (often changing some ENV vars or
# deciding if to use the system provided version or not.)
# `:build` means this dep is only needed during build.
depends_on "cmake" => :build
# Explictly name formulae in other taps. Non-optional tap dependencies won't
# be accepted in core.
depends_on "homebrew/dupes/tcl-tk" => :optional
# `:recommended` dependencies are built by default. But a `--without-...`
# option is generated to opt-out.
depends_on "readline" => :recommended
# `:optional` dependencies are NOT built by default but a `--with-...`
# options is generated.
depends_on "glib" => :optional
# If you need to specify that another formula has to be built with/out
# certain options (note, no `--` needed before the option):
depends_on "zeromq" => "with-pgm"
depends_on "qt" => ["with-qtdbus", "developer"] # Multiple options.
# Optional and enforce that boost is built with `--with-c++11`.
depends_on "boost" => [:optional, "with-c++11"]
# If a dependency is only needed in certain cases:
depends_on "sqlite" if MacOS.version == :leopard
depends_on :xcode # If the formula really needs full Xcode.
depends_on :tex # Homebrew does not provide a Tex Distribution.
depends_on :fortran # Checks that `gfortran` is available or `FC` is set.
depends_on :mpi => :cc # Needs MPI with `cc`
depends_on :mpi => [:cc, :cxx, :optional] # Is optional. MPI with `cc` and `cxx`.
depends_on :macos => :lion # Needs at least Mac OS X "Lion" aka. 10.7.
depends_on :apr # If a formula requires the CLT-provided apr library to exist.
depends_on :arch => :intel # If this formula only builds on Intel architecture.
depends_on :arch => :x86_64 # If this formula only builds on Intel x86 64-bit.
depends_on :arch => :ppc # Only builds on PowerPC?
depends_on :ld64 # Sometimes ld fails on `MacOS.version < :leopard`. Then use this.
depends_on :x11 # X11/XQuartz components. Non-optional X11 deps should go in Homebrew/Homebrew-x11
depends_on :osxfuse # Permits the use of the upstream signed binary or our source package.
depends_on :tuntap # Does the same thing as above. This is vital for Yosemite and above.
depends_on :mysql => :recommended
# It is possible to only depend on something if
# `build.with?` or `build.without? "another_formula"`:
depends_on :mysql # allows brewed or external mysql to be used
depends_on :postgresql if build.without? "sqlite"
depends_on :hg # Mercurial (external or brewed) is needed
# If any Python >= 2.7 < 3.x is okay (either from OS X or brewed):
depends_on :python
# to depend on Python >= 2.7 but use system Python where possible
depends_on :python if MacOS.version <= :snow_leopard
# Python 3.x if the `--with-python3` is given to `brew install example`
depends_on :python3 => :optional
# Modules/Packages from other languages, such as :chicken, :jruby, :lua,
# :node, :ocaml, :perl, :python, :rbx, :ruby, can be specified by
depends_on "some_module" => :lua
## Conflicts
# If this formula conflicts with another one:
conflicts_with "imagemagick", :because => "because this is just a stupid example"
## Failing with a certain compiler?
# If it is failing for certain compiler:
fails_with :llvm do # :llvm is really llvm-gcc
build 2334
cause "Segmentation fault during linking."
end
fails_with :clang do
build 600
cause "multiple configure and compile errors"
end
## Resources
# Additional downloads can be defined as resources and accessed in the
# install method. Resources can also be defined inside a stable, devel, or
# head block. This mechanism replaces ad-hoc "subformula" classes.
resource "additional_files" do
url "https://example.com/additional-stuff.tar.gz"
sha256 "c6bc3f48ce8e797854c4b865f6a8ff969867bbcaebd648ae6fd825683e59fef2"
end
## Patches
# External patches can be declared using resource-style blocks.
patch do
url "https://example.com/example_patch.diff"
sha256 "c6bc3f48ce8e797854c4b865f6a8ff969867bbcaebd648ae6fd825683e59fef2"
end
# A strip level of -p1 is assumed. It can be overridden using a symbol
# argument:
patch :p0 do
url "https://example.com/example_patch.diff"
sha256 "c6bc3f48ce8e797854c4b865f6a8ff969867bbcaebd648ae6fd825683e59fef2"
end
# Patches can be declared in stable, devel, and head blocks. This form is
# preferred over using conditionals.
stable do
patch do
url "https://example.com/example_patch.diff"
sha256 "c6bc3f48ce8e797854c4b865f6a8ff969867bbcaebd648ae6fd825683e59fef2"
end
end
# Embedded (__END__) patches are declared like so:
patch :DATA
patch :p0, :DATA
# Patches can also be embedded by passing a string. This makes it possible
# to provide multiple embedded patches while making only some of them
# conditional.
patch :p0, "..."
## The install method.
def install
# Now the sources (from `url`) are downloaded, hash-checked and
# Homebrew has changed into a temporary directory where the
# archive has been unpacked or the repository has been cloned.
# Print a warning (do this rarely)
opoo "Dtrace features are experimental!" if build.with? "dtrace"
# Sometimes we have to change a bit before we install. Mostly we
# prefer a patch but if you need the `prefix` of this formula in the
# patch you have to resort to `inreplace`, because in the patch
# you don't have access to any var defined by the formula. Only
# HOMEBREW_PREFIX is available in the embedded patch.
# inreplace supports regular expressions.
inreplace "somefile.cfg", /look[for]what?/, "replace by #{bin}/tool"
# To call out to the system, we use the `system` method and we prefer
# you give the args separately as in the line below, otherwise a subshell
# has to be opened first.
system "./bootstrap.sh", "--arg1", "--prefix=#{prefix}"
# For Cmake, we have some necessary defaults in `std_cmake_args`:
system "cmake", ".", *std_cmake_args
# If the arguments given to configure (or make or cmake) are depending
# on options defined above, we usually make a list first and then
# use the `args << if <condition>` to append to:
args = ["--option1", "--option2"]
args << "--i-want-spam" if build.with? "spam"
args << "--qt-gui" if build.with? "qt" # "--with-qt" ==> build.with? "qt"
args << "--some-new-stuff" if build.head? # if head is used instead of url.
args << "--universal-binary" if build.universal?
# If there are multiple conditional arguments use a block instead of lines.
if build.head?
args << "--i-want-pizza"
args << "--and-a-cold-beer" if build.with? "cold-beer"
end
# If a formula presents a user with a choice, but the choice must be fulfilled:
if build.with? "example2"
args << "--with-example2"
else
args << "--with-example1"
end
# The `build.with?` and `build.without?` are smart enough to do the
# right thing with respect to defaults defined via `:optional` and
# `:recommended` dependencies.
# If you need to give the path to lib/include of another brewed formula
# please use the `opt_prefix` instead of the `prefix` of that other
# formula. The reasoning behind this is that `prefix` has the exact
# version number and if you update that other formula, things might
# break if they remember that exact path. In contrast to that, the
# `$(brew --prefix)/opt/formula` is the same path for all future
# versions of the formula!
args << "--with-readline=#{Formula["readline"].opt_prefix}" if build.with? "readline"
# Most software still uses `configure` and `make`.
# Check with `./configure --help` what our options are.
system "./configure", "--disable-debug", "--disable-dependency-tracking",
"--disable-silent-rules", "--prefix=#{prefix}",
*args # our custom arg list (needs `*` to unpack)
# If your formula's build system is not thread safe:
ENV.deparallelize
# A general note: The commands here are executed line by line, so if
# you change some variable or call a method like ENV.deparallelize, it
# only affects the lines after that command.
# Do something only for clang
if ENV.compiler == :clang
# modify CFLAGS CXXFLAGS OBJCFLAGS OBJCXXFLAGS in one go:
ENV.append_to_cflags "-I ./missing/includes"
end
# Overwriting any env var:
ENV["LDFLAGS"] = "--tag CC"
# Is the formula struggling to find the pkgconfig file? Point it to it.
# This is done automatically for `keg_only` formulae.
ENV.prepend_path "PKG_CONFIG_PATH", "#{Formula["glib"].opt_lib}/pkgconfig"
# Need to install into the bin but the makefile doesn't mkdir -p prefix/bin?
bin.mkpath
# Need a custom directory?
(share/"concept").mkpath
# Installing something into another custom directory?
(share/"concept2").install "ducks.txt"
# No "make", "install" available?
bin.install "binary1"
include.install "example.h"
lib.install "example.dylib"
man1.install "example.1"
man3.install "example.3"
pkgshare.install "examples"
# Maybe you'd like to remove a broken or unnecessary element?
# Empty directories will be removed by Homebrew automatically post-install!
rm "bin/example"
rm_rf "share/pointless"
# If there is a "make", "install" available, please use it!
system "make", "install"
# We are in a temporary directory and don't have to care about cleanup.
# Instead of `system "cp"` or something, call `install` on the Pathname
# objects as they are smarter with respect to correcting access rights.
# (`install` is a Homebrew mixin into Ruby's Pathname)
# The pathnames defined in the formula
prefix # == HOMEBREW_PREFIX+"Cellar"+name+version
bin # == prefix+"bin"
doc # == share+"doc"+name
include # == prefix+"include"
info # == share+"info"
lib # == prefix+"lib"
libexec # == prefix+"libexec"
buildpath # The temporary directory where build occurs.
man # share+"man"
man1 # man+"man1"
man2 # man+"man2"
man3 # man+"man3"
man4 # man+"man4"
man5 # man+"man5"
man6 # man+"man6"
man7 # man+"man7"
man8 # man+"man8"
sbin # prefix+"sbin"
share # prefix+"share"
pkgshare # prefix+"share"+name
frameworks # prefix+"Frameworks"
kext_prefix # prefix+"Library/Extensions"
# Configuration stuff that will survive formula updates
etc # HOMEBREW_PREFIX+"etc"
# Generally we don't want var stuff inside the keg
var # HOMEBREW_PREFIX+"var"
bash_completion # prefix+"etc/bash_completion.d"
zsh_completion # share+"zsh/site-functions"
# Further possibilities with the pathnames:
# http://www.ruby-doc.org/stdlib-1.8.7/libdoc/pathname/rdoc/Pathname.html
# Copy `./example_code/simple/ones` to share/demos
(share/"demos").install "example_code/simple/ones"
# Copy `./example_code/simple/ones` to share/demos/examples
(share/"demos").install "example_code/simple/ones" => "examples"
# Additional downloads can be defined as resources (see above).
# The stage method will create a temporary directory and yield
# to a block.
resource("additional_files").stage { bin.install "my/extra/tool" }
# `name` and `version` are accessible too, if you need them.
end
## Caveats
def caveats; <<-EOS.undent
Are optional. Something the user should know?
EOS
end
def caveats
s = <<-EOS.undent
Print some important notice to the user when `brew info <formula>` is
called or when brewing a formula.
This is optional. You can use all the vars like #{version} here.
EOS
s += "Some issue only on older systems" if MacOS.version < :mountain_lion
s
end
## Test (is required for new formula & makes us happy)
test do
# `test do` will create, run in, and delete a temporary directory.
# We are fine if the executable does not error out, so we know linking
# and building the software was ok.
system bin/"foobar", "--version"
(testpath/"Test.file").write <<-EOS.undent
writing some test file, if you need to
EOS
# To capture the output of a command, we use backtics:
assert_equal "OK", ` test.file`.strip
# Need complete control over stdin, stdout?
require "open3"
Open3.popen3("#{bin}/example", "argument") do |stdin, stdout, _|
stdin.write("some text")
stdin.close
assert_equal "result", stdout.read
end
# The test will fail if it returns false, or if an exception is raised.
# Failed assertions and failed `system` commands will raise exceptions.
end
## Plist handling
# Does your plist need to be loaded at startup?
plist_options :startup => true
# Or only when necessary or desired by the user?
plist_options :manual => "foo"
# Or perhaps you'd like to give the user a choice? Ooh fancy.
plist_options :startup => "true", :manual => "foo start"
# Define this method to provide a plist.
# Looking for another example? Check out Apple's handy manpage =>
# https://developer.apple.com/library/mac/documentation/Darwin/Reference/ManPages/man5/plist.5.html
def plist; <<-EOS.undent
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>Label</key>
<string>#{plist_name}</string>
<key>ProgramArguments</key>
<array>
<string>#{opt_bin}/example</string>
<string>--do-this</string>
</array>
<key>RunAtLoad</key>
<true/>
<key>KeepAlive</key>
<true/>
<key>StandardErrorPath</key>
<string>/dev/null</string>
<key>StandardOutPath</key>
<string>/dev/null</string>
</plist>
EOS
end
end
__END__
# Room for a patch after the `__END__`
# Read about how to get a patch in here:
# https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Formula-Cookbook.md
# In short, `brew install --interactive --git <formula>` and make your edits.
# Then `git diff >> path/to/your/formula.rb`
# Note, that HOMEBREW_PREFIX will be replaced in the path before it is
# applied. A patch can consit of several hunks.

10
Library/Homebrew/README.md
View File

@ -1,4 +1,8 @@
# Homebrew Public API
We're (finally) working on a documented public API for Homebrew. It's currently a work in progress; a bunch of public stuff is documented and a bunch of private stuff is undocumented. Sorry about that!
# Homebrew's Formula API
This is the (partially) documented public API for Homebrew. It's currently a work in progress. Sorry about that!
The main class you should look at is {Formula}. Assume everything else is private for now.
The main class you should look at is the {Formula} class (and classes linked from there). That's the class that's used to create Homebrew formulae (i.e. package descriptions). Assume anything else you stumble upon is private.
You may also find the [Formula Cookbook](Formula-Cookbook.md) and [Ruby Style Guide](https://github.com/styleguide/ruby) helpful in creating formulae.
Good luck!

39
Library/Homebrew/build_options.rb
View File

@ -1,13 +1,28 @@
class BuildOptions
# @private
def initialize(args, options)
@args = args
@options = options
end
# True if a {Formula} is being built with a specific option
# (which isn't named `with-*` or `without-*`).
# @deprecated
def include?(name)
@args.include?("--#{name}")
end
# True if a {Formula} is being built with a specific option.
# <pre>args << "--i-want-spam" if build.with? "spam"
#
# args << "--qt-gui" if build.with? "qt" # "--with-qt" ==> build.with? "qt"
#
# # If a formula presents a user with a choice, but the choice must be fulfilled:
# if build.with? "example2"
# args << "--with-example2"
# else
# args << "--with-example1"
# end</pre>
def with?(val)
name = val.respond_to?(:option_name) ? val.option_name : val
@ -20,47 +35,65 @@ class BuildOptions
end
end
# True if a {Formula} is being built without a specific option.
# <pre>args << "--no-spam-plz" if build.without? "spam"
def without?(name)
!with? name
end
# True if a {Formula} is being built as a bottle (i.e. binary package).
def bottle?
include? "build-bottle"
end
# True if a {Formula} is being built with {Formula.head} instead of {Formula.stable}.
# <pre>args << "--some-new-stuff" if build.head?</pre>
# <pre># If there are multiple conditional arguments use a block instead of lines.
# if build.head?
# args << "--i-want-pizza"
# args << "--and-a-cold-beer" if build.with? "cold-beer"
# end</pre>
def head?
include? "HEAD"
end
# True if a {Formula} is being built with {Formula.devel} instead of {Formula.stable}.
# <pre>args << "--some-beta" if build.devel?</pre>
def devel?
include? "devel"
end
# True if a {Formula} is being built with {Formula.stable} instead of {Formula.devel} or {Formula.head}. This is the default.
# <pre>args << "--some-beta" if build.devel?</pre>
def stable?
!(head? || devel?)
end
# True if the user requested a universal build.
# True if a {Formula} is being built universally.
# e.g. on newer Intel Macs this means a combined x86_64/x86 binary/library.
# <pre>args << "--universal-binary" if build.universal?</pre>
def universal?
include?("universal") && option_defined?("universal")
end
# True if the user requested to enable C++11 mode.
# True if a {Formula} is being built in C++11 mode.
def cxx11?
include?("c++11") && option_defined?("c++11")
end
# Request a 32-bit only build.
# True if a {Formula} is being built in 32-bit/x86 mode.
# This is needed for some use-cases though we prefer to build Universal
# when a 32-bit version is needed.
def build_32_bit?
include?("32-bit") && option_defined?("32-bit")
end
# @private
def used_options
@options & @args
end
# @private
def unused_options
@options - @args
end

2
Library/Homebrew/cmd/create.rb
View File

@ -118,7 +118,7 @@ class FormulaCreator
def template; <<-EOS.undent
# Documentation: https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Formula-Cookbook.md
# #{HOMEBREW_CONTRIB}/example-formula.rb
# http://www.rubydoc.info/github/Homebrew/homebrew/master/frames
# PLEASE REMOVE ALL GENERATED COMMENTS BEFORE SUBMITTING YOUR PULL REQUEST!
class #{Formulary.class_s(name)} < Formula

8
Library/Homebrew/cmd/man.rb
View File

@ -3,6 +3,7 @@ require "formula"
module Homebrew
SOURCE_PATH=HOMEBREW_REPOSITORY/"Library/Homebrew/manpages"
TARGET_PATH=HOMEBREW_REPOSITORY/"share/man/man1"
DOC_PATH=HOMEBREW_REPOSITORY/"share/doc/homebrew"
LINKED_PATH=HOMEBREW_PREFIX/"share/man/man1"
def man
@ -21,12 +22,15 @@ module Homebrew
else
Homebrew.install_gem_setup_path! "ronn"
puts "Writing HTML fragments to #{DOC_PATH}"
puts "Writing manpages to #{TARGET_PATH}"
target_file = nil
Dir["#{SOURCE_PATH}/*.md"].each do |source_file|
target_file = TARGET_PATH/File.basename(source_file, ".md")
safe_system "ronn --roff --pipe --organization='Homebrew' --manual='brew' #{source_file} > #{target_file}"
target_html = DOC_PATH/"#{File.basename(source_file, ".md")}.html"
safe_system "ronn --fragment --pipe --organization='Homebrew' --manual='brew' #{source_file} > #{target_html}"
target_man = TARGET_PATH/File.basename(source_file, ".md")
safe_system "ronn --roff --pipe --organization='Homebrew' --manual='brew' #{source_file} > #{target_man}"
end
system "man", target_file if ARGV.flag? "--verbose"

1
Library/Homebrew/compilers.rb
View File

@ -1,3 +1,4 @@
# @private
module CompilerConstants
GNU_GCC_VERSIONS = %w[4.3 4.4 4.5 4.6 4.7 4.8 4.9 5]
GNU_GCC_REGEXP = /^gcc-(4\.[3-9]|5)$/

32
Library/Homebrew/extend/ENV/shared.rb
View File

@ -1,12 +1,20 @@
require "formula"
require "compilers"
# Homebrew extends Ruby's `ENV` to make our code more readable.
# Implemented in {SharedEnvExtension} and either {Superenv} or
# {Stdenv} (depending on the build mode).
# @see Superenv
# @see Stdenv
# @see http://www.rubydoc.info/stdlib/Env Ruby's ENV API
module SharedEnvExtension
include CompilerConstants
# @private
CC_FLAG_VARS = %w[CFLAGS CXXFLAGS OBJCFLAGS OBJCXXFLAGS]
# @private
FC_FLAG_VARS = %w[FCFLAGS FFLAGS]
# @private
SANITIZED_VARS = %w[
CDPATH GREP_OPTIONS CLICOLOR_FORCE
CPATH C_INCLUDE_PATH CPLUS_INCLUDE_PATH OBJC_INCLUDE_PATH
@ -18,11 +26,13 @@ module SharedEnvExtension
LIBRARY_PATH
]
# @private
def setup_build_environment(formula = nil)
@formula = formula
reset
end
# @private
def reset
SANITIZED_VARS.each { |k| delete(k) }
end
@ -72,6 +82,10 @@ module SharedEnvExtension
append key, path, File::PATH_SEPARATOR if File.directory? path
end
# Prepends a directory to `PATH`.
# Is the formula struggling to find the pkgconfig file? Point it to it.
# This is done automatically for `keg_only` formulae.
# <pre>ENV.prepend_path "PKG_CONFIG_PATH", "#{Formula["glib"].opt_lib}/pkgconfig"</pre>
def prepend_path(key, path)
prepend key, path, File::PATH_SEPARATOR if File.directory? path
end
@ -126,6 +140,13 @@ module SharedEnvExtension
self["FCFLAGS"]
end
# Outputs the current compiler.
# @return [Symbol]
# <pre># Do something only for clang
# if ENV.compiler == :clang
# # modify CFLAGS CXXFLAGS OBJCFLAGS OBJCXXFLAGS in one go:
# ENV.append_to_cflags "-I ./missing/includes"
# end</pre>
def compiler
@compiler ||= if (cc = ARGV.cc)
warn_about_non_apple_gcc($&) if cc =~ GNU_GCC_REGEXP
@ -147,6 +168,7 @@ module SharedEnvExtension
end
end
# @private
def determine_cc
COMPILER_SYMBOL_MAP.invert.fetch(compiler, compiler)
end
@ -159,13 +181,14 @@ module SharedEnvExtension
end
end
# Snow Leopard defines an NCURSES value the opposite of most distros
# Snow Leopard defines an NCURSES value the opposite of most distros.
# See: https://bugs.python.org/issue6848
# Currently only used by aalib in core
# Currently only used by aalib in core.
def ncurses_define
append "CPPFLAGS", "-DNCURSES_OPAQUE=0"
end
# @private
def userpaths!
paths = ORIGINAL_PATHS.map { |p| p.realpath.to_s rescue nil } - %w[/usr/X11/bin /opt/X11/bin]
self["PATH"] = paths.unshift(*self["PATH"].split(File::PATH_SEPARATOR)).uniq.join(File::PATH_SEPARATOR)
@ -212,12 +235,14 @@ module SharedEnvExtension
end
# ld64 is a newer linker provided for Xcode 2.5
# @private
def ld64
ld64 = Formulary.factory("ld64")
self["LD"] = ld64.bin/"ld"
append "LDFLAGS", "-B#{ld64.bin}/"
end
# @private
def gcc_version_formula(name)
version = name[GNU_GCC_REGEXP, 1]
gcc_version_name = "gcc#{version.delete(".")}"
@ -230,6 +255,7 @@ module SharedEnvExtension
end
end
# @private
def warn_about_non_apple_gcc(name)
begin
gcc_formula = gcc_version_formula(name)

11
Library/Homebrew/extend/ENV/std.rb
View File

@ -2,9 +2,11 @@ require "hardware"
require "os/mac"
require "extend/ENV/shared"
# @deprecated
module Stdenv
include SharedEnvExtension
# @private
SAFE_CFLAGS_FLAGS = "-w -pipe"
DEFAULT_FLAGS = "-march=core2 -msse4"
@ -14,6 +16,7 @@ module Stdenv
end
end
# @private
def setup_build_environment(formula = nil)
super
@ -69,6 +72,7 @@ module Stdenv
end
end
# @private
def determine_pkg_config_libdir
paths = []
paths << "#{HOMEBREW_PREFIX}/lib/pkgconfig"
@ -106,11 +110,13 @@ module Stdenv
end
end
# @private
def determine_cc
s = super
MacOS.locate(s) || Pathname.new(s)
end
# @private
def determine_cxx
dir, base = determine_cc.split
dir / base.to_s.sub("gcc", "g++").sub("clang", "clang++")
@ -295,6 +301,7 @@ module Stdenv
end
end
# @private
def replace_in_cflags(before, after)
CC_FLAG_VARS.each do |key|
self[key] = self[key].sub(before, after) if key?(key)
@ -308,6 +315,7 @@ module Stdenv
# Sets architecture-specific flags for every environment variable
# given in the list `flags`.
# @private
def set_cpu_flags(flags, default = DEFAULT_FLAGS, map = Hardware::CPU.optimization_flags)
cflags =~ /(-Xarch_#{Hardware::CPU.arch_32_bit} )-march=/
xarch = $1.to_s
@ -319,6 +327,7 @@ module Stdenv
append flags, map.fetch(effective_arch, default)
end
# @private
def effective_arch
if ARGV.build_bottle?
ARGV.bottle_arch || Hardware.oldest_cpu
@ -332,6 +341,7 @@ module Stdenv
end
end
# @private
def set_cpu_cflags(default = DEFAULT_FLAGS, map = Hardware::CPU.optimization_flags)
set_cpu_flags CC_FLAG_VARS, default, map
end
@ -346,5 +356,6 @@ module Stdenv
end
# This method does nothing in stdenv since there's no arg refurbishment
# @private
def refurbish_args; end
end

29
Library/Homebrew/extend/ENV/super.rb
View File

@ -1,20 +1,23 @@
require "os/mac"
require "extend/ENV/shared"
### Why `superenv`?
# 1) Only specify the environment we need (NO LDFLAGS for cmake)
# 2) Only apply compiler specific options when we are calling that compiler
# 3) Force all incpaths and libpaths into the cc instantiation (less bugs)
# 4) Cater toolchain usage to specific Xcode versions
# 5) Remove flags that we don't want or that will break builds
# 6) Simpler code
# 7) Simpler formula that *just work*
# 8) Build-system agnostic configuration of the tool-chain
# ### Why `superenv`?
#
# 1. Only specify the environment we need (NO LDFLAGS for cmake)
# 2. Only apply compiler specific options when we are calling that compiler
# 3. Force all incpaths and libpaths into the cc instantiation (less bugs)
# 4. Cater toolchain usage to specific Xcode versions
# 5. Remove flags that we don't want or that will break builds
# 6. Simpler code
# 7. Simpler formula that *just work*
# 8. Build-system agnostic configuration of the tool-chain
module Superenv
include SharedEnvExtension
attr_accessor :keg_only_deps, :deps, :x11
# @private
attr_accessor :keg_only_deps, :deps
attr_accessor :x11
alias_method :x11?, :x11
def self.extended(base)
@ -22,6 +25,7 @@ module Superenv
base.deps = []
end
# @private
def self.bin
return unless MacOS.has_apple_developer_tools?
@ -36,6 +40,7 @@ module Superenv
delete("as_nl")
end
# @private
def setup_build_environment(formula = nil)
super
send(compiler)
@ -302,6 +307,7 @@ module Superenv
append "HOMEBREW_CCCFG", "h", "" if compiler == :clang
end
# @private
def refurbish_args
append "HOMEBREW_CCCFG", "O", ""
end
@ -312,6 +318,7 @@ module Superenv
end
end
# @private
def noop(*_args); end
noops = []

22
Library/Homebrew/extend/fileutils.rb
View File

@ -1,7 +1,8 @@
require "fileutils"
require "tmpdir"
# We enhance FileUtils to make our Formula code more readable.
# Homebrew extends Ruby's `FileUtils` to make our code more readable.
# @see http://ruby-doc.org/stdlib-1.8.7/libdoc/fileutils/rdoc/FileUtils.html Ruby's FileUtils API
module FileUtils
# Create a temporary directory then yield. When the block returns,
# recursively delete the temporary directory.
@ -23,8 +24,10 @@ module FileUtils
end
module_function :mktemp
# A version of mkdir that also changes to that folder in a block.
# @private
alias_method :old_mkdir, :mkdir
# A version of mkdir that also changes to that folder in a block.
def mkdir(name, &_block)
old_mkdir(name)
if block_given?
@ -42,6 +45,7 @@ module FileUtils
# never backported into the 1.9.3 branch. Fixed in 2.0.0.
# The monkey-patched method here is copied directly from upstream fix.
if RUBY_VERSION < "2.0.0"
# @private
class Entry_
alias_method :old_copy_metadata, :copy_metadata
def copy_metadata(path)
@ -82,23 +86,27 @@ module FileUtils
end
end
private
# Run scons using a Homebrew-installed version, instead of whatever
# is in the user's PATH
# Run `scons` using a Homebrew-installed version rather than whatever is in the `PATH`.
def scons(*args)
system Formulary.factory("scons").opt_bin/"scons", *args
end
# Run the `rake` from the `ruby` Homebrew is using rather than whatever is in the `PATH`.
def rake(*args)
system RUBY_BIN/"rake", *args
end
alias_method :old_ruby, :ruby if method_defined?(:ruby)
if method_defined?(:ruby)
# @private
alias_method :old_ruby, :ruby
end
# Run the `ruby` Homebrew is using rather than whatever is in the `PATH`.
def ruby(*args)
system RUBY_PATH, *args
end
# Run `xcodebuild` without Homebrew's compiler environment variables set.
def xcodebuild(*args)
removed = ENV.remove_cc_etc
system "xcodebuild", *args

36
Library/Homebrew/extend/pathname.rb
View File

@ -3,12 +3,15 @@ require "mach"
require "resource"
require "metafiles"
# we enhance pathname to make our code more readable
# Homebrew extends Ruby's `Pathname` to make our code more readable.
# @see http://ruby-doc.org/stdlib-1.8.7/libdoc/pathname/rdoc/Pathname.html Ruby's Pathname API
class Pathname
include MachO
# @private
BOTTLE_EXTNAME_RX = /(\.[a-z0-9_]+\.bottle\.(\d+\.)?tar\.gz)$/
# Moves a file from the original location to the {Pathname}'s.
def install(*sources)
sources.each do |src|
case src
@ -77,8 +80,12 @@ class Pathname
end
private :install_symlink_p
if method_defined?(:write)
# @private
alias_method :old_write, :write
end
# we assume this pathname object is a file obviously
alias_method :old_write, :write if method_defined?(:write)
def write(content, *open_args)
raise "Will not overwrite #{self}" if exist?
dirname.mkpath
@ -131,6 +138,7 @@ class Pathname
end
private :default_stat
# @private
def cp(dst)
opoo "Pathname#cp is deprecated, use FileUtils.cp"
if file?
@ -141,6 +149,7 @@ class Pathname
dst
end
# @private
def cp_path_sub(pattern, replacement)
raise "#{self} does not exist" unless self.exist?
@ -157,8 +166,10 @@ class Pathname
end
end
# extended to support common double extensions
# @private
alias_method :extname_old, :extname
# extended to support common double extensions
def extname(path = to_s)
BOTTLE_EXTNAME_RX.match(path)
return $1 if $1
@ -175,6 +186,7 @@ class Pathname
# I don't trust the children.length == 0 check particularly, not to mention
# it is slow to enumerate the whole directory just to see if it is empty,
# instead rely on good ol' libc and the filesystem
# @private
def rmdir_if_possible
rmdir
true
@ -189,17 +201,20 @@ class Pathname
false
end
# @private
def chmod_R(perms)
opoo "Pathname#chmod_R is deprecated, use FileUtils.chmod_R"
require "fileutils"
FileUtils.chmod_R perms, to_s
end
# @private
def version
require "version"
Version.parse(self)
end
# @private
def compression_type
case extname
when ".jar", ".war"
@ -240,10 +255,12 @@ class Pathname
end
end
# @private
def text_executable?
/^#!\s*\S+/ === open("r") { |f| f.read(1024) }
end
# @private
def incremental_hash(klass)
digest = klass.new
if digest.respond_to?(:file)
@ -255,6 +272,7 @@ class Pathname
digest.hexdigest
end
# @private
def sha1
require "digest/sha1"
incremental_hash(Digest::SHA1)
@ -282,10 +300,12 @@ class Pathname
children.select(&:directory?)
end
# @private
def resolved_path
self.symlink? ? dirname+readlink : self
end
# @private
def resolved_path_exists?
link = readlink
rescue ArgumentError
@ -295,6 +315,7 @@ class Pathname
(dirname+link).exist?
end
# @private
def make_relative_symlink(src)
dirname.mkpath
File.symlink(src.relative_path_from(dirname), self)
@ -308,6 +329,7 @@ class Pathname
self + other.to_s
end unless method_defined?(:/)
# @private
def ensure_writable
saved_perms = nil
unless writable_real?
@ -319,10 +341,12 @@ class Pathname
chmod saved_perms if saved_perms
end
# @private
def install_info
quiet_system "/usr/bin/install-info", "--quiet", to_s, "#{dirname}/dir"
end
# @private
def uninstall_info
quiet_system "/usr/bin/install-info", "--delete", "--quiet", to_s, "#{dirname}/dir"
end
@ -389,6 +413,7 @@ class Pathname
end
end
# @private
def abv
out = ""
n = Utils.popen_read("find", expand_path.to_s, "-type", "f", "!", "-name", ".DS_Store").split("\n").size
@ -403,7 +428,9 @@ class Pathname
# the Regexp literals, which forces string interpolation to happen only
# once instead of each time the method is called. This is fixed in 1.9+.
if RUBY_VERSION <= "1.8.7"
# @private
alias_method :old_chop_basename, :chop_basename
def chop_basename(path)
base = File.basename(path)
if /\A#{Pathname::SEPARATOR_PAT}?\z/o =~ base
@ -414,7 +441,9 @@ class Pathname
end
private :chop_basename
# @private
alias_method :old_prepend_prefix, :prepend_prefix
def prepend_prefix(prefix, relpath)
if relpath.empty?
File.dirname(prefix)
@ -437,6 +466,7 @@ class Pathname
end
end
# @private
module ObserverPathnameExtension
class << self
attr_accessor :n, :d

483
Library/Homebrew/formula.rb
View File

File diff suppressed because it is too large Load Diff

16
Library/Homebrew/mach.rb
View File

@ -1,21 +1,26 @@
module ArchitectureListExtension
# @private
def fat?
length > 1
end
# @private
def intel_universal?
intersects_all?(Hardware::CPU::INTEL_32BIT_ARCHS, Hardware::CPU::INTEL_64BIT_ARCHS)
end
# @private
def ppc_universal?
intersects_all?(Hardware::CPU::PPC_32BIT_ARCHS, Hardware::CPU::PPC_64BIT_ARCHS)
end
# Old-style 32-bit PPC/Intel universal, e.g. ppc7400 and i386
# @private
def cross_universal?
intersects_all?(Hardware::CPU::PPC_32BIT_ARCHS, Hardware::CPU::INTEL_32BIT_ARCHS)
end
# @private
def universal?
intel_universal? || ppc_universal? || cross_universal?
end
@ -24,6 +29,7 @@ module ArchitectureListExtension
(Hardware::CPU::PPC_32BIT_ARCHS+Hardware::CPU::PPC_64BIT_ARCHS).any? { |a| self.include? a }
end
# @private
def remove_ppc!
(Hardware::CPU::PPC_32BIT_ARCHS+Hardware::CPU::PPC_64BIT_ARCHS).each { |a| delete a }
end
@ -46,12 +52,13 @@ module ArchitectureListExtension
end
module MachO
# @private
OTOOL_RX = /\t(.*) \(compatibility version (?:\d+\.)*\d+, current version (?:\d+\.)*\d+\)/
# Mach-O binary methods, see:
# /usr/include/mach-o/loader.h
# /usr/include/mach-o/fat.h
# @private
def mach_data
@mach_data ||= begin
offsets = []
@ -132,18 +139,22 @@ module MachO
arch == :ppc64
end
# @private
def dylib?
mach_data.any? { |m| m.fetch(:type) == :dylib }
end
# @private
def mach_o_executable?
mach_data.any? { |m| m.fetch(:type) == :executable }
end
# @private
def mach_o_bundle?
mach_data.any? { |m| m.fetch(:type) == :bundle }
end
# @private
class Metadata
attr_reader :path, :dylib_id, :dylibs
@ -171,6 +182,7 @@ module MachO
end
end
# @private
def mach_metadata
@mach_metadata ||= Metadata.new(self)
end
@ -180,10 +192,12 @@ module MachO
# to be absolute paths.
# Returns an empty array both for software that links against no libraries,
# and for non-mach objects.
# @private
def dynamically_linked_libraries
mach_metadata.dylibs
end
# @private
def dylib_id
mach_metadata.dylib_id
end

2
Library/Homebrew/manpages/brew.1.md
View File

@ -92,7 +92,7 @@ Note that these flags should only appear after a command.
and version, but if it fails, you'll have to make your own template. The wget
formula serves as a simple example. For a complete cheat-sheet, have a look at
`$(brew --repository)/Library/Contributions/example-formula.rb`
<http://www.rubydoc.info/github/Homebrew/homebrew/master/frames>
If `--autotools` is passed, create a basic template for an Autotools-style build.
If `--cmake` is passed, create a basic template for a CMake-style build.

1
Library/Homebrew/utils.rb
View File

@ -80,6 +80,7 @@ def oh1(title)
puts "#{Tty.green}==>#{Tty.white} #{title}#{Tty.reset}"
end
# Print a warning (do this rarely)
def opoo(warning)
$stderr.puts "#{Tty.yellow}Warning#{Tty.reset}: #{warning}"
end

7
Library/Homebrew/utils/inreplace.rb
View File

@ -8,6 +8,13 @@ module Utils
end
module Inreplace
# Sometimes we have to change a bit before we install. Mostly we
# prefer a patch but if you need the `prefix` of this formula in the
# patch you have to resort to `inreplace`, because in the patch
# you don't have access to any var defined by the formula. Only
# HOMEBREW_PREFIX is available in the embedded patch.
# inreplace supports regular expressions.
# <pre>inreplace "somefile.cfg", /look[for]what?/, "replace by #{bin}/tool"</pre>
def inreplace(paths, before = nil, after = nil)
errors = {}

2
share/doc/homebrew/Formula-Cookbook.md
View File

@ -81,7 +81,7 @@ Formulae aren’t that complicated. [etl](https://github.com/Homebrew/homebrew/b
And then [Git](https://github.com/Homebrew/homebrew/tree/master/Library/Formula/git.rb) and [flac](https://github.com/Homebrew/homebrew/tree/master/Library/Formula/flac.rb) show more advanced functionality.
A more complete example-formula [cheat-sheet](https://github.com/Homebrew/homebrew/blob/master/Library/Contributions/example-formula.rb) shows almost all the stuff you can use in a Formula.
Refer to the [Formula class API documentation](http://www.rubydoc.info/github/Homebrew/homebrew/master/frames) which shows all the stuff you can use in a Formula.
## Grab the URL

599
share/doc/homebrew/brew.1.html Normal file
View File

@ -0,0 +1,599 @@
<div class='mp'>
<h2 id="NAME">NAME</h2>
<p class="man-name">
<code>brew</code> - <span class="man-whatis">The missing package manager for OS X</span>
</p>
<h2 id="SYNOPSIS">SYNOPSIS</h2>
<p><code>brew</code> --version<br />
<code>brew</code> command [--verbose|-v] [options] [formula] ...</p>
<h2 id="DESCRIPTION">DESCRIPTION</h2>
<p>Homebrew is the easiest and most flexible way to install the UNIX tools Apple
didn't include with OS X.</p>
<h2 id="ESSENTIAL-COMMANDS">ESSENTIAL COMMANDS</h2>
<p>For the full command list, see the COMMANDS section.</p>
<p>With <code>--verbose</code> or <code>-v</code>, many commands print extra debugging information.
Note that these flags should only appear after a command.</p>
<dl>
<dt><code>install</code> <var>formula</var></dt><dd><p>Install <var>formula</var>.</p></dd>
<dt><code>remove</code> <var>formula</var></dt><dd><p>Uninstall <var>formula</var>.</p></dd>
<dt class="flush"><code>update</code></dt><dd><p>Fetch the newest version of Homebrew from GitHub using <code>git</code>(1).</p></dd>
<dt class="flush"><code>list</code></dt><dd><p>List all installed formulae.</p></dd>
<dt><code>search</code> <var>text</var>|/<var>text</var>/</dt><dd><p>Perform a substring search of formula names for <var>text</var>. If <var>text</var> is
surrounded with slashes, then it is interpreted as a regular expression.
The search for <var>text</var> is extended online to some popular taps.
If no search term is given, all locally available formulae are listed.</p></dd>
</dl>
<h2 id="COMMANDS">COMMANDS</h2>
<ul>
<li><p><code>audit</code> [--strict] [--online] [<var>formulae</var>]:
Check <var>formulae</var> for Homebrew coding style violations. This should be
run before submitting a new formula.</p>
<p>If no <var>formulae</var> are provided, all of them are checked.</p>
<p>If <code>--strict</code> is passed, additional checks are run. This should be used
when creating for new formulae.</p>
<p>If <code>--online</code> is passed, additional slower checks that require a network
connection are run. This should be used when creating for new formulae.</p>
<p><code>audit</code> exits with a non-zero status if any errors are found. This is useful,
for instance, for implementing pre-commit hooks.</p></li>
<li><p><code>cat</code> <var>formula</var>:
Display the source to <var>formula</var>.</p></li>
<li><p><code>cleanup [--force] [--prune=&lt;days>] [-ns]</code> [<var>formulae</var>]:
For all installed or specific formulae, remove any older versions from the
cellar. By default, does not remove out-of-date keg-only brews, as other
software may link directly to specific versions. In addition old downloads from
the Homebrew download-cache are deleted.</p>
<p>If <code>--force</code> is passed, remove out-of-date keg-only brews as well.</p>
<p>If <code>--prune=&lt;days></code> is specified, remove all cache files older than <var>days</var>.</p>
<p>If <code>-n</code> is passed, show what would be removed, but do not actually remove anything.</p>
<p>If <code>-s</code> is passed, scrubs the cache, removing downloads for even the latest
versions of formula. Note downloads for any installed formula will still not be
deleted. If you want to delete those too: <code>rm -rf $(brew --cache)</code></p></li>
<li><p><code>command</code> <var>cmd</var>:
Display the path to the file which is used when invoking <code>brew &lt;cmd></code>.</p></li>
<li><p><code>commands [--quiet [--include-aliases]]</code>:
Show a list of built-in and external commands.</p>
<p>If <code>--quiet</code> is passed, list only the names of commands without the header.
With <code>--include-aliases</code>, the aliases of internal commands will be included.</p></li>
<li><p><code>config</code>:
Show Homebrew and system configuration useful for debugging. If you file
a bug report, you will likely be asked for this information if you do not
provide it.</p></li>
<li><p><code>create &lt;URL> [--autotools|--cmake] [--no-fetch] [--set-name &lt;name>] [--set-version &lt;version>]</code>:
Generate a formula for the downloadable file at <var>URL</var> and open it in the editor.
Homebrew will attempt to automatically derive the formula name
and version, but if it fails, you'll have to make your own template. The wget
formula serves as a simple example. For a complete cheat-sheet, have a look at</p>
<p><a href="http://www.rubydoc.info/github/Homebrew/homebrew/master/frames" data-bare-link="true">http://www.rubydoc.info/github/Homebrew/homebrew/master/frames</a></p>
<p>If <code>--autotools</code> is passed, create a basic template for an Autotools-style build.
If <code>--cmake</code> is passed, create a basic template for a CMake-style build.</p>
<p>If <code>--no-fetch</code> is passed, Homebrew will not download <var>URL</var> to the cache and
will thus not add the SHA256 to the formula for you.</p>
<p>The options <code>--set-name</code> and <code>--set-version</code> each take an argument and allow
you to explicitly set the name and version of the package you are creating.</p></li>
<li><p><code>deps [--1] [-n] [--union] [--tree] [--all] [--installed] [--skip-build] [--skip-optional]</code> <var>formulae</var>:
Show dependencies for <var>formulae</var>. When given multiple formula arguments,
show the intersection of dependencies for <var>formulae</var>, except when passed
<code>--tree</code>, <code>--all</code>, or <code>--installed</code>.</p>
<p>If <code>--1</code> is passed, only show dependencies one level down, instead of
recursing.</p>
<p>If <code>-n</code> is passed, show dependencies in topological order.</p>
<p>If <code>--union</code> is passed, show the union of dependencies for <var>formulae</var>,
instead of the intersection.</p>
<p>If <code>--tree</code> is passed, show dependencies as a tree.</p>
<p>If <code>--all</code> is passed, show dependencies for all formulae.</p>
<p>If <code>--installed</code> is passed, show dependencies for all installed formulae.</p>
<p>By default, <code>deps</code> shows dependencies for <var>formulae</var>. To skip the <code>:build</code>
type dependencies, pass <code>--skip-build</code>. Similarly, pass <code>--skip-optional</code>
to skip <code>:optional</code> dependencies.</p></li>
<li><p><code>diy [--name=&lt;name>] [--version=&lt;version>]</code>:
Automatically determine the installation prefix for non-Homebrew software.</p>
<p>Using the output from this command, you can install your own software into
the Cellar and then link it into Homebrew's prefix with <code>brew link</code>.</p>
<p>The options <code>--name=&lt;name></code> and <code>--version=&lt;version></code> each take an argument
and allow you to explicitly set the name and version of the package you are
installing.</p></li>
<li><p><code>doctor</code>:
Check your system for potential problems. Doctor exits with a non-zero status
if any problems are found.</p></li>
<li><p><code>edit</code>:
Open all of Homebrew for editing.</p></li>
<li><p><code>edit</code> <var>formula</var>:
Open <var>formula</var> in the editor.</p></li>
<li><p><code>fetch [--force] [-v] [--devel|--HEAD] [--deps] [--build-from-source|--force-bottle]</code> <var>formulae</var>:
Download the source packages for the given <var>formulae</var>.
For tarballs, also print SHA1 and SHA-256 checksums.</p>
<p>If <code>--HEAD</code> or <code>--devel</code> is passed, fetch that version instead of the
stable version.</p>
<p>If <code>-v</code> is passed, do a verbose VCS checkout, if the URL represents a CVS.
This is useful for seeing if an existing VCS cache has been updated.</p>
<p>If <code>--force</code> is passed, remove a previously cached version and re-fetch.</p>
<p>If <code>--deps</code> is passed, also download dependencies for any listed <var>formulae</var>.</p>
<p>If <code>--build-from-source</code> is passed, download the source rather than a
bottle.</p>
<p>If <code>--force-bottle</code> is passed, download a bottle if it exists for the current
version of OS X, even if it would not be used during installation.</p></li>
<li><p><code>home</code>:
Open Homebrew's own homepage in a browser.</p></li>
<li><p><code>home</code> <var>formula</var>:
Open <var>formula</var>'s homepage in a browser.</p></li>
<li><p><code>info</code> <var>formula</var>:
Display information about <var>formula</var>.</p></li>
<li><p><code>info --github</code> <var>formula</var>:
Open a browser to the GitHub History page for formula <var>formula</var>.</p>
<p>To view formula history locally: <code>brew log -p &lt;formula></code>.</p></li>
<li><p><code>info --json=&lt;version></code> (--all|--installed|<var>formulae</var>):
Print a JSON representation of <var>formulae</var>. Currently the only accepted value
for <var>version</var> is <code>v1</code>.</p>
<p>Pass <code>--all</code> to get information on all formulae, or <code>--installed</code> to get
information on all installed formulae.</p>
<p>See the docs for examples of using the JSON:
<a href="https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Querying-Brew.md" data-bare-link="true">https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Querying-Brew.md</a></p></li>
<li><p><code>install [--debug] [--env=&lt;std|super>] [--ignore-dependencies] [--only-dependencies] [--cc=&lt;compiler>] [--build-from-source|--force-bottle] [--devel|--HEAD]</code> <var>formula</var>:
Install <var>formula</var>.</p>
<p><var>formula</var> is usually the name of the formula to install, but it can be specified
several different ways. See <a href="#SPECIFYING-FORMULAE" title="SPECIFYING FORMULAE" data-bare-link="true">SPECIFYING FORMULAE</a>.</p>
<p>If <code>--debug</code> is passed and brewing fails, open an interactive debugging
session with access to IRB or a shell inside the temporary build directory.</p>
<p>If <code>--env=std</code> is passed, use the standard build environment instead of superenv.</p>
<p>If <code>--env=super</code> is passed, use superenv even if the formula specifies the
standard build environment.</p>
<p>If <code>--ignore-dependencies</code> is passed, skip installing any dependencies of
any kind. If they are not already present, the formula will probably fail
to install.</p>
<p>If <code>--only-dependencies</code> is passed, install the dependencies with specified
options but do not install the specified formula.</p>
<p>If <code>--cc=&lt;compiler></code> is passed, attempt to compile using <var>compiler</var>.
<var>compiler</var> should be the name of the compiler's executable, for instance
<code>gcc-4.2</code> for Apple's GCC 4.2, or <code>gcc-4.9</code> for a Homebrew-provided GCC
4.9.</p>
<p>If <code>--build-from-source</code> is passed, compile from source even if a bottle
is provided for <var>formula</var>.</p>
<p>If <code>--force-bottle</code> is passed, install from a bottle if it exists
for the current version of OS X, even if custom options are given.</p>
<p>If <code>--devel</code> is passed, and <var>formula</var> defines it, install the development version.</p>
<p>If <code>--HEAD</code> is passed, and <var>formula</var> defines it, install the HEAD version,
aka master, trunk, unstable.</p>
<p>To install a newer version of HEAD use
<code>brew rm &lt;foo> &amp;&amp; brew install --HEAD &lt;foo></code>.</p></li>
<li><p><code>install --interactive [--git]</code> <var>formula</var>:
Download and patch <var>formula</var>, then open a shell. This allows the user to
run <code>./configure --help</code> and otherwise determine how to turn the software
package into a Homebrew formula.</p>
<p>If <code>--git</code> is passed, Homebrew will create a Git repository, useful for
creating patches to the software.</p></li>
<li><p><code>irb [--examples]</code>:
Enter the interactive Homebrew Ruby shell.</p>
<p>If <code>--examples</code> is passed, several examples will be shown.</p></li>
<li><p><code>leaves</code>:
Show installed formulae that are not dependencies of another installed formula.</p></li>
<li><p><code>ln</code>, <code>link [--overwrite] [--dry-run] [--force]</code> <var>formula</var>:
Symlink all of <var>formula</var>'s installed files into the Homebrew prefix. This
is done automatically when you install formulae but can be useful for DIY
installations.</p>
<p>If <code>--overwrite</code> is passed, Homebrew will delete files which already exist in
the prefix while linking.</p>
<p>If <code>--dry-run</code> or <code>-n</code> is passed, Homebrew will list all files which would
be linked or which would be deleted by <code>brew link --overwrite</code>, but will not
actually link or delete any files.</p>
<p>If <code>--force</code> is passed, Homebrew will allow keg-only formulae to be linked.</p></li>
<li><p><code>linkapps [--local]</code> [<var>formulae</var>]:
Find installed formulae that have compiled <code>.app</code>-style "application"
packages for OS X, and symlink those apps into <code>/Applications</code>, allowing
for easier access.</p>
<p>If no <var>formulae</var> are provided, all of them will have their .apps symlinked.</p>
<p>If provided, <code>--local</code> will move them into the user's <code>~/Applications</code>
directory instead of the system directory. It may need to be created, first.</p></li>
<li><p><code>ls</code>, <code>list [--full-name]</code>
List all installed formulae. If <code>--full-name</code> is passed, print formulae with
full-qualified names.</p></li>
<li><p><code>ls</code>, <code>list --unbrewed</code>
List all files in the Homebrew prefix not installed by Homebrew.</p></li>
<li><p><code>ls</code>, <code>list [--versions [--multiple]] [--pinned]</code> [<var>formulae</var>]:
List the installed files for <var>formulae</var>. Combined with <code>--verbose</code>, recursively
list the contents of all subdirectories in each <var>formula</var>'s keg.</p>
<p>If <code>--versions</code> is passed, show the version number for installed formulae,
or only the specified formulae if <var>formulae</var> are given. With <code>--multiple</code>,
only show formulae with multiple versions installed.</p>
<p>If <code>--pinned</code> is passed, show the versions of pinned formulae, or only the
specified (pinned) formulae if <var>formulae</var> are given.
See also <code>pin</code>, <code>unpin</code>.</p></li>
<li><p><code>log [git-log-options]</code> <var>formula</var> ...:
Show the git log for the given formulae. Options that <code>git-log</code>(1)
recognizes can be passed before the formula list.</p></li>
<li><p><code>missing</code> [<var>formulae</var>]:
Check the given <var>formulae</var> for missing dependencies.</p>
<p>If no <var>formulae</var> are given, check all installed brews.</p></li>
<li><p><code>migrate [--force]</code> <var>formulae</var>:
Migrate renamed packages to new name, where <var>formulae</var> are old names of
packages.</p>
<p>If <code>--force</code> is passed, then treat installed <var>formulae</var> and passed <var>formulae</var>
like if they are from same taps and migrate them anyway.</p></li>
<li><p><code>options [--compact] [--all] [--installed]</code> <var>formula</var>:
Display install options specific to <var>formula</var>.</p>
<p>If <code>--compact</code> is passed, show all options on a single line separated by
spaces.</p>
<p>If <code>--all</code> is passed, show options for all formulae.</p>
<p>If <code>--installed</code> is passed, show options for all installed formulae.</p></li>
<li><p><code>outdated [--quiet | --verbose | --json=v1 ]</code>:
Show formulae that have an updated version available.</p>
<p>By default, version information is displayed in interactive shells, and
suppressed otherwise.</p>
<p>If <code>--quiet</code> is passed, list only the names of outdated brews (takes
precedence over <code>--verbose</code>).</p>
<p>If <code>--verbose</code> is passed, display detailed version information.</p>
<p>If <code>--json=&lt;version></code> is passed, the output will be in JSON format. The only
valid version is <code>v1</code>.</p></li>
<li><p><code>pin</code> <var>formulae</var>:
Pin the specified <var>formulae</var>, preventing them from being upgraded when
issuing the <code>brew upgrade</code> command. See also <code>unpin</code>.</p></li>
<li><p><code>prune</code>:
Remove dead symlinks from the Homebrew prefix. This is generally not
needed, but can be useful when doing DIY installations.</p></li>
<li><p><code>reinstall</code> <var>formula</var>:
Uninstall then install <var>formula</var></p></li>
<li><p><code>rm</code>, <code>remove</code>, <code>uninstall [--force]</code> <var>formula</var>:
Uninstall <var>formula</var>.</p>
<p>If <code>--force</code> is passed, and there are multiple versions of <var>formula</var>
installed, delete all installed versions.</p></li>
<li><p><code>search</code>, <code>-S</code>:
Display all locally available formulae for brewing (including tapped ones).
No online search is performed if called without arguments.</p></li>
<li><p><code>search</code>, <code>-S</code> <var>text</var>|/<var>text</var>/:
Perform a substring search of formula names for <var>text</var>. If <var>text</var> is
surrounded with slashes, then it is interpreted as a regular expression.
The search for <var>text</var> is extended online to some popular taps.</p></li>
<li><p><code>search --debian</code>|<code>--fedora</code>|<code>--fink</code>|<code>--macports</code>|<code>--opensuse</code>|<code>--ubuntu</code> <var>text</var>:
Search for <var>text</var> in the given package manager's list.</p></li>
<li><p><code>sh [--env=std]</code>:
Instantiate a Homebrew build environment. Uses our years-battle-hardened
Homebrew build logic to help your <code>./configure &amp;&amp; make &amp;&amp; make install</code>
or even your <code>gem install</code> succeed. Especially handy if you run Homebrew
in a Xcode-only configuration since it adds tools like make to your PATH
which otherwise build-systems would not find.</p></li>
<li><p><code>switch</code> <var>name</var> <var>version</var>:
Symlink all of the specific <var>version</var> of <var>name</var>'s install to Homebrew prefix.</p></li>
<li><p><code>tap</code> [--full] [<user/repo>] [<var>URL</var>]:
Tap a formula repository or list existing taps. This command can be invoked
in three ways.</p>
<ul>
<li><p><code>tap</code> without arguments displays existing taps.</p></li>
<li><p><code>tap &lt;user/repo&gt;</code> taps a formula repository from GitHub using HTTPS.
Since so many taps are hosted on GitHub, this command is a shortcut for
<code>tap user/repo https://github.com/#{user}/homebrew-#{repo}</code>.</p></li>
<li><p><code>tap &lt;user/repo&gt; &lt;URL></code> taps a formula repository from anywhere, using
any transport protocol that <code>git</code> handles. The one-argument form of <code>tap</code>
simplifies but also limits. This two-argument command makes no
assumptions, so taps can be cloned from places other than GitHub and
using protocols other than HTTPS, e.g., SSH, GIT, HTTP, FTP(S), RSYNC.</p></li>
</ul>
<p>By default, the repository is cloned as a shallow copy (<code>--depth=1</code>), but
if <code>--full</code> is passed, a full clone will be used.</p></li>
<li><p><code>tap --repair</code>:
Migrate tapped formulae from symlink-based to directory-based structure.</p></li>
<li><p><code>tap --list-official</code>:
List all official taps.</p></li>
<li><p><code>tap --list-pinned</code>:
List all pinned taps.</p></li>
<li><p><code>tap-info</code> <var>tap</var>:
Display information about <var>tap</var>.</p></li>
<li><p><code>tap-info --json=&lt;version></code> (--installed|<var>taps</var>):
Print a JSON representation of <var>taps</var>. Currently the only accepted value
for <var>version</var> is <code>v1</code>.</p>
<p>Pass <code>--installed</code> to get information on installed taps.</p>
<p>See the docs for examples of using the JSON:
<a href="https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Querying-Brew.md" data-bare-link="true">https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Querying-Brew.md</a></p></li>
<li><p><code>tap-pin</code> <var>tap</var>:
Pin <var>tap</var>, prioritizing its formulae over core when formula names are supplied
by the user. See also <code>tap-unpin</code>.</p></li>
<li><p><code>tap-unpin</code> <var>tap</var>:
Unpin <var>tap</var> so its formulae are no longer prioritized. See also <code>tap-pin</code>.</p></li>
<li><p><code>test</code> [--devel|--HEAD] [--debug] <var>formula</var>:
A few formulae provide a test method. <code>brew test &lt;formula></code> runs this
test method. There is no standard output or return code, but it should
generally indicate to the user if something is wrong with the installed
formula.</p>
<p>To test the development or head version of a formula, use <code>--devel</code> or
<code>--HEAD</code>.</p>
<p>If <code>--debug</code> is passed and the test fails, an interactive debugger will be
launched with access to IRB or a shell inside the temporary test directory.</p>
<p>Example: <code>brew install jruby &amp;&amp; brew test jruby</code></p></li>
<li><p><code>unlink</code> <var>formula</var>:
Remove symlinks for <var>formula</var> from the Homebrew prefix. This can be useful
for temporarily disabling a formula:
<code>brew unlink foo &amp;&amp; commands &amp;&amp; brew link foo</code>.</p></li>
<li><p><code>unlinkapps [--local]</code> [<var>formulae</var>]:
Removes links created by <code>brew linkapps</code>.</p>
<p>If no <var>formulae</var> are provided, all linked app will be removed.</p></li>
<li><p><code>unpack [--git|--patch] [--destdir=&lt;path>]</code> <var>formulae</var>:
Unpack the source files for <var>formulae</var> into subdirectories of the current
working directory. If <code>--destdir=&lt;path></code> is given, the subdirectories will
be created in the directory named by <code>&lt;path></code> instead.</p>
<p>If <code>--patch</code> is passed, patches for <var>formulae</var> will be applied to the
unpacked source.</p>
<p>If <code>--git</code> is passed, a Git repository will be initalized in the unpacked
source. This is useful for creating patches for the software.</p></li>
<li><p><code>unpin</code> <var>formulae</var>:
Unpin <var>formulae</var>, allowing them to be upgraded by <code>brew upgrade</code>. See also
<code>pin</code>.</p></li>
<li><p><code>untap</code> <var>tap</var>:
Remove a tapped repository.</p></li>
<li><p><code>update [--rebase]</code>:
Fetch the newest version of Homebrew and all formulae from GitHub using
<code>git</code>(1).</p>
<p>If <code>--rebase</code> is specified then <code>git pull --rebase</code> is used.</p></li>
<li><p><code>upgrade [install-options]</code> [<var>formulae</var>]:
Upgrade outdated, unpinned brews.</p>
<p>Options for the <code>install</code> command are also valid here.</p>
<p>If <var>formulae</var> are given, upgrade only the specified brews (but do so even
if they are pinned; see <code>pin</code>, <code>unpin</code>).</p></li>
<li><p><code>uses [--installed] [--recursive] [--skip-build] [--skip-optional] [--devel|--HEAD]</code> <var>formulae</var>:
Show the formulae that specify <var>formulae</var> as a dependency. When given
multiple formula arguments, show the intersection of formulae that use
<var>formulae</var>.</p>
<p>Use <code>--recursive</code> to resolve more than one level of dependencies.</p>
<p>If <code>--installed</code> is passed, only list installed formulae.</p>
<p>By default, <code>uses</code> shows all formulae that specify <var>formulae</var> as a dependency.
To skip the <code>:build</code> type dependencies, pass <code>--skip-build</code>. Similarly, pass
<code>--skip-optional</code> to skip <code>:optional</code> dependencies.</p>
<p>By default, <code>uses</code> shows usages of <code>formula</code> by stable builds. To find
cases where <code>formula</code> is used by development or HEAD build, pass
<code>--devel</code> or <code>--HEAD</code>.</p></li>
<li><p><code>--cache</code>:
Display Homebrew's download cache. See also <code>HOMEBREW_CACHE</code>.</p></li>
<li><p><code>--cache</code> <var>formula</var>:
Display the file or directory used to cache <var>formula</var>.</p></li>
<li><p><code>--cellar</code>:
Display Homebrew's Cellar path. <em>Default:</em> <code>$(brew --prefix)/Cellar</code>, or if
that directory doesn't exist, <code>$(brew --repository)/Cellar</code>.</p></li>
<li><p><code>--cellar</code> <var>formula</var>:
Display the location in the cellar where <var>formula</var> would be installed,
without any sort of versioned directory as the last path.</p></li>
<li><p><code>--env</code>:
Show a summary of the Homebrew build environment.</p></li>
<li><p><code>--prefix</code>:
Display Homebrew's install path. <em>Default:</em> <code>/usr/local</code></p></li>
<li><p><code>--prefix</code> <var>formula</var>:
Display the location in the cellar where <var>formula</var> is or would be installed.</p></li>
<li><p><code>--repository</code>:
Display where Homebrew's <code>.git</code> directory is located. For standard installs,
the <code>prefix</code> and <code>repository</code> are the same directory.</p></li>
<li><p><code>--version</code>:
Print the version number of brew to standard error and exit.</p></li>
</ul>
<h2 id="EXTERNAL-COMMANDS">EXTERNAL COMMANDS</h2>
<p>Homebrew, like <code>git</code>(1), supports external commands. These are executable
scripts that reside somewhere in the PATH, named <code>brew-&lt;cmdname></code> or
<code>brew-&lt;cmdname>.rb</code>, which can be invoked like <code>brew cmdname</code>. This allows you
to create your own commands without modifying Homebrew's internals.</p>
<p>Instructions for creating your own commands can be found in the docs:
<a href="https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/External-Commands.md" data-bare-link="true">https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/External-Commands.md</a></p>
<h2 id="SPECIFYING-FORMULAE">SPECIFYING FORMULAE</h2>
<p>Many Homebrew commands accept one or more <var>formula</var> arguments. These arguments
can take several different forms:</p>
<dl>
<dt>The name of a formula</dt><dd><p>e.g. <code>git</code>, <code>node</code>, <code>wget</code>.</p></dd>
<dt>The fully-qualified name of a tapped formula</dt><dd><p>Sometimes a formula from a tapped repository may conflict with one in Homebrew/homebrew.
You can still access these formulae by using a special syntax, e.g.
<code>homebrew/dupes/vim</code> or <code>homebrew/versions/node4</code>.</p></dd>
<dt>An arbitrary URL</dt><dd><p>Homebrew can install formulae via URL, e.g.
<code>https://raw.github.com/Homebrew/homebrew/master/Library/Formula/git.rb</code>.
The formula file will be cached for later use.</p></dd>
</dl>
<h2 id="ENVIRONMENT">ENVIRONMENT</h2>
<dl>
<dt>AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY</dt><dd><p>When using the S3 download strategy, Homebrew will look in
these variables for access credentials (see
<a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html#cli-environment" data-bare-link="true">https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html#cli-environment</a>
to retrieve these access credentials from AWS). If they are not set,
the S3 download strategy will download with a public
(unsigned) URL.</p></dd>
<dt class="flush">BROWSER</dt><dd><p>If set, and <code>HOMEBREW_BROWSER</code> is not, use <code>BROWSER</code> as the web browser
when opening project homepages.</p></dd>
<dt class="flush">EDITOR</dt><dd><p>If set, and <code>HOMEBREW_EDITOR</code> and <code>VISUAL</code> are not, use <code>EDITOR</code> as the text editor.</p></dd>
<dt class="flush">GIT</dt><dd><p>When using Git, Homebrew will use <code>GIT</code> if set,
a Homebrew-built Git if installed, or the system-provided binary.</p>
<p>Set this to force Homebrew to use a particular git binary.</p></dd>
<dt>HOMEBREW_BOTTLE_DOMAIN</dt><dd><p>If set, instructs Homebrew to use the given URL as a download mirror for bottles.</p></dd>
<dt>HOMEBREW_BROWSER</dt><dd><p>If set, uses this setting as the browser when opening project homepages,
instead of the OS default browser.</p></dd>
<dt>HOMEBREW_BUILD_FROM_SOURCE</dt><dd><p>If set, instructs Homebrew to compile from source even when a formula
provides a bottle.</p></dd>
<dt>HOMEBREW_CACHE</dt><dd><p>If set, instructs Homebrew to use the given directory as the download cache.</p>
<p><em>Default:</em> <code>~/Library/Caches/Homebrew</code> if it exists; otherwise,
<code>/Library/Caches/Homebrew</code>.</p></dd>
<dt>HOMEBREW_CURL_VERBOSE</dt><dd><p>If set, Homebrew will pass <code>--verbose</code> when invoking <code>curl</code>(1).</p></dd>
<dt>HOMEBREW_DEBUG</dt><dd><p>If set, any commands that can emit debugging information will do so.</p></dd>
<dt>HOMEBREW_DEBUG_INSTALL</dt><dd><p>When <code>brew install -d</code> or <code>brew install -i</code> drops into a shell,
<code>HOMEBREW_DEBUG_INSTALL</code> will be set to the name of the formula being
brewed.</p></dd>
<dt>HOMEBREW_DEBUG_PREFIX</dt><dd><p>When <code>brew install -d</code> or <code>brew install -i</code> drops into a shell,
<code>HOMEBREW_DEBUG_PREFIX</code> will be set to the target prefix in the Cellar
of the formula being brewed.</p></dd>
<dt>HOMEBREW_DEVELOPER</dt><dd><p>If set, Homebrew will print warnings that are only relevant to Homebrew
developers (active or budding).</p></dd>
<dt>HOMEBREW_EDITOR</dt><dd><p>If set, Homebrew will use this editor when editing a single formula, or
several formulae in the same directory.</p>
<p><em>NOTE</em>: <code>brew edit</code> will open all of Homebrew as discontinuous files and
directories. TextMate can handle this correctly in project mode, but many
editors will do strange things in this case.</p></dd>
<dt>HOMEBREW_GITHUB_API_TOKEN</dt><dd><p>A personal access token for the GitHub API, which you can create at
<a href="https://github.com/settings/tokens" data-bare-link="true">https://github.com/settings/tokens</a>. If set, GitHub will allow you a
greater number of API requests. See
<a href="https://developer.github.com/v3/#rate-limiting" data-bare-link="true">https://developer.github.com/v3/#rate-limiting</a> for more information.
Homebrew uses the GitHub API for features such as <code>brew search</code>.</p></dd>
<dt>HOMEBREW_LOGS</dt><dd><p>If set, Homebrew will use the given directory to store log files.</p></dd>
<dt>HOMEBREW_MAKE_JOBS</dt><dd><p>If set, instructs Homebrew to use the value of <code>HOMEBREW_MAKE_JOBS</code> as
the number of parallel jobs to run when building with <code>make</code>(1).</p>
<p><em>Default:</em> the number of available CPU cores.</p></dd>
<dt>HOMEBREW_NO_EMOJI</dt><dd><p>If set, Homebrew will not print the <code>HOMEBREW_INSTALL_BADGE</code> on a
successful build.</p>
<p><em>Note:</em> Homebrew will only try to print emoji on Lion or newer.</p></dd>
<dt>HOMEBREW_NO_INSECURE_REDIRECT</dt><dd><p>If set, Homebrew will not permit redirects from secure HTTPS
to insecure HTTP.</p>
<p>While ensuring your downloads are fully secure, this is likely
to cause from-source Sourceforge &amp; GNOME based formulae
to fail to download.</p>
<p>Apache formulae are currently unaffected by this variable and
can redirect to plaintext.</p></dd>
<dt>HOMEBREW_NO_GITHUB_API</dt><dd><p>If set, Homebrew will not use the GitHub API for e.g searches or
fetching relevant issues on a failed install.</p></dd>
<dt>HOMEBREW_INSTALL_BADGE</dt><dd><p>Text printed before the installation summary of each successful build.
Defaults to the beer emoji.</p></dd>
<dt>HOMEBREW_SVN</dt><dd><p>When exporting from Subversion, Homebrew will use <code>HOMEBREW_SVN</code> if set,
a Homebrew-built Subversion if installed, or the system-provided binary.</p>
<p>Set this to force Homebrew to use a particular svn binary.</p></dd>
<dt>HOMEBREW_TEMP</dt><dd><p>If set, instructs Homebrew to use <code>HOMEBREW_TEMP</code> as the temporary directory
for building packages. This may be needed if your system temp directory and
Homebrew Prefix are on different volumes, as OS X has trouble moving
symlinks across volumes when the target does not yet exist.</p>
<p>This issue typically occurs when using FileVault or custom SSD
configurations.</p></dd>
<dt>HOMEBREW_VERBOSE</dt><dd><p>If set, Homebrew always assumes <code>--verbose</code> when running commands.</p></dd>
<dt class="flush">VISUAL</dt><dd><p>If set, and <code>HOMEBREW_EDITOR</code> is not, use <code>VISUAL</code> as the text editor.</p></dd>
</dl>
<h2 id="USING-HOMEBREW-BEHIND-A-PROXY">USING HOMEBREW BEHIND A PROXY</h2>
<p>Homebrew uses several commands for downloading files (e.g. curl, git, svn).
Many of these tools can download via a proxy. It's common for these tools
to read proxy parameters from environment variables.</p>
<p>For the majority of cases setting <code>http_proxy</code> is enough. You can set this in
your shell profile, or you can use it before a brew command:</p>
<pre><code>http_proxy=http://&lt;host>:&lt;port> brew install foo
</code></pre>
<p>If your proxy requires authentication:</p>
<pre><code>http_proxy=http://&lt;user>:&lt;password>@&lt;host>:&lt;port> brew install foo
</code></pre>
<h2 id="SEE-ALSO">SEE ALSO</h2>
<p>Homebrew Documentation: <a href="https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/" data-bare-link="true">https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/</a></p>
<p><code>git</code>(1), <code>git-log</code>(1)</p>
<h2 id="AUTHORS">AUTHORS</h2>
<p>Homebrew's current maintainers are Misty De Meo, Adam Vandenberg, Xu Cheng, Mike McQuaid, Baptiste Fontaine, Brett Koonce, Dominyk Tiller, Tim Smith and Alex Dunn.</p>
<p>Homebrew was originally created by Max Howell.</p>
<h2 id="BUGS">BUGS</h2>
<p>See Issues on GitHub: <a href="https://github.com/Homebrew/homebrew/issues" data-bare-link="true">https://github.com/Homebrew/homebrew/issues</a></p>
</div>

2
share/man/man1/brew.1
View File

@ -92,7 +92,7 @@ If \fB\-\-quiet\fR is passed, list only the names of commands without the header
\fBcreate <URL> [\-\-autotools|\-\-cmake] [\-\-no\-fetch] [\-\-set\-name <name>] [\-\-set\-version <version>]\fR: Generate a formula for the downloadable file at \fIURL\fR and open it in the editor\. Homebrew will attempt to automatically derive the formula name and version, but if it fails, you\'ll have to make your own template\. The wget formula serves as a simple example\. For a complete cheat\-sheet, have a look at
.
.IP
\fB$(brew \-\-repository)/Library/Contributions/example\-formula\.rb\fR
\fIhttp://www\.rubydoc\.info/github/Homebrew/homebrew/master/frames\fR
.
.IP
If \fB\-\-autotools\fR is passed, create a basic template for an Autotools\-style build\. If \fB\-\-cmake\fR is passed, create a basic template for a CMake\-style build\.