From aee23ccb0355228f24d387fcbe7cf5d30f57d8b6 Mon Sep 17 00:00:00 2001 From: EricFromCanada Date: Sun, 5 Mar 2017 21:45:15 -0500 Subject: Add more flags and descriptions to man pages. --- docs/brew.1.html | 61 ++++++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 51 insertions(+), 10 deletions(-) (limited to 'docs') diff --git a/docs/brew.1.html b/docs/brew.1.html index 717542127..7a06426ae 100644 --- a/docs/brew.1.html +++ b/docs/brew.1.html @@ -152,7 +152,7 @@ information on all installed formulae.
See the docs for examples of using the JSON output: http://docs.brew.sh/Querying-Brew.html
-install [--debug] [--env=std|super] [--ignore-dependencies] [--only-dependencies] [--cc=compiler] [--build-from-source] [--devel|--HEAD] [--keep-tmp] formulaInstall formula.
+install [--debug] [--env=(std|super)] [--ignore-dependencies|--only-dependencies] [--cc=compiler] [--build-from-source|--force-bottle] [--devel|--HEAD] [--keep-tmp] [--build-bottle] formulaInstall formula.
formula is usually the name of the formula to install, but it can be specified in several different ways. See SPECIFYING FORMULAE.
@@ -195,7 +195,10 @@ for installation. aka master, trunk, unstable.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] formulaDownload and patch formula, then open a shell. This allows the user to
run ./configure --help and otherwise determine how to turn the software
package into a Homebrew formula.
If --desc is passed, browse available packages matching text including a
description for each.
search (--debian|--fedora|--fink|--macports|--opensuse|--ubuntu) textSearch for text in the given package manager's list.
sh [--env=std]Instantiate a Homebrew build environment. Uses our years-battle-hardened +
sh [--env=std]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.
If --env=std is passed, use the standard PATH instead of superenv's.
style [--fix] [--display-cop-names] [files|taps|formulae]Check formulae or files for conformance to Homebrew style guidelines.
formulae and files may not be combined. If both are omitted, style will run @@ -478,9 +483,29 @@ name of the file or formula being audited, to make the output easy to grep.
audit exits with a non-zero status if any errors are found. This is useful,
for instance, for implementing pre-commit hooks.
bottle [--verbose] [--no-rebuild] [--keep-old] [--skip-relocation] [--root-url=URL] [--force-core-tap]:bottle --merge [--no-commit] [--keep-old] [--write]Generate a bottle (binary package) from a formula installed with
---build-bottle.
bottle [--verbose] [--no-rebuild|--keep-old] [--skip-relocation] [--root-url=URL] [--force-core-tap] formulaeGenerate a bottle (binary package) from a formula installed with
+--build-bottle.
If the formula specifies a rebuild version, it will be incremented in the
+generated DSL. Passing --keep-old will attempt to keep it at its
+original value, while --no-rebuild will remove it.
If --verbose is passed, print the bottling commands and any warnings
+encountered.
If --skip-relocation is passed, do not check if the bottle can be marked
+as relocatable.
If --root-url is passed, use the specified URL as the root of the
+bottle's URL instead of Homebrew's default.
If --force-core-tap is passed, build a bottle even if formula is not
+in homebrew/core or any installed taps.
bottle --merge [--keep-old] [--write [--no-commit]] formulaeGenerate a bottle from a formula and print the new DSL merged into the +existing formula.
+ +If --write is passed, write the changes to the formula file. A new
+commit will then be generated unless --no-commit is passed.
bump-formula-pr [--devel] [--dry-run [--write]] [--audit|--strict] [--mirror=URL] [--version=version] [--message=message] (--url=URL --sha256=sha-256|--tag=tag --revision=revision) formulaCreates a pull request to update the formula with a new URL or a new tag.
If a URL is specified, the sha-256 checksum of the new download must @@ -612,8 +637,24 @@ launched with access to IRB or a shell inside the temporary test directory.
not deleted.Example: brew install jruby && brew test jruby
tests [-v] [--coverage] [--generic] [--no-compat] [--only=test_script:line_number] [--seed seed] [--online] [--official-cmd-taps]Run Homebrew's unit and integration tests.
update-test [--commit=commit] [--before=date] [--keep-tmp]Runs a test of brew update with a new repository clone.
tests [--verbose] [--coverage] [--generic] [--no-compat] [--only=test_script[:line_number]] [--seed seed] [--online] [--official-cmd-taps]Run Homebrew's unit and integration tests. If provided,
+--only=test_script runs only test_script_spec.rb, and --seed
+randomizes tests with the provided value instead of a random seed.
If --verbose is passed, print the command that runs the tests.
If --coverage is passed, also generate code coverage reports.
If --generic is passed, only run OS-agnostic tests.
If --no-compat is passed, do not load the compatibility layer when
+running tests.
If --online is passed, include tests that use the GitHub API.
If --official-cmd-taps is passed, include tests that use any of the
+taps for official external commands.
update-test [--commit=commit] [--before=date] [--to-tag] [--keep-tmp]Runs a test of brew update with a new repository clone.
If no arguments are passed, use origin/master as the start commit.
caskInstall macOS applications distributed as binaries: https://github.com/caskroom/homebrew-cask
servicesIntegrates Homebrew formulae with macOS's launchctl manager:
+
servicesIntegrates Homebrew formulae with macOS's launchctl(1) manager:
https://github.com/Homebrew/homebrew-services