235 Commits

Author SHA1 Message Date
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
Adam Smith
9383063216 add --language to brew-cask manpage 2017-09-28 20:02:24 -07:00
Alexey Alekhin
50db7db724 Updated cask search manpage 2017-09-02 14:27:02 +02: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
Markus Reiter
0bb2773b17 Deprecate --caskroom flag. 2017-05-24 23:54:36 +02:00
Markus Reiter
4bfd94cb30 Add SUDO_ASKPASS to brew-cask manpage. 2017-05-23 16:01:13 +02:00
Markus Reiter
0977b4a17d Merge pull request #2494 from numbermaniac/fix-env
cask manpage: Fix section header link for Environment
2017-05-18 18:40:08 +02: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
numbermaniac
2a29b33fe9 Fix section header link for Environment
brew-cask.1.md
2017-04-15 15:59:16 +10:00
Valentin VĂLCIU
7532545140 add command 'cask outdated' 2017-03-15 22:58:25 +02:00
Viktor Szakats
cc8f029f22 secure urls + remove -k from in-doc curl command 2017-03-14 17:27:11 +00:00
Numbermaniac
b704b48b2f Change instances of caskroom.io to caskroom.github.io 2017-03-12 23:23:22 +11:00
EricFromCanada
aee23ccb03 Add more flags and descriptions to man pages. 2017-03-05 21:45:15 -05:00
EricFromCanada
922a52486b Update brew cask's man page formatting and grammar
Includes replacing some non-ASCII characters, which weren't being
processed properly.
2017-02-25 17:45:43 -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
Miccal Matthews
d68fc389e3 Update brew-cask.1.md 2017-01-27 09:26:57 +08:00
Markus Reiter
2076b494a6 Add manpage entry for _appcast_checkpoint. 2017-01-23 16:23:01 +01: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
Markus Reiter
1745997a30 Remove brew cask update from manpage. 2016-12-30 14:01:43 +01:00
Josh Hagins
606a762344 Merge pull request #1248 from Git-Jiro/add_reinstall_cmd_to_cask
add cask reinstall command
2016-10-24 01:11:48 -04:00
Martin Schimandl
0b8af5771f Remove duplicate description of <token> 2016-10-24 05:30:49 +02:00
Martin Schimandl
32dc78835d Add documentation for cask reinstall command 2016-10-23 20:20:08 +02:00
Eitot
0b176f9cc8 Add dictionary artifact 2016-10-23 17:43:06 +02: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
Nathan Toone
8995d8b9e5 Fix documentation for --caskroom default 2016-09-26 17:26:03 -06:00
Markus Reiter
4a9ee8154a Simplify brew man authors. 2016-09-20 12:12:36 +02:00
Markus Reiter
598b303e3a Update `brew-cask man page. 2016-09-20 12:02:12 +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
Markus Reiter
a98015192b Move Cask man page to root. 2016-08-22 01:49:12 +02: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