From 598b303e3a8991693314ac5f460502d1c8de1f8a Mon Sep 17 00:00:00 2001 From: Markus Reiter Date: Tue, 20 Sep 2016 09:08:26 +0200 Subject: Update `brew-cask man page. --- Library/Homebrew/manpages/brew-cask.1.md | 37 +++++++++++--------------------- 1 file changed, 12 insertions(+), 25 deletions(-) (limited to 'Library') diff --git a/Library/Homebrew/manpages/brew-cask.1.md b/Library/Homebrew/manpages/brew-cask.1.md index fc14d54d1..4e160b527 100644 --- a/Library/Homebrew/manpages/brew-cask.1.md +++ b/Library/Homebrew/manpages/brew-cask.1.md @@ -19,10 +19,10 @@ names, and other aspects of this manual are still subject to change. ## FREQUENTLY USED COMMANDS - * `install [--force] [--skip-cask-deps] [--require-sha]` [ ... ]: + * `install` [--force] [--skip-cask-deps] [--require-sha] [ ... ]: Install Cask identified by . - * `uninstall [--force]` [ ... ]: + * `uninstall` [--force] [ ... ]: Uninstall Cask identified by . * `search` | //: @@ -69,7 +69,7 @@ names, and other aspects of this manual are still subject to change. * `info` or `abv` [ ... ]: Display information about the given Cask. - * `install [--force] [--skip-cask-deps] [--require-sha]` [ ... ]: + * `install` [--force] [--skip-cask-deps] [--require-sha] [ ... ]: 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 @@ -78,42 +78,29 @@ names, and other aspects of this manual are still subject to change. 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 | -l] [ ... ]: + * `list` or `ls` [-1] [--versions] [ ... ]: Without any arguments, list all installed Casks. With `-1`, always - format the output in a single column. With `-l`, give a more detailed - listing. + format the output in a single column. With `--versions`, show all installed + versions. If is given, summarize the staged files associated with the given Cask. - * `search` or `-S`: - Display all Casks available for install. - - * `search` or `-S` | //: - Perform a substring search of known Cask tokens for . If the text - is delimited by slashes, it is interpreted as a Ruby regular expression. + * `search` or `-S` [ | //]: + Without argument, display all Casks available for install, otherwise + perform a substring search of known Cask tokens for or, if the + text is delimited by slashes (//), it is interpreted as a + Ruby regular expression. * `style` [--fix] [ ... ]: 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 [--force]` or `rm` or `remove` [ ... ]: + * `uninstall` or `rm` or `remove` [--force] [ ... ]: Uninstall the given Cask. With `--force`, uninstall even if the Cask does not appear to be present. - Note that `uninstall --force` is currently imperfect. It will follow - the `uninstall` instructions from *newest* Cask definition, even if - the given Cask has changed since you installed it. The result is that - `uninstall --force` will always succeed in removing relevant files - under ``, but will sometimes fail to remove relevant - installed files outside of it. This issue is being - addressed. - - `uninstall` without `--force` is also imperfect. It may be unable to - perform an `uninstall` operation if the given Cask has changed since you - installed it. This issue is being addressed. - * `update`: For convenience. `brew cask update` is a synonym for `brew update`. -- cgit v1.2.3 From 4a9ee8154a13a0bc7b9fa3aea47108b12072ab07 Mon Sep 17 00:00:00 2001 From: Markus Reiter Date: Tue, 20 Sep 2016 11:50:02 +0200 Subject: Simplify `brew man` authors. --- Library/Homebrew/dev-cmd/man.rb | 17 ++++++----------- Library/Homebrew/manpages/brew.1.md.erb | 6 +++--- 2 files changed, 9 insertions(+), 14 deletions(-) (limited to 'Library') diff --git a/Library/Homebrew/dev-cmd/man.rb b/Library/Homebrew/dev-cmd/man.rb index 0627241a3..871fbf46c 100644 --- a/Library/Homebrew/dev-cmd/man.rb +++ b/Library/Homebrew/dev-cmd/man.rb @@ -52,17 +52,12 @@ module Homebrew variables[:commands] = path_glob_commands("#{HOMEBREW_LIBRARY_PATH}/cmd/*.{rb,sh}") variables[:developer_commands] = path_glob_commands("#{HOMEBREW_LIBRARY_PATH}/dev-cmd/*.{rb,sh}") readme = HOMEBREW_REPOSITORY/"README.md" - variables[:lead_maintainer] = readme - .read[/Homebrew's lead maintainer is (.*)\./, 1] - .scan(/\[([^\]]*)\]/).flatten.first - variables[:maintainers] = readme - .read[/Homebrew's current maintainers are (.*)\./, 1] - .scan(/\[([^\]]*)\]/).flatten - former_maintainers = readme - .read[/Former maintainers with significant contributions include (.*)\./, 1] - .scan(/\[([^\]]*)\]/).flatten - variables[:former_maintainers] = former_maintainers[0...-1] - variables[:creator] = former_maintainers.last + variables[:lead_maintainer] = readme.read[/(Homebrew's lead maintainer .*\.)/, 1] + .gsub(/\[([^\]]+)\]\([^)]+\)/, '\1') + variables[:maintainers] = readme.read[/(Homebrew's current maintainers .*\.)/, 1] + .gsub(/\[([^\]]+)\]\([^)]+\)/, '\1') + variables[:former_maintainers] = readme.read[/(Former maintainers .*\.)/, 1] + .gsub(/\[([^\]]+)\]\([^)]+\)/, '\1') ERB.new(template, nil, ">").result(variables.instance_eval { binding }) end diff --git a/Library/Homebrew/manpages/brew.1.md.erb b/Library/Homebrew/manpages/brew.1.md.erb index e44dc2658..bc2140b40 100644 --- a/Library/Homebrew/manpages/brew.1.md.erb +++ b/Library/Homebrew/manpages/brew.1.md.erb @@ -255,11 +255,11 @@ Homebrew Documentation: ## AUTHORS -Homebrew's lead maintainer is <%= lead_maintainer %>. +<%= lead_maintainer.concat("\n") %> -Homebrew's current maintainers are <%= maintainers[0...-1].join(", ") %> and <%= maintainers[-1] %>. +<%= maintainers.concat("\n") %> -Former maintainers with significant contributions include <%= former_maintainers.join(", ") %> and Homebrew's creator: <%= creator %>. +<%= former_maintainers.concat("\n") %> ## BUGS -- cgit v1.2.3