aboutsummaryrefslogtreecommitdiffstats
path: root/Library/Homebrew/manpages
AgeCommit message (Collapse)Author
2016-08-10Ship Homebrew auto-update support.Mike McQuaid
Roll this out to everyone (not just developers) and document the environment variables used for configuration.
2016-07-13Add HOMEBREW_ARTIFACT_DOMAIN option.jainish shah
If set, this environment variable instructs Homebrew to use the given URL as a download mirror (e.g. an Artifactory instance) for bottles and binaries. Closes #387. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2016-06-22audit.rb: require https for ftpmirror.gnu.org (#393)Viktor Szakats
* audit.rb: require https for ftpmirror.gnu.org The situation is similar to other mirror redirectors: the server may subsequently redirect to an insecure url. But it's a step. * manpage: update HOMEBREW_NO_INSECURE_REDIRECT section
2016-06-14man: auto detect maintainers listXu Cheng
2016-06-01Move HOMEBREW_CACHE to ~/Library/Caches (#292)Mike McQuaid
* cleanup: accept cache as an argument. * config: move default HOMEBREW_CACHE to ~/Library. * brew.1: document new default Homebrew cache. * update-report: migrate legacy Homebrew cache.
2016-05-30man: changes for 75ab94cDominyk Tiller
2016-05-02Update Homebrew/homebrew references in man pageMartin Afanasjew
Replace `homebrew` with `brew`, `homebrew-core`, or `legacy-homebrew` depending on context. Closes #175. Signed-off-by: Martin Afanasjew <martin@afanasjew.de>
2016-04-23Ship analytics for Homebrew.Mike McQuaid
For more information and opt-out instructions please read: https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Analytics.md#analytics
2016-04-20--version: move help to documentation commentMartin Afanasjew
This implies that `--version` is treated in most places like a regular command, e.g. being suggested in shell completion. Also fix the help text that claimed output goes to standard error, while it actually goes to standard output.
2016-04-20--repository: move help to documentation commentMartin Afanasjew
2016-04-20--prefix: move help to documentation commentMartin Afanasjew
2016-04-20--env: move help to documentation commentMartin Afanasjew
2016-04-20--cellar: move help to documentation commentMartin Afanasjew
2016-04-20--cache: move help to documentation commentMartin Afanasjew
2016-04-17manpages: add editing instructions to ERB templateMartin Afanasjew
Closes #102. Signed-off-by: Martin Afanasjew <martin@afanasjew.de>
2016-04-17man: replace split header/footer with ERB templateMartin Afanasjew
2016-04-17manpages: remove no longer needed 'brew.1.md'Martin Afanasjew
Changes to the man page are made in `header.1.md`, `footer.1.md`, or the documentation comment block in the respective command file. Remove old Markdown file to reduce confusion, now that it is no longer needed (and not even used by `brew man`).
2016-04-16update manpage for deps/usesXu Cheng
2016-04-12Document disabling of opt-in Homebrew analytics. (#79)Mike McQuaid
2016-04-10Fix documentation errorMax Nordlund
Closes #10. Signed-off-by: Martin Afanasjew <martin@afanasjew.de>
2016-04-10Generate the new man pageMax Nordlund
2016-04-06prune: handle broken app symlinksMartin Afanasjew
Remove broken symlinks from `/Applications` and `~/Applications` that were previously created by `brew linkapps`, but are no longer valid because formulae were uninstalled or the provided apps have changed.
2016-04-06unlinkapps: add --dry-run optionMartin Afanasjew
Add `--dry-run` option as is customary for destructive commands. Update `bash` completion and man page accordingly. Also correct and update documentation for both `brew linkapps` and `brew unlinkapps` in more general terms.
2016-04-05tap: support --full even if installedilovezfs
Makes `tap` re-runnable and unshallows when requested with `--full`. Tapping with a different URL raises an exception. The homebrew/core tap cannot be untapped with `untap` so running `brew tap --full homebrew/core` is now a built-in way to get a full clone of this tap without resorting to workarounds. Closes #17. Signed-off-by: ilovezfs <ilovezfs@icloud.com>
2016-04-03Update documentation after repository split.Mike McQuaid
2016-04-02doc: update for core/formula separationXu Cheng
Closes Homebrew/homebrew#50632. Signed-off-by: Xu Cheng <xucheng@me.com>
2016-03-24--repository: support to show tap pathXu Cheng
This can become handy when we separate core code and formulae. For example, we could use `cd $(brew --repo homebrew/core)` to go to core tap path. Closes Homebrew/homebrew#50346. Signed-off-by: Xu Cheng <xucheng@me.com>
2016-01-18Update manpage to remove cleanup --forceMisty De Meo
2016-01-06manpage: document '--dry-run' for 'prune' commandMartin Afanasjew
2016-01-06manpage: add parentheses in 'search' synopsisMartin Afanasjew
For consistency with other commands where there is a list of mutually exclusive options of which exactly one has to be specified.
2016-01-06manpage: fix minor formatting inconsistenciesMartin Afanasjew
2016-01-06manpage: improve synopsis for 'options' commandMartin Afanasjew
The options `--all`, `--installed`, and a list of formulae are mutually exclusive arguments, of which exactly one is required.
2015-12-13cleanup: consistently document --dry-run optionMartin Afanasjew
All other commands document both `--dry-run` and `-n` in the option description and mention only `--dry-run` in the command summary. Let's do the same for `cleanup`. Closes Homebrew/homebrew#46942. Signed-off-by: Martin Afanasjew <martin@afanasjew.de>
2015-12-10manpage: remove superfluous spaces for consistencyMartin Afanasjew
All other alternatives already don't use spaces around the pipe symbol. Closes Homebrew/homebrew#46825. Signed-off-by: Martin Afanasjew <martin@afanasjew.de>
2015-12-10manpage: fix formatting of command listMartin Afanasjew
Restore definition list in `COMMANDS` section, thus massively improve formatting. In theory, `ronn` supports nested (definition) lists. In practice, this does not work (and is unlikely to be fixed soon because upstream seems to be rather inactive) causing the entire definition list to be longer recognized because of a single nested list. Work around by rearranging the `tap` documentation (sole command with a nested list).
2015-12-08manpages: minor markup fixesAndrew Janke
Fixes a couple issues left behind by Homebrew/homebrew#46676. Closes Homebrew/homebrew#46706. Signed-off-by: Andrew Janke <andrew@apjanke.net>
2015-12-07Overhaul, simplify and cleanup documentation.Mike McQuaid
Remove duplication, link to the API documentation more often, tweak wording, add `@UniqMartin` as a maintainer, note `@jacknagel`'s and `@adamv`'s significant past contributions to Homebrew, delete some outdated or unneeded documentation, add some missing `Formula` API. entries and simplify/improve `CONTRIBUTING.md`. Closes Homebrew/homebrew#46179. Closes Homebrew/homebrew#46618. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-12-05manpages: fix missing backtickAndrew Janke
2015-12-05man page: finer-grained markupAndrew Janke
Closes Homebrew/homebrew#44769 Closes Homebrew/homebrew#46676. Signed-off-by: Andrew Janke <andrew@apjanke.net>
2015-12-02manpage: synchronize maintainer list with READMEMartin Afanasjew
2015-10-27The Formula API is no longer work-in-progress.Mike McQuaid
Feature it a bit more prominently in the documentation as a result. Closes Homebrew/homebrew#45374. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-10-20Provide better link when rate limit exceeded error is thrownPatrick Stadler
Closes Homebrew/homebrew#45134. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-10-07brew upgrade: provides an option `--cleanup`Rakesh
Closes Homebrew/homebrew#44305. Signed-off-by: Xu Cheng <xucheng@me.com>
2015-09-08Improve description searching and add a cache.Dan Martinez
Closes Homebrew/homebrew#42281. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-09-06manpage: add unlink --dry-runXu Cheng
2015-08-29More API documentation.Mike McQuaid
And remove the documented stuff from the `example-formula.rb`. Closes Homebrew/homebrew#43241. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-08-21manpage: add doc for tap --list-official and --list-pinnedXu Cheng
2015-08-20update manpages for migrateVlad Shablinsky
Closes Homebrew/homebrew#42801. Signed-off-by: Xu Cheng <xucheng@me.com>
2015-08-17manpage: slight format tweakXu Cheng
2015-08-11man: sha1 => sha256 referenceDominyk Tiller
Closes Homebrew/homebrew#42507.