EricFromCanada afc539f86e Update brew's man page formatting and grammar
Also update command specifications to match descriptions.
2017-02-25 17:37:57 -05:00

39 lines
1.3 KiB
Ruby

#: * `desc` <formula>:
#: Display <formula>'s name and one-line description.
#:
#: * `desc` [`-s`|`-n`|`-d`] (<text>|`/`<text>`/`):
#: Search both name and description (`-s`), just the names (`-n`), or just the
#: descriptions (`-d`) for <text>. If <text> is flanked by slashes, it is interpreted
#: as a regular expression. Formula descriptions are cached; the cache is created on
#: the first search, making that search slower than subsequent ones.
require "descriptions"
require "cmd/search"
module Homebrew
module_function
def desc
search_type = []
search_type << :either if ARGV.flag? "--search"
search_type << :name if ARGV.flag? "--name"
search_type << :desc if ARGV.flag? "--description"
if search_type.empty?
raise FormulaUnspecifiedError if ARGV.named.empty?
desc = {}
ARGV.formulae.each { |f| desc[f.full_name] = f.desc }
results = Descriptions.new(desc)
results.print
elsif search_type.size > 1
odie "Pick one, and only one, of -s/--search, -n/--name, or -d/--description."
elsif arg = ARGV.named.first
regex = Homebrew.query_regexp(arg)
results = Descriptions.search(regex, search_type.first)
results.print
else
odie "You must provide a search term."
end
end
end