aboutsummaryrefslogtreecommitdiffstats
path: root/Library/Homebrew/cmd
diff options
context:
space:
mode:
authorEricFromCanada2017-03-05 21:45:15 -0500
committerEricFromCanada2017-03-05 21:45:15 -0500
commitaee23ccb0355228f24d387fcbe7cf5d30f57d8b6 (patch)
tree1ac8c783b840d3f012bc462c40cf5c7b52b59337 /Library/Homebrew/cmd
parentc349b37b4fc5c0856e5a93e059494824e41f4a0e (diff)
downloadbrew-aee23ccb0355228f24d387fcbe7cf5d30f57d8b6.tar.bz2
Add more flags and descriptions to man pages.
Diffstat (limited to 'Library/Homebrew/cmd')
-rw-r--r--Library/Homebrew/cmd/install.rb5
-rw-r--r--Library/Homebrew/cmd/sh.rb10
2 files changed, 10 insertions, 5 deletions
diff --git a/Library/Homebrew/cmd/install.rb b/Library/Homebrew/cmd/install.rb
index 5a3aeb7b3..c825e2796 100644
--- a/Library/Homebrew/cmd/install.rb
+++ b/Library/Homebrew/cmd/install.rb
@@ -1,4 +1,4 @@
-#: * `install` [`--debug`] [`--env=`<std>|<super>] [`--ignore-dependencies`] [`--only-dependencies`] [`--cc=`<compiler>] [`--build-from-source`] [`--devel`|`--HEAD`] [`--keep-tmp`] <formula>:
+#: * `install` [`--debug`] [`--env=`(`std`|`super`)] [`--ignore-dependencies`|`--only-dependencies`] [`--cc=`<compiler>] [`--build-from-source`|`--force-bottle`] [`--devel`|`--HEAD`] [`--keep-tmp`] [`--build-bottle`] <formula>:
#: Install <formula>.
#:
#: <formula> is usually the name of the formula to install, but it can be specified
@@ -44,6 +44,9 @@
#: If `--keep-tmp` is passed, the temporary files created during installation
#: are not deleted.
#:
+#: If `--build-bottle` is passed, prepare the formula for eventual bottling
+#: during installation.
+#:
#: * `install` `--interactive` [`--git`] <formula>:
#: Download and patch <formula>, then open a shell. This allows the user to
#: run `./configure --help` and otherwise determine how to turn the software
diff --git a/Library/Homebrew/cmd/sh.rb b/Library/Homebrew/cmd/sh.rb
index 09e7f435e..249753355 100644
--- a/Library/Homebrew/cmd/sh.rb
+++ b/Library/Homebrew/cmd/sh.rb
@@ -1,9 +1,11 @@
#: * `sh` [`--env=std`]:
-#: Instantiate a Homebrew build environment. Uses our years-battle-hardened
+#: Start a Homebrew build environment shell. Uses our years-battle-hardened
#: Homebrew build logic to help your `./configure && make && make install`
#: or even your `gem install` succeed. Especially handy if you run Homebrew
#: in an Xcode-only configuration since it adds tools like `make` to your `PATH`
-#: which otherwise build-systems would not find.
+#: which otherwise build systems would not find.
+#:
+#: If `--env=std` is passed, use the standard `PATH` instead of superenv's.
require "extend/ENV"
require "formula"
@@ -20,13 +22,13 @@ module Homebrew
end
ENV.setup_build_environment
if superenv?
- # superenv stopped adding brew's bin but generally user's will want it
+ # superenv stopped adding brew's bin but generally users will want it
ENV["PATH"] = ENV["PATH"].split(File::PATH_SEPARATOR).insert(1, "#{HOMEBREW_PREFIX}/bin").join(File::PATH_SEPARATOR)
end
ENV["PS1"] = 'brew \[\033[1;32m\]\w\[\033[0m\]$ '
ENV["VERBOSE"] = "1"
puts <<-EOS.undent_________________________________________________________72
- Your shell has been configured to use Homebrew's build environment:
+ Your shell has been configured to use Homebrew's build environment;
this should help you build stuff. Notably though, the system versions of
gem and pip will ignore our configuration and insist on using the
environment they were built under (mostly). Sadly, scons will also