From 0ddcd8fa6f264bf753e66efad7f737ac7cbc8fba Mon Sep 17 00:00:00 2001 From: Markus Reiter Date: Mon, 21 May 2018 21:21:38 +0200 Subject: [PATCH] Update URLs. --- CONTRIBUTING.md | 6 ++-- Casks/adobe-air-sdk.rb | 2 +- Casks/adobe-photoshop-lightroom.rb | 6 ++-- Casks/android-ndk.rb | 2 +- Casks/armitage.rb | 2 +- Casks/avast-security.rb | 2 +- Casks/bandage.rb | 2 +- Casks/blender.rb | 2 +- Casks/cocoscreator.rb | 2 +- Casks/copyq.rb | 2 +- Casks/crystax-ndk.rb | 2 +- Casks/decitime.rb | 2 +- Casks/devonthink-pro-office.rb | 2 +- Casks/dwarf-fortress.rb | 2 +- Casks/dynamodb-local.rb | 2 +- Casks/eventstore.rb | 2 +- Casks/flymaster-designer.rb | 2 +- Casks/futuniuniu.rb | 2 +- Casks/gogs.rb | 2 +- Casks/gqrx.rb | 2 +- Casks/handy-outliner.rb | 2 +- Casks/imagemin.rb | 2 +- Casks/kdiff3.rb | 2 +- Casks/libreoffice.rb | 2 +- Casks/lilypond.rb | 2 +- Casks/logisim-evolution.rb | 2 +- Casks/mars.rb | 2 +- Casks/minecraft-server.rb | 2 +- Casks/mousepose.rb | 2 +- Casks/music-manager.rb | 2 +- Casks/nodeclipse.rb | 2 +- Casks/osmc.rb | 2 +- Casks/parallels-access.rb | 2 +- Casks/polar-websync.rb | 2 +- Casks/private-eye.rb | 2 +- Casks/radio-silence.rb | 2 +- Casks/scala-ide.rb | 2 +- Casks/screens-connect.rb | 2 +- Casks/squirrelsql.rb | 2 +- Casks/steamcmd.rb | 2 +- Casks/toontown-rewritten.rb | 2 +- Casks/vlc.rb | 2 +- Casks/xeora-cli.rb | 2 +- README.md | 12 ++++---- USAGE.md | 20 ++++++------- ci/travis/before_script.sh | 2 +- ci/travis/script.sh | 6 ++-- developer/bin/cask_pr_manual_check | 2 +- developer/bin/list_pkg_ids_by_regexp | 2 +- developer/bin/sync_templates_and_ci | 18 +++++------ doc/cask_language_reference/all_stanzas.md | 4 +-- doc/cask_language_reference/readme.md | 4 +-- doc/cask_language_reference/stanzas/app.md | 6 ++-- .../stanzas/appcast.md | 16 +++++----- doc/cask_language_reference/stanzas/binary.md | 4 +-- .../stanzas/caveats.md | 2 +- .../stanzas/depends_on.md | 2 +- doc/cask_language_reference/stanzas/flight.md | 4 +-- doc/cask_language_reference/stanzas/gpg.md | 2 +- .../stanzas/installer.md | 6 ++-- .../stanzas/language.md | 2 +- doc/cask_language_reference/stanzas/name.md | 2 +- doc/cask_language_reference/stanzas/pkg.md | 8 ++--- doc/cask_language_reference/stanzas/suite.md | 2 +- .../stanzas/uninstall.md | 30 +++++++++---------- doc/cask_language_reference/stanzas/url.md | 10 +++---- doc/cask_language_reference/stanzas/zap.md | 2 +- .../token_reference.md | 4 +-- doc/development/adding_a_cask.md | 26 ++++++++-------- doc/development/hacking.md | 6 ++-- doc/development/maintaining.md | 8 ++--- doc/faq/apps_with_malware.md | 6 ++-- doc/faq/closing_issues_without_review.md | 2 +- doc/faq/not_a_discoverability_service.md | 6 ++-- doc/faq/rejected_casks.md | 20 ++++++------- ...cksum_does_not_match_error_fix_outdated.md | 2 +- .../curl_error_fix_no_download.md | 2 +- doc/reporting_bugs/curl_error_fix_outdated.md | 2 +- .../permission_denied_error_fix_appdir.md | 2 +- .../permission_denied_error_fix_bundle.md | 2 +- doc/reporting_bugs/source_is_not_there_fix.md | 6 ++-- ...l_wrongly_reports_cask_as_not_installed.md | 2 +- .../wrong_number_of_arguments_fix.md | 4 +-- 83 files changed, 181 insertions(+), 181 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b15f5297d4..ec8afbc565 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,7 +22,7 @@ cask-repair --help cask-repair ``` -If there is a more complicated change, or there is a case where `cask-repair` fails (for example, where a Cask uses a [`url do` block](https://github.com/caskroom/homebrew-cask/blob/60531a2812005dd5f17dc92f3ce7419af3c5d019/Casks/audacity.rb#L5#L15) or the [`language` stanza](https://github.com/caskroom/homebrew-cask/blob/306b8fbd9502036f1ca742f70c569d8677b62403/Casks/firefox.rb#L4L74)), you can also follow the steps in [Adding a Cask](doc/development/adding_a_cask.md) to do the same thing manually. Remember to update the `version` and `shasum` values, as well as the appcast [`checkpoint`](doc/cask_language_reference/stanzas/appcast.md), if there is one. +If there is a more complicated change, or there is a case where `cask-repair` fails (for example, where a Cask uses a [`url do` block](https://github.com/Homebrew/homebrew-cask/blob/60531a2812005dd5f17dc92f3ce7419af3c5d019/Casks/audacity.rb#L5#L15) or the [`language` stanza](https://github.com/Homebrew/homebrew-cask/blob/306b8fbd9502036f1ca742f70c569d8677b62403/Casks/firefox.rb#L4L74)), you can also follow the steps in [Adding a Cask](doc/development/adding_a_cask.md) to do the same thing manually. Remember to update the `version` and `shasum` values, as well as the appcast [`checkpoint`](doc/cask_language_reference/stanzas/appcast.md), if there is one. ## Getting Set Up To Contribute @@ -35,7 +35,7 @@ For manual updates, you'll need to fork the repository and add your copy as a re ```bash $ github_user='' -$ cd "$(brew --repository)"/Library/Taps/caskroom/homebrew-cask +$ cd "$(brew --repository)"/Library/Taps/Homebrew/homebrew-cask $ git remote add "${github_user}" "https://github.com/${github_user}/homebrew-cask" ``` @@ -46,7 +46,7 @@ $ git remote add "${github_user}" "https://github.com/${github_user}/homebrew-ca ## Adding a Cask -Notice an application that's not in Homebrew-Cask yet? Make sure it's not yet in [Caskroom/versions](https://github.com/caskroom/homebrew-versions) or [Homebrew/core](https://github.com/Homebrew/homebrew-core) (can be searched with `brew search`). Mac App Store apps can't be installed via Homebrew-Cask, but check out [mas](https://github.com/argon/mas) for an alternative. +Notice an application that's not in Homebrew-Cask yet? Make sure it's not yet in [Caskroom/versions](https://github.com/Homebrew/homebrew-cask-versions) or [Homebrew/core](https://github.com/Homebrew/homebrew-core) (can be searched with `brew search`). Mac App Store apps can't be installed via Homebrew-Cask, but check out [mas](https://github.com/argon/mas) for an alternative. With a bit of work, you can create a Cask for it. [This document](doc/development/adding_a_cask.md) will walk you through creating a new Cask, testing it, and submitting it to us. diff --git a/Casks/adobe-air-sdk.rb b/Casks/adobe-air-sdk.rb index 8b779583f1..d20c65d896 100644 --- a/Casks/adobe-air-sdk.rb +++ b/Casks/adobe-air-sdk.rb @@ -36,7 +36,7 @@ cask 'adobe-air-sdk' do 'swcdepends', 'swfdump', ].each do |shimscript| - # shim script (https://github.com/caskroom/homebrew-cask/issues/18809) + # shim script (https://github.com/Homebrew/homebrew-cask/issues/18809) IO.write "#{staged_path}/bin/#{shimscript}.wrapper.sh", <<~EOS #!/bin/sh exec '#{staged_path}/bin/#{shimscript}' "$@" diff --git a/Casks/adobe-photoshop-lightroom.rb b/Casks/adobe-photoshop-lightroom.rb index a85b3ce624..5399cc73ca 100644 --- a/Casks/adobe-photoshop-lightroom.rb +++ b/Casks/adobe-photoshop-lightroom.rb @@ -7,11 +7,11 @@ cask 'adobe-photoshop-lightroom' do homepage 'https://www.adobe.com/products/photoshop-lightroom.html' auto_updates true - depends_on cask: 'caskroom/versions/adobe-photoshop-lightroom600' + depends_on cask: 'homebrew/cask-versions/adobe-photoshop-lightroom600' # staged_path not available in Installer/Uninstall Stanza, workaround by nesting with preflight/postflight - # see https://github.com/caskroom/homebrew-cask/pull/8887 - # and https://github.com/caskroom/homebrew-versions/pull/296 + # see https://github.com/Homebrew/homebrew-cask/pull/8887 + # and https://github.com/Homebrew/homebrew-cask-versions/pull/296 preflight do processes = system_command '/bin/launchctl', args: ['list'] diff --git a/Casks/android-ndk.rb b/Casks/android-ndk.rb index 7b68a1b6be..de9e9781a8 100644 --- a/Casks/android-ndk.rb +++ b/Casks/android-ndk.rb @@ -9,7 +9,7 @@ cask 'android-ndk' do conflicts_with cask: 'crystax-ndk' - # shim script (https://github.com/caskroom/homebrew-cask/issues/18809) + # shim script (https://github.com/Homebrew/homebrew-cask/issues/18809) shimscript = "#{staged_path}/ndk_exec.sh" preflight do FileUtils.ln_sf("#{staged_path}/android-ndk-r#{version}", "#{HOMEBREW_PREFIX}/share/android-ndk") diff --git a/Casks/armitage.rb b/Casks/armitage.rb index 55c8c6ca15..8649132f08 100644 --- a/Casks/armitage.rb +++ b/Casks/armitage.rb @@ -7,7 +7,7 @@ cask 'armitage' do homepage 'http://www.fastandeasyhacking.com/' app 'Armitage.app' - # shim script (https://github.com/caskroom/homebrew-cask/issues/18809) + # shim script (https://github.com/Homebrew/homebrew-cask/issues/18809) shimscript = "#{staged_path}/armitage.wrapper.sh" binary shimscript, target: 'armitage' diff --git a/Casks/avast-security.rb b/Casks/avast-security.rb index 947a78696c..904777050e 100644 --- a/Casks/avast-security.rb +++ b/Casks/avast-security.rb @@ -10,7 +10,7 @@ cask 'avast-security' do uninstall script: { executable: '/Library/Application Support/Avast/hub/uninstall.sh', - must_succeed: false, # A non-0 exit code may be given even if the uninstall succeeds (https://github.com/caskroom/homebrew-cask/issues/21740#issuecomment-224094946). + must_succeed: false, # A non-0 exit code may be given even if the uninstall succeeds (https://github.com/Homebrew/homebrew-cask/issues/21740#issuecomment-224094946). sudo: true, } diff --git a/Casks/bandage.rb b/Casks/bandage.rb index 05da67c41d..71825e5b8f 100644 --- a/Casks/bandage.rb +++ b/Casks/bandage.rb @@ -10,7 +10,7 @@ cask 'bandage' do homepage 'https://rrwick.github.io/Bandage/' app 'Bandage.app' - # shim script (https://github.com/caskroom/homebrew-cask/issues/18809) + # shim script (https://github.com/Homebrew/homebrew-cask/issues/18809) shimscript = "#{staged_path}/bandage.wrapper.sh" binary shimscript, target: 'bandage' diff --git a/Casks/blender.rb b/Casks/blender.rb index ae55e0a91d..f2334d5eb2 100644 --- a/Casks/blender.rb +++ b/Casks/blender.rb @@ -9,7 +9,7 @@ cask 'blender' do # Renamed for consistency: app name is different in the Finder and in a shell. app "blender-#{version}-macOS-10.6/blender.app", target: 'Blender.app' app "blender-#{version}-macOS-10.6/blenderplayer.app", target: 'Blenderplayer.app' - # shim script (https://github.com/caskroom/homebrew-cask/issues/18809) + # shim script (https://github.com/Homebrew/homebrew-cask/issues/18809) shimscript = "#{staged_path}/blender.wrapper.sh" binary shimscript, target: 'blender' diff --git a/Casks/cocoscreator.rb b/Casks/cocoscreator.rb index 469b9cea2d..22366409f0 100644 --- a/Casks/cocoscreator.rb +++ b/Casks/cocoscreator.rb @@ -7,7 +7,7 @@ cask 'cocoscreator' do name 'CocosCreator' homepage 'http://www.cocos2d-x.org/' - # shim script (https://github.com/caskroom/homebrew-cask/issues/18809) + # shim script (https://github.com/Homebrew/homebrew-cask/issues/18809) shimscript = "#{staged_path}/cocos.wrapper.sh" app 'CocosCreator.app' diff --git a/Casks/copyq.rb b/Casks/copyq.rb index be1e9b534b..f743d9db62 100644 --- a/Casks/copyq.rb +++ b/Casks/copyq.rb @@ -10,7 +10,7 @@ cask 'copyq' do homepage 'https://hluk.github.io/CopyQ/' app 'CopyQ.app' - # shim script (https://github.com/caskroom/homebrew-cask/issues/18809) + # shim script (https://github.com/Homebrew/homebrew-cask/issues/18809) shimscript = "#{staged_path}/copyq.wrapper.sh" binary shimscript, target: 'copyq' diff --git a/Casks/crystax-ndk.rb b/Casks/crystax-ndk.rb index e7d3a307c3..475b6be48b 100644 --- a/Casks/crystax-ndk.rb +++ b/Casks/crystax-ndk.rb @@ -8,7 +8,7 @@ cask 'crystax-ndk' do conflicts_with cask: 'android-ndk' - # shim script (https://github.com/caskroom/homebrew-cask/issues/18809) + # shim script (https://github.com/Homebrew/homebrew-cask/issues/18809) shimscript = "#{staged_path}/ndk_exec.sh" preflight do FileUtils.ln_sf("#{staged_path}/crystax-ndk-#{version}", "#{HOMEBREW_PREFIX}/share/crystax-ndk") diff --git a/Casks/decitime.rb b/Casks/decitime.rb index 58db0ba4f7..0df0e2b608 100644 --- a/Casks/decitime.rb +++ b/Casks/decitime.rb @@ -13,7 +13,7 @@ cask 'decitime' do app 'DeciTime.app' # fix wonky DMG by mounting it once read-write per discussion at - # https://github.com/caskroom/homebrew-cask/pull/2654 + # https://github.com/Homebrew/homebrew-cask/pull/2654 preflight do system %Q{/usr/bin/hdiutil eject "$(/usr/bin/hdiutil mount -readwrite -noidme -nobrowse -mountrandom /tmp #{staged_path.join(nested_container)} | /usr/bin/cut -f3 -- - | /usr/bin/grep -- '.' -)" >/dev/null 2>&1} end diff --git a/Casks/devonthink-pro-office.rb b/Casks/devonthink-pro-office.rb index d2308d4a36..9eb2f8838e 100644 --- a/Casks/devonthink-pro-office.rb +++ b/Casks/devonthink-pro-office.rb @@ -13,6 +13,6 @@ cask 'devonthink-pro-office' do depends_on macos: '>= :mavericks' # Renamed for consistency: app name is different in the Finder and in a shell. - # Original discussion: https://github.com/caskroom/homebrew-cask/pull/3838 + # Original discussion: https://github.com/Homebrew/homebrew-cask/pull/3838 app 'DEVONthink Pro.app', target: 'DEVONthink Pro Office.app' end diff --git a/Casks/dwarf-fortress.rb b/Casks/dwarf-fortress.rb index 64ade60482..a969fe4e55 100644 --- a/Casks/dwarf-fortress.rb +++ b/Casks/dwarf-fortress.rb @@ -6,7 +6,7 @@ cask 'dwarf-fortress' do name 'Dwarf Fortress' homepage 'http://www.bay12games.com/dwarves/' - # shim script (https://github.com/caskroom/homebrew-cask/issues/18809) + # shim script (https://github.com/Homebrew/homebrew-cask/issues/18809) shimscript = "#{staged_path}/df_osx/df.wrapper.sh" binary shimscript, target: 'dwarf-fortress' diff --git a/Casks/dynamodb-local.rb b/Casks/dynamodb-local.rb index 72f577bbc8..28011d6408 100644 --- a/Casks/dynamodb-local.rb +++ b/Casks/dynamodb-local.rb @@ -7,7 +7,7 @@ cask 'dynamodb-local' do name 'Amazon DynamoDB Local' homepage 'https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.html' - # shim script (https://github.com/caskroom/homebrew-cask/issues/18809) + # shim script (https://github.com/Homebrew/homebrew-cask/issues/18809) shimscript = "#{staged_path}/dynamodb-local.wrapper.sh" binary shimscript, target: 'dynamodb-local' diff --git a/Casks/eventstore.rb b/Casks/eventstore.rb index eca88beae4..cb2fb7d31a 100644 --- a/Casks/eventstore.rb +++ b/Casks/eventstore.rb @@ -9,7 +9,7 @@ cask 'eventstore' do binary "EventStore-OSS-MacOSX-v#{version}/eventstore" binary "EventStore-OSS-MacOSX-v#{version}/eventstore-testclient" - # shim script (https://github.com/caskroom/homebrew-cask/issues/18809) + # shim script (https://github.com/Homebrew/homebrew-cask/issues/18809) eventstore_shimscript = "#{staged_path}/EventStore-OSS-MacOSX-v#{version}/eventstore" testclient_shimscript = "#{staged_path}/EventStore-OSS-MacOSX-v#{version}/eventstore-testclient" diff --git a/Casks/flymaster-designer.rb b/Casks/flymaster-designer.rb index f3500b1309..32ccc885a1 100644 --- a/Casks/flymaster-designer.rb +++ b/Casks/flymaster-designer.rb @@ -8,7 +8,7 @@ cask 'flymaster-designer' do homepage 'https://www.flymaster.net/' # Renamed for clarity: app name is inconsistent with its branding. - # Original discussion: https://github.com/caskroom/homebrew-cask/pull/9334 + # Original discussion: https://github.com/Homebrew/homebrew-cask/pull/9334 app 'B2designer.app', target: 'Flymaster Designer.app' uninstall quit: 'net.flymaster.designer' diff --git a/Casks/futuniuniu.rb b/Casks/futuniuniu.rb index f4b2adda65..0f73837b46 100644 --- a/Casks/futuniuniu.rb +++ b/Casks/futuniuniu.rb @@ -8,6 +8,6 @@ cask 'futuniuniu' do homepage 'https://hk.futu5.com/' # Renamed for consistency: app name is different in the Finder and in a shell. - # Original discussion: https://github.com/caskroom/homebrew-cask/pull/7435 + # Original discussion: https://github.com/Homebrew/homebrew-cask/pull/7435 app 'FutuNiuniu.app', target: '富途牛牛.app' end diff --git a/Casks/gogs.rb b/Casks/gogs.rb index 0189a76c71..1083ec7125 100644 --- a/Casks/gogs.rb +++ b/Casks/gogs.rb @@ -9,7 +9,7 @@ cask 'gogs' do name 'Go Git Service' homepage 'https://gogs.io/' - # shim script (https://github.com/caskroom/homebrew-cask/issues/18809) + # shim script (https://github.com/Homebrew/homebrew-cask/issues/18809) shimscript = "#{staged_path}/gogs.wrapper.sh" binary shimscript, target: 'gogs' diff --git a/Casks/gqrx.rb b/Casks/gqrx.rb index 0ecfb94eb4..e74c4f87de 100644 --- a/Casks/gqrx.rb +++ b/Casks/gqrx.rb @@ -27,7 +27,7 @@ cask 'gqrx' do binary "#{appdir}/Gqrx.app/Contents/MacOS/rtl_test" binary "#{appdir}/Gqrx.app/Contents/MacOS/SoapySDRUtil", target: 'soapysdrutil' binary "#{appdir}/Gqrx.app/Contents/MacOS/volk_profile" - # shim script (https://github.com/caskroom/homebrew-cask/issues/18809) + # shim script (https://github.com/Homebrew/homebrew-cask/issues/18809) shimscript = "#{staged_path}/gqrx.wrapper.sh" binary shimscript, target: 'gqrx' diff --git a/Casks/handy-outliner.rb b/Casks/handy-outliner.rb index 4844b9a478..67ffda0708 100644 --- a/Casks/handy-outliner.rb +++ b/Casks/handy-outliner.rb @@ -13,7 +13,7 @@ cask 'handy-outliner' do binary 'handy-outliner' - # shim script (https://github.com/caskroom/homebrew-cask/issues/18809) + # shim script (https://github.com/Homebrew/homebrew-cask/issues/18809) shimscript = "#{staged_path}/handy-outliner" preflight do diff --git a/Casks/imagemin.rb b/Casks/imagemin.rb index 61546f421a..06148fa384 100644 --- a/Casks/imagemin.rb +++ b/Casks/imagemin.rb @@ -9,6 +9,6 @@ cask 'imagemin' do homepage 'https://github.com/imagemin/imagemin-app' # Renamed for clarity: app name is inconsistent with its branding. - # Original discussion: https://github.com/caskroom/homebrew-cask/pull/4701 + # Original discussion: https://github.com/Homebrew/homebrew-cask/pull/4701 app "imagemin-app-v#{version}-darwin/Atom.app", target: 'imagemin.app' end diff --git a/Casks/kdiff3.rb b/Casks/kdiff3.rb index c95fcc09a9..f51febab9a 100644 --- a/Casks/kdiff3.rb +++ b/Casks/kdiff3.rb @@ -10,7 +10,7 @@ cask 'kdiff3' do homepage 'http://kdiff3.sourceforge.net/' app 'kdiff3.app' - # shim script (https://github.com/caskroom/homebrew-cask/issues/18809) + # shim script (https://github.com/Homebrew/homebrew-cask/issues/18809) shimscript = "#{staged_path}/kdiff3.wrapper.sh" binary shimscript, target: 'kdiff3' diff --git a/Casks/libreoffice.rb b/Casks/libreoffice.rb index d374510127..193599f3a7 100644 --- a/Casks/libreoffice.rb +++ b/Casks/libreoffice.rb @@ -27,7 +27,7 @@ cask 'libreoffice' do binary "#{appdir}/LibreOffice.app/Contents/MacOS/unopkg" binary "#{appdir}/LibreOffice.app/Contents/MacOS/uri-encode" binary "#{appdir}/LibreOffice.app/Contents/MacOS/xpdfimport" - # shim script (https://github.com/caskroom/homebrew-cask/issues/18809) + # shim script (https://github.com/Homebrew/homebrew-cask/issues/18809) shimscript = "#{staged_path}/soffice.wrapper.sh" binary shimscript, target: 'soffice' diff --git a/Casks/lilypond.rb b/Casks/lilypond.rb index 84781dcb57..5394786c2e 100644 --- a/Casks/lilypond.rb +++ b/Casks/lilypond.rb @@ -24,7 +24,7 @@ cask 'lilypond' do preflight do binaries.each do |shimscript| - # shim script (https://github.com/caskroom/homebrew-cask/issues/18809) + # shim script (https://github.com/Homebrew/homebrew-cask/issues/18809) IO.write "#{staged_path}/#{shimscript}.wrapper.sh", <<~EOS #!/bin/sh exec '#{appdir}/LilyPond.app/Contents/Resources/bin/#{shimscript}' "$@" diff --git a/Casks/logisim-evolution.rb b/Casks/logisim-evolution.rb index 57eb24b3a7..919a7301c8 100644 --- a/Casks/logisim-evolution.rb +++ b/Casks/logisim-evolution.rb @@ -10,7 +10,7 @@ cask 'logisim-evolution' do container type: :naked - # shim script (https://github.com/caskroom/homebrew-cask/issues/18809) + # shim script (https://github.com/Homebrew/homebrew-cask/issues/18809) shimscript = "#{staged_path}/logisim-evolution.wrapper.sh" binary shimscript, target: 'logisim-evolution' diff --git a/Casks/mars.rb b/Casks/mars.rb index ce67b77ff7..7ac98cbdf4 100644 --- a/Casks/mars.rb +++ b/Casks/mars.rb @@ -11,7 +11,7 @@ cask 'mars' do container type: :naked - # shim script (https://github.com/caskroom/homebrew-cask/issues/18809) + # shim script (https://github.com/Homebrew/homebrew-cask/issues/18809) shimscript = "#{staged_path}/mars.wrapper.sh" binary shimscript, target: 'mars' diff --git a/Casks/minecraft-server.rb b/Casks/minecraft-server.rb index b6e518a04f..c65712da2c 100644 --- a/Casks/minecraft-server.rb +++ b/Casks/minecraft-server.rb @@ -9,7 +9,7 @@ cask 'minecraft-server' do container type: :naked - # shim script (https://github.com/caskroom/homebrew-cask/issues/18809) + # shim script (https://github.com/Homebrew/homebrew-cask/issues/18809) shimscript = "#{staged_path}/minecraft-server.wrapper.sh" binary shimscript, target: 'minecraft-server' diff --git a/Casks/mousepose.rb b/Casks/mousepose.rb index 8a6045f788..2f7a4c3b83 100644 --- a/Casks/mousepose.rb +++ b/Casks/mousepose.rb @@ -7,7 +7,7 @@ cask 'mousepose' do homepage 'https://boinx.com/mousepose/overview/' # Renamed for consistency: app name is different in the Finder and in a shell. - # Original discussion: https://github.com/caskroom/homebrew-cask/pull/15708 + # Original discussion: https://github.com/Homebrew/homebrew-cask/pull/15708 app 'Mousepose.app', target: "Mousepose\314\201.app" zap trash: [ diff --git a/Casks/music-manager.rb b/Casks/music-manager.rb index 4e09e24873..14728764a1 100644 --- a/Casks/music-manager.rb +++ b/Casks/music-manager.rb @@ -7,7 +7,7 @@ cask 'music-manager' do homepage 'https://play.google.com/music/listen' # Renamed for consistency: app name is different in the Finder and in a shell. - # Original discussion: https://github.com/caskroom/homebrew-cask/pull/4282 + # Original discussion: https://github.com/Homebrew/homebrew-cask/pull/4282 app 'MusicManager.app', target: 'Music Manager.app' uninstall delete: '~/Library/PreferencePanes/MusicManager.prefPane', diff --git a/Casks/nodeclipse.rb b/Casks/nodeclipse.rb index 3d2a2d3e0f..2e3b46d8db 100644 --- a/Casks/nodeclipse.rb +++ b/Casks/nodeclipse.rb @@ -11,6 +11,6 @@ cask 'nodeclipse' do # Renamed for clarity: app name is inconsistent with its branding. # Also renamed to avoid conflict with other eclipse Casks. - # Original discussion: https://github.com/caskroom/homebrew-cask/pull/8183 + # Original discussion: https://github.com/Homebrew/homebrew-cask/pull/8183 app 'Eclipse.app', target: 'Nodeclipse.app' end diff --git a/Casks/osmc.rb b/Casks/osmc.rb index ea00ab5ddf..3e1952d8b5 100644 --- a/Casks/osmc.rb +++ b/Casks/osmc.rb @@ -7,6 +7,6 @@ cask 'osmc' do homepage 'https://osmc.tv/' # Renamed for clarity: app name is inconsistent with its branding. - # Original discussion: https://github.com/caskroom/homebrew-cask/pull/9420 + # Original discussion: https://github.com/Homebrew/homebrew-cask/pull/9420 app 'qt_host_installer.app', target: 'OSMC.app' end diff --git a/Casks/parallels-access.rb b/Casks/parallels-access.rb index a122d6d31e..c94db5f8bc 100644 --- a/Casks/parallels-access.rb +++ b/Casks/parallels-access.rb @@ -7,7 +7,7 @@ cask 'parallels-access' do homepage 'https://www.parallels.com/products/access/' # This .dmg cannot be extracted normally - # Original discussion: https://github.com/caskroom/homebrew-cask/issues/26872 + # Original discussion: https://github.com/Homebrew/homebrew-cask/issues/26872 container type: :naked preflight do diff --git a/Casks/polar-websync.rb b/Casks/polar-websync.rb index ae0122f429..a0e70cc8f5 100644 --- a/Casks/polar-websync.rb +++ b/Casks/polar-websync.rb @@ -8,7 +8,7 @@ cask 'polar-websync' do homepage 'https://support.polar.com/support/downloads/Polar_WebSync_Software' # cannot be installed automatically, because it presents a choice - # See more: https://github.com/caskroom/homebrew-cask/pull/11040#issuecomment-100454926 + # See more: https://github.com/Homebrew/homebrew-cask/pull/11040#issuecomment-100454926 installer manual: 'Polar WebSync.pkg' uninstall pkgutil: 'fi.polar.websync.pkg', diff --git a/Casks/private-eye.rb b/Casks/private-eye.rb index 92aed564b2..07d09fa35f 100644 --- a/Casks/private-eye.rb +++ b/Casks/private-eye.rb @@ -9,7 +9,7 @@ cask 'private-eye' do pkg 'Private_Eye_for_OS_X_10.9_and_later.pkg' # We intentionally unload the kext twice as a workaround - # See https://github.com/caskroom/homebrew-cask/pull/1802#issuecomment-34171151 + # See https://github.com/Homebrew/homebrew-cask/pull/1802#issuecomment-34171151 uninstall early_script: { executable: '/sbin/kextunload', diff --git a/Casks/radio-silence.rb b/Casks/radio-silence.rb index f9937fc0c5..54c68b74cd 100644 --- a/Casks/radio-silence.rb +++ b/Casks/radio-silence.rb @@ -11,7 +11,7 @@ cask 'radio-silence' do pkg "Radio_Silence_#{version}.pkg" # We intentionally unload the kext twice as a workaround - # See https://github.com/caskroom/homebrew-cask/pull/1802#issuecomment-34171151 + # See https://github.com/Homebrew/homebrew-cask/pull/1802#issuecomment-34171151 uninstall early_script: { executable: '/sbin/kextunload', diff --git a/Casks/scala-ide.rb b/Casks/scala-ide.rb index 8411db4ca9..347a2ef97a 100644 --- a/Casks/scala-ide.rb +++ b/Casks/scala-ide.rb @@ -9,6 +9,6 @@ cask 'scala-ide' do # Renamed for clarity: app name is inconsistent with its branding. # Also renamed to avoid conflict with other eclipse Casks. - # Original discussion: https://github.com/caskroom/homebrew-cask/pull/2731 + # Original discussion: https://github.com/Homebrew/homebrew-cask/pull/2731 app 'eclipse.app', target: 'Scala IDE.app' end diff --git a/Casks/screens-connect.rb b/Casks/screens-connect.rb index b6fc9531de..04aecaa34f 100644 --- a/Casks/screens-connect.rb +++ b/Casks/screens-connect.rb @@ -14,7 +14,7 @@ cask 'screens-connect' do app 'Screens Connect.app' # Uninstall script can fail when trying to remove legacy PKGIDS - # Original discussion: https://github.com/caskroom/homebrew-cask/pull/8833 + # Original discussion: https://github.com/Homebrew/homebrew-cask/pull/8833 uninstall quit: 'com.edovia.Screens-Connect', launchctl: [ 'com.edovia.Screens-Connect.launcher', diff --git a/Casks/squirrelsql.rb b/Casks/squirrelsql.rb index 99fc8edd58..0795da4b05 100644 --- a/Casks/squirrelsql.rb +++ b/Casks/squirrelsql.rb @@ -14,7 +14,7 @@ cask 'squirrelsql' do installoptions = "#{staged_path}/install-options.xml" preflight do - # shim script (https://github.com/caskroom/homebrew-cask/issues/18809) + # shim script (https://github.com/Homebrew/homebrew-cask/issues/18809) File.open(installoptions, 'w') do |f| f.print <<~EOS diff --git a/Casks/steamcmd.rb b/Casks/steamcmd.rb index 3889476254..65cfdb42e2 100644 --- a/Casks/steamcmd.rb +++ b/Casks/steamcmd.rb @@ -9,7 +9,7 @@ cask 'steamcmd' do auto_updates true - # shim script (https://github.com/caskroom/homebrew-cask/issues/18809) + # shim script (https://github.com/Homebrew/homebrew-cask/issues/18809) shimscript = "#{staged_path}/steamcmd.sh.wrapper.sh" binary shimscript, target: 'steamcmd' diff --git a/Casks/toontown-rewritten.rb b/Casks/toontown-rewritten.rb index 9abab610f8..a312f79e2c 100644 --- a/Casks/toontown-rewritten.rb +++ b/Casks/toontown-rewritten.rb @@ -8,6 +8,6 @@ cask 'toontown-rewritten' do homepage 'https://www.toontownrewritten.com/' # Renamed for consistency: app name is different in the Finder and in a shell. - # Original discussion: https://github.com/caskroom/homebrew-cask/pull/8037 + # Original discussion: https://github.com/Homebrew/homebrew-cask/pull/8037 app 'Toontown Launcher.app', target: 'Toontown Rewritten.app' end diff --git a/Casks/vlc.rb b/Casks/vlc.rb index 2552d4e41d..163de32d0f 100644 --- a/Casks/vlc.rb +++ b/Casks/vlc.rb @@ -12,7 +12,7 @@ cask 'vlc' do auto_updates true app 'VLC.app' - # shim script (https://github.com/caskroom/homebrew-cask/issues/18809) + # shim script (https://github.com/Homebrew/homebrew-cask/issues/18809) shimscript = "#{staged_path}/vlc.wrapper.sh" binary shimscript, target: 'vlc' diff --git a/Casks/xeora-cli.rb b/Casks/xeora-cli.rb index 98d54079fa..07d0c02252 100644 --- a/Casks/xeora-cli.rb +++ b/Casks/xeora-cli.rb @@ -8,7 +8,7 @@ cask 'xeora-cli' do depends_on cask: 'dotnet-sdk' - # shim script (https://github.com/caskroom/homebrew-cask/issues/18809) + # shim script (https://github.com/Homebrew/homebrew-cask/issues/18809) shimscript = "#{staged_path}/xeora.wrapper.sh" binary shimscript, target: 'xeora' diff --git a/README.md b/README.md index cac3e31246..dce52404af 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Homebrew-Cask extends [Homebrew](http://brew.sh) and brings its elegance, simpli We do this by providing a friendly Homebrew-style CLI workflow for the administration of macOS applications distributed as binaries. -[![Join the chat at https://gitter.im/caskroom/homebrew-cask](https://img.shields.io/badge/gitter-join%20chat-blue.svg)](https://gitter.im/caskroom/homebrew-cask) +[![Join the chat at https://gitter.im/Homebrew/homebrew-cask](https://img.shields.io/badge/gitter-join%20chat-blue.svg)](https://gitter.im/Homebrew/homebrew-cask) ## Let’s try it! @@ -57,20 +57,20 @@ If your issue persists, search for it before opening a new one. If you find an o * [Unlisted reason](doc/reporting_bugs/a_cask_fails_to_install.md#unlisted-reason) * [`uninstall` wrongly reports cask as not installed](doc/reporting_bugs/uninstall_wrongly_reports_cask_as_not_installed.md) * [`Error: Unknown command: cask` error](doc/reporting_bugs/error_unknown_command_cask.md) -* [My problem isn’t listed](https://github.com/caskroom/homebrew-cask/issues/new) +* [My problem isn’t listed](https://github.com/Homebrew/homebrew-cask/issues/new) ## Requests -* Cask requests will be automatically closed. If you want a cask added, [submit a pull request](https://github.com/caskroom/homebrew-cask/blob/master/CONTRIBUTING.md#adding-a-cask). -* For a feature request, [use this template](https://github.com/caskroom/homebrew-cask/issues/new?template=02_feature_request.md). +* Cask requests will be automatically closed. If you want a cask added, [submit a pull request](https://github.com/Homebrew/homebrew-cask/blob/master/CONTRIBUTING.md#adding-a-cask). +* For a feature request, [use this template](https://github.com/Homebrew/homebrew-cask/issues/new?template=02_feature_request.md). ## Questions? Wanna chat? We’re really rather friendly! Here are the best places to talk about the project: -* If none of the templates above is appropriate, [open an issue](https://github.com/caskroom/homebrew-cask/issues/new). +* If none of the templates above is appropriate, [open an issue](https://github.com/Homebrew/homebrew-cask/issues/new). * Join us (and [caskbot](https://github.com/passcod/caskbot)) on IRC at `#homebrew-cask` on Freenode -* Join us on [Gitter](https://gitter.im/caskroom/homebrew-cask) +* Join us on [Gitter](https://gitter.im/Homebrew/homebrew-cask) ## License Code is under the [BSD 2 Clause (NetBSD) license](LICENSE) diff --git a/USAGE.md b/USAGE.md index 4b0e3e1530..734c2e39ee 100644 --- a/USAGE.md +++ b/USAGE.md @@ -119,7 +119,7 @@ $ brew cask info caffeine caffeine: 1.1.1 http://lightheadsw.com/caffeine/ Not installed -From: https://github.com/caskroom/homebrew-cask/blob/master/Casks/caffeine.rb +From: https://github.com/Homebrew/homebrew-cask/blob/master/Casks/caffeine.rb ==> Name Caffeine ==> Artifacts @@ -134,7 +134,7 @@ It is generally safe to run updates from within an application. ## Updating/Upgrading the Homebrew-Cask Tool -Homebrew [automatically taps and keeps Homebrew-Cask updated](https://github.com/caskroom/homebrew-cask/pull/15381). `brew update` is all that is required. +Homebrew [automatically taps and keeps Homebrew-Cask updated](https://github.com/Homebrew/homebrew-cask/pull/15381). `brew update` is all that is required. ## Additional Taps (optional) @@ -142,10 +142,10 @@ The primary Homebrew-Cask Tap includes most of the Casks that a typical user wil | Tap name | description | | -------- | ----------- | -| [caskroom/versions](https://github.com/caskroom/homebrew-versions) | contains alternate versions of Casks (e.g. betas, nightly releases, old versions) -| [caskroom/fonts](https://github.com/caskroom/homebrew-fonts) | contains Casks that install fonts -| [caskroom/eid](https://github.com/caskroom/homebrew-eid) | contains Casks that install electronic identity card software of various countries -| [caskroom/drivers](https://github.com/caskroom/homebrew-drivers) | contains Casks that install drivers for various devices +| [Homebrew/cask-versions](https://github.com/Homebrew/homebrew-cask-versions) | contains alternate versions of Casks (e.g. betas, nightly releases, old versions) +| [Homebrew/cask-fonts](https://github.com/Homebrew/homebrew-cask-fonts) | contains Casks that install fonts +| [Homebrew/cask-eid](https://github.com/Homebrew/homebrew-cask-eid) | contains Casks that install electronic identity card software of various countries +| [Homebrew/cask-drivers](https://github.com/Homebrew/homebrew-cask-drivers) | contains Casks that install drivers for various devices You can tap any of the above with a `brew tap` command: @@ -158,7 +158,7 @@ after which, Casks from the new Tap will be available to `search` or `install` j You may also specify a fully-qualified Cask token (which includes the Tap) for any `brew cask` command. This will implicitly add the Tap if you have not previously added it with `brew tap`: ```bash -$ brew cask install caskroom/fonts/font-symbola +$ brew cask install homebrew/cask-fonts/font-symbola ``` ## Options @@ -206,12 +206,12 @@ google-chrome Most `brew cask` commands can accept a Cask token as an argument. As described above, the token on the command line can take the form of: * A token as returned by `brew cask search`, _eg_: `google-chrome`. -* A fully-qualified token which includes the Tap, _eg_: `caskroom/fonts/font-symbola`. +* A fully-qualified token which includes the Tap, _eg_: `homebrew/cask-fonts/font-symbola`. `brew cask` also accepts three other forms as arguments: -* A path to a Cask file, _eg_: `/usr/local/Library/Taps/caskroom/homebrew-cask/Casks/google-chrome.rb`. -* A `curl`-retrievable URI to a Cask file, _eg_: `https://raw.githubusercontent.com/caskroom/homebrew-cask/f25b6babcd398abf48e33af3d887b2d00de1d661/Casks/google-chrome.rb`. +* A path to a Cask file, _eg_: `/usr/local/Library/Taps/Homebrew/homebrew-cask/Casks/google-chrome.rb`. +* A `curl`-retrievable URI to a Cask file, _eg_: `https://raw.githubusercontent.com/Homebrew/homebrew-cask/f25b6babcd398abf48e33af3d887b2d00de1d661/Casks/google-chrome.rb`. * A file in the current working directory, _eg_: `my-modfied-google-chrome.rb`. Note that matching Tapped Cask tokens will be preferred over this form when there is a conflict. To force the use of a Cask file in the current directory, specify a pathname with slashes, _eg_: `./google-chrome.rb`. The last three forms are intended for users who wish to maintain private Casks. diff --git a/ci/travis/before_script.sh b/ci/travis/before_script.sh index fb1676ffff..fc79030468 100755 --- a/ci/travis/before_script.sh +++ b/ci/travis/before_script.sh @@ -11,7 +11,7 @@ header 'Running before_script.sh...' # this is not normally required but does prevent problems with outdated forks and/or deleted casks -# see https://github.com/caskroom/homebrew-cask/pull/43164 +# see https://github.com/Homebrew/homebrew-cask/pull/43164 run export BRANCH_COMMIT="${TRAVIS_COMMIT_RANGE##*.}" run export TARGET_COMMIT="${TRAVIS_COMMIT_RANGE%%.*}" # shellcheck disable=SC2016 diff --git a/ci/travis/script.sh b/ci/travis/script.sh index adcdb9e4c0..c9a69edfe1 100755 --- a/ci/travis/script.sh +++ b/ci/travis/script.sh @@ -11,9 +11,9 @@ header 'Running script.sh...' apps () { /usr/bin/find /Applications -type d -name '*.app' -maxdepth 2 ; } -launchjob_install () { "$(brew --repository)/Library/Taps/caskroom/homebrew-cask/developer/bin/list_installed_launchjob_ids" ; } -launchjob_load () { "$(brew --repository)/Library/Taps/caskroom/homebrew-cask/developer/bin/list_loaded_launchjob_ids" ; } -pkgs () { "$(brew --repository)/Library/Taps/caskroom/homebrew-cask/developer/bin/list_recent_pkg_ids" ; } +launchjob_install () { "$(brew --repository)/Library/Taps/Homebrew/homebrew-cask/developer/bin/list_installed_launchjob_ids" ; } +launchjob_load () { "$(brew --repository)/Library/Taps/Homebrew/homebrew-cask/developer/bin/list_loaded_launchjob_ids" ; } +pkgs () { "$(brew --repository)/Library/Taps/Homebrew/homebrew-cask/developer/bin/list_recent_pkg_ids" ; } checks=('pkgs' 'apps' 'launchjob_install' 'launchjob_load') diff --git a/developer/bin/cask_pr_manual_check b/developer/bin/cask_pr_manual_check index 442c40535c..66cd2b0d5d 100755 --- a/developer/bin/cask_pr_manual_check +++ b/developer/bin/cask_pr_manual_check @@ -7,7 +7,7 @@ require 'tmpdir' pr_url = ARGV[0] abort 'You need to give the script exactly one argument, the URL to a pull request on the Caskroom organisation' if ARGV[0].empty? -abort 'URL is not from the Caskroom organization' if pr_url !~ %r{^https://github.com/caskroom/} +abort 'URL is not from the Homebrew organization' if pr_url !~ %r{^https://github.com/Homebrew/} pr_api = pr_url.sub(%r{^https://github.com/([^/]+)/([^/]+)/pull/([^/]+).*}, 'https://api.github.com/repos/\1/\2/pulls/\3/files') pr_json = JSON.parse(open(pr_api).read) diff --git a/developer/bin/list_pkg_ids_by_regexp b/developer/bin/list_pkg_ids_by_regexp index b364c147e1..7afc4f0f66 100755 --- a/developer/bin/list_pkg_ids_by_regexp +++ b/developer/bin/list_pkg_ids_by_regexp @@ -71,7 +71,7 @@ essential system files due to an exuberant regexp. For more information, see - https://github.com/caskroom/homebrew-cask/blob/master/doc/cask_language_reference/stanzas/uninstall.md + https://github.com/Homebrew/homebrew-cask/blob/master/doc/cask_language_reference/stanzas/uninstall.md " exit diff --git a/developer/bin/sync_templates_and_ci b/developer/bin/sync_templates_and_ci index 887eb413ab..628c365fe9 100755 --- a/developer/bin/sync_templates_and_ci +++ b/developer/bin/sync_templates_and_ci @@ -1,16 +1,16 @@ #!/bin/bash -readonly caskroom_online='https://github.com/caskroom' -readonly caskroom_repos_dir="$(mktemp -d)" +readonly homebrew_online='https://github.com/Homebrew' +readonly repos_dir="$(mktemp -d)" readonly main_repo_dir="$(mktemp -d)" # From where files will be copied -readonly caskroom_repos=(homebrew-versions homebrew-fonts homebrew-eid homebrew-drivers) # homebrew-cask is absent since it's the repo all the others are compared against +readonly cask_repos=(homebrew-cask-versions homebrew-cask-fonts homebrew-cask-eid homebrew-cask-drivers) # homebrew-cask is absent since it's the repo all the others are compared against function message { echo "${1}" } function get_main_repo { - curl --silent --location "${caskroom_online}/homebrew-cask/archive/master.zip" | ditto -xk - "${main_repo_dir}" + curl --silent --location "${homebrew_online}/homebrew-cask/archive/master.zip" | ditto -xk - "${main_repo_dir}" mv "${main_repo_dir}/homebrew-cask-master/"{,.[^.]}* "${main_repo_dir}" rmdir "${main_repo_dir}/homebrew-cask-master" } @@ -19,11 +19,11 @@ function get_repo { local repo_name repo_dir repo_name="${1}" - repo_dir="${caskroom_repos_dir}/${repo_name}" + repo_dir="${repos_dir}/${repo_name}" - cd "${caskroom_repos_dir}" || exit 1 + cd "${repos_dir}" || exit 1 message "Cloning ${repo_name}…" - git clone "${caskroom_online}/${repo_name}.git" --quiet + git clone "${homebrew_online}/${repo_name}.git" --quiet cd "${repo_dir}" || exit 1 } @@ -36,7 +36,7 @@ function copy_templates_and_ci { /usr/bin/sed -i '' -E "s:homebrew-cask/(pulls|issues):${repo_name}/\1:" '.github/PULL_REQUEST_TEMPLATE.md' # PULL_REQUEST_TEMPLATE has repo-specific links # increase script.sh install cap for fonts repo - if [[ "${repo_name}" == 'homebrew-fonts' ]]; then + if [[ "${repo_name}" == 'homebrew-cask-fonts' ]]; then /usr/bin/sed -i '' -e 's:-le 3:-le 15:' -e 's:than 3 Casks:than 15 Casks:' 'ci/travis/script.sh' fi } @@ -58,7 +58,7 @@ function push_changes { } get_main_repo -for repo in "${caskroom_repos[@]}"; do +for repo in "${cask_repos[@]}"; do get_repo "${repo}" copy_templates_and_ci "${repo}" push_changes diff --git a/doc/cask_language_reference/all_stanzas.md b/doc/cask_language_reference/all_stanzas.md index 6bcf8709b8..e6fdcf6bfc 100644 --- a/doc/cask_language_reference/all_stanzas.md +++ b/doc/cask_language_reference/all_stanzas.md @@ -34,7 +34,7 @@ Each Cask must declare one or more *artifacts* (i.e. something to install). | `vst_plugin` | yes | relative path to a VST Plugin that should be moved into the `~/Library/Audio/VST` folder on installation | `vst3_plugin` | yes | relative path to a VST3 Plugin that should be moved into the `~/Library/Audio/VST3` folder on installation | `suite` | yes | relative path to a containing directory that should be moved into the `/Applications` folder on installation (see also [Suite Stanza Details](stanzas/suite.md)) -| `artifact` | yes | relative path to an arbitrary path that should be moved on installation. Must provide an absolute path as a `target` (example [alcatraz.rb](https://github.com/caskroom/homebrew-cask/blob/312ae841f1f1b2ec07f4d88b7dfdd7fbdf8d4f94/Casks/alcatraz.rb#L12)). This is only for unusual cases. The `app` stanza is strongly preferred when moving `.app` bundles. +| `artifact` | yes | relative path to an arbitrary path that should be moved on installation. Must provide an absolute path as a `target` (example [alcatraz.rb](https://github.com/Homebrew/homebrew-cask/blob/312ae841f1f1b2ec07f4d88b7dfdd7fbdf8d4f94/Casks/alcatraz.rb#L12)). This is only for unusual cases. The `app` stanza is strongly preferred when moving `.app` bundles. | `installer` | yes | describes an executable which must be run to complete the installation (see [Installer Stanza Details](stanzas/installer.md)) | `stage_only` | no | `true`. Assert that the Cask contains no activatable artifacts. @@ -55,6 +55,6 @@ Each Cask must declare one or more *artifacts* (i.e. something to install). | `language` | required | a Ruby block, called with language code parameters, containing other stanzas and/or a return value | `accessibility_access` | no | `true` if the application should be granted accessibility access | `container nested:` | no | relative path to an inner container that must be extracted before moving on with the installation; this allows us to support dmg inside tar, zip inside dmg, etc. -| `container type:` | no | a symbol to override container-type autodetect. May be one of: `:air`, `:bz2`, `:cab`, `:dmg`, `:generic_unar`, `:gzip`, `:otf`, `:pkg`, `:rar`, `:seven_zip`, `:sit`, `:tar`, `:ttf`, `:xar`, `:zip`, `:naked`. (example [parse.rb](https://github.com/caskroom/homebrew-cask/blob/312ae841f1f1b2ec07f4d88b7dfdd7fbdf8d4f94/Casks/parse.rb#L11)) +| `container type:` | no | a symbol to override container-type autodetect. May be one of: `:air`, `:bz2`, `:cab`, `:dmg`, `:generic_unar`, `:gzip`, `:otf`, `:pkg`, `:rar`, `:seven_zip`, `:sit`, `:tar`, `:ttf`, `:xar`, `:zip`, `:naked`. (example [parse.rb](https://github.com/Homebrew/homebrew-cask/blob/312ae841f1f1b2ec07f4d88b7dfdd7fbdf8d4f94/Casks/parse.rb#L11)) | `gpg` | no | *stub: not yet functional.* (see also [GPG Stanza Details](stanzas/gpg.md)) | `auto_updates` | no | `true`. Assert the Cask artifacts auto-update. (Use if `Check for Updates…` or similar is present in app menu) diff --git a/doc/cask_language_reference/readme.md b/doc/cask_language_reference/readme.md index 9d1bd15f07..275440c186 100644 --- a/doc/cask_language_reference/readme.md +++ b/doc/cask_language_reference/readme.md @@ -35,7 +35,7 @@ Tests on the following values are known to be acceptable: | value | examples | ----------------------------|-------------------------------------- -| `MacOS.version` | [macports.rb](https://github.com/caskroom/homebrew-cask/blob/90e2d103a0069b9366e9d6cd5346c98686c40dce/Casks/macports.rb#L4#L29), [coconutbattery.rb](https://github.com/caskroom/homebrew-cask/blob/2c801af44be29fff7f3cb2996455fce5dd95d1cc/Casks/coconutbattery.rb#L3#L17) +| `MacOS.version` | [macports.rb](https://github.com/Homebrew/homebrew-cask/blob/90e2d103a0069b9366e9d6cd5346c98686c40dce/Casks/macports.rb#L4#L29), [coconutbattery.rb](https://github.com/Homebrew/homebrew-cask/blob/2c801af44be29fff7f3cb2996455fce5dd95d1cc/Casks/coconutbattery.rb#L3#L17) ### Version Comparisons @@ -54,7 +54,7 @@ The available symbols for macOS versions are: `:cheetah`, `:puma`, `:jaguar`, `: ### Always Fall Through to the Newest Case -Conditionals should be constructed so that the default is the newest OS version. When using an `if` statement, test for older versions, and then let the `else` statement hold the latest and greatest. This makes it more likely that the Cask will work without alteration when a new OS is released. Example (from [coconutbattery.rb](https://github.com/caskroom/homebrew-cask/blob/2c801af44be29fff7f3cb2996455fce5dd95d1cc/Casks/coconutbattery.rb)): +Conditionals should be constructed so that the default is the newest OS version. When using an `if` statement, test for older versions, and then let the `else` statement hold the latest and greatest. This makes it more likely that the Cask will work without alteration when a new OS is released. Example (from [coconutbattery.rb](https://github.com/Homebrew/homebrew-cask/blob/2c801af44be29fff7f3cb2996455fce5dd95d1cc/Casks/coconutbattery.rb)): ```ruby if MacOS.version <= :tiger diff --git a/doc/cask_language_reference/stanzas/app.md b/doc/cask_language_reference/stanzas/app.md index 47fea22932..eab61913f9 100644 --- a/doc/cask_language_reference/stanzas/app.md +++ b/doc/cask_language_reference/stanzas/app.md @@ -14,7 +14,7 @@ by default moves the source to: ## Renaming the Target -You can rename the target which appears in your `/Applications` directory by adding a `target:` key to `app`. Example (from [scala-ide.rb](https://github.com/caskroom/homebrew-cask/blob/312ae841f1f1b2ec07f4d88b7dfdd7fbdf8d4f94/Casks/scala-ide.rb#L21)): +You can rename the target which appears in your `/Applications` directory by adding a `target:` key to `app`. Example (from [scala-ide.rb](https://github.com/Homebrew/homebrew-cask/blob/312ae841f1f1b2ec07f4d88b7dfdd7fbdf8d4f94/Casks/scala-ide.rb#L21)): ```ruby app 'eclipse/Eclipse.app', target: 'Scala IDE.app' @@ -22,7 +22,7 @@ app 'eclipse/Eclipse.app', target: 'Scala IDE.app' ## target: May Contain an Absolute Path -If `target:` has a leading slash, it is interpreted as an absolute path. The containing directory for the absolute path will be created if it does not already exist. Example (from [manopen.rb](https://github.com/caskroom/homebrew-cask/blob/312ae841f1f1b2ec07f4d88b7dfdd7fbdf8d4f94/Casks/manopen.rb#L12)): +If `target:` has a leading slash, it is interpreted as an absolute path. The containing directory for the absolute path will be created if it does not already exist. Example (from [manopen.rb](https://github.com/Homebrew/homebrew-cask/blob/312ae841f1f1b2ec07f4d88b7dfdd7fbdf8d4f94/Casks/manopen.rb#L12)): ```ruby artifact 'openman.1', target: '/usr/local/share/man/man1/openman.1' @@ -34,4 +34,4 @@ The `target:` key works similarly for most Cask artifacts, such as `app`, `binar ## target: Should Only Be Used in Select Cases -Don’t use `target:` for aesthetic reasons, like removing version numbers (`app "Slack #{version}.app", target: 'Slack.app'`). Use it when it makes sense functionally and document your reason clearly in the Cask, using one of the templates: [for clarity](https://github.com/caskroom/homebrew-cask/blob/312ae841f1f1b2ec07f4d88b7dfdd7fbdf8d4f94/Casks/imagemin.rb#L12); [for consistency](https://github.com/caskroom/homebrew-cask/blob/d2a6b26df69fc28c4d84d6f5198b2b652c2f414d/Casks/devonthink-pro-office.rb#L16); [to prevent conflicts](https://github.com/caskroom/homebrew-cask/blob/bd6dc1a64e0bdd35ba0e20789045ea023b0b6aed/Casks/flash-player-debugger.rb#L11); [due to developer suggestion](https://github.com/caskroom/homebrew-cask/blob/ff3e9c4a6623af44b8a071027e8dcf3f4edfc6d9/Casks/kivy.rb#L12). +Don’t use `target:` for aesthetic reasons, like removing version numbers (`app "Slack #{version}.app", target: 'Slack.app'`). Use it when it makes sense functionally and document your reason clearly in the Cask, using one of the templates: [for clarity](https://github.com/Homebrew/homebrew-cask/blob/312ae841f1f1b2ec07f4d88b7dfdd7fbdf8d4f94/Casks/imagemin.rb#L12); [for consistency](https://github.com/Homebrew/homebrew-cask/blob/d2a6b26df69fc28c4d84d6f5198b2b652c2f414d/Casks/devonthink-pro-office.rb#L16); [to prevent conflicts](https://github.com/Homebrew/homebrew-cask/blob/bd6dc1a64e0bdd35ba0e20789045ea023b0b6aed/Casks/flash-player-debugger.rb#L11); [due to developer suggestion](https://github.com/Homebrew/homebrew-cask/blob/ff3e9c4a6623af44b8a071027e8dcf3f4edfc6d9/Casks/kivy.rb#L12). diff --git a/doc/cask_language_reference/stanzas/appcast.md b/doc/cask_language_reference/stanzas/appcast.md index 138b1f815e..31b1d7ddcc 100644 --- a/doc/cask_language_reference/stanzas/appcast.md +++ b/doc/cask_language_reference/stanzas/appcast.md @@ -8,20 +8,20 @@ The value of the `appcast` stanza is a string, holding the URL for an appcast wh | ------------- | ----------- | | `checkpoint:` | a string holding a custom checksum of the most recent appcast which matches the current Cask versioning. Use `brew cask _appcast_checkpoint --calculate "{{appcast_url}}"` to calculate it. -Example: [`atom.rb`](https://github.com/caskroom/homebrew-cask/blob/4d5a2dd2376f42c726148cfccaefe839f21e42ab/Casks/atom.rb#L7L8) +Example: [`atom.rb`](https://github.com/Homebrew/homebrew-cask/blob/4d5a2dd2376f42c726148cfccaefe839f21e42ab/Casks/atom.rb#L7L8) There are a few different ways the `appcast` can be determined: - * If the app is distributed via GitHub releases, the `appcast` will be of the form `https://github.com/{{user}}/{{project_name}}/releases.atom`. (Example: [`electron.rb`](https://github.com/caskroom/homebrew-cask/blob/14f8510e4466f1409feb0de4a309c21f5395aefe/Casks/electron.rb#L7L8)) + * If the app is distributed via GitHub releases, the `appcast` will be of the form `https://github.com/{{user}}/{{project_name}}/releases.atom`. (Example: [`electron.rb`](https://github.com/Homebrew/homebrew-cask/blob/14f8510e4466f1409feb0de4a309c21f5395aefe/Casks/electron.rb#L7L8)) - * The popular update framework [Sparkle](https://sparkle-project.org/) generally uses the `SUFeedURL` property in `Contents/Info.plist` inside `.app` bundles. (Example: [`glyphs.rb`](https://github.com/caskroom/homebrew-cask/blob/e7cb7464e58b01b641da64f6016761411fbaef12/Casks/glyphs.rb#L6L7)) + * The popular update framework [Sparkle](https://sparkle-project.org/) generally uses the `SUFeedURL` property in `Contents/Info.plist` inside `.app` bundles. (Example: [`glyphs.rb`](https://github.com/Homebrew/homebrew-cask/blob/e7cb7464e58b01b641da64f6016761411fbaef12/Casks/glyphs.rb#L6L7)) -* HockeyApp URLs are of the form `https://rink.hockeyapp.net/api/2/apps/{{hexadecimal_string}}{{something_else}}`. For the `appcast`, remove `{{something_else}}` (ending up with `https://rink.hockeyapp.net/api/2/apps/{{hexadecimal_string}}`. (Example: [`iconjar.rb`](https://github.com/caskroom/homebrew-cask/blob/190c98214e699be43f00ab91780d9184a96c7525/Casks/iconjar.rb#L7L8)) +* HockeyApp URLs are of the form `https://rink.hockeyapp.net/api/2/apps/{{hexadecimal_string}}{{something_else}}`. For the `appcast`, remove `{{something_else}}` (ending up with `https://rink.hockeyapp.net/api/2/apps/{{hexadecimal_string}}`. (Example: [`iconjar.rb`](https://github.com/Homebrew/homebrew-cask/blob/190c98214e699be43f00ab91780d9184a96c7525/Casks/iconjar.rb#L7L8)) -* DevMate appcasts resemble `https://updates.devmate.com/{{app_bundle_id}}.xml`. (Example: [vox.rb](https://github.com/caskroom/homebrew-cask/blob/e705f44d58ca093d478f8bb07b6d3aa83ba2fce4/Casks/vox.rb#L7L8)) +* DevMate appcasts resemble `https://updates.devmate.com/{{app_bundle_id}}.xml`. (Example: [vox.rb](https://github.com/Homebrew/homebrew-cask/blob/e705f44d58ca093d478f8bb07b6d3aa83ba2fce4/Casks/vox.rb#L7L8)) -* Sourceforge projects follow the form `https://sourceforge.net/projects/{{project_name}}/rss`. A more specific page can be used as needed, pointing to a specific directory structure: `https://sourceforge.net/projects/{{project_name}}/rss?path=/{{path_here}}`. (Example: [`seashore.rb`](https://github.com/caskroom/homebrew-cask/blob/60531a2812005dd5f17dc92f3ce7419af3c5d019/Casks/seashore.rb#L6L7)) +* Sourceforge projects follow the form `https://sourceforge.net/projects/{{project_name}}/rss`. A more specific page can be used as needed, pointing to a specific directory structure: `https://sourceforge.net/projects/{{project_name}}/rss?path=/{{path_here}}`. (Example: [`seashore.rb`](https://github.com/Homebrew/homebrew-cask/blob/60531a2812005dd5f17dc92f3ce7419af3c5d019/Casks/seashore.rb#L6L7)) -* An appcast can be any URL hosted by the app’s developer that changes every time a new release is out (e.g. a changelog HTML page). (Example: [`shortcat.rb`](https://github.com/caskroom/homebrew-cask/blob/60531a2812005dd5f17dc92f3ce7419af3c5d019/Casks/shortcat.rb#L6L7)) +* An appcast can be any URL hosted by the app’s developer that changes every time a new release is out (e.g. a changelog HTML page). (Example: [`shortcat.rb`](https://github.com/Homebrew/homebrew-cask/blob/60531a2812005dd5f17dc92f3ce7419af3c5d019/Casks/shortcat.rb#L6L7)) -The [`find_appcast`](https://github.com/caskroom/homebrew-cask/blob/master/developer/bin/find_appcast) script can automatically identify some of these. You can run it with `"$(brew --repository)/Library/Taps/caskroom/homebrew-cask/developer/bin/find_sparkle_appcast" '{{/path/to/software.app'}}` to find the `appcast` and `checkpoint` automatically. +The [`find_appcast`](https://github.com/Homebrew/homebrew-cask/blob/master/developer/bin/find_appcast) script can automatically identify some of these. You can run it with `"$(brew --repository)/Library/Taps/homebrew/homebrew-cask/developer/bin/find_sparkle_appcast" '{{/path/to/software.app'}}` to find the `appcast` and `checkpoint` automatically. diff --git a/doc/cask_language_reference/stanzas/binary.md b/doc/cask_language_reference/stanzas/binary.md index ee16a00b03..14e80bc95d 100644 --- a/doc/cask_language_reference/stanzas/binary.md +++ b/doc/cask_language_reference/stanzas/binary.md @@ -1,6 +1,6 @@ # binary -In the simple case of a string argument to `binary`, the source file is linked into the `$(brew --prefix)/bin` directory (typically `/usr/local/bin`) on installation. For example (from [operadriver.rb](https://github.com/caskroom/homebrew-cask/blob/60531a2812005dd5f17dc92f3ce7419af3c5d019/Casks/operadriver.rb#L11)): +In the simple case of a string argument to `binary`, the source file is linked into the `$(brew --prefix)/bin` directory (typically `/usr/local/bin`) on installation. For example (from [operadriver.rb](https://github.com/Homebrew/homebrew-cask/blob/60531a2812005dd5f17dc92f3ce7419af3c5d019/Casks/operadriver.rb#L11)): ```ruby binary 'operadriver' @@ -20,4 +20,4 @@ from a source file such as: ## Renaming the Target -You can rename the target which appears in your binaries directory by adding a `target:` key to `binary`. Behaviour and usage is [the same as with `app`](https://github.com/caskroom/homebrew-cask/blob/master/doc/cask_language_reference/stanzas/app.md#renaming-the-target). However, for `binary` the select cases don’t apply as rigidly. It’s fine to take extra liberties with `target:` to be consistent with other command-line tools, like [changing case](https://github.com/caskroom/homebrew-cask/blob/9ad93b833961f1d969505bc6bdb1c2ad4e58a433/Casks/openscad.rb#L12), [removing an extension](https://github.com/caskroom/homebrew-cask/blob/c443d4f5c6864538efe5bb1ecf662565a5ffb438/Casks/filebot.rb#L13), or [cleaning up the name](https://github.com/caskroom/homebrew-cask/blob/146917cbcc679648de6b0bccff4e9b43fce0e6c8/Casks/minishift.rb#L13). +You can rename the target which appears in your binaries directory by adding a `target:` key to `binary`. Behaviour and usage is [the same as with `app`](https://github.com/Homebrew/homebrew-cask/blob/master/doc/cask_language_reference/stanzas/app.md#renaming-the-target). However, for `binary` the select cases don’t apply as rigidly. It’s fine to take extra liberties with `target:` to be consistent with other command-line tools, like [changing case](https://github.com/Homebrew/homebrew-cask/blob/9ad93b833961f1d969505bc6bdb1c2ad4e58a433/Casks/openscad.rb#L12), [removing an extension](https://github.com/Homebrew/homebrew-cask/blob/c443d4f5c6864538efe5bb1ecf662565a5ffb438/Casks/filebot.rb#L13), or [cleaning up the name](https://github.com/Homebrew/homebrew-cask/blob/146917cbcc679648de6b0bccff4e9b43fce0e6c8/Casks/minishift.rb#L13). diff --git a/doc/cask_language_reference/stanzas/caveats.md b/doc/cask_language_reference/stanzas/caveats.md index 5b38aec55e..c98786fbcb 100644 --- a/doc/cask_language_reference/stanzas/caveats.md +++ b/doc/cask_language_reference/stanzas/caveats.md @@ -42,7 +42,7 @@ The following methods may be called to generate standard warning messages: | `files_in_usr_local` | the Cask installs files to `/usr/local`, which may confuse Homebrew. | `discontinued` | all software development has been officially discontinued upstream. | `free_license 'web_page'` | users may get an official license to use the software at `web_page`. -| `malware 'radar_number'` | app has been reported to bundle malware. See [the FAQ](https://github.com/caskroom/homebrew-cask/blob/master/doc/faq/apps_with_malware.md) for the necessary steps. +| `malware 'radar_number'` | app has been reported to bundle malware. See [the FAQ](https://github.com/Homebrew/homebrew-cask/blob/master/doc/faq/apps_with_malware.md) for the necessary steps. | `kext` | users may need to enable their kexts in System Preferences → Security & Privacy → General. | `license 'web_page'`               | software has a usage license at `web_page`. diff --git a/doc/cask_language_reference/stanzas/depends_on.md b/doc/cask_language_reference/stanzas/depends_on.md index 24be02470a..302bc6176a 100644 --- a/doc/cask_language_reference/stanzas/depends_on.md +++ b/doc/cask_language_reference/stanzas/depends_on.md @@ -7,7 +7,7 @@ The value should be another Cask token, needed by the current Cask. -Example use: [`SSHFS`](https://github.com/caskroom/homebrew-cask/blob/312ae841f1f1b2ec07f4d88b7dfdd7fbdf8d4f94/Casks/sshfs.rb#L12) depends on OSXFUSE: +Example use: [`SSHFS`](https://github.com/Homebrew/homebrew-cask/blob/312ae841f1f1b2ec07f4d88b7dfdd7fbdf8d4f94/Casks/sshfs.rb#L12) depends on OSXFUSE: ```ruby depends_on cask: 'osxfuse' diff --git a/doc/cask_language_reference/stanzas/flight.md b/doc/cask_language_reference/stanzas/flight.md index 7c1ab78743..a6cb74b0e0 100644 --- a/doc/cask_language_reference/stanzas/flight.md +++ b/doc/cask_language_reference/stanzas/flight.md @@ -12,7 +12,7 @@ The following methods may be called to perform standard tasks: | method | availability | description | | ----------------------------------------- | ------------------------------------------------ | ----------- | -| `set_ownership(paths)` | `preflight`, `postflight`, `uninstall_preflight` | set user and group ownership of `paths`. Example: [`unifi-controller.rb`](https://github.com/caskroom/homebrew-cask/blob/8a452a41707af6a661049da6254571090fac5418/Casks/unifi-controller.rb#L13) -| `set_permissions(paths, permissions_str)` | `preflight`, `postflight`, `uninstall_preflight` | set permissions in `paths` to `permissions_str`. Example: [`docker-machine.rb`](https://github.com/caskroom/homebrew-cask/blob/8a452a41707af6a661049da6254571090fac5418/Casks/docker-machine.rb#L16) +| `set_ownership(paths)` | `preflight`, `postflight`, `uninstall_preflight` | set user and group ownership of `paths`. Example: [`unifi-controller.rb`](https://github.com/Homebrew/homebrew-cask/blob/8a452a41707af6a661049da6254571090fac5418/Casks/unifi-controller.rb#L13) +| `set_permissions(paths, permissions_str)` | `preflight`, `postflight`, `uninstall_preflight` | set permissions in `paths` to `permissions_str`. Example: [`docker-machine.rb`](https://github.com/Homebrew/homebrew-cask/blob/8a452a41707af6a661049da6254571090fac5418/Casks/docker-machine.rb#L16) `set_ownership(paths)` defaults user ownership to the current user and group ownership to `staff`. These can be changed by passing in extra options: `set_ownership(paths, user: 'user', group: 'group')`. diff --git a/doc/cask_language_reference/stanzas/gpg.md b/doc/cask_language_reference/stanzas/gpg.md index 21a19350e6..ba09806995 100644 --- a/doc/cask_language_reference/stanzas/gpg.md +++ b/doc/cask_language_reference/stanzas/gpg.md @@ -8,4 +8,4 @@ The `gpg` stanza contains signature information for GPG-signed distributions. Th gpg , : ``` -where `` is one of `key_id` or `key_url`, and `` points to the detached signature of the distribution. Commonly, the signature follows the `url` value. Example: [libreoffice.rb](https://github.com/caskroom/homebrew-cask/blob/03690236575a20bfcd5524bc02a352a62aaba691/Casks/libreoffice.rb#L9). +where `` is one of `key_id` or `key_url`, and `` points to the detached signature of the distribution. Commonly, the signature follows the `url` value. Example: [libreoffice.rb](https://github.com/Homebrew/homebrew-cask/blob/03690236575a20bfcd5524bc02a352a62aaba691/Casks/libreoffice.rb#L9). diff --git a/doc/cask_language_reference/stanzas/installer.md b/doc/cask_language_reference/stanzas/installer.md index 660648e943..a5cb6bc5c9 100644 --- a/doc/cask_language_reference/stanzas/installer.md +++ b/doc/cask_language_reference/stanzas/installer.md @@ -6,7 +6,7 @@ The `installer` stanza takes a series of key-value pairs, the first key of which ## installer manual: -`installer manual:` takes a single string value, describing a GUI installer which must be run by the user at a later time. The path may be absolute, or relative to the Cask. Example (from [little-snitch.rb](https://github.com/caskroom/homebrew-cask/blob/818047bf488be92923c8770ef3df8007a0db7704/Casks/little-snitch.rb#L10)): +`installer manual:` takes a single string value, describing a GUI installer which must be run by the user at a later time. The path may be absolute, or relative to the Cask. Example (from [little-snitch.rb](https://github.com/Homebrew/homebrew-cask/blob/818047bf488be92923c8770ef3df8007a0db7704/Casks/little-snitch.rb#L10)): ```ruby installer manual: 'Little Snitch Installer.app' @@ -24,7 +24,7 @@ installer manual: 'Little Snitch Installer.app' | `must_succeed:` | set to `false` if the script is allowed to fail | `sudo:` | set to `true` if the script needs `sudo` -The path may be absolute, or relative to the Cask. Example (from [ransomwhere.rb](https://github.com/caskroom/homebrew-cask/blob/2a7499561420bd375e45e96082c273ca75b600d1/Casks/ransomwhere.rb#L12-L16)): +The path may be absolute, or relative to the Cask. Example (from [ransomwhere.rb](https://github.com/Homebrew/homebrew-cask/blob/2a7499561420bd375e45e96082c273ca75b600d1/Casks/ransomwhere.rb#L12-L16)): ```ruby installer script: { @@ -34,7 +34,7 @@ The path may be absolute, or relative to the Cask. Example (from [ransomwhere.rb } ``` -If the `installer script:` does not require any of the key-values it can point directly to the path of the install script. Example (from [amazon-drive.rb](https://github.com/caskroom/homebrew-cask/blob/427c52acdc3ce0ab1e97950e6cee9896480d7353/Casks/amazon-drive.rb#L10)): +If the `installer script:` does not require any of the key-values it can point directly to the path of the install script. Example (from [amazon-drive.rb](https://github.com/Homebrew/homebrew-cask/blob/427c52acdc3ce0ab1e97950e6cee9896480d7353/Casks/amazon-drive.rb#L10)): ```ruby installer script: 'Amazon Drive Installer.app/Contents/MacOS/Amazon Drive Installer' diff --git a/doc/cask_language_reference/stanzas/language.md b/doc/cask_language_reference/stanzas/language.md index 76654f5a61..c3eff5448b 100644 --- a/doc/cask_language_reference/stanzas/language.md +++ b/doc/cask_language_reference/stanzas/language.md @@ -40,7 +40,7 @@ The return value of the matching `language` block can be accessed by simply call homepage "https://example.org/#{language}" ``` -Examples: [Firefox](https://github.com/caskroom/homebrew-cask/blob/306b8fbd9502036f1ca742f70c569d8677b62403/Casks/firefox.rb#L4L74), [Battle.net](https://github.com/caskroom/homebrew-cask/blob/306b8fbd9502036f1ca742f70c569d8677b62403/Casks/battle-net.rb#L5L17) +Examples: [Firefox](https://github.com/Homebrew/homebrew-cask/blob/306b8fbd9502036f1ca742f70c569d8677b62403/Casks/firefox.rb#L4L74), [Battle.net](https://github.com/Homebrew/homebrew-cask/blob/306b8fbd9502036f1ca742f70c569d8677b62403/Casks/battle-net.rb#L5L17) ## Installation diff --git a/doc/cask_language_reference/stanzas/name.md b/doc/cask_language_reference/stanzas/name.md index 115001ffbd..c35056c8fa 100644 --- a/doc/cask_language_reference/stanzas/name.md +++ b/doc/cask_language_reference/stanzas/name.md @@ -4,6 +4,6 @@ Its first instance should use the latin alphabet, include the software vendor’s name, and be as verbose as possible while still making sense. -A good example is [`pycharm-ce`](https://github.com/caskroom/homebrew-cask/blob/fc05c0353aebb28e40db72faba04b82ca832d11a/Casks/pycharm-ce.rb#L6#L7). `Jetbrains PyCharm Community Edition` makes sense even though it is likely never referenced as such anywhere, but `Jetbrains PyCharm Community Edition CE` doesn’t, hence why it has a second line. Another example are casks whose original names do not use the latin alphabet, like [`cave-story`](https://github.com/caskroom/homebrew-cask/blob/0fe48607f5656e4f1de58c6884945378b7e6f960/Casks/cave-story.rb#L7#L9). +A good example is [`pycharm-ce`](https://github.com/Homebrew/homebrew-cask/blob/fc05c0353aebb28e40db72faba04b82ca832d11a/Casks/pycharm-ce.rb#L6#L7). `Jetbrains PyCharm Community Edition` makes sense even though it is likely never referenced as such anywhere, but `Jetbrains PyCharm Community Edition CE` doesn’t, hence why it has a second line. Another example are casks whose original names do not use the latin alphabet, like [`cave-story`](https://github.com/Homebrew/homebrew-cask/blob/0fe48607f5656e4f1de58c6884945378b7e6f960/Casks/cave-story.rb#L7#L9). Note that `brew cask search` and `brew cask list` are not yet capable of using the information stored in the `name` stanza. \ No newline at end of file diff --git a/doc/cask_language_reference/stanzas/pkg.md b/doc/cask_language_reference/stanzas/pkg.md index 6356d34e0d..73f74445fd 100644 --- a/doc/cask_language_reference/stanzas/pkg.md +++ b/doc/cask_language_reference/stanzas/pkg.md @@ -16,7 +16,7 @@ Subsequent arguments to `pkg` are key/value pairs which modify the install proce This option is not permitted in official Homebrew-Cask taps, it is only provided for use in third-party taps or local Casks. -Example ([alinof-timer.rb](https://github.com/caskroom/homebrew-cask/blob/312ae841f1f1b2ec07f4d88b7dfdd7fbdf8d4f94/Casks/alinof-timer.rb#L10)): +Example ([alinof-timer.rb](https://github.com/Homebrew/homebrew-cask/blob/312ae841f1f1b2ec07f4d88b7dfdd7fbdf8d4f94/Casks/alinof-timer.rb#L10)): ```ruby pkg 'AlinofTimer.pkg', allow_untrusted: true @@ -34,9 +34,9 @@ $ installer -showChoicesXML -pkg '/path/to/my.pkg' will output an XML which you can use to extract the `choices:` values, as well as their equivalents to the GUI options. -See [this pull request for wireshark-chmodbpf](https://github.com/caskroom/homebrew-cask/pull/26997) and [this one for wine-staging](https://github.com/caskroom/homebrew-cask/pull/27937) for some examples of the procedure. +See [this pull request for wireshark-chmodbpf](https://github.com/Homebrew/homebrew-cask/pull/26997) and [this one for wine-staging](https://github.com/Homebrew/homebrew-cask/pull/27937) for some examples of the procedure. -Example ([wireshark-chmodbpf.rb](https://github.com/caskroom/homebrew-cask/blob/f95b8a8306b91fe9da7908b842f4a5fa80f7afe0/Casks/wireshark-chmodbpf.rb#L9#L26)): +Example ([wireshark-chmodbpf.rb](https://github.com/Homebrew/homebrew-cask/blob/f95b8a8306b91fe9da7908b842f4a5fa80f7afe0/Casks/wireshark-chmodbpf.rb#L9#L26)): ```ruby pkg "Wireshark #{version} Intel 64.pkg", choices: [ @@ -58,7 +58,7 @@ pkg "Wireshark #{version} Intel 64.pkg", ] ``` -Example ([wine-staging.rb](https://github.com/caskroom/homebrew-cask/blob/51b65f6a5a25a7f79af4d372e1a0bf1dc3849251/Casks/wine-staging.rb#L11#L18)): +Example ([wine-staging.rb](https://github.com/Homebrew/homebrew-cask/blob/51b65f6a5a25a7f79af4d372e1a0bf1dc3849251/Casks/wine-staging.rb#L11#L18)): ```ruby pkg "winehq-staging-#{version}.pkg", choices: [ diff --git a/doc/cask_language_reference/stanzas/suite.md b/doc/cask_language_reference/stanzas/suite.md index 024b3393f5..68abaa396c 100644 --- a/doc/cask_language_reference/stanzas/suite.md +++ b/doc/cask_language_reference/stanzas/suite.md @@ -2,7 +2,7 @@ Some distributions provide a suite of multiple applications, or an application with required data, to be installed together in a subdirectory of `/Applications`. -For these Casks, use the `suite` stanza to define the directory containing the application suite. Example (from [sketchup.rb](https://github.com/caskroom/homebrew-cask/blob/312ae841f1f1b2ec07f4d88b7dfdd7fbdf8d4f94/Casks/sketchup.rb#L12)): +For these Casks, use the `suite` stanza to define the directory containing the application suite. Example (from [sketchup.rb](https://github.com/Homebrew/homebrew-cask/blob/312ae841f1f1b2ec07f4d88b7dfdd7fbdf8d4f94/Casks/sketchup.rb#L12)): ```ruby suite 'SketchUp 2016' diff --git a/doc/cask_language_reference/stanzas/uninstall.md b/doc/cask_language_reference/stanzas/uninstall.md index 5a880cae69..95e5220758 100644 --- a/doc/cask_language_reference/stanzas/uninstall.md +++ b/doc/cask_language_reference/stanzas/uninstall.md @@ -50,13 +50,13 @@ This is the most useful uninstall key. `pkgutil:` is often sufficient to complet IDs for the most recently-installed packages can be listed using the command: ```bash -$ "$(brew --repository)/Library/Taps/caskroom/homebrew-cask/developer/bin/list_recent_pkg_ids" +$ "$(brew --repository)/Library/Taps/Homebrew/homebrew-cask/developer/bin/list_recent_pkg_ids" ``` `pkgutil:` also accepts a regular expression match against multiple package IDs. The regular expressions are somewhat nonstandard. To test a `pkgutil:` regular expression against currently-installed packages, use the command: ```bash -$ "$(brew --repository)/Library/Taps/caskroom/homebrew-cask/developer/bin/list_pkg_ids_by_regexp" +$ "$(brew --repository)/Library/Taps/Homebrew/homebrew-cask/developer/bin/list_pkg_ids_by_regexp" ``` ## List Files Associated With a pkg Id @@ -74,13 +74,13 @@ Listing the associated files can help you assess whether the package included an IDs for currently loaded `launchctl` jobs can be listed using the command: ```bash -$ "$(brew --repository)/Library/Taps/caskroom/homebrew-cask/developer/bin/list_loaded_launchjob_ids" +$ "$(brew --repository)/Library/Taps/Homebrew/homebrew-cask/developer/bin/list_loaded_launchjob_ids" ``` IDs for all installed `launchctl` jobs can be listed using the command: ```bash -$ "$(brew --repository)/Library/Taps/caskroom/homebrew-cask/developer/bin/list_installed_launchjob_ids" +$ "$(brew --repository)/Library/Taps/Homebrew/homebrew-cask/developer/bin/list_installed_launchjob_ids" ``` ## uninstall Key quit: @@ -88,13 +88,13 @@ $ "$(brew --repository)/Library/Taps/caskroom/homebrew-cask/developer/bin/list_i Bundle IDs for currently running Applications can be listed using the command: ```bash -$ "$(brew --repository)/Library/Taps/caskroom/homebrew-cask/developer/bin/list_running_app_ids" +$ "$(brew --repository)/Library/Taps/Homebrew/homebrew-cask/developer/bin/list_running_app_ids" ``` Bundle IDs inside an Application bundle on disk can be listed using the command: ```bash -$ "$(brew --repository)/Library/Taps/caskroom/homebrew-cask/developer/bin/list_ids_in_app" '/path/to/application.app' +$ "$(brew --repository)/Library/Taps/Homebrew/homebrew-cask/developer/bin/list_ids_in_app" '/path/to/application.app' ``` ## uninstall Key signal: @@ -130,7 +130,7 @@ Unlike `quit:` directives, Unix signals originate from the current user, not fro Login items associated with an Application bundle on disk can be listed using the command: ```bash -$ "$(brew --repository)/Library/Taps/caskroom/homebrew-cask/developer/bin/list_login_items_for_app" '/path/to/application.app' +$ "$(brew --repository)/Library/Taps/Homebrew/homebrew-cask/developer/bin/list_login_items_for_app" '/path/to/application.app' ``` Note that you will likely need to have opened the app at least once for any login items to be present. @@ -140,18 +140,18 @@ Note that you will likely need to have opened the app at least once for any logi IDs for currently loaded kernel extensions can be listed using the command: ```bash -$ "$(brew --repository)/Library/Taps/caskroom/homebrew-cask/developer/bin/list_loaded_kext_ids" +$ "$(brew --repository)/Library/Taps/Homebrew/homebrew-cask/developer/bin/list_loaded_kext_ids" ``` IDs inside a kext bundle you have located on disk can be listed using the command: ```bash -$ "$(brew --repository)/Library/Taps/caskroom/homebrew-cask/developer/bin/list_id_in_kext" '/path/to/name.kext' +$ "$(brew --repository)/Library/Taps/Homebrew/homebrew-cask/developer/bin/list_id_in_kext" '/path/to/name.kext' ``` ## uninstall Key script: -`uninstall script:` introduces a series of key-value pairs describing a command which will automate completion of the uninstall. Example (from [gpgtools.rb](https://github.com/caskroom/homebrew-cask/blob/4a0a49d1210a8202cbdd54bce2986f15049b8b61/Casks/gpgtools.rb#L33-#L37)): +`uninstall script:` introduces a series of key-value pairs describing a command which will automate completion of the uninstall. Example (from [gpgtools.rb](https://github.com/Homebrew/homebrew-cask/blob/4a0a49d1210a8202cbdd54bce2986f15049b8b61/Casks/gpgtools.rb#L33-#L37)): ```ruby uninstall script: { @@ -168,12 +168,12 @@ It is important to note that, although `script:` in the above example does attem Arguments to `uninstall delete:` should use the following basic rules: -* Only single quotes should be used, except when invoking [`#{version}` interpolation](https://github.com/caskroom/homebrew-cask/blob/master/doc/cask_language_reference/stanzas/version.md). `ENV['HOME']` and other variables should not be interpolated in the value. +* Only single quotes should be used, except when invoking [`#{version}` interpolation](https://github.com/Homebrew/homebrew-cask/blob/master/doc/cask_language_reference/stanzas/version.md). `ENV['HOME']` and other variables should not be interpolated in the value. * Basic tilde expansion is performed on paths, i.e., leading `~` is expanded to the home directory. * Paths must be absolute. * Glob expansion is performed using the [standard set of characters](https://en.wikipedia.org/wiki/Glob_(programming)). -To remove user-specific files, use the [`zap` stanza](https://github.com/caskroom/homebrew-cask/blob/master/doc/cask_language_reference/stanzas/zap.md). +To remove user-specific files, use the [`zap` stanza](https://github.com/Homebrew/homebrew-cask/blob/master/doc/cask_language_reference/stanzas/zap.md). ## uninstall Key trash: @@ -186,19 +186,19 @@ Advanced users may wish to work with a `pkg` file manually, without having the p A list of files which may be installed from a `pkg` can be extracted using the command: ```bash -$ "$(brew --repository)/Library/Taps/caskroom/homebrew-cask/developer/bin/list_payload_in_pkg" '/path/to/my.pkg' +$ "$(brew --repository)/Library/Taps/Homebrew/homebrew-cask/developer/bin/list_payload_in_pkg" '/path/to/my.pkg' ``` Candidate application names helpful for determining the name of a Cask may be extracted from a `pkg` file using the command: ```bash -$ "$(brew --repository)/Library/Taps/caskroom/homebrew-cask/developer/bin/list_apps_in_pkg" '/path/to/my.pkg' +$ "$(brew --repository)/Library/Taps/Homebrew/homebrew-cask/developer/bin/list_apps_in_pkg" '/path/to/my.pkg' ``` Candidate package IDs which may be useful in a `pkgutil:` key may be extracted from a `pkg` file using the command: ```bash -$ "$(brew --repository)/Library/Taps/caskroom/homebrew-cask/developer/bin/list_ids_in_pkg" '/path/to/my.pkg' +$ "$(brew --repository)/Library/Taps/Homebrew/homebrew-cask/developer/bin/list_ids_in_pkg" '/path/to/my.pkg' ``` A fully manual method for finding bundle ids in a package file follows: diff --git a/doc/cask_language_reference/stanzas/url.md b/doc/cask_language_reference/stanzas/url.md index cb50546be9..b139841fad 100644 --- a/doc/cask_language_reference/stanzas/url.md +++ b/doc/cask_language_reference/stanzas/url.md @@ -16,9 +16,9 @@ When a plain URL string is insufficient to fetch a file, additional information | `user_agent:` | a string holding the user agent to set for the download request. Can also be set to the symbol `:fake`, which will use a generic Browser-like user agent string. We prefer `:fake` when the server does not require a specific user agent. | `data:` | a hash of parameters to be set in the POST request -Example of using `cookies:`: [java.rb](https://github.com/caskroom/homebrew-cask/blob/472930df191d66747a57d5c96c0d00511d56e21b/Casks/java.rb#L5#L8) +Example of using `cookies:`: [java.rb](https://github.com/Homebrew/homebrew-cask/blob/472930df191d66747a57d5c96c0d00511d56e21b/Casks/java.rb#L5#L8) -Example of using `referer:`: [rrootage.rb](https://github.com/caskroom/homebrew-cask/blob/312ae841f1f1b2ec07f4d88b7dfdd7fbdf8d4f94/Casks/rrootage.rb#L5) +Example of using `referer:`: [rrootage.rb](https://github.com/Homebrew/homebrew-cask/blob/312ae841f1f1b2ec07f4d88b7dfdd7fbdf8d4f94/Casks/rrootage.rb#L5) ## When URL and Homepage Hostnames Differ, Add a Comment @@ -28,7 +28,7 @@ When the hostnames of `url` and `homepage` differ, the discrepancy should be doc # URL_SECTION was verified as official when first introduced to the cask ``` -Where `URL_SECTION` is the smallest possible portion of the URL that uniquely identifies the app or vendor. Examples can be seen in [`airfoil.rb`](https://github.com/caskroom/homebrew-cask/blob/1666993ee93e2a43f00a4dfc3c727da7c0b5ada9/Casks/airfoil.rb#L5), [`knockknock.rb`](https://github.com/caskroom/homebrew-cask/blob/6645a6090d1cb8fc026f243a47048749b31c32bf/Casks/knockknock.rb#L5), [`lightpaper.rb`](https://github.com/caskroom/homebrew-cask/blob/7a75f4e84c01bf192bd55f251b96cf2c1e086281/Casks/lightpaper.rb#L5), [`airtool.rb`](https://github.com/caskroom/homebrew-cask/blob/355211a8a3ea54046ae45022bcf71980bd2d5432/Casks/airtool.rb#L5), [`screencat.rb`](https://github.com/caskroom/homebrew-cask/blob/5fc818752c30c156c00f79b04b66406189ab2f30/Casks/screencat.rb#L5), [`0ad.rb`](https://github.com/caskroom/homebrew-cask/blob/7a75f4e84c01bf192bd55f251b96cf2c1e086281/Casks/0ad.rb#L5). +Where `URL_SECTION` is the smallest possible portion of the URL that uniquely identifies the app or vendor. Examples can be seen in [`airfoil.rb`](https://github.com/Homebrew/homebrew-cask/blob/1666993ee93e2a43f00a4dfc3c727da7c0b5ada9/Casks/airfoil.rb#L5), [`knockknock.rb`](https://github.com/Homebrew/homebrew-cask/blob/6645a6090d1cb8fc026f243a47048749b31c32bf/Casks/knockknock.rb#L5), [`lightpaper.rb`](https://github.com/Homebrew/homebrew-cask/blob/7a75f4e84c01bf192bd55f251b96cf2c1e086281/Casks/lightpaper.rb#L5), [`airtool.rb`](https://github.com/Homebrew/homebrew-cask/blob/355211a8a3ea54046ae45022bcf71980bd2d5432/Casks/airtool.rb#L5), [`screencat.rb`](https://github.com/Homebrew/homebrew-cask/blob/5fc818752c30c156c00f79b04b66406189ab2f30/Casks/screencat.rb#L5), [`0ad.rb`](https://github.com/Homebrew/homebrew-cask/blob/7a75f4e84c01bf192bd55f251b96cf2c1e086281/Casks/0ad.rb#L5). These comments must be added so a user auditing the cask knows the URL was verified by the Homebrew-Cask team as the one provided by the vendor, even though it may look unofficial or suspicious. It is our responsibility as Homebrew-Cask maintainers to verify both the `url` and `homepage` information when first added (or subsequently modified, apart from versioning). @@ -39,7 +39,7 @@ The comment doesn’t mean you should trust the source blindly, but we only appr Web browsers may obscure the direct `url` download location for a variety of reasons. Homebrew-Cask supplies a script which can read extended file attributes to extract the actual source URL for most files downloaded by a browser on macOS. The script usually emits multiple candidate URLs; you may have to test each of them: ```bash -$ $(brew --repository)/Library/Taps/caskroom/homebrew-cask/developer/bin/list_url_attributes_on_file +$ $(brew --repository)/Library/Taps/Homebrew/homebrew-cask/developer/bin/list_url_attributes_on_file ``` ## Subversion URLs @@ -124,7 +124,7 @@ The block will be called immediately before downloading; its result value will b You can use the `url` stanza with either a direct argument or a block but not with both. -Example for using the block syntax: [vlc-nightly.rb](https://github.com/caskroom/homebrew-versions/blob/2bf0f13dd49d263ebec0ca56e58ad8458633f789/Casks/vlc-nightly.rb#L5L10) +Example for using the block syntax: [vlc-nightly.rb](https://github.com/Homebrew/homebrew-cask-versions/blob/2bf0f13dd49d263ebec0ca56e58ad8458633f789/Casks/vlc-nightly.rb#L5L10) ### Mixing Additional URL Parameters With the Block Syntax diff --git a/doc/cask_language_reference/stanzas/zap.md b/doc/cask_language_reference/stanzas/zap.md index 5283de0ed1..82f76a0baf 100644 --- a/doc/cask_language_reference/stanzas/zap.md +++ b/doc/cask_language_reference/stanzas/zap.md @@ -21,4 +21,4 @@ $ brew cask zap td-toolbelt # also removes org.ruby-lang.installer The form of `zap` stanza follows the [`uninstall` stanza](uninstall.md). All of the same directives are available. The `trash:` key is preferred over `delete:`. -Example: [dropbox.rb](https://github.com/caskroom/homebrew-cask/blob/31cd96cc0e00dab1bff74d622e32d816bafd1f6f/Casks/dropbox.rb#L17-L35) +Example: [dropbox.rb](https://github.com/Homebrew/homebrew-cask/blob/31cd96cc0e00dab1bff74d622e32d816bafd1f6f/Casks/dropbox.rb#L17-L35) diff --git a/doc/cask_language_reference/token_reference.md b/doc/cask_language_reference/token_reference.md index 3e33ed8db9..ca0bf446c9 100644 --- a/doc/cask_language_reference/token_reference.md +++ b/doc/cask_language_reference/token_reference.md @@ -23,7 +23,7 @@ The token itself should be: * Suitable for use as a filename * Mnemonic -Details of software names and brands will inevitably be lost in the conversion to a minimal token. To capture the vendor’s full name for a distribution, use the [`name`](https://github.com/caskroom/homebrew-cask/blob/master/doc/cask_language_reference/stanzas/name.md) within a Cask. `name` accepts an unrestricted UTF-8 string. +Details of software names and brands will inevitably be lost in the conversion to a minimal token. To capture the vendor’s full name for a distribution, use the [`name`](https://github.com/Homebrew/homebrew-cask/blob/master/doc/cask_language_reference/stanzas/name.md) within a Cask. `name` accepts an unrestricted UTF-8 string. ## Finding the Simplified Name of the Vendor’s Distribution @@ -39,7 +39,7 @@ Details of software names and brands will inevitably be lost in the conversion t * Remove from the end: version numbers or incremental release designations such as “alpha”, “beta”, or “release candidate”. Strings which distinguish different capabilities or codebases such as “Community Edition” are currently accepted. Exception: when a number is not an incremental release counter, but a differentiator for a different product from a different vendor, as in [pgadmin3.rb](../../Casks/pgadmin3.rb). -* If the version number is arranged to occur in the middle of the App name, it should also be removed. Example: [IntelliJ IDEA 13 CE.app](../../../../../homebrew-versions/tree/master/Casks/intellij-idea-ce.rb). +* If the version number is arranged to occur in the middle of the App name, it should also be removed. Example: [IntelliJ IDEA 13 CE.app](../../../../../homebrew-cask-versions/tree/master/Casks/intellij-idea-ce.rb). * Remove from the end: “Launcher”, “Quick Launcher”. diff --git a/doc/development/adding_a_cask.md b/doc/development/adding_a_cask.md index c7ca290a4e..cd1eedfedb 100644 --- a/doc/development/adding_a_cask.md +++ b/doc/development/adding_a_cask.md @@ -1,4 +1,4 @@ -**Note**: Before taking the time to craft a new cask, make sure it can be accepted by checking the [Rejected Casks FAQ document](https://github.com/caskroom/homebrew-cask/blob/master/doc/faq/rejected_casks.md). +**Note**: Before taking the time to craft a new cask, make sure it can be accepted by checking the [Rejected Casks FAQ document](https://github.com/Homebrew/homebrew-cask/blob/master/doc/faq/rejected_casks.md). ## Adding a Cask @@ -67,13 +67,13 @@ The Cask **token** is the mnemonic string people will use to interact with the C The easiest way to generate a token for a Cask is to run this command: ```bash -$ "$(brew --repository)/Library/Taps/caskroom/homebrew-cask/developer/bin/generate_cask_token" '/full/path/to/new/software.app' +$ "$(brew --repository)/Library/Taps/Homebrew/homebrew-cask/developer/bin/generate_cask_token" '/full/path/to/new/software.app' ``` If the software you wish to Cask is not installed, or does not have an associated App bundle, just give the full proper name of the software instead of a pathname: ```bash -$ "$(brew --repository)/Library/Taps/caskroom/homebrew-cask/developer/bin/generate_cask_token" 'Google Chrome' +$ "$(brew --repository)/Library/Taps/Homebrew/homebrew-cask/developer/bin/generate_cask_token" 'Google Chrome' ``` If the `generate_cask_token` script does not work for you, see [Cask Token Details](#cask-token-details). @@ -164,13 +164,13 @@ brew cask audit my-new-cask --download You should also check stylistic details with `brew cask style`: ```bash -$ cd "$(brew --repository)"/Library/Taps/caskroom/homebrew-cask +$ cd "$(brew --repository)"/Library/Taps/Homebrew/homebrew-cask $ brew cask style Casks/my-new-cask.rb [--fix] ``` Keep in mind all of these checks will be made when you submit your PR, so by doing them in advance you’re saving everyone a lot of time and trouble. -If your application and Homebrew-Cask do not work well together, feel free to [file an issue](https://github.com/caskroom/homebrew-cask#reporting-bugs) after checking out open issues. +If your application and Homebrew-Cask do not work well together, feel free to [file an issue](https://github.com/Homebrew/homebrew-cask#reporting-bugs) after checking out open issues. ## Finding a Home For Your Cask @@ -193,7 +193,7 @@ We maintain separate Taps for different types of binaries. Our nomenclature is: ### Stable Versions -Stable versions live in the main repository at [caskroom/homebrew-cask](https://github.com/caskroom/homebrew-cask). They should run on the latest release of macOS or the previous point release (High Sierra and Sierra as of late 2017). +Stable versions live in the main repository at [Homebrew/homebrew-cask](https://github.com/Homebrew/homebrew-cask). They should run on the latest release of macOS or the previous point release (High Sierra and Sierra as of late 2017). ### But There Is No Stable Version! @@ -201,7 +201,7 @@ When an App is only available as beta, development, or unstable versions, or in ### Beta, Unstable, Development, Nightly, or Legacy -When an App has a main stable version, alternative versions should be submitted to [caskroom/homebrew-versions](https://github.com/caskroom/homebrew-versions). +When an App has a main stable version, alternative versions should be submitted to [Homebrew/homebrew-cask-versions](https://github.com/Homebrew/homebrew-cask-versions). ### Regional and Localized @@ -221,17 +221,17 @@ We do not accept these casks since they offer a higher-than-normal security risk ### Fonts -Font Casks live in the [caskroom/homebrew-fonts](https://github.com/caskroom/homebrew-fonts) repository. See the font repo [CONTRIBUTING.md](../../../../../homebrew-fonts/blob/master/CONTRIBUTING.md) +Font Casks live in the [Homebrew/homebrew-cask-fonts](https://github.com/Homebrew/homebrew-cask-fonts) repository. See the font repo [CONTRIBUTING.md](../../../../../homebrew-cask-fonts/blob/master/CONTRIBUTING.md) for details. ### eIDs -eID Casks live in the [caskroom/homebrew-eid](https://github.com/caskroom/homebrew-eid) repository. See the eid repo [CONTRIBUTING.md](../../../../../homebrew-eid/blob/master/CONTRIBUTING.md) +eID Casks live in the [Homebrew/homebrew-cask-eid](https://github.com/Homebrew/homebrew-cask-eid) repository. See the eid repo [CONTRIBUTING.md](../../../../../homebrew-cask-eid/blob/master/CONTRIBUTING.md) for details. ### Drivers -Driver Casks live in the [caskroom/homebrew-drivers](https://github.com/caskroom/homebrew-drivers) repository. See the drivers repo [CONTRIBUTING.md](../../../../../homebrew-drivers/blob/master/CONTRIBUTING.md) +Driver Casks live in the [Homebrew/homebrew-cask-drivers](https://github.com/Homebrew/homebrew-cask-drivers) repository. See the drivers repo [CONTRIBUTING.md](../../../../../homebrew-cask-drivers/blob/master/CONTRIBUTING.md) for details. ## Submitting Your Changes @@ -239,7 +239,7 @@ for details. Hop into your Tap and check to make sure your new Cask is there: ```bash -$ cd "$(brew --repository)"/Library/Taps/caskroom/homebrew-cask +$ cd "$(brew --repository)"/Library/Taps/Homebrew/homebrew-cask $ git status # On branch master # Untracked files: @@ -297,7 +297,7 @@ If you are using [GitHub two-factor authentication](https://help.github.com/arti ### Filing a Pull Request on GitHub -Now go to the [`homebrew-cask` GitHub repository](https://github.com/caskroom/homebrew-cask). GitHub will often show your `my-new-cask` branch with a handy button to `Compare & pull request`. Otherwise, click the `New pull request` button and choose to `compare across forks`. The base fork should be `caskroom/homebrew-cask @ master`, and the head fork should be `my-github-username/homebrew-cask @ my-new-cask`. You can also add any further comments to your pull request at this stage. +Now go to the [`homebrew-cask` GitHub repository](https://github.com/Homebrew/homebrew-cask). GitHub will often show your `my-new-cask` branch with a handy button to `Compare & pull request`. Otherwise, click the `New pull request` button and choose to `compare across forks`. The base fork should be `Homebrew/homebrew-cask @ master`, and the head fork should be `my-github-username/homebrew-cask @ my-new-cask`. You can also add any further comments to your pull request at this stage. Congratulations! You are done now, and your Cask should be pulled in or otherwise noticed in a while. If a maintainer suggests some changes, just make them on the `my-new-cask` branch locally and [push](#pushing). @@ -306,6 +306,6 @@ Congratulations! You are done now, and your Cask should be pulled in or otherwis After your Pull Request is submitted, you should get yourself back onto `master`, so that `brew update` will pull down new Casks properly: ```bash -cd "$(brew --repository)"/Library/Taps/caskroom/homebrew-cask +cd "$(brew --repository)"/Library/Taps/Homebrew/homebrew-cask git checkout master ``` diff --git a/doc/development/hacking.md b/doc/development/hacking.md index 605b01e483..67a95fc10d 100644 --- a/doc/development/hacking.md +++ b/doc/development/hacking.md @@ -15,7 +15,7 @@ Homebrew-Cask is designed to work like a traditional Unix tool: Homebrew-Cask is still young, and should be considered in alpha. -We have good support for a variety of artifacts such as apps, pkgs, binaries, plugins, and [fonts](https://github.com/caskroom/homebrew-fonts/). Homebrew-Cask can install and uninstall any of those. However, these commands don’t work well with multiple versions, and most importantly, we currently can’t `upgrade` ([but are working on it](https://github.com/caskroom/homebrew-cask/issues/29301)). +We have good support for a variety of artifacts such as apps, pkgs, binaries, plugins, and [fonts](https://github.com/Homebrew/homebrew-cask-fonts/). Homebrew-Cask can install and uninstall any of those. However, these commands don’t work well with multiple versions, and most importantly, we currently can’t `upgrade` ([but are working on it](https://github.com/Homebrew/homebrew-cask/issues/29301)). ### Casks and Formulae @@ -25,7 +25,7 @@ Casks, by contrast, only need to support the few installation methods used by ap We encourage Cask authors to use the DSL as much as possible, since that makes things easier for everyone: from maintainers who review pull requests, to first-time contributors, to people who are unfamiliar with Ruby but would like to help. -For software with unusual needs that are not covered by the DSL, we generally accept Casks containing small hacks or arbitrary code (for example, though the use of [shims scripts](https://github.com/caskroom/homebrew-cask/issues/18809)). If the hack becomes common enough, we extend the DSL with a simple shorthand that offers the same (or better) functionality. +For software with unusual needs that are not covered by the DSL, we generally accept Casks containing small hacks or arbitrary code (for example, though the use of [shims scripts](https://github.com/Homebrew/homebrew-cask/issues/18809)). If the hack becomes common enough, we extend the DSL with a simple shorthand that offers the same (or better) functionality. ## Contributing @@ -75,4 +75,4 @@ brew cask _stanza [ --table | --yaml | --inspect | --quiet ] [ `’s are given, then data for all Casks is returned. On failure, a blank line is returned to the standard output. -For example, `brew cask _stanza appcast atom` outputs the [`appcast` for the Cask atom.rb](https://github.com/caskroom/homebrew-cask/blob/43ad9d8ddbad71fbeee42710d567861f080fedf8/Casks/atom.rb#L7), namely `https://github.com/atom/atom/releases.atom`. +For example, `brew cask _stanza appcast atom` outputs the [`appcast` for the Cask atom.rb](https://github.com/Homebrew/homebrew-cask/blob/43ad9d8ddbad71fbeee42710d567861f080fedf8/Casks/atom.rb#L7), namely `https://github.com/atom/atom/releases.atom`. diff --git a/doc/development/maintaining.md b/doc/development/maintaining.md index e903b43d09..937abbb97b 100644 --- a/doc/development/maintaining.md +++ b/doc/development/maintaining.md @@ -8,7 +8,7 @@ __^^ NOTE - DRAFT DOC! ^^__ As a relatively large open source project with plenty of daily activity, Homebrew-Cask requires regular care and feeding. This includes reviewing and merging PRs, diagnosing bugs, improving documentation, discussing project policy and features, and plenty more! -This responsibility is shared by @caskroom/maintainers - a team of humans spanning the globe each of whom has agreed to dedicate some of their spare time to helping our dear users. What a kind and friendly bunch they must be! (It’s true, they are.) +This responsibility is shared by @Homebrew/cask - a team of humans spanning the globe each of whom has agreed to dedicate some of their spare time to helping our dear users. What a kind and friendly bunch they must be! (It’s true, they are.) As the project matures and grows, so does the team of maintainers. It’s becoming more and more important to write down things that once were done ad-hoc. @@ -44,7 +44,7 @@ Label | Description | Issues | Pull Requests **documentation** | Relates to the documentation. | ✓ | ✓ **duplicate** | An issue or pull request that is essentially the same as another. Should be immediately closed. | ✓ | ✓ **enhancement** | Something we want implemented. Must always be accompanied by **cask** or **core**. | ✓ | ✓ -**future** | Something that can currently only be referenced and will only be possible to act upon in the future, after certain conditions are met. Currently references [changes to the installation behaviour](https://github.com/caskroom/homebrew-cask/issues/13201). To be used sparingly. | ✓ | ✓ +**future** | Something that can currently only be referenced and will only be possible to act upon in the future, after certain conditions are met. Currently references [changes to the installation behaviour](https://github.com/Homebrew/homebrew-cask/issues/13201). To be used sparingly. | ✓ | ✓ **meta** | Relates to Homebrew-Cask itself as a project and its policies/decisions. | ✓ | **on hold** | A pull request that depends on another being merged before it itself can be as well. | | ✓ **roadmap** | Roadmap for feature implementation. | ✓ | @@ -53,7 +53,7 @@ Label | Description | Issues | Pull Requests **upstream** | Something we have no hand in, and can only be fixed with intervention from developers outside Homebrew-Cask. Always refers to a cask, and never to the core. | ✓ | ✓ **awaiting maintainer feedback** | A maintainer requires input from other maintainers to proceed. Other maintainers should occasionally check this label and give their feedback on the subject, if able. | ✓ | ✓ **awaiting user reply** | A maintainer requires further action or information from the original poster to proceed. Particularly useful to weed out those cases where issues and pull requests would otherwise be left open indefinitely because the original poster never replies. | ✓ | ✓ -**awaiting verification** | A pull request that [requires verification](https://github.com/caskroom/homebrew-cask/blob/master/doc/cask_language_reference/stanzas/sha256.md#updating-the-sha256) of a `sha256` change. | | ✓ +**awaiting verification** | A pull request that [requires verification](https://github.com/Homebrew/homebrew-cask/blob/master/doc/cask_language_reference/stanzas/sha256.md#updating-the-sha256) of a `sha256` change. | | ✓ ## Handling Cask Update PRs @@ -65,7 +65,7 @@ Lastly, if you see an outdated cask that just needs a version bump, you can use ## Tips -* To keep your repository up to date with caskroom/master, you can create a custom bash function to save some typing. Feel free to adapt the following set of commands to your specific needs --> `cd "$(brew --repository)"/Library/Taps/caskroom/homebrew-cask; git checkout master; git pull origin; git push "${GITHUB_USERNAME}" master; git remote prune origin; git fetch -p origin; git remote update --prune` +* To keep your repository up to date, you can create a custom bash function to save some typing. Feel free to adapt the following set of commands to your specific needs --> `cd "$(brew --repository)"/Library/Taps/Homebrew/homebrew-cask; git checkout master; git pull origin; git push "${GITHUB_USERNAME}" master; git remote prune origin; git fetch -p origin; git remote update --prune` ## Ideas for other things to include here diff --git a/doc/faq/apps_with_malware.md b/doc/faq/apps_with_malware.md index 825c2af145..0713532e64 100644 --- a/doc/faq/apps_with_malware.md +++ b/doc/faq/apps_with_malware.md @@ -1,13 +1,13 @@ # Apps that bundle malware -Unfortunately, in the world of software there are bad actors that bundle malware with their apps. Even so, Homebrew-Cask has long decided it is not a gatekeeper ([macOS already has one](https://support.apple.com/en-us/HT202491)) and [users are expected to know about the software they are installing](not_a_discoverability_service.md). This means we will not remove casks that link to these apps. We have several reasons for this, summarised in [a comment on issue #21399](https://github.com/caskroom/homebrew-cask/issues/21399#issuecomment-223148829). +Unfortunately, in the world of software there are bad actors that bundle malware with their apps. Even so, Homebrew-Cask has long decided it is not a gatekeeper ([macOS already has one](https://support.apple.com/en-us/HT202491)) and [users are expected to know about the software they are installing](not_a_discoverability_service.md). This means we will not remove casks that link to these apps. We have several reasons for this, summarised in [a comment on issue #21399](https://github.com/Homebrew/homebrew-cask/issues/21399#issuecomment-223148829). Within that context, we would still like for users to enjoy some kind of protection while minimising occurrences of legitimate developers being branded as malware carriers. We feel removing casks is an ineffective band-aid and the issue needs to be tackled earlier in the chain: at the macOS level. -If an app that bundles malware was not signed with an Apple Developer ID and you purposefully disabled or bypassed Gatekeeper, no action will be taken on our part. When you disable security features, you do so at your own risk. If, however, an app that bundles malware is signed, Apple can revoke its permissions and it will no longer run on the computers of users that keep security features on — we all benefit, Homebrew-Cask users or not. **Note that for the time being, Homebrew-Cask will not quarantine download files. See [issue #22388](https://github.com/caskroom/homebrew-cask/issues/22388)**. +If an app that bundles malware was not signed with an Apple Developer ID and you purposefully disabled or bypassed Gatekeeper, no action will be taken on our part. When you disable security features, you do so at your own risk. If, however, an app that bundles malware is signed, Apple can revoke its permissions and it will no longer run on the computers of users that keep security features on — we all benefit, Homebrew-Cask users or not. **Note that for the time being, Homebrew-Cask will not quarantine download files. See [issue #22388](https://github.com/Homebrew/homebrew-cask/issues/22388)**. To report a signed app that bundles malware, follow these steps: * Go to [Apple’s Bug Reporter](https://bugreport.apple.com/) and report the app that bundles malware. Be as precise as possible about how you know it bundles malware, and what steps reproduce your conclusions. Be sure to include relevant URLs, such as the app’s homepage. * Make the report public at [Open Radar](http://www.openradar.me/). -* Submit a pull request with a [`malware` `caveat`](https://github.com/caskroom/homebrew-cask/blob/master/doc/cask_language_reference/stanzas/caveats.md#caveats-mini-dsl). +* Submit a pull request with a [`malware` `caveat`](https://github.com/Homebrew/homebrew-cask/blob/master/doc/cask_language_reference/stanzas/caveats.md#caveats-mini-dsl). diff --git a/doc/faq/closing_issues_without_review.md b/doc/faq/closing_issues_without_review.md index 48ac432599..fe6abb0344 100644 --- a/doc/faq/closing_issues_without_review.md +++ b/doc/faq/closing_issues_without_review.md @@ -1,6 +1,6 @@ # If your issue was closed without review -Both the [reporting bugs section of the readme](https://github.com/caskroom/homebrew-cask#reporting-bugs) and [the issue template you need to fill before opening an issue](https://github.com/caskroom/homebrew-cask/blob/master/.github/ISSUE_TEMPLATE.md) warn that if the instructions aren’t followed, your issue may be closed without review. +Both the [reporting bugs section of the readme](https://github.com/Homebrew/homebrew-cask#reporting-bugs) and [the issue template you need to fill before opening an issue](https://github.com/Homebrew/homebrew-cask/blob/master/.github/ISSUE_TEMPLATE.md) warn that if the instructions aren’t followed, your issue may be closed without review. You might have been redirected to this document if it was apparent to a maintainer that was the case. We worked hard on those guides to keep things running smoothly, so we ask you go back and follow them. It is OK to open a new issue for that. diff --git a/doc/faq/not_a_discoverability_service.md b/doc/faq/not_a_discoverability_service.md index 104e616538..e4d70f8b1c 100644 --- a/doc/faq/not_a_discoverability_service.md +++ b/doc/faq/not_a_discoverability_service.md @@ -4,9 +4,9 @@ Ever since the inception of Homebrew-Cask, various requests fell under the umbre Examples of requests under this same theme: -+ [Separate by categories](https://github.com/caskroom/homebrew-cask/issues/5425). -+ [Rank by popularity](https://github.com/caskroom/homebrew-cask/issues/4323). -+ [Add descriptions](https://github.com/caskroom/homebrew-cask/issues/16089). ++ [Separate by categories](https://github.com/Homebrew/homebrew-cask/issues/5425). ++ [Rank by popularity](https://github.com/Homebrew/homebrew-cask/issues/4323). ++ [Add descriptions](https://github.com/Homebrew/homebrew-cask/issues/16089). Amongst other things, the logistics of such requests are unsustainable for Homebrew-Cask. Before making a request of this nature, you must read through those issues, as well as any other issues they link to, to get a full understanding of why that is the case, and why “but project *x* does *y*” arguments aren’t applicable, and not every package manager is the same. diff --git a/doc/faq/rejected_casks.md b/doc/faq/rejected_casks.md index ad6dbac56a..e968fba04c 100644 --- a/doc/faq/rejected_casks.md +++ b/doc/faq/rejected_casks.md @@ -4,20 +4,20 @@ Before submitting a Cask to any of our repos, you must read [our documentation o Common reasons to reject a Cask entirely: -+ We have strong reasons to believe including the Cask can put the whole project at risk. Happened only once so far, [with Popcorn Time](https://github.com/caskroom/homebrew-cask/pull/3954). -+ The cask is so difficult to maintain, it constantly breaks. Happened only once so far, [with Audacity](https://github.com/caskroom/homebrew-cask/pull/27517), because it uses [fosshub](https://www.fosshub.com/faq.html) as a distribution site. ++ We have strong reasons to believe including the Cask can put the whole project at risk. Happened only once so far, [with Popcorn Time](https://github.com/Homebrew/homebrew-cask/pull/3954). ++ The cask is so difficult to maintain, it constantly breaks. Happened only once so far, [with Audacity](https://github.com/Homebrew/homebrew-cask/pull/27517), because it uses [fosshub](https://www.fosshub.com/faq.html) as a distribution site. + The app is a trial version, and the only way to acquire the full version is through the Mac App Store. + Similarly (and trickier to spot), the app has moved to the Mac App Store but still provides old versions via direct download. We reject these in all official repos so users don’t get stuck using an old version, wrongly thinking they’re using the most up-to-date one (which, amongst other things, might be a security risk). -+ The app is both open-source and CLI-only (i.e. it only uses the `binary` artifact). In that case, and [in the spirit of deduplication](https://github.com/caskroom/homebrew-cask/issues/15603), submit it first to [Homebrew/core](https://github.com/Homebrew/homebrew-core). If it is rejected there, you may then try again in Homebrew-Cask (link us to the issue on Homebrew so we can see their reasoning for rejection). -+ The app is open-source and has a GUI but no compiled versions (or only old ones) are provided. It’s better to have them in [Homebrew](https://github.com/Homebrew/homebrew) so users don’t get perpetually outdated versions. See [`gedit`](https://github.com/caskroom/homebrew-cask/pull/23360) for example. -+ The app has been rejected before due to an issue we cannot fix, and this new submission doesn’t fix that . An example would be [the first submission of `soapui`](https://github.com/caskroom/homebrew-cask/pull/4939), whose installation problems were not fixed in the two subsequent submissions ([#9969](https://github.com/caskroom/homebrew-cask/pull/9969), [#10606](https://github.com/caskroom/homebrew-cask/pull/10606)). ++ The app is both open-source and CLI-only (i.e. it only uses the `binary` artifact). In that case, and [in the spirit of deduplication](https://github.com/Homebrew/homebrew-cask/issues/15603), submit it first to [Homebrew/core](https://github.com/Homebrew/homebrew-core). If it is rejected there, you may then try again in Homebrew-Cask (link us to the issue on Homebrew so we can see their reasoning for rejection). ++ The app is open-source and has a GUI but no compiled versions (or only old ones) are provided. It’s better to have them in [Homebrew](https://github.com/Homebrew/homebrew) so users don’t get perpetually outdated versions. See [`gedit`](https://github.com/Homebrew/homebrew-cask/pull/23360) for example. ++ The app has been rejected before due to an issue we cannot fix, and this new submission doesn’t fix that . An example would be [the first submission of `soapui`](https://github.com/Homebrew/homebrew-cask/pull/4939), whose installation problems were not fixed in the two subsequent submissions ([#9969](https://github.com/Homebrew/homebrew-cask/pull/9969), [#10606](https://github.com/Homebrew/homebrew-cask/pull/10606)). + The Cask is a duplicate. These submissions mostly occur when the [token reference](../cask_language_reference/token_reference.md) was not followed. + The download URL for the app is both behind a login/registration form and from a host that differs from the homepage, meaning users can’t easily verify its authenticity. [alehouse/homebrew-unofficial](https://github.com/alehouse/homebrew-unofficial) is a sister repo where you may wish to submit your cask. -+ The Cask is for an app that is unmaintained (no releases in the last year, or [explicitly discontinued](https://github.com/caskroom/homebrew-cask/pull/22699)). -+ The Cask is too obscure (for example, a self-submitted app from a GitHub repository that is [not notable enough](https://github.com/caskroom/homebrew-cask/pull/28103) (under 50 stars)). -+ The author has [specifically asked us not to include it](https://github.com/caskroom/homebrew-cask/pull/5342). -+ The Cask requires [SIP to be disabled](https://github.com/caskroom/homebrew-cask/pull/41890) to be installed and/or used. -+ The Cask is a `pkg` that requires [`allow_untrusted: true`](https://github.com/caskroom/homebrew-cask/blob/master/doc/cask_language_reference/stanzas/pkg.md#pkg-allow_untrusted). ++ The Cask is for an app that is unmaintained (no releases in the last year, or [explicitly discontinued](https://github.com/Homebrew/homebrew-cask/pull/22699)). ++ The Cask is too obscure (for example, a self-submitted app from a GitHub repository that is [not notable enough](https://github.com/Homebrew/homebrew-cask/pull/28103) (under 50 stars)). ++ The author has [specifically asked us not to include it](https://github.com/Homebrew/homebrew-cask/pull/5342). ++ The Cask requires [SIP to be disabled](https://github.com/Homebrew/homebrew-cask/pull/41890) to be installed and/or used. ++ The Cask is a `pkg` that requires [`allow_untrusted: true`](https://github.com/Homebrew/homebrew-cask/blob/master/doc/cask_language_reference/stanzas/pkg.md#pkg-allow_untrusted). Common reasons to reject a Cask from the main repo: diff --git a/doc/reporting_bugs/checksum_does_not_match_error_fix_outdated.md b/doc/reporting_bugs/checksum_does_not_match_error_fix_outdated.md index fd9bdf6c4f..db2c9472ca 100644 --- a/doc/reporting_bugs/checksum_does_not_match_error_fix_outdated.md +++ b/doc/reporting_bugs/checksum_does_not_match_error_fix_outdated.md @@ -8,4 +8,4 @@ Let's bring the cask up to date. It’ll likely need a new version, but it’s p 3. Take a look at the cask’s version (`brew cask _stanza version {{cask_name}}`) and verify it is indeed outdated. * If the app’s version is `latest`, it means the `url` itself is outdated. It will need to be changed to the new one. -If it is outdated, start by trying to [submit a fix](../../CONTRIBUTING.md#updating-a-cask). If you’re having trouble, [open an issue](https://github.com/caskroom/homebrew-cask/issues/new?template=01_bug_report.md) explaining your steps so far and why you’re having trouble submitting the update. +If it is outdated, start by trying to [submit a fix](../../CONTRIBUTING.md#updating-a-cask). If you’re having trouble, [open an issue](https://github.com/Homebrew/homebrew-cask/issues/new?template=01_bug_report.md) explaining your steps so far and why you’re having trouble submitting the update. diff --git a/doc/reporting_bugs/curl_error_fix_no_download.md b/doc/reporting_bugs/curl_error_fix_no_download.md index 1991843937..71606d93d9 100644 --- a/doc/reporting_bugs/curl_error_fix_no_download.md +++ b/doc/reporting_bugs/curl_error_fix_no_download.md @@ -6,4 +6,4 @@ There are a few reasons why you might not be finding a download: * You can access the vendor’s site but they’re informing you the app is now discontinued. Submit a pull request deleting the cask or [open an issue][01_bug_report] informing us of the situation. * You can access the vendor’s site but you cannot find the download link. [Open an issue][01_bug_report] and detail all your steps so far. -[01_bug_report]: https://github.com/caskroom/homebrew-cask/issues/new?template=01_bug_report.md +[01_bug_report]: https://github.com/Homebrew/homebrew-cask/issues/new?template=01_bug_report.md diff --git a/doc/reporting_bugs/curl_error_fix_outdated.md b/doc/reporting_bugs/curl_error_fix_outdated.md index d00b031ce6..a76f1d9ac2 100644 --- a/doc/reporting_bugs/curl_error_fix_outdated.md +++ b/doc/reporting_bugs/curl_error_fix_outdated.md @@ -6,4 +6,4 @@ Since the download started, it likely means the cask is outdated. Let's fix it: 2. Take a look at the cask’s version (`brew cask _stanza version {{cask_name}}`) and verify it is indeed outdated. * If the app’s version is `latest`, it means the `url` itself is outdated. It will need to be changed to the new one. -If it is outdated, start by trying to [submit a fix](../../CONTRIBUTING.md#updating-a-cask). If you’re having trouble, [open an issue](https://github.com/caskroom/homebrew-cask/issues/new?template=01_bug_report.md) explaining your steps so far and why you’re having trouble submitting the update. +If it is outdated, start by trying to [submit a fix](../../CONTRIBUTING.md#updating-a-cask). If you’re having trouble, [open an issue](https://github.com/Homebrew/homebrew-cask/issues/new?template=01_bug_report.md) explaining your steps so far and why you’re having trouble submitting the update. diff --git a/doc/reporting_bugs/permission_denied_error_fix_appdir.md b/doc/reporting_bugs/permission_denied_error_fix_appdir.md index fcee7fd738..fe04b25b74 100644 --- a/doc/reporting_bugs/permission_denied_error_fix_appdir.md +++ b/doc/reporting_bugs/permission_denied_error_fix_appdir.md @@ -2,6 +2,6 @@ In this case, it’s likely you’re a standard user and don’t have permissions to write to `/Applications` (which is now our default). If you never changed your default installation directory for apps and were using Homebrew-Cask before we changed our behaviour to moving apps instead of linking, you should have some symlinks in your `~/Applications` directory, which you do have permission to write to. -You can use `--appdir=~/Applications` when installing to bring back the old behaviour. For a permanent change, [follow the `Options` section in `USAGE.md`](https://github.com/caskroom/homebrew-cask/blob/1de4657a0ed35463602b31061b0c16dc9078b8a0/USAGE.md#options). Specifically, you’ll want to set `export HOMEBREW_CASK_OPTS="--appdir=~/Applications"` in your shell’s startup file. +You can use `--appdir=~/Applications` when installing to bring back the old behaviour. For a permanent change, [follow the `Options` section in `USAGE.md`](https://github.com/Homebrew/homebrew-cask/blob/1de4657a0ed35463602b31061b0c16dc9078b8a0/USAGE.md#options). Specifically, you’ll want to set `export HOMEBREW_CASK_OPTS="--appdir=~/Applications"` in your shell’s startup file. If `--appdir` doesn’t fix the issue or you do have write permissions to `/Applications`, the problem may lie [in the app bundle itself](permission_denied_error_fix_bundle.md). diff --git a/doc/reporting_bugs/permission_denied_error_fix_bundle.md b/doc/reporting_bugs/permission_denied_error_fix_bundle.md index 84af1976b5..2ab6937ce6 100644 --- a/doc/reporting_bugs/permission_denied_error_fix_bundle.md +++ b/doc/reporting_bugs/permission_denied_error_fix_bundle.md @@ -1,5 +1,5 @@ [Go back](permission_denied_error_fix_appdir.md) -Some app bundles don’t have certain permissions that might be necessary for us to move them to the appropriate location. You may check such permissions with `ls -ls {{path_to_app_bundle}}`. If you see something like `dr-xr-xr-x` at the start of the output, that may be the cause. To fix it, we simply change the app bundle’s permission to allow us to move it, and then set it back to what it was (in case the developer set those permissions deliberately). See [`litecoin`](https://github.com/caskroom/homebrew-cask/blob/0cde71f1fea8ad62d6ec4732fcf35ac0c52d8792/Casks/litecoin.rb#L14L20) for an example of such a cask. +Some app bundles don’t have certain permissions that might be necessary for us to move them to the appropriate location. You may check such permissions with `ls -ls {{path_to_app_bundle}}`. If you see something like `dr-xr-xr-x` at the start of the output, that may be the cause. To fix it, we simply change the app bundle’s permission to allow us to move it, and then set it back to what it was (in case the developer set those permissions deliberately). See [`litecoin`](https://github.com/Homebrew/homebrew-cask/blob/0cde71f1fea8ad62d6ec4732fcf35ac0c52d8792/Casks/litecoin.rb#L14L20) for an example of such a cask. If you’ve made the change and the issue persists or you’re having trouble making the change, [go back](../../README.md#reporting-bugs) and pick `My problem isn’t listed`. Be sure to mention all your steps so far and what you’re having difficulties with. diff --git a/doc/reporting_bugs/source_is_not_there_fix.md b/doc/reporting_bugs/source_is_not_there_fix.md index 1bc82fb3e7..81f1378e34 100644 --- a/doc/reporting_bugs/source_is_not_there_fix.md +++ b/doc/reporting_bugs/source_is_not_there_fix.md @@ -1,6 +1,6 @@ [Go back](a_cask_fails_to_install.md#source-is-not-there-error) -First, you need to identify which artifact is not being handled correctly anymore. It’s explicit in the error message: if it says `Error: It seems the App source…'` the problem is [`app`](https://github.com/caskroom/homebrew-cask/blob/master/doc/cask_language_reference/stanzas/app.md). The pattern is the same across all artifacts. +First, you need to identify which artifact is not being handled correctly anymore. It’s explicit in the error message: if it says `Error: It seems the App source…'` the problem is [`app`](https://github.com/Homebrew/homebrew-cask/blob/master/doc/cask_language_reference/stanzas/app.md). The pattern is the same across all artifacts. Fixing this error is typically easy, and requires only a bit of time on your part. Start by downloading the package for the cask: `brew cask fetch {{cask_name}}`. The last line of output will inform you of the location of the download. Navigate there and manually unpack it. As an example, lets say the structure inside the archive is as follows: @@ -21,6 +21,6 @@ app 'SomeApp.app' The cask was expecting `SomeApp.app` to be in the top directory of the archive (see how it says simply `SomeApp.app`) but the developer changed it to inside a `Files` directory. All we have to do is update that line of the cask to follow the new structure: `app 'Files/SomeApp.app'`. -Note that occasionally the app’s name changes completely (from `SomeApp.app` to `OtherApp.app`, let's say). In these instances, the filename of the cask itself, as well as its token, must also change. Consult the [`token reference`](https://github.com/caskroom/homebrew-cask/blob/master/doc/cask_language_reference/token_reference.md) for complete instructions on the new name. +Note that occasionally the app’s name changes completely (from `SomeApp.app` to `OtherApp.app`, let's say). In these instances, the filename of the cask itself, as well as its token, must also change. Consult the [`token reference`](https://github.com/Homebrew/homebrew-cask/blob/master/doc/cask_language_reference/token_reference.md) for complete instructions on the new name. -Follow the instructions to [submit a fix](../../CONTRIBUTING.md#updating-a-cask), and make the change to the cask. If using `cask-repair`, you may give it the `--edit-cask` flag when calling it on the command-line to step right into editing it. If you’re having trouble, [open an issue](https://github.com/caskroom/homebrew-cask/issues/new?template=01_bug_report.md) explaining your steps so far and why you’re having trouble submitting the update. +Follow the instructions to [submit a fix](../../CONTRIBUTING.md#updating-a-cask), and make the change to the cask. If using `cask-repair`, you may give it the `--edit-cask` flag when calling it on the command-line to step right into editing it. If you’re having trouble, [open an issue](https://github.com/Homebrew/homebrew-cask/issues/new?template=01_bug_report.md) explaining your steps so far and why you’re having trouble submitting the update. diff --git a/doc/reporting_bugs/uninstall_wrongly_reports_cask_as_not_installed.md b/doc/reporting_bugs/uninstall_wrongly_reports_cask_as_not_installed.md index 1b1227de85..d602cf8031 100644 --- a/doc/reporting_bugs/uninstall_wrongly_reports_cask_as_not_installed.md +++ b/doc/reporting_bugs/uninstall_wrongly_reports_cask_as_not_installed.md @@ -2,7 +2,7 @@ # `uninstall` wrongly reports cask as not installed -Reports of this bug are usually accompanied with the output of `brew cask list` showing the cask is indeed installed. [You should not rely on `brew cask list`](https://github.com/caskroom/homebrew-cask/issues/14058) anyway, and this error is somewhat related to it. +Reports of this bug are usually accompanied with the output of `brew cask list` showing the cask is indeed installed. [You should not rely on `brew cask list`](https://github.com/Homebrew/homebrew-cask/issues/14058) anyway, and this error is somewhat related to it. This is prone to happen when you try to uninstall a cask that has been updated since you last installed, or when a cask no longer exists in the repo (`brew cask list` will show it with `(!)`). We’re working to handle those situations better. diff --git a/doc/reporting_bugs/wrong_number_of_arguments_fix.md b/doc/reporting_bugs/wrong_number_of_arguments_fix.md index 1c13636aa4..5b5b4d5ec5 100644 --- a/doc/reporting_bugs/wrong_number_of_arguments_fix.md +++ b/doc/reporting_bugs/wrong_number_of_arguments_fix.md @@ -1,5 +1,5 @@ [Go back](a_cask_fails_to_install.md#wrong-number-of-arguments-error) -Make sure the issue really lies with your macOS version. To do so, try to install the software manually. If it is incompatible with your macOS version, it will tell you. In that case, there is nothing we can do to help you install the software, but we can add a [`depends_on macos:`](https://github.com/caskroom/homebrew-cask/blob/master/doc/cask_language_reference/stanzas/depends_on.md#depends_on-macos) stanza to prevent the cask from trying to install on incompatible macOS versions. +Make sure the issue really lies with your macOS version. To do so, try to install the software manually. If it is incompatible with your macOS version, it will tell you. In that case, there is nothing we can do to help you install the software, but we can add a [`depends_on macos:`](https://github.com/Homebrew/homebrew-cask/blob/master/doc/cask_language_reference/stanzas/depends_on.md#depends_on-macos) stanza to prevent the cask from trying to install on incompatible macOS versions. -Follow the instructions to [submit a fix](../../CONTRIBUTING.md#updating-a-cask), and make the change to the cask. If using `cask-repair`, you may give it the `--edit-cask` flag when calling it on the command-line to step right into editing it. If you’re having trouble submitting the fix or manually installing the software worked without a problem, [open an issue](https://github.com/caskroom/homebrew-cask/issues/new?template=01_bug_report.md) explaining your steps so far and the current situation. +Follow the instructions to [submit a fix](../../CONTRIBUTING.md#updating-a-cask), and make the change to the cask. If using `cask-repair`, you may give it the `--edit-cask` flag when calling it on the command-line to step right into editing it. If you’re having trouble submitting the fix or manually installing the software worked without a problem, [open an issue](https://github.com/Homebrew/homebrew-cask/issues/new?template=01_bug_report.md) explaining your steps so far and the current situation.