231 Commits

Author SHA1 Message Date
Martin Afanasjew
feb1e75b61 manpages: add editing instructions to ERB template
Closes #102.

Signed-off-by: Martin Afanasjew <martin@afanasjew.de>
2016-04-17 20:43:27 +02:00
Martin Afanasjew
3680c4667f man: replace split header/footer with ERB template 2016-04-17 20:43:27 +02:00
Martin Afanasjew
b4b53e5067 manpages: remove no longer needed 'brew.1.md'
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-17 20:43:27 +02:00
Xu Cheng
df79659045 update manpage for deps/uses 2016-04-16 21:47:47 +08:00
Mike McQuaid
4e8c6e633c Document disabling of opt-in Homebrew analytics. (#79) 2016-04-12 12:17:56 +01:00
Max Nordlund
10edfcd218 Fix documentation error
Closes #10.

Signed-off-by: Martin Afanasjew <martin@afanasjew.de>
2016-04-10 22:59:25 +02:00
Max Nordlund
c8a2cd4e10 Generate the new man page 2016-04-10 22:59:25 +02:00
Martin Afanasjew
ea38a70395 prune: handle broken app symlinks
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-06 10:31:54 +02:00
Martin Afanasjew
b50e950f0e unlinkapps: add --dry-run option
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-06 10:31:54 +02:00
ilovezfs
fad235d8e8 tap: support --full even if installed
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-05 07:25:27 -07:00
Mike McQuaid
276a797d37 Update documentation after repository split. 2016-04-03 14:03:33 +01:00
Xu Cheng
e72ea94824 doc: update for core/formula separation
Closes Homebrew/homebrew#50632.

Signed-off-by: Xu Cheng <xucheng@me.com>
2016-04-02 21:51:36 +08:00
Xu Cheng
b8a4677de0 --repository: support to show tap path
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-03-24 14:52:13 +08:00
Misty De Meo
d1440e504e Update manpage to remove cleanup --force 2016-01-18 10:14:56 -08:00
Martin Afanasjew
53e1ba3274 manpage: document '--dry-run' for 'prune' command 2016-01-06 08:18:59 +01:00
Martin Afanasjew
8161595015 manpage: add parentheses in 'search' synopsis
For consistency with other commands where there is a list of mutually
exclusive options of which exactly one has to be specified.
2016-01-06 08:18:04 +01:00
Martin Afanasjew
b3627cc5b2 manpage: fix minor formatting inconsistencies 2016-01-06 08:17:29 +01:00
Martin Afanasjew
aaefcb02b6 manpage: improve synopsis for 'options' command
The options `--all`, `--installed`, and a list of formulae are mutually
exclusive arguments, of which exactly one is required.
2016-01-06 08:17:17 +01:00
Martin Afanasjew
18bf5a74a8 cleanup: consistently document --dry-run option
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-13 02:20:02 +01:00
Martin Afanasjew
85181a067f manpage: remove superfluous spaces for consistency
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-10 15:00:36 +01:00
Martin Afanasjew
8144f90eac manpage: fix formatting of command list
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-10 15:00:36 +01:00
Andrew Janke
92a1fca6e4 manpages: minor markup fixes
Fixes a couple issues left behind by Homebrew/homebrew#46676.

Closes Homebrew/homebrew#46706.

Signed-off-by: Andrew Janke <andrew@apjanke.net>
2015-12-08 12:35:20 -05:00
Mike McQuaid
b745546943 Overhaul, simplify and cleanup documentation.
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-07 13:37:49 +00:00
Andrew Janke
98fbcb7299 manpages: fix missing backtick 2015-12-05 10:23:16 -05:00
Andrew Janke
5230ed2117 man page: finer-grained markup
Closes Homebrew/homebrew#44769

Closes Homebrew/homebrew#46676.

Signed-off-by: Andrew Janke <andrew@apjanke.net>
2015-12-05 00:41:32 -05:00
Martin Afanasjew
18a743c470 manpage: synchronize maintainer list with README 2015-12-02 00:56:36 +01:00
Mike McQuaid
74e407dc54 The Formula API is no longer work-in-progress.
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-27 10:45:23 -06:00
Patrick Stadler
3dda14f5bd Provide better link when rate limit exceeded error is thrown
Closes Homebrew/homebrew#45134.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-10-20 08:38:53 +01:00
Rakesh
2d60187e1a brew upgrade: provides an option --cleanup
Closes Homebrew/homebrew#44305.

Signed-off-by: Xu Cheng <xucheng@me.com>
2015-10-07 14:05:11 +08:00
Dan Martinez
8374374168 Improve description searching and add a cache.
Closes Homebrew/homebrew#42281.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-09-08 15:23:37 +01:00
Xu Cheng
5eab79e70f manpage: add unlink --dry-run 2015-09-06 15:37:47 +08:00
Mike McQuaid
2c959a7d58 More API documentation.
And remove the documented stuff from the `example-formula.rb`.

Closes Homebrew/homebrew#43241.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-08-29 15:43:16 +01:00
Xu Cheng
329358c33c manpage: add doc for tap --list-official and --list-pinned 2015-08-21 20:08:13 +08:00
Vlad Shablinsky
35ef2bc132 update manpages for migrate
Closes Homebrew/homebrew#42801.

Signed-off-by: Xu Cheng <xucheng@me.com>
2015-08-20 19:55:35 +08:00
Xu Cheng
502101a2e2 manpage: slight format tweak 2015-08-17 16:12:29 +08:00
Dominyk Tiller
fbfaa8a39a man: sha1 => sha256 reference
Closes Homebrew/homebrew#42507.
2015-08-11 20:36:13 +01:00
Xu Cheng
12e154a418 man: remove unnecessary --all in brew upgrade 2015-08-10 23:12:30 +08:00
Vlad Shablinsky
622a8502dc add manpages 2015-08-10 13:57:59 +01:00
CNA-Bld
77ee9bd446 update man page
Closes Homebrew/homebrew#41736.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-08-10 12:17:26 +01:00
Alex Dunn
b22d899d3a Add Alex Dunn as a maintainer.
Closes Homebrew/homebrew#42347.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-08-02 13:19:55 +01:00
Baptiste Fontaine
587ab81074 manpage: new maintainers added to the list
I kept the same order as in README.md.

Closes Homebrew/homebrew#41655.

Signed-off-by: Baptiste Fontaine <batifon@yahoo.fr>
2015-07-14 13:31:22 +02:00
Xu Cheng
a2d9d68591 commands: support list all commands without header 2015-07-11 00:07:29 +08:00
Mike McQuaid
3ac6005931 audit: add --online flag.
Also add it to the manpage and brew-test-bot.

Closes Homebrew/homebrew#41516.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-07-09 14:50:55 +01:00
Alex Dunn
8071dcac24 brew.1: document install --force-bottle
Closes Homebrew/homebrew#41398.

Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2015-07-08 02:43:32 +01:00
Xu Cheng
ab9a62370f support downloading bottles through 3rd-party mirror
Closes Homebrew/homebrew#41328.

Closes Homebrew/homebrew#41332.

Signed-off-by: Xu Cheng <xucheng@me.com>
2015-07-06 18:05:00 +08:00
Jack Nagel
690bf9b8b9 Remove myself from the maintainers list
It's been fun.
2015-07-04 23:04:02 -04:00
Xu Cheng
78a7dea3a0 add brew command
Closes Homebrew/homebrew#41034.

Signed-off-by: Xu Cheng <xucheng@me.com>
2015-07-03 14:22:38 +08:00
Dominyk Tiller
0341f85b06 man: fix typo 2015-06-26 20:25:15 +01:00
Colin Dean
e12295849d Adds JSON output to outdated command
After some musing on brunophilipe/Cakebrew#71, I thought it would
be useful to let Cakebrew and other tools grab the outdated formulae
version information using a method more elegant than regex.

Closes Homebrew/homebrew#30693.

Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2015-06-25 19:32:23 -04:00
Xu Cheng
b18015a7e1 manpage: update list command
Closes Homebrew/homebrew#40921.

Signed-off-by: Xu Cheng <xucheng@me.com>
2015-06-22 22:17:10 +08:00