Mike McQuaid
845b29467f
Note environment variables need to have values.
...
Address the confusion in #4015 .
2018-04-07 10:10:24 +01:00
Mike McQuaid
b23f66982f
Improve external command documentation
...
Extract `brew bundle` and `brew services` docs from their help. Add a
little for `brew cask` until we can think about e.g. merging the
manpages.
2018-03-15 16:25:14 +00:00
Mike McQuaid
e817bba18d
upgrade: add HOMEBREW_UPGRADE_CLEANUP variable.
...
Allow users to specify they want `brew upgrade --cleanup` to always be
run when they run `brew upgrade`.
2018-03-12 11:05:06 +00:00
Mike McQuaid
2205f62ec6
irb: add pry support.
...
Make `brew irb` optionally support `pry`. While doing so, also make it a `dev-cmd`.
2018-02-28 11:36:23 +00:00
Mike McQuaid
f2ce6489b2
Use more docs.brew.sh short links
...
These are nicer on the eyes.
2018-02-22 19:46:58 +00:00
joshua stein
7388acb86e
Tty: if HOMEBREW_NO_COLOR env var is present, disable color
...
bin/brew will recognize NO_COLOR variable and copy it to
HOMEBREW_NO_COLOR
2018-02-12 14:19:25 -06:00
xiehuc
3e6adb7e33
update all_proxy and man pages #3751
2018-02-01 18:11:29 +08:00
Mike McQuaid
65695885b6
Update other Homebrew maintainers.
2018-01-18 15:45:51 +00:00
Ivars Berzinsh
28a0e445f0
Added info about no_proxy to docs
2017-12-19 10:59:04 +02:00
Mike McQuaid
4eeeb5eac4
brew.1: clarify Homebrew's Ruby isn't 2.0 now.
...
Make this generic; it doesn't matter what version this is and this will
future proof it.
2017-12-08 16:49:33 +00:00
Mike McQuaid
1d344cf2f5
Document HOMEBREW_FORCE_BREWED_CURL
...
Should have been in #3482 .
2017-12-06 12:56:15 +00:00
Mike McQuaid
022303f96c
Unify proxy documentation.
...
Specify under the list of environment variables how to set each of those
that we passthrough and use.
2017-11-30 14:05:06 +00:00
Mike McQuaid
baa61f5a6e
Use https for all docs.brew.sh links.
...
May as well use the more secure link when possible.
2017-07-27 15:59:37 +01:00
Mike McQuaid
4fd8aea015
Documentation improvements
...
- Document ilovezfs as the official lead maintainer of
Homebrew/homebrew-core. This is a role he's been doing unofficially
(and brilliantly) for a while and explicit documentation of power
structures makes it easier for non-Homebrew-maintainers to understand.
- Document the contents of some of Homebrew's subdirectories for people
clicking around in the GitHub UI looking to contribute.
- Remove update bug mention from README. Enough time has passed that we
can remove this disappointment.
2017-07-15 12:57:34 +01:00
Mike McQuaid
54e01d76db
Merge pull request #2599 from peternewman/patch-1
...
Fix internal links on the manpage
2017-06-04 11:52:13 +01:00
Mike McQuaid
9e17e44b3e
Change manpage internal links in correct location.
2017-06-04 11:12:56 +01:00
Mike McQuaid
8205e61e64
More environment filtering tweaks
...
- only document HOMEBREW_* variables in the manpage (although still
read from all the original environment variables).
- resort manpage environment variables in alphabetical order
- check the original path for trailing slashes
2017-05-13 11:42:01 +01:00
EricFromCanada
aee23ccb03
Add more flags and descriptions to man pages.
2017-03-05 21:45:15 -05:00
EricFromCanada
afc539f86e
Update brew's man page formatting and grammar
...
Also update command specifications to match descriptions.
2017-02-25 17:37:57 -05:00
Mike McQuaid
3ccbfa72a2
brew.1: use uninstall instead of remove.
...
Fixes #1817 .
2017-01-11 14:19:56 -08:00
Mike McQuaid
a3bffe70bc
Use docs.brew.sh links.
2017-01-04 11:13:41 +00:00
Mike McQuaid
8eac5314f6
Add official external commands to manpage.
...
These are the ones that are auto-installed without tapping and it makes
sense to make them more prominent in our documentation as we've
offloaded various functionality over the years to each of them.
2016-10-02 18:21:04 +01:00
Markus Reiter
4a9ee8154a
Simplify brew man
authors.
2016-09-20 12:12:36 +02:00
Mike McQuaid
b85ee1cb8f
Update documentation links.
2016-09-20 10:41:42 +01:00
Mike McQuaid
51ed08d733
man: read lead, former maintainers, creator.
2016-09-20 09:31:19 +01:00
Mike McQuaid
3f9cce0a03
Use new "macOS" naming where appropriate.
...
Not quite a mass replacement as I've used OS X and Mac OS X where
describing specific older versions and added compatibility methods
for things in the DSL.
2016-09-18 19:57:19 +01:00
Mike McQuaid
71881fd7a6
Add DEVELOPER COMMANDS to manpage.
2016-09-08 20:46:51 +01:00
Dominyk Tiller
003b39bc84
man: update for tap preinstall
2016-08-27 15:57:09 +01:00
Mike McQuaid
63949a8e04
Tweak HOMEBREW_DEVELOPER documentation.
...
This option does more than just print warnings so let's make a more
generic description with a more specific example.
Closes #716 .
2016-08-17 08:22:16 +01:00
Mike McQuaid
8a24d5f942
Merge pull request #513 from MikeMcQuaid/enable-vendor-ruby
...
Enable vendored Ruby 2.0.
2016-08-16 10:16:49 +01:00
Mike McQuaid
4eaa40ae1f
Enable vendored Ruby 2.0.
2016-08-10 20:06:14 +01:00
Mike McQuaid
b6f467b007
Ship Homebrew auto-update support.
...
Roll this out to everyone (not just developers) and document the
environment variables used for configuration.
2016-08-10 15:46:31 +01:00
jainish shah
48a1e1b47f
Add HOMEBREW_ARTIFACT_DOMAIN option.
...
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-07-13 11:45:15 +01:00
Viktor Szakats
6bd24a7fb8
audit.rb: require https for ftpmirror.gnu.org ( #393 )
...
* 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-22 18:56:10 +01:00
Xu Cheng
79345592a9
man: auto detect maintainers list
2016-06-14 21:22:07 +08:00
Mike McQuaid
a9abbab917
Move HOMEBREW_CACHE to ~/Library/Caches ( #292 )
...
* 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-06-01 08:46:33 +01:00
Dominyk Tiller
a112627888
man: changes for 75ab94c
2016-05-30 17:06:23 +01:00
Martin Afanasjew
8284fb3fef
Update Homebrew/homebrew references in man page
...
Replace `homebrew` with `brew`, `homebrew-core`, or `legacy-homebrew`
depending on context.
Closes #175 .
Signed-off-by: Martin Afanasjew <martin@afanasjew.de>
2016-05-02 21:19:09 +02:00
Mike McQuaid
1451553188
Ship analytics for Homebrew.
...
For more information and opt-out instructions please read:
https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Analytics.md#analytics
2016-04-23 14:27:09 +01:00
Martin Afanasjew
312fdaa892
--version: move help to documentation comment
...
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 13:45:26 +02:00
Martin Afanasjew
76f0479969
--repository: move help to documentation comment
2016-04-20 13:45:26 +02:00
Martin Afanasjew
6931e9421a
--prefix: move help to documentation comment
2016-04-20 13:45:26 +02:00
Martin Afanasjew
a3352c000e
--env: move help to documentation comment
2016-04-20 13:45:26 +02:00
Martin Afanasjew
046b481806
--cellar: move help to documentation comment
2016-04-20 13:45:26 +02:00
Martin Afanasjew
bab823288f
--cache: move help to documentation comment
2016-04-20 13:45:26 +02:00
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