Amory Meltzer
e766cba9d6
Update links/paths in manpage, hacking.md, usage.md to reflect structure of brew-cask
...
- Old github.com links were invalid
- Old Cellar structure was invalid
- Man page regenerated, including content from #15643
Refs #15381
2015-12-20 15:11:00 -05:00
Francis T. O'Donovan
bdedf7c51a
Update USAGE.md to remove brew-cask install #15381
2015-12-11 13:08:47 -05:00
Josh Hagins
c65720470c
Remove extra space in update command
...
I assume this is the more commonly used form. I've never seen anyone space out
their semicolons like `foo ; bar`.
2015-12-10 11:19:38 -05:00
Vítor Galvão
5e79596ef7
long update command now uses ';' instead of '&&'
2015-12-09 17:18:46 -05:00
Vítor Galvão
4caa121d9f
usage: add '$' to completion commands
2015-10-23 17:39:01 +01:00
Xie Yanbo
b5ccc39b17
tab completion usage
2015-10-23 17:37:38 +01:00
Vítor Galvão
cf23b6b1e3
USAGE.md: general structure fixes
2015-09-18 01:48:56 +01:00
Vítor Galvão
c7b5b47b88
USAGE.md: removed double spacing
2015-09-18 01:48:55 +01:00
Vítor Galvão
fd6b163aa1
usage: typographical fixes
2015-09-08 01:29:32 +01:00
Vítor Galvão
bcdb0e6d13
usage.md: warning on --caskroom
...
Closes #10009 .
2015-03-17 17:16:07 +01:00
Vítor Galvão
078f0b0300
removed alfred support
2015-01-13 17:49:32 +00:00
Vítor Galvão
529bd801e4
Removed support for widgets
...
Closes #2206 .
2015-01-08 19:51:15 +00:00
Roland Walker
8f2a2b42d6
doc: update Alfred Integration in USAGE.md
...
* fix transposed line
* recast first-person phrasing
* better explain what a "scope" is
* better explain what the "Caskroom" is
fixes #7759
fixes #6059
2014-12-04 15:14:27 -05:00
Roland Walker
6736f795f6
uncapitalize several doc files
...
* `alternate_cask_taps.md`
* `automation.md`
* `hacking.md`
* `releasing.md`
2014-12-02 12:20:13 -05:00
Roland Walker
a335d3b06d
unify and recast "Cask name" & "title" as "token"
...
* "Canonical App Name" becomes "Simplified App Name"
* devscript `cask_namer` renamed to `generate_cask_token`
* doc file `CASK_NAMING_REFERENCE.md` renamed to `cask_token_reference.md`
* DSL uses `"#{token}"` for interpolation instead of `"#{title}"`
* documentation text
* backend code (variables, method, class names)
* error message text
* tests
* code comments
* Cask comments
* emphasize `tags :name`
* doc: use "vendor" consistently instead of "developer"
* doc: many man page argument descriptions were incorrect
* incidental clarifications
Many backend variables similar to `cask_name` or `cask` have
been standardized to `cask_token`, `token`, etc, resolving a long-
standing ambiguity in which variables named `cask` might contain
a Cask instance or a string token.
In many places the docs could be shortened from "Cask name" to
simply "token", which is desirable because we use the term "Cask"
in too many contexts.
2014-12-01 11:00:23 -05:00
Roland Walker
839ccb98d4
recast _checklinks verb as _checkurl
...
remove stray doc item missed in #6966
2014-10-28 12:12:10 -04:00
Roland Walker
cd63241558
use "staged" instead of "installed" for Caskroom
...
refs: #6783
2014-10-21 07:13:04 -04:00
Roland Walker
a57ac581a6
doc nits: table order, table format, whitespace
...
make the order of tables match the order of stanzas in
the examples and `brew cask create` template
2014-09-27 13:35:49 -04:00
Roland Walker
d156cbfcb2
add `--force` option for `brew cask uninstall`
...
also update some related docs for verbs `install` and `uninstall`
2014-09-16 10:59:44 -04:00
Roland Walker
00921dd513
functionality and docs for zap stanza
...
* `zap` was previously supported as a noop for forward-compatibility
* Also adds restrictions against relative paths in `uninstall :files`
* Also documents safety conventions for `uninstall :files`
2014-09-13 10:21:17 -04:00
Jianwei Han
e7ef6d0157
Fix broken link in USAGE.md
2014-07-05 10:18:36 +08:00
Vladimír Kriška
71f3a0d968
Show file contents instead of commits
2014-06-21 01:19:07 +02:00
Roland Walker
2ffee346df
standardize the recommended upgrade command
...
in both docs and error messages.
Recent bug reports indicate that `cleanup` commands are essential
in some situations.
2014-06-18 15:15:50 -04:00
Roland Walker
e84c8faabb
Merge pull request #4661 from rolandwalker/doc_alt_taps
...
Document alternative Taps
2014-06-03 19:14:59 -04:00
Roland Walker
d3e2c477ee
doc: we now have user-maintained alt Cask Taps
2014-06-03 11:58:57 -04:00
Roland Walker
db5f82ccab
document the caskroom/unofficial Tap
2014-06-03 11:57:11 -04:00
Roland Walker
f8c9567a66
Don't prefer Cask files in the cwd
...
Fixes #4641 . Cask files in the cwd are still permitted, but
at the very lowest priority, below Tapped Cask names.
2014-06-03 10:33:19 -04:00
Vítor Galvão
823e361426
Clarified when to use certain options
...
Options such as '--caskroom' and '--appdir' should be used in
conjuntcion with 'brew cask install'.
Addresses #3813 .
2014-05-13 15:46:32 +01:00
Roland Walker
e910467b39
update docs and messages for `brew cask cat`
2014-05-07 10:32:15 -04:00
Paul Hinze
f54eaf7082
update all references to new caskroom org home
...
global replace of:
'phinze/homebrew-cask' -> 'caskroom/homebrew-cask'
'phinze/cask' -> 'caskroom/cask'
'phinze/homebrew-testcasks' -> 'caskroom/homebrew-testcasks'
and various other specific places that needed updates
<3 the homebrew-cask community!
2014-05-03 10:29:17 -05:00
Adam Chainz
b3a8895d95
Update USAGE.md re: alfred link
2014-04-07 11:57:29 +01:00
Võ Anh Duy
33a97a1a5f
CLI - Fetch
...
Add `fetch` command to cli like suggestion at the end of #2528
2014-02-26 00:44:22 +07:00
Roland Walker
22e24ea5c5
Merge pull request #3131 from rolandwalker/cmd_aliases
...
provide command aliases to match Homebrew
2014-02-25 12:29:22 -05:00
Roland Walker
4fcdab0583
provide command aliases to match Homebrew
...
fixes #2969
2014-02-24 08:15:52 -05:00
Roland Walker
55e9cfc39d
make `brew cask update` synonym for `brew update`
...
for convenience/typo
2014-02-21 10:23:16 -05:00
Roland Walker
b67b2c53f2
make clear that only Alfred 2.x is supported
...
fixes #2891
2014-02-14 19:39:45 -05:00
Roland Walker
d6c8a6917d
add command `brew cask cleanup`
...
plus new option --outdated
2014-02-08 14:40:53 -05:00
Roland Walker
28a84baf92
Merge pull request #2545 from rolandwalker/search_followups
...
search docs/test/fix tapname-search
2014-01-29 09:14:26 -08:00
Roland Walker
872132f7c8
screensaver spelled screen_saver in DSL and opts
2014-01-29 11:27:44 -05:00
Jonathan Dahan
ca61dfdd81
Add support for screensaver artifact
2014-01-28 10:17:50 -05:00
Roland Walker
a5ce3cdbd8
search docs/test/fix tapname-search
...
This is the promised followup to #2496
- docs
- test
- bugfix: search string was being tested against fully-qualified
Cask name including Tap, so "brew cask search phinze" would
(confusingly) return all Casks.
2014-01-23 17:50:45 -05:00
Roland Walker
19f4ce3cfb
`brew cask home` with no args opens project page
...
- in duplication of similar functionality in Homebrew
- in celebration of proposed design by @ndr-qef
2014-01-23 17:17:33 -05:00
Lincoln Lee
cc14ebdb55
Implement `input_method` artifact
2014-01-19 00:40:56 +08:00
Roland Walker
8f9fc13cf5
standardize project name: homebrew-cask
...
- make lower-case and remove backticks for project name
(backticks kept for commands/filenames/etc)
2014-01-17 20:14:48 -05:00
Roland Walker
9268552fcd
Overhaul USAGE.md
...
- Include all current commands
- Use new functionality to skip explicit "brew tap" commands
- Document all forms for specifying Casks (URI, etc)
- Demote "Additional Taps" section to near the end
- Other small tweaks too numerous to list
2014-01-15 10:44:29 -05:00
Stratos Moros
7136269198
implement `binary` artifact
2014-01-05 22:55:18 +02:00
Guillermo Pascual
7689b059d5
Fix typo in USAGE.md
2013-12-30 23:09:12 +01:00
Joel Kuzmarski
c503886d70
Close #2113
...
@muescha suggested adding to USAGE.md to clarify how Taps work but we
decided the docs are already comprehensive. In the process a typo was
identified, which this commit fixes.
2013-12-19 03:01:20 -06:00
Paul Hinze
2e3e1993dc
document the new caskroom/fonts tap
2013-12-15 15:08:27 -06:00
future
51128842b6
Minor USAGE tweaks
2013-12-14 10:10:50 +01:00