man-brew-cask.man

BREW-CASK(1)			   brew-cask			  BREW-CASK(1)



NAME
       brew-cask - a friendly binary installer for macOS

SYNOPSIS
       brew cask command [options] [ token ... ]

DESCRIPTION
       Homebrew-Cask is a tool for installing precompiled macOS binaries (such
       as Applications) from the command line. The user is never  required  to
       use the graphical user interface.

ALPHA-QUALITY SOFTWARE
       Homebrew-Cask  works robustly enough that we welcome new users, but the
       project is still in early development. That means command names, option
       names, and other aspects of this manual are still subject to change.

FREQUENTLY USED COMMANDS
       install	[--force] [--skip-cask-deps] [--require-sha] token [ token ...
       ]
	      Install Cask identified by token.

       uninstall [--force] token [ token ... ]
	      Uninstall Cask identified by token.

       search text | /regexp/
	      Perform a substring search of known Cask tokens for text. If the
	      text is delimited by slashes, it is interpreted as a Ruby  regu-
	      lar expression.

	      The tokens returned by search are suitable as arguments for most
	      other commands, such as install or uninstall.

COMMANDS
       audit [ token ... ]
	      Check the given Casks for installability. If no tokens are given
	      on the command line, all Casks are audited.

       cat token [ token ... ]
	      Dump the given Cask definition file to the standard output.

       cleanup [--outdated]
	      Clean up cached downloads and tracker symlinks. With --outdated,
	      only clean up cached downloads older than 10 days old.

       create token
	      Generate a Cask definition file for the Cask identified by token
	      and open a template for it in your favorite editor.

       doctor or dr
	      Check  for  configuration  issues.  Can be useful to upload as a
	      gist for developers along with a bug report.

       edit token
	      Open the given Cask definition file for editing.

       fetch [--force] token [ token ... ]
	      Download remote application files for  the  given  Cask  to  the
	      local  cache.  With --force, force re-download even if the files
	      are already cached.

       home or homepage [ token ... ]
	      Display the homepage associated with a given Cask in a  browser.

	      With     no     arguments,     display	the    project	  page
	      https://caskroom.github.io/.

       info or abv token [ token ... ]
	      Display information about the given Cask.

       install [--force] [--skip-cask-deps] [--require-sha] token [ token  ...
       ]
	      Install the given Cask. With --force,  re-install  even  if  the
	      Cask  appears to be already present. With --skip-cask-deps, skip
	      any Cask dependencies. --require-sha will abort installation  if
	      the Cask does not have a checksum defined.

	      token  is  usually  the  ID  of  a Cask as returned by brew cask
	      search, but see OTHER WAYS TO SPECIFY A CASK for variations.

       list or ls [-1] [--versions] [ token ... ]
	      Without any arguments, list all installed Casks. With -1, always
	      format  the output in a single column. With --versions, show all
	      installed versions.

	      If token is given, summarize the staged  files  associated  with
	      the given Cask.

       outdated [--greedy] [--verbose|--quiet] [ token ...]
	      Without  token  arguments,  display all the installed Casks that
	      have newer versions available in the tap; otherwise  check  only
	      the  tokens given in the command line. If --greedy is given then
	      also include in the output the Casks having auto_updates true or
	      version  :latest. Otherwise they are skipped because there is no
	      reliable way to know when updates are available for them.
	      --verbose forces the display of the outdated and latest version.
	      --quiet suppresses the display of versions.

       reinstall token [ token ... ]
	      Reinstall the given Cask.

       search or -S [text | /regexp/]
	      Without  an  argument,  display all Casks available for install;
	      otherwise perform a substring search of known  Cask  tokens  for
	      text  or,  if the text is delimited by slashes (/regexp/), it is
	      interpreted as a Ruby regular expression.

       style [--fix] [ token ... ]
	      Check the given Casks  for  correct  style  using  RuboCop  Cask
	      https://github.com/caskroom/rubocop-cask. If no tokens are given
	      on  the  command	line,  all  Casks  are	checked.  With	--fix,
	      auto-correct any style errors if possible.

       uninstall or rm or remove [--force] token [ token ... ]
	      Uninstall  the  given  Cask. With --force, uninstall even if the
	      Cask does not appear to be present.

       zap token [ token ... ]
	      Unconditionally remove all files associated with the given Cask.

	      Implicitly  performs all actions associated with uninstall, even
	      if the Cask does not appear to be currently installed.

	      Removes all staged versions of the Cask distribution found under
	      <Caskroom_path>/token.

	      If  the  Cask  definition  contains a zap stanza, performs addi-
	      tional zap actions as defined  there,  such  as  removing  local
	      preference  files.  zap  actions	are variable, depending on the
	      level of detail defined by the Cask author.

	      zap may remove files which are shared between applications.

INTERNAL COMMANDS
       _appcast_checkpoint [--calculate] [ token ... | URL ... ]
	      Given a token, returns the current appcast checkpoint, or calcu-
	      lates  the  appcast checkpoint if the --calculate flag is speci-
	      fied.

	      Given a URL, calculates the appcast checkpoint for it.

       _stanza stanza_name [ --table | --yaml | --inspect | --quiet ] [  token
       ... ]
	      Given a stanza_name and a token, returns the current stanza  for
	      a  given	Cask. If no token is given, then data for all Casks is
	      returned.

OPTIONS
       To make these options persistent, see the ENVIRONMENT section, below.

       Some of these (such as --prefpanedir) may be subject to	removal  in  a
       future version.

       --force
	      Force  an  install  to  proceed  even when a previously-existing
	      install is detected.

       --skip-cask-deps
	      Skip Cask dependencies when installing.

       --require-sha
	      Abort Cask installation if the Cask does	not  have  a  checksum
	      defined.

       --verbose
	      Give additional feedback during installation.

       --appdir=<path>
	      Target location for Applications. The default value is /Applica-
	      tions.

       --colorpickerdir=<path>
	      Target  location	for  Color  Pickers.  The  default  value   is
	      ~/Library/ColorPickers.

       --prefpanedir=<path>
	      Target  location	for  Preference  Panes.  The  default value is
	      ~/Library/PreferencePanes.

       --qlplugindir=<path>
	      Target location for QuickLook  Plugins.  The  default  value  is
	      ~/Library/QuickLook.

       --dictionarydir=<path>
	      Target   location   for	Dictionaries.  The  default  value  is
	      ~/Library/Dictionaries.

       --fontdir=<path>
	      Target location for Fonts. The default value is ~/Library/Fonts.

       --servicedir=<path>
	      Target   location   for	Services.   The   default   value   is
	      ~/Library/Services.

       --input_methoddir=<path>
	      Target  location	for  Input  Methods.  The  default  value   is
	      ~/Library/Input Methods.

       --internet_plugindir=<path>
	      Target  location	for  Internet  Plugins.  The  default value is
	      ~/Library/Internet Plug-Ins.

       --audio_unit_plugindir=<path>
	      Target location for Audio Unit Plugins.  The  default  value  is
	      ~/Library/Audio/Plug-Ins/Components.

       --vst_plugindir=<path>
	      Target   location   for	VST  Plugins.  The  default  value  is
	      ~/Library/Audio/Plug-Ins/VST.

       --vst3_plugindir=<path>
	      Target  location	for  VST3  Plugins.  The  default   value   is
	      ~/Library/Audio/Plug-Ins/VST3.

       --screen_saverdir=<path>
	      Target   location  for  Screen  Savers.  The  default  value  is
	      ~/Library/Screen Savers.

       --no-binaries
	      Do not link "helper" executables to /usr/local/bin.

       --debug
	      Output debugging information of use to Cask authors and develop-
	      ers.

INTERACTION WITH HOMEBREW
       Homebrew-Cask  is  implemented as a external command for Homebrew. That
       means this project is entirely built upon the Homebrew  infrastructure.
       For  example,  upgrades	to the Homebrew-Cask tool are received through
       Homebrew:



	   brew update; brew cleanup; brew cask cleanup



       And updates to individual Cask definitions are  received  whenever  you
       issue the Homebrew command:



	   brew update



OTHER WAYS TO SPECIFY A CASK
       Most  Homebrew-Cask commands can accept a Cask token as an argument. As
       described above, the argument can take the form of:

       o   A token as returned by brew cask search, e.g. google-chrome



       Homebrew-Cask also accepts three other forms in place of plain tokens:

       o   A  fully-qualified  token  which  includes  the  Tap   name,   e.g.
	   caskroom/fonts/font-symbola

       o   A	fully-qualified    pathname    to    a	  Cask	  file,   e.g.
	   /usr/local/Library/Taps/caskroom/home-
	   brew-cask/Casks/google-chrome.rb

       o   A curl-retrievable URI to a Cask file, e.g. https://raw.githubuser-
	   content.com/caskroom/home-
	   brew-cask/f25b6babcd398abf48e33af3d887b2d00de1d661/Casks/google-chrome.rb



ENVIRONMENT
       Homebrew-Cask respects many of the environment variables  used  by  the
       parent  command	brew.  Please  refer  to the brew(1) man page for more
       information.

       Environment variables specific to Homebrew-Cask:

       HOMEBREW_CASK_OPTS
	      This variable may contain any arguments normally used as options
	      on the command-line. This is particularly useful to make options
	      persistent. For example, you might add to your .bash_profile  or
	      .zshenv something like:



		  export HOMEBREW_CASK_OPTS='--appdir=~/Applications --fontdir=/Library/Fonts'




       Other environment variables:

       SUDO_ASKPASS
	      When  this variable is set, Homebrew-Cask will call sudo(8) with
	      the -A option.

SEE ALSO
       The Homebrew-Cask home page: https://caskroom.github.io/

       The  Homebrew-Cask   GitHub   page:   https://github.com/caskroom/home-
       brew-cask

       brew(1), curl(1)

AUTHORS
       Paul Hinze and Contributors.

       Man page format based on brew.1.md from Homebrew.

BUGS
       We  still  have bugs - and we are busy fixing them! If you have a prob-
       lem, don't be  shy  about  reporting  it  on  our  GitHub  issues  page
       https://github.com/caskroom/homebrew-cask/issues?state=open.

       When  reporting	bugs,  remember  that  Homebrew-Cask is an independent
       project from Homebrew. Do your best to direct bug reports to the appro-
       priate  project. If your command-line started with brew cask, bring the
       bug to us first!



Homebrew			  August 2017			  BREW-CASK(1)