From 6cb56297378cb57ade790c392dacf4a3bf02f7da Mon Sep 17 00:00:00 2001 From: EricFromCanada Date: Sat, 25 Feb 2017 17:27:08 -0500 Subject: Work around man page generator bug for pull.rb To work around ronn's [issue with nested lists](https://github.com/rtomayko/ronn/issues/35), treat each item as a separate paragraph with alternate list markers. --- Library/Homebrew/dev-cmd/pull.rb | 53 +++++++++++++++++++++++----------------- 1 file changed, 31 insertions(+), 22 deletions(-) (limited to 'Library') diff --git a/Library/Homebrew/dev-cmd/pull.rb b/Library/Homebrew/dev-cmd/pull.rb index c2342d39c..98a62e578 100644 --- a/Library/Homebrew/dev-cmd/pull.rb +++ b/Library/Homebrew/dev-cmd/pull.rb @@ -1,33 +1,42 @@ -#: `pull` [`--bottle`] [`--bump`] [`--clean`] [`--ignore-whitespace`] [`--resolve`] [`--branch-okay`] [`--no-pbcopy`] [`--no-publish`] [] -#: +#: * `pull` [`--bottle`] [`--bump`] [`--clean`] [`--ignore-whitespace`] [`--resolve`] [`--branch-okay`] [`--no-pbcopy`] [`--no-publish`] []: #: Gets a patch from a GitHub commit or pull request and applies it to Homebrew. #: Optionally, installs the formulae changed by the patch. #: #: Each may be one of: -#: * The ID number of a PR (Pull Request) in the homebrew/core GitHub +#: +#: ~ The ID number of a PR (pull request) in the homebrew/core GitHub #: repository -#: * The URL of a PR on GitHub, using either the web page or API URL +#: +#: ~ The URL of a PR on GitHub, using either the web page or API URL #: formats. In this form, the PR may be on Homebrew/brew, #: Homebrew/homebrew-core or any tap. -#: * The URL of a commit on GitHub -#: * A "http://bot.brew.sh/job/..." string specifying a testing job ID #: -#: If `--bottle` was passed, handle bottles, pulling the bottle-update -#: commit and publishing files on Bintray. -#: If `--bump` was passed, for one-formula PRs, automatically reword -#: commit message to our preferred format. -#: If `--clean` was passed, do not rewrite or otherwise modify the -#: commits found in the pulled PR. -#: If `--ignore-whitespace` was passed, silently ignore whitespace -#: discrepancies when applying diffs. -#: If `--resolve` was passed, when a patch fails to apply, leave in -#: progress and allow user to -#: resolve, instead of aborting. -#: If `--branch-okay` was passed, do not warn if pulling to a branch -#: besides master (useful for testing). -#: If `--no-pbcopy` was passed, do not copy anything to the system -# clipboard. -#: If `--no-publish` was passed, do not publish bottles to Bintray. +#: ~ The URL of a commit on GitHub +#: +#: ~ A "http://bot.brew.sh/job/..." string specifying a testing job ID +#: +#: If `--bottle` is passed, handle bottles, pulling the bottle-update +#: commit and publishing files on Bintray. +#: +#: If `--bump` is passed, for one-formula PRs, automatically reword +#: commit message to our preferred format. +#: +#: If `--clean` is passed, do not rewrite or otherwise modify the +#: commits found in the pulled PR. +#: +#: If `--ignore-whitespace` is passed, silently ignore whitespace +#: discrepancies when applying diffs. +#: +#: If `--resolve` is passed, when a patch fails to apply, leave in +#: progress and allow user to resolve, instead of aborting. +#: +#: If `--branch-okay` is passed, do not warn if pulling to a branch +#: besides master (useful for testing). +#: +#: If `--no-pbcopy` is passed, do not copy anything to the system +#: clipboard. +#: +#: If `--no-publish` is passed, do not publish bottles to Bintray. require "net/http" require "net/https" -- cgit v1.2.3 From afc539f86e2be27744838d0db6f85bcfe20fa857 Mon Sep 17 00:00:00 2001 From: EricFromCanada Date: Sat, 25 Feb 2017 17:37:57 -0500 Subject: Update brew's man page formatting and grammar Also update command specifications to match descriptions. --- Library/Homebrew/cmd/cleanup.rb | 2 +- Library/Homebrew/cmd/desc.rb | 7 +++---- Library/Homebrew/cmd/info.rb | 4 ++-- Library/Homebrew/cmd/outdated.rb | 2 +- Library/Homebrew/cmd/readall.rb | 2 +- Library/Homebrew/cmd/search.rb | 2 +- Library/Homebrew/cmd/tap-info.rb | 2 +- Library/Homebrew/cmd/unlink.rb | 2 +- Library/Homebrew/cmd/unpack.rb | 2 +- Library/Homebrew/cmd/uses.rb | 4 ++-- Library/Homebrew/dev-cmd/boneyard-formula-pr.rb | 2 +- Library/Homebrew/dev-cmd/bottle.rb | 3 +-- Library/Homebrew/dev-cmd/bump-formula-pr.rb | 13 ++++++------- Library/Homebrew/dev-cmd/create.rb | 3 +-- Library/Homebrew/dev-cmd/formula.rb | 2 +- Library/Homebrew/dev-cmd/linkage.rb | 2 +- Library/Homebrew/dev-cmd/mirror.rb | 2 +- Library/Homebrew/dev-cmd/release-notes.rb | 6 +++--- Library/Homebrew/dev-cmd/tests.rb | 2 +- Library/Homebrew/dev-cmd/update-test.rb | 8 ++++---- Library/Homebrew/manpages/brew.1.md.erb | 4 ++-- 21 files changed, 36 insertions(+), 40 deletions(-) (limited to 'Library') diff --git a/Library/Homebrew/cmd/cleanup.rb b/Library/Homebrew/cmd/cleanup.rb index 5b46e0872..126309579 100644 --- a/Library/Homebrew/cmd/cleanup.rb +++ b/Library/Homebrew/cmd/cleanup.rb @@ -7,7 +7,7 @@ #: If `--dry-run` or `-n` is passed, show what would be removed, but do not #: actually remove anything. #: -#: If `-s` is passed, scrubs the cache, removing downloads for even the latest +#: If `-s` is passed, scrub the cache, removing downloads for even the latest #: versions of formulae. Note downloads for any installed formulae will still not be #: deleted. If you want to delete those too: `rm -rf $(brew --cache)` diff --git a/Library/Homebrew/cmd/desc.rb b/Library/Homebrew/cmd/desc.rb index 3ef02288b..53291602e 100644 --- a/Library/Homebrew/cmd/desc.rb +++ b/Library/Homebrew/cmd/desc.rb @@ -1,11 +1,10 @@ #: * `desc` : #: Display 's name and one-line description. #: -#: * `desc` [`-s`|`-n`|`-d`] : +#: * `desc` [`-s`|`-n`|`-d`] (|`/``/`): #: Search both name and description (`-s`), just the names (`-n`), or just the -#: descriptions (`-d`) for ``. `` is by default interpreted -#: as a literal string; if flanked by slashes, it is instead interpreted as a -#: regular expression. Formula descriptions are cached; the cache is created on +#: descriptions (`-d`) for . If is flanked by slashes, it is interpreted +#: as a regular expression. Formula descriptions are cached; the cache is created on #: the first search, making that search slower than subsequent ones. require "descriptions" diff --git a/Library/Homebrew/cmd/info.rb b/Library/Homebrew/cmd/info.rb index 1850ae003..b06d99466 100644 --- a/Library/Homebrew/cmd/info.rb +++ b/Library/Homebrew/cmd/info.rb @@ -4,7 +4,7 @@ #: * `info` `--github` : #: Open a browser to the GitHub History page for formula . #: -#: To view formula history locally: `brew log -p `. +#: To view formula history locally: `brew log -p ` #: #: * `info` `--json=` (`--all`|`--installed`|): #: Print a JSON representation of . Currently the only accepted value @@ -13,7 +13,7 @@ #: Pass `--all` to get information on all formulae, or `--installed` to get #: information on all installed formulae. #: -#: See the docs for examples of using the JSON: +#: See the docs for examples of using the JSON output: #: require "blacklist" diff --git a/Library/Homebrew/cmd/outdated.rb b/Library/Homebrew/cmd/outdated.rb index 9ed7a0f79..a18f4e399 100644 --- a/Library/Homebrew/cmd/outdated.rb +++ b/Library/Homebrew/cmd/outdated.rb @@ -1,4 +1,4 @@ -#: * `outdated` [`--quiet`|`--verbose`|`--json=v1`] [`--fetch-HEAD`]: +#: * `outdated` [`--quiet`|`--verbose`|`--json=`] [`--fetch-HEAD`]: #: Show formulae that have an updated version available. #: #: By default, version information is displayed in interactive shells, and diff --git a/Library/Homebrew/cmd/readall.rb b/Library/Homebrew/cmd/readall.rb index 7c1a085c9..3591e0c09 100644 --- a/Library/Homebrew/cmd/readall.rb +++ b/Library/Homebrew/cmd/readall.rb @@ -4,7 +4,7 @@ #: #: This can be useful for debugging issues across all formulae #: when making significant changes to `formula.rb`, -#: or to determine if any current formulae have Ruby issues +#: or to determine if any current formulae have Ruby issues. require "readall" diff --git a/Library/Homebrew/cmd/search.rb b/Library/Homebrew/cmd/search.rb index d69164eb9..e834a00b5 100644 --- a/Library/Homebrew/cmd/search.rb +++ b/Library/Homebrew/cmd/search.rb @@ -2,7 +2,7 @@ #: Display all locally available formulae for brewing (including tapped ones). #: No online search is performed if called without arguments. #: -#: * `search` [`--desc`] |`/``/`: +#: * `search` [`--desc`] (|`/``/`): #: Perform a substring search of formula names for . If is #: surrounded with slashes, then it is interpreted as a regular expression. #: The search for is extended online to some popular taps. diff --git a/Library/Homebrew/cmd/tap-info.rb b/Library/Homebrew/cmd/tap-info.rb index b46de30c1..225b70097 100644 --- a/Library/Homebrew/cmd/tap-info.rb +++ b/Library/Homebrew/cmd/tap-info.rb @@ -12,7 +12,7 @@ #: #: Pass `--installed` to get information on installed taps. #: -#: See the docs for examples of using the JSON: +#: See the docs for examples of using the JSON output: #: require "tap" diff --git a/Library/Homebrew/cmd/unlink.rb b/Library/Homebrew/cmd/unlink.rb index a105f9c56..3f858b2c4 100644 --- a/Library/Homebrew/cmd/unlink.rb +++ b/Library/Homebrew/cmd/unlink.rb @@ -1,7 +1,7 @@ #: * `unlink` [`--dry-run`] : #: Remove symlinks for from the Homebrew prefix. This can be useful #: for temporarily disabling a formula: -#: `brew unlink foo && commands && brew link foo`. +#: `brew unlink && && brew link ` #: #: If `--dry-run` or `-n` is passed, Homebrew will list all files which would #: be unlinked, but will not actually unlink or delete any files. diff --git a/Library/Homebrew/cmd/unpack.rb b/Library/Homebrew/cmd/unpack.rb index 4e6584e70..60d796d9f 100644 --- a/Library/Homebrew/cmd/unpack.rb +++ b/Library/Homebrew/cmd/unpack.rb @@ -1,7 +1,7 @@ #: * `unpack` [`--git`|`--patch`] [`--destdir=`] : #: Unpack the source files for into subdirectories of the current #: working directory. If `--destdir=` is given, the subdirectories will -#: be created in the directory named by `` instead. +#: be created in the directory named by instead. #: #: If `--patch` is passed, patches for will be applied to the #: unpacked source. diff --git a/Library/Homebrew/cmd/uses.rb b/Library/Homebrew/cmd/uses.rb index 5f6611dfc..b1122c90a 100644 --- a/Library/Homebrew/cmd/uses.rb +++ b/Library/Homebrew/cmd/uses.rb @@ -12,8 +12,8 @@ #: `--include-build`. Similarly, pass `--include-optional` to include `:optional` #: dependencies. To skip `:recommended` type dependencies, pass `--skip-recommended`. #: -#: By default, `uses` shows usages of `formula` by stable builds. To find -#: cases where `formula` is used by development or HEAD build, pass +#: By default, `uses` shows usages of by stable builds. To find +#: cases where is used by development or HEAD build, pass #: `--devel` or `--HEAD`. require "formula" diff --git a/Library/Homebrew/dev-cmd/boneyard-formula-pr.rb b/Library/Homebrew/dev-cmd/boneyard-formula-pr.rb index 3066d2ee6..7531ef9cf 100644 --- a/Library/Homebrew/dev-cmd/boneyard-formula-pr.rb +++ b/Library/Homebrew/dev-cmd/boneyard-formula-pr.rb @@ -1,5 +1,5 @@ #: @hide_from_man_page -#: * `boneyard-formula-pr` [`--dry-run`] [`--local`] [`--reason=`] : +#: * `boneyard-formula-pr` [`--dry-run`] [`--local`] [`--reason=`] : #: Creates a pull request to boneyard a formula. #: #: If `--dry-run` is passed, print what would be done rather than doing it. diff --git a/Library/Homebrew/dev-cmd/bottle.rb b/Library/Homebrew/dev-cmd/bottle.rb index 7367e5c37..91bdcba93 100644 --- a/Library/Homebrew/dev-cmd/bottle.rb +++ b/Library/Homebrew/dev-cmd/bottle.rb @@ -1,6 +1,5 @@ -#: * `bottle` [`--verbose`] [`--no-rebuild`] [`--keep-old`] [`--skip-relocation`] [`--root-url=`] [`--force-core-tap`]: +#: * `bottle` [`--verbose`] [`--no-rebuild`] [`--keep-old`] [`--skip-relocation`] [`--root-url=`] [`--force-core-tap`]: #: * `bottle` `--merge` [`--no-commit`] [`--keep-old`] [`--write`]: -#: #: Generate a bottle (binary package) from a formula installed with #: `--build-bottle`. diff --git a/Library/Homebrew/dev-cmd/bump-formula-pr.rb b/Library/Homebrew/dev-cmd/bump-formula-pr.rb index bfe9c7776..6c7b7d5b5 100644 --- a/Library/Homebrew/dev-cmd/bump-formula-pr.rb +++ b/Library/Homebrew/dev-cmd/bump-formula-pr.rb @@ -1,8 +1,7 @@ -#: * `bump-formula-pr` [`--devel`] [`--dry-run`] [`--audit`|`--strict`] [`--message=`] `--url=` `--sha256=` : -#: * `bump-formula-pr` [`--devel`] [`--dry-run`] [`--audit`|`--strict`] [`--message=`] `--tag=` `--revision=` : -#: Creates a pull request to update the formula with a new url or a new tag. +#: * `bump-formula-pr` [`--devel`] [`--dry-run` [`--write`]] [`--audit`|`--strict`] [`--mirror=`] [`--version=`] [`--message=`] (`--url=` `--sha256=`|`--tag=` `--revision=`) : +#: Creates a pull request to update the formula with a new URL or a new tag. #: -#: If a is specified, the checksum of the new download must +#: If a is specified, the checksum of the new download must #: also be specified. A best effort to determine the and #: name will be made if either or both values are not supplied by the user. #: @@ -21,17 +20,17 @@ #: #: If `--strict` is passed, run `brew audit --strict` before opening the PR. #: -#: If `--mirror=` is passed, use the value as a mirror url. +#: If `--mirror=` is passed, use the value as a mirror URL. #: #: If `--version=` is passed, use the value to override the value -#: parsed from the url or tag. Note that `--version=0` can be used to delete +#: parsed from the URL or tag. Note that `--version=0` can be used to delete #: an existing `version` override from a formula if it has become redundant. #: #: If `--message=` is passed, append to the default PR #: message. #: #: Note that this command cannot be used to transition a formula from a -#: url-and-sha256 style specification into a tag-and-revision style +#: URL-and-sha256 style specification into a tag-and-revision style #: specification, nor vice versa. It must use whichever style specification #: the preexisting formula already uses. diff --git a/Library/Homebrew/dev-cmd/create.rb b/Library/Homebrew/dev-cmd/create.rb index b4cda0fad..9c58dc71a 100644 --- a/Library/Homebrew/dev-cmd/create.rb +++ b/Library/Homebrew/dev-cmd/create.rb @@ -3,8 +3,7 @@ #: 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 the complete API have a look at -#: -#: +#: . #: #: 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. diff --git a/Library/Homebrew/dev-cmd/formula.rb b/Library/Homebrew/dev-cmd/formula.rb index 71687dfa7..67d11edce 100644 --- a/Library/Homebrew/dev-cmd/formula.rb +++ b/Library/Homebrew/dev-cmd/formula.rb @@ -1,5 +1,5 @@ #: * `formula` : -#: Display the path where is +#: Display the path where is located. require "formula" diff --git a/Library/Homebrew/dev-cmd/linkage.rb b/Library/Homebrew/dev-cmd/linkage.rb index 44e0f224e..e4da827f2 100644 --- a/Library/Homebrew/dev-cmd/linkage.rb +++ b/Library/Homebrew/dev-cmd/linkage.rb @@ -1,4 +1,4 @@ -#: * `linkage` [`--test`] [`--reverse`] : +#: * `linkage` [`--test`] [`--reverse`] : #: Checks the library links of an installed formula. #: #: Only works on installed formulae. An error is raised if it is run on diff --git a/Library/Homebrew/dev-cmd/mirror.rb b/Library/Homebrew/dev-cmd/mirror.rb index bd5868726..10811493c 100644 --- a/Library/Homebrew/dev-cmd/mirror.rb +++ b/Library/Homebrew/dev-cmd/mirror.rb @@ -1,5 +1,5 @@ #: @hide_from_man_page -#: * `mirror` [`--test`] [ ...]: +#: * `mirror` [`--test`] : #: Reuploads the stable URL for a formula to Bintray to use it as a mirror. module Homebrew diff --git a/Library/Homebrew/dev-cmd/release-notes.rb b/Library/Homebrew/dev-cmd/release-notes.rb index 919243764..eb398fcfb 100644 --- a/Library/Homebrew/dev-cmd/release-notes.rb +++ b/Library/Homebrew/dev-cmd/release-notes.rb @@ -1,7 +1,7 @@ -#: * `release-notes` [] []: +#: * `release-notes` [`--markdown`] [] []: #: Output the merged pull requests on Homebrew/brew between two Git refs. -#: If no `previous_tag` is provided it defaults to the newest tag. -#: If no `end_ref` is provided it defaults to `origin/master`. +#: If no is provided it defaults to the newest tag. +#: If no is provided it defaults to `origin/master`. #: #: If `--markdown` is passed, output as a Markdown list. diff --git a/Library/Homebrew/dev-cmd/tests.rb b/Library/Homebrew/dev-cmd/tests.rb index 6276d1c1b..0c8621a01 100644 --- a/Library/Homebrew/dev-cmd/tests.rb +++ b/Library/Homebrew/dev-cmd/tests.rb @@ -1,4 +1,4 @@ -#: * `tests` [`-v`] [`--coverage`] [`--generic`] [`--no-compat`] [`--only=`] [`--seed` ] [`--trace`] [`--online`] [`--official-cmd-taps`]: +#: * `tests` [`-v`] [`--coverage`] [`--generic`] [`--no-compat`] [`--only=``:`] [`--seed` ] [`--trace`] [`--online`] [`--official-cmd-taps`]: #: Run Homebrew's unit and integration tests. require "fileutils" diff --git a/Library/Homebrew/dev-cmd/update-test.rb b/Library/Homebrew/dev-cmd/update-test.rb index 3b8dc11f9..9704426dd 100644 --- a/Library/Homebrew/dev-cmd/update-test.rb +++ b/Library/Homebrew/dev-cmd/update-test.rb @@ -1,14 +1,14 @@ -#: * `update-test` [`--commit=`] [`--before=`] [`--keep-tmp`]: +#: * `update-test` [`--commit=`] [`--before=`] [`--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. #: -#: If `--commit=` is passed, use `` as the start commit. +#: If `--commit=` is passed, use as the start commit. #: -#: If `--before=` is passed, use the commit at `` as the +#: If `--before=` is passed, use the commit at as the #: start commit. #: -#: If `--to-tag` is passed, set HOMEBREW_UPDATE_TO_TAG to test updating +#: If `--to-tag` is passed, set `HOMEBREW_UPDATE_TO_TAG` to test updating #: between tags. #: #: If `--keep-tmp` is passed, retain the temporary directory containing diff --git a/Library/Homebrew/manpages/brew.1.md.erb b/Library/Homebrew/manpages/brew.1.md.erb index a7f099e9d..05fc1cb23 100644 --- a/Library/Homebrew/manpages/brew.1.md.erb +++ b/Library/Homebrew/manpages/brew.1.md.erb @@ -40,7 +40,7 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note * `list`: List all installed formulae. - * `search` |`/``/`: + * `search` (|`/``/`): Perform a substring search of formula names for . If is surrounded with slashes, then it is interpreted as a regular expression. The search for is extended online to some popular taps. @@ -214,7 +214,7 @@ can take several different forms: to insecure HTTP. While ensuring your downloads are fully secure, this is likely - to cause from-source Sourceforge, some GNU & GNOME based + to cause from-source SourceForge, some GNU & GNOME based formulae to fail to download. * `HOMEBREW_NO_GITHUB_API`: -- cgit v1.2.3 From 922a52486bba6afbb01d259f1890c38cde609406 Mon Sep 17 00:00:00 2001 From: EricFromCanada Date: Sat, 25 Feb 2017 17:45:43 -0500 Subject: Update brew cask's man page formatting and grammar Includes replacing some non-ASCII characters, which weren't being processed properly. --- Library/Homebrew/manpages/brew-cask.1.md | 49 ++++++++++++++++---------------- 1 file changed, 25 insertions(+), 24 deletions(-) (limited to 'Library') diff --git a/Library/Homebrew/manpages/brew-cask.1.md b/Library/Homebrew/manpages/brew-cask.1.md index a9da5bca6..e882f09d1 100644 --- a/Library/Homebrew/manpages/brew-cask.1.md +++ b/Library/Homebrew/manpages/brew-cask.1.md @@ -86,19 +86,19 @@ names, and other aspects of this manual are still subject to change. If is given, summarize the staged files associated with the given Cask. - * `reinstall` [ ...] + * `reinstall` [ ... ]: Reinstall the given Cask. * `search` or `-S` [ | //]: - Without argument, display all Casks available for install, otherwise + Without an argument, display all Casks available for install; otherwise perform a substring search of known Cask tokens for or, if the text is delimited by slashes (//), it is interpreted as a Ruby regular expression. * `style` [--fix] [ ... ]: - Check the given Casks for correct style using [RuboCop Cask](https://github.com/caskroom/rubocop-cask). - If no tokens are given on the command line, all Casks are checked. - With `--fix`, auto-correct any style errors if possible. + Check the given Casks for correct style using [RuboCop Cask](https://github.com/caskroom/rubocop-cask). + If no tokens are given on the command line, all Casks are checked. + With `--fix`, auto-correct any style errors if possible. * `uninstall` or `rm` or `remove` [--force] [ ... ]: Uninstall the given Cask. With `--force`, uninstall even if the Cask @@ -111,7 +111,7 @@ names, and other aspects of this manual are still subject to change. the Cask does not appear to be currently installed. Removes all staged versions of the Cask distribution found under - `/`. + `/`. If the Cask definition contains a `zap` stanza, performs additional `zap` actions as defined there, such as removing local preference @@ -123,18 +123,18 @@ names, and other aspects of this manual are still subject to change. ## INTERNAL COMMANDS * `_appcast_checkpoint` [--calculate] [ ... | ... ]: - Given a `token`, returns the current appcast checkpoint, or calculates - the appcast checkpoint if the `--calculate` flag is specified. - Given a `URL`, calculates the appcast checkpoint for it. + Given a , returns the current appcast checkpoint, or calculates + the appcast checkpoint if the `--calculate` flag is specified. - * `_stanza` [ --table | --yaml | --inspect | --quiet ] [ ... ]: - Given a `stanza_name` and a `cask_token`, returns the current stanza - for a given Cask. If no `cask_token` is given, then data for all - Casks is returned. + Given a , calculates the appcast checkpoint for it. + + * `_stanza` [ --table | --yaml | --inspect | --quiet ] [ ... ]: + Given a and a , returns the current stanza for a + given Cask. If no is given, then data for all Casks is returned. ## OPTIONS -To make these options persistent, see the ENVIRONMENT section, below. +To make these options persistent, see the [ENVIRONMENT][] section, below. Some of these (such as `--prefpanedir`) may be subject to removal in a future version. @@ -150,7 +150,7 @@ in a future version. Abort Cask installation if the Cask does not have a checksum defined. * `--caskroom=`: - Location of the Caskroom, where all binaries are stored. The default value is: `$(brew --prefix)/Caskroom`. + Set location of the Caskroom, where all binaries are stored. The default value is `$(brew --prefix)/Caskroom`. * `--verbose`: Give additional feedback during installation. @@ -218,17 +218,17 @@ the Homebrew command: Most Homebrew-Cask commands can accept a Cask token as an argument. As described above, the argument can take the form of: - * A token as returned by `brew cask search`, _eg_ `google-chrome` + * A token as returned by `brew cask search`, e.g. `google-chrome` Homebrew-Cask also accepts three other forms in place of plain tokens: - * A fully-qualified token which includes the Tap name, _eg_ + * A fully-qualified token which includes the Tap name, e.g. `caskroom/fonts/font-symbola` - * A fully-qualified pathname to a Cask file, _eg_ + * A fully-qualified pathname to a Cask file, e.g. `/usr/local/Library/Taps/caskroom/homebrew-cask/Casks/google-chrome.rb` - * A `curl`-retrievable URI to a Cask file, _eg_ + * A `curl`-retrievable URI to a Cask file, e.g. `https://raw.githubusercontent.com/caskroom/homebrew-cask/f25b6babcd398abf48e33af3d887b2d00de1d661/Casks/google-chrome.rb` ## ENVIRONMENT @@ -239,17 +239,18 @@ information. Environment variables specific to Homebrew-Cask: - * HOMEBREW\_CASK\_OPTS: + * `HOMEBREW_CASK_OPTS`: This variable may contain any arguments normally used as options on the command-line. This is particularly useful to make options persistent. For example, you might add to your .bash_profile or .zshenv something like: - `export HOMEBREW_CASK_OPTS='--appdir=/Applications --caskroom=/etc/Caskroom'`. + + export HOMEBREW_CASK_OPTS='--appdir=/Applications --caskroom=/etc/Caskroom' ## SEE ALSO -The Homebrew-Cask home page: . +The Homebrew-Cask home page: -The Homebrew-Cask GitHub page: . +The Homebrew-Cask GitHub page: `brew`(1), `curl`(1) @@ -261,7 +262,7 @@ Man page format based on `brew.1.md` from Homebrew. ## BUGS -We still have bugs — and we are busy fixing them! If you have a problem, don’t +We still have bugs - and we are busy fixing them! If you have a problem, don't be shy about reporting it on our [GitHub issues page](https://github.com/caskroom/homebrew-cask/issues?state=open). When reporting bugs, remember that Homebrew-Cask is an independent project from -- cgit v1.2.3