b21f699ff2
This is also used by `brew <cmd> --help`. The basic idea is to have the documentation as a top level comment in each command file. To find these comments, they have to be like this `#:`. This is also used by the `brew man` command to keep the documentation DRY, and for that there are now a header and footer for the man page.
62 lines
1.7 KiB
Ruby
62 lines
1.7 KiB
Ruby
HOMEBREW_HELP = <<-EOS
|
|
Example usage:
|
|
brew [info | home | options ] [FORMULA...]
|
|
brew install FORMULA...
|
|
brew uninstall FORMULA...
|
|
brew search [foo]
|
|
brew list [FORMULA...]
|
|
brew update
|
|
brew upgrade [FORMULA...]
|
|
brew pin/unpin [FORMULA...]
|
|
|
|
Troubleshooting:
|
|
brew doctor
|
|
brew install -vd FORMULA
|
|
brew [--env | config]
|
|
|
|
Brewing:
|
|
brew create [URL [--no-fetch]]
|
|
brew edit [FORMULA...]
|
|
https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Formula-Cookbook.md
|
|
|
|
Further help:
|
|
man brew
|
|
brew home
|
|
EOS
|
|
|
|
# NOTE Keep the lenth of vanilla --help less than 25 lines!
|
|
# This is because the default Terminal height is 25 lines. Scrolling sucks
|
|
# and concision is important. If more help is needed we should start
|
|
# specialising help like the gem command does.
|
|
# NOTE Keep lines less than 80 characters! Wrapping is just not cricket.
|
|
# NOTE The reason the string is at the top is so 25 lines is easy to measure!
|
|
|
|
module Homebrew
|
|
def help
|
|
puts HOMEBREW_HELP
|
|
end
|
|
|
|
def help_s
|
|
HOMEBREW_HELP
|
|
end
|
|
|
|
def help_for_command(cmd)
|
|
cmd_path = if File.exist?(HOMEBREW_LIBRARY_PATH/"cmd/#{cmd}.sh")
|
|
HOMEBREW_LIBRARY_PATH/"cmd/#{cmd}.sh"
|
|
elsif ARGV.homebrew_developer? && File.exist?(HOMEBREW_LIBRARY_PATH/"dev-cmd/#{cmd}.sh")
|
|
HOMEBREW_LIBRARY_PATH/"dev-cmd/#{cmd}.sh"
|
|
elsif File.exist?(HOMEBREW_LIBRARY_PATH/"cmd/#{cmd}.rb")
|
|
HOMEBREW_LIBRARY_PATH/"cmd/#{cmd}.rb"
|
|
elsif ARGV.homebrew_developer? && File.exist?(HOMEBREW_LIBRARY_PATH/"dev-cmd/#{cmd}.rb")
|
|
HOMEBREW_LIBRARY_PATH/"dev-cmd/#{cmd}.rb"
|
|
end
|
|
return if cmd_path.nil?
|
|
|
|
cmd_path.read.
|
|
split("\n").
|
|
grep(/^#:/).
|
|
map { |line| line.slice(2..-1).delete("`").sub(/^ \* /, "brew ") }.
|
|
join("\n")
|
|
end
|
|
end
|