admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

manpage: fixes for grammar

Browse Source
This commit is contained in:
EricFromCanada 2020-11-12 10:40:48 -05:00
parent 19f3acea41
commit f784b7107f
9 changed files with 65 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Library/Homebrew/cask/cmd/abstract_command.rb
View File

@ -42,7 +42,7 @@ module Cask
OPTIONS = [ OPTIONS = [
[:switch, "--[no-]binaries", { [:switch, "--[no-]binaries", {
description: "Disable/enable linking of helper executables. Default: enabled", description: "Disable/enable linking of helper executables (default: enabled).",
env: :cask_opts_binaries, env: :cask_opts_binaries,
}], }],
[:switch, "--require-sha", { [:switch, "--require-sha", {
@ -50,7 +50,7 @@ module Cask
env: :cask_opts_require_sha, env: :cask_opts_require_sha,
}], }],
[:switch, "--[no-]quarantine", { [:switch, "--[no-]quarantine", {
description: "Disable/enable quarantining of downloads. Default: enabled", description: "Disable/enable quarantining of downloads (default: enabled).",
env: :cask_opts_quarantine, env: :cask_opts_quarantine,
}], }],
].freeze ].freeze

62
Library/Homebrew/cli/parser.rb
View File

@ -33,65 +33,65 @@ module Homebrew
def self.global_cask_options def self.global_cask_options
[ [
[:flag, "--appdir=", { [:flag, "--appdir=", {
description: "Target location for Applications. " \ description: "Target location for Applications " \
"Default: `#{Cask::Config::DEFAULT_DIRS[:appdir]}`", "(default: `#{Cask::Config::DEFAULT_DIRS[:appdir]}`).",
}], }],
[:flag, "--colorpickerdir=", { [:flag, "--colorpickerdir=", {
description: "Target location for Color Pickers. " \ description: "Target location for Color Pickers " \
"Default: `#{Cask::Config::DEFAULT_DIRS[:colorpickerdir]}`", "(default: `#{Cask::Config::DEFAULT_DIRS[:colorpickerdir]}`).",
}], }],
[:flag, "--prefpanedir=", { [:flag, "--prefpanedir=", {
description: "Target location for Preference Panes. " \ description: "Target location for Preference Panes " \
"Default: `#{Cask::Config::DEFAULT_DIRS[:prefpanedir]}`", "(default: `#{Cask::Config::DEFAULT_DIRS[:prefpanedir]}`).",
}], }],
[:flag, "--qlplugindir=", { [:flag, "--qlplugindir=", {
description: "Target location for QuickLook Plugins. " \ description: "Target location for QuickLook Plugins " \
"Default: `#{Cask::Config::DEFAULT_DIRS[:qlplugindir]}`", "(default: `#{Cask::Config::DEFAULT_DIRS[:qlplugindir]}`).",
}], }],
[:flag, "--mdimporterdir=", { [:flag, "--mdimporterdir=", {
description: "Target location for Spotlight Plugins. " \ description: "Target location for Spotlight Plugins " \
"Default: `#{Cask::Config::DEFAULT_DIRS[:mdimporterdir]}`", "(default: `#{Cask::Config::DEFAULT_DIRS[:mdimporterdir]}`).",
}], }],
[:flag, "--dictionarydir=", { [:flag, "--dictionarydir=", {
description: "Target location for Dictionaries. " \ description: "Target location for Dictionaries " \
"Default: `#{Cask::Config::DEFAULT_DIRS[:dictionarydir]}`", "(default: `#{Cask::Config::DEFAULT_DIRS[:dictionarydir]}`).",
}], }],
[:flag, "--fontdir=", { [:flag, "--fontdir=", {
description: "Target location for Fonts. " \ description: "Target location for Fonts " \
"Default: `#{Cask::Config::DEFAULT_DIRS[:fontdir]}`", "(default: `#{Cask::Config::DEFAULT_DIRS[:fontdir]}`).",
}], }],
[:flag, "--servicedir=", { [:flag, "--servicedir=", {
description: "Target location for Services. " \ description: "Target location for Services " \
"Default: `#{Cask::Config::DEFAULT_DIRS[:servicedir]}`", "(default: `#{Cask::Config::DEFAULT_DIRS[:servicedir]}`).",
}], }],
[:flag, "--input_methoddir=", { [:flag, "--input_methoddir=", {
description: "Target location for Input Methods. " \ description: "Target location for Input Methods " \
"Default: `#{Cask::Config::DEFAULT_DIRS[:input_methoddir]}`", "(default: `#{Cask::Config::DEFAULT_DIRS[:input_methoddir]}`).",
}], }],
[:flag, "--internet_plugindir=", { [:flag, "--internet_plugindir=", {
description: "Target location for Internet Plugins. " \ description: "Target location for Internet Plugins " \
"Default: `#{Cask::Config::DEFAULT_DIRS[:internet_plugindir]}`", "(default: `#{Cask::Config::DEFAULT_DIRS[:internet_plugindir]}`).",
}], }],
[:flag, "--audio_unit_plugindir=", { [:flag, "--audio_unit_plugindir=", {
description: "Target location for Audio Unit Plugins. " \ description: "Target location for Audio Unit Plugins " \
"Default: `#{Cask::Config::DEFAULT_DIRS[:audio_unit_plugindir]}`", "(default: `#{Cask::Config::DEFAULT_DIRS[:audio_unit_plugindir]}`).",
}], }],
[:flag, "--vst_plugindir=", { [:flag, "--vst_plugindir=", {
description: "Target location for VST Plugins. " \ description: "Target location for VST Plugins " \
"Default: `#{Cask::Config::DEFAULT_DIRS[:vst_plugindir]}`", "(default: `#{Cask::Config::DEFAULT_DIRS[:vst_plugindir]}`).",
}], }],
[:flag, "--vst3_plugindir=", { [:flag, "--vst3_plugindir=", {
description: "Target location for VST3 Plugins. " \ description: "Target location for VST3 Plugins " \
"Default: `#{Cask::Config::DEFAULT_DIRS[:vst3_plugindir]}`", "(default: `#{Cask::Config::DEFAULT_DIRS[:vst3_plugindir]}`).",
}], }],
[:flag, "--screen_saverdir=", { [:flag, "--screen_saverdir=", {
description: "Target location for Screen Savers. " \ description: "Target location for Screen Savers " \
"Default: `#{Cask::Config::DEFAULT_DIRS[:screen_saverdir]}`", "(default: `#{Cask::Config::DEFAULT_DIRS[:screen_saverdir]}`).",
}], }],
[:comma_array, "--language", { [:comma_array, "--language", {
description: "Set language of the Cask to install. The first matching " \ description: "Comma-separated list of language codes to prefer for cask installation. " \
"language is used, otherwise the default language on the Cask. " \ "The first matching language is used, otherwise it reverts to the cask's " \
"The default value is the `language of your system`", "default language. The default value is the language of your system.",
}], }],
] ]
end end

4
Library/Homebrew/cmd/list.rb
View File

@ -17,12 +17,12 @@ module Homebrew
usage_banner <<~EOS usage_banner <<~EOS
`list`, `ls` [<options>] [<formula|cask>] `list`, `ls` [<options>] [<formula|cask>]
List all installed formulae or casks List all installed formulae and casks.
If <formula> is provided, summarise the paths within its current keg. If <formula> is provided, summarise the paths within its current keg.
EOS EOS
switch "--formula", "--formulae", switch "--formula", "--formulae",
description: "List only formulae. `This is the default action on non TTY.`" description: "List only formulae. This is the default when output is not to a terminal."
switch "--cask", "--casks", switch "--cask", "--casks",
description: "List only casks, or <cask> if provided." description: "List only casks, or <cask> if provided."
switch "--unbrewed", switch "--unbrewed",

4
Library/Homebrew/cmd/outdated.rb
View File

@ -26,9 +26,9 @@ module Homebrew
switch "-v", "--verbose", switch "-v", "--verbose",
description: "Include detailed version information." description: "Include detailed version information."
switch "--formula", switch "--formula",
description: "Only output outdated formulae." description: "List only outdated formulae."
switch "--cask", switch "--cask",
description: "Only output outdated casks." description: "List only outdated casks."
flag "--json", flag "--json",
description: "Print output in JSON format. There are two versions: v1 and v2. " \ description: "Print output in JSON format. There are two versions: v1 and v2. " \
"v1 is deprecated and is currently the default if no version is specified. " \ "v1 is deprecated and is currently the default if no version is specified. " \

2
Library/Homebrew/cmd/search.rb
View File

@ -50,7 +50,7 @@ module Homebrew
description: "Search for formulae with a description matching <text> and casks with "\ description: "Search for formulae with a description matching <text> and casks with "\
"a name matching <text>." "a name matching <text>."
switch "--pull-request", switch "--pull-request",
description: "Search for GitHub pull requests for <text>." description: "Search for GitHub pull requests containing <text>."
package_manager_switches = PACKAGE_MANAGERS.keys.map { |name| "--#{name}" } package_manager_switches = PACKAGE_MANAGERS.keys.map { |name| "--#{name}" }
package_manager_switches.each do |s| package_manager_switches.each do |s|

2
Library/Homebrew/dev-cmd/audit.rb
View File

@ -54,7 +54,7 @@ module Homebrew
"make output easy to grep." "make output easy to grep."
switch "--skip-style", switch "--skip-style",
description: "Skip running non-RuboCop style checks. Useful if you plan on running "\ description: "Skip running non-RuboCop style checks. Useful if you plan on running "\
"`brew style` separately. Default unless a formula is specified by name" "`brew style` separately. Enabled by default unless a formula is specified by name."
switch "-D", "--audit-debug", switch "-D", "--audit-debug",
description: "Enable debugging and profiling of audit methods." description: "Enable debugging and profiling of audit methods."
comma_array "--only", comma_array "--only",

2
Library/Homebrew/dev-cmd/create.rb
View File

@ -59,7 +59,7 @@ module Homebrew
flag "--tap=", flag "--tap=",
description: "Generate the new formula within the given tap, specified as <user>`/`<repo>." description: "Generate the new formula within the given tap, specified as <user>`/`<repo>."
switch "-f", "--force", switch "-f", "--force",
description: "Ignore errors for disallowed formula names and named that shadow aliases." description: "Ignore errors for disallowed formula names and names that shadow aliases."
conflicts "--autotools", "--cmake", "--crystal", "--go", "--meson", "--node", "--perl", "--python", "--rust" conflicts "--autotools", "--cmake", "--crystal", "--go", "--meson", "--node", "--perl", "--python", "--rust"
named 1 named 1

6
Library/Homebrew/dev-cmd/tap-new.rb
View File

@ -19,11 +19,11 @@ module Homebrew
EOS EOS
switch "--no-git", switch "--no-git",
description: "Don't initialize a git repository for the tap." description: "Don't initialize a Git repository for the tap."
flag "--pull-label=", flag "--pull-label=",
description: "Label name for pull requests ready to be pulled (default `pr-pull`)." description: "Label name for pull requests ready to be pulled (default: `pr-pull`)."
flag "--branch=", flag "--branch=",
description: "Initialize git repository with the specified branch name (default `main`)." description: "Initialize Git repository with the specified branch name (default: `main`)."
conflicts "--no-git", "--branch" conflicts "--no-git", "--branch"
named 1 named 1

44
Library/Homebrew/env_config.rb
View File

@ -12,7 +12,7 @@ module Homebrew
ENVS = { ENVS = {
HOMEBREW_ARCH: { HOMEBREW_ARCH: {
description: "Linux only: Pass the set value to a type name representing the compiler's `-march` option.", description: "Linux only: Pass this value to a type name representing the compiler's `-march` option.",
default: "native", default: "native",
}, },
HOMEBREW_ARTIFACT_DOMAIN: { HOMEBREW_ARTIFACT_DOMAIN: {
@ -30,8 +30,8 @@ module Homebrew
boolean: true, boolean: true,
}, },
HOMEBREW_BAT_CONFIG_PATH: { HOMEBREW_BAT_CONFIG_PATH: {
description: "Use the `bat` configuration file. For example, `HOMEBREW_BAT=$HOME/.bat/config`.", description: "Use this as the `bat` configuration file.",
default_text: "$HOME/.bat/config", default_text: "`$HOME/.bat/config`.",
}, },
HOMEBREW_BINTRAY_KEY: { HOMEBREW_BINTRAY_KEY: {
description: "Use this API key when accessing the Bintray API (where bottles are stored).", description: "Use this API key when accessing the Bintray API (where bottles are stored).",
@ -47,7 +47,7 @@ module Homebrew
default: HOMEBREW_BOTTLE_DEFAULT_DOMAIN, default: HOMEBREW_BOTTLE_DEFAULT_DOMAIN,
}, },
HOMEBREW_BREW_GIT_REMOTE: { HOMEBREW_BREW_GIT_REMOTE: {
description: "Use the specified URL as the Homebrew/brew `git`(1) remote.", description: "Use this URL as the Homebrew/brew `git`(1) remote.",
default: HOMEBREW_BREW_DEFAULT_GIT_REMOTE, default: HOMEBREW_BREW_DEFAULT_GIT_REMOTE,
}, },
HOMEBREW_BROWSER: { HOMEBREW_BROWSER: {
@ -55,13 +55,13 @@ module Homebrew
default_text: "`$BROWSER` or the OS's default browser.", default_text: "`$BROWSER` or the OS's default browser.",
}, },
HOMEBREW_CACHE: { HOMEBREW_CACHE: {
description: "Use the specified directory as the download cache.", description: "Use this directory as the download cache.",
default_text: "macOS: `$HOME/Library/Caches/Homebrew`, " \ default_text: "macOS: `$HOME/Library/Caches/Homebrew`, " \
"Linux: `$XDG_CACHE_HOME/Homebrew` or `$HOME/.cache/Homebrew`.", "Linux: `$XDG_CACHE_HOME/Homebrew` or `$HOME/.cache/Homebrew`.",
default: HOMEBREW_DEFAULT_CACHE, default: HOMEBREW_DEFAULT_CACHE,
}, },
HOMEBREW_CASK_OPTS: { HOMEBREW_CASK_OPTS: {
description: "Options which should be used for all `cask` commands. All `--*dir` options, " \ description: "Append these options to all `cask` commands. All `--*dir` options, " \
"`--language`, `--require-sha`, `--no-quarantine` and `--no-binaries` are supported." \ "`--language`, `--require-sha`, `--no-quarantine` and `--no-binaries` are supported." \
"\n" \ "\n" \
"For example, you might add something like the following to your " \ "For example, you might add something like the following to your " \
@ -77,7 +77,7 @@ module Homebrew
boolean: true, boolean: true,
}, },
HOMEBREW_CORE_GIT_REMOTE: { HOMEBREW_CORE_GIT_REMOTE: {
description: "Use the specified URL as the Homebrew/homebrew-core `git`(1) remote.", description: "Use this URL as the Homebrew/homebrew-core `git`(1) remote.",
default_text: "macOS: `https://github.com/Homebrew/homebrew-core`, " \ default_text: "macOS: `https://github.com/Homebrew/homebrew-core`, " \
"Linux: `https://github.com/Homebrew/linuxbrew-core`.", "Linux: `https://github.com/Homebrew/linuxbrew-core`.",
default: HOMEBREW_CORE_DEFAULT_GIT_REMOTE, default: HOMEBREW_CORE_DEFAULT_GIT_REMOTE,
@ -127,7 +127,7 @@ module Homebrew
}, },
HOMEBREW_FORBIDDEN_LICENSES: { HOMEBREW_FORBIDDEN_LICENSES: {
description: "A space-separated list of licenses. Homebrew will refuse to install a " \ description: "A space-separated list of licenses. Homebrew will refuse to install a " \
"formula if that formula or any of its dependencies has a license on this list.", "formula if it or any of its dependencies has a license on this list.",
}, },
HOMEBREW_FORCE_BREWED_CURL: { HOMEBREW_FORCE_BREWED_CURL: {
description: "If set, always use a Homebrew-installed `curl`(1) rather than the system version. " \ description: "If set, always use a Homebrew-installed `curl`(1) rather than the system version. " \
@ -166,10 +166,10 @@ module Homebrew
"such as `brew search`. This is deprecated in favour of using `HOMEBREW_GITHUB_API_TOKEN`.", "such as `brew search`. This is deprecated in favour of using `HOMEBREW_GITHUB_API_TOKEN`.",
}, },
HOMEBREW_GIT_EMAIL: { HOMEBREW_GIT_EMAIL: {
description: "Set the Git author and committer name to this value.", description: "Set the Git author and committer email to this value.",
}, },
HOMEBREW_GIT_NAME: { HOMEBREW_GIT_NAME: {
description: "Set the Git author and committer email to this value.", description: "Set the Git author and committer name to this value.",
}, },
HOMEBREW_INSTALL_BADGE: { HOMEBREW_INSTALL_BADGE: {
description: "Print this text before the installation summary of each successful build.", description: "Print this text before the installation summary of each successful build.",
@ -177,13 +177,13 @@ module Homebrew
default: "🍺", default: "🍺",
}, },
HOMEBREW_LIVECHECK_WATCHLIST: { HOMEBREW_LIVECHECK_WATCHLIST: {
description: "Use this file to get the list of default Formulae to check when no Formula argument " \ description: "Consult this file for the list of formulae to check by default when no formula argument " \
"is passed to `brew livecheck`", "is passed to `brew livecheck`.",
default: "$HOME/.brew_livecheck_watchlist", default: "$HOME/.brew_livecheck_watchlist",
}, },
HOMEBREW_LOGS: { HOMEBREW_LOGS: {
description: "Use the specified directory to store log files.", description: "Use this directory to store log files.",
default_text: "macOS: `$HOME/Library/Logs/Homebrew`, "\ default_text: "macOS: `$HOME/Library/Logs/Homebrew`, " \
"Linux: `$XDG_CACHE_HOME/Homebrew/Logs` or `$HOME/.cache/Homebrew/Logs`.", "Linux: `$XDG_CACHE_HOME/Homebrew/Logs` or `$HOME/.cache/Homebrew/Logs`.",
default: HOMEBREW_DEFAULT_LOGS, default: HOMEBREW_DEFAULT_LOGS,
}, },
@ -197,7 +197,7 @@ module Homebrew
}, },
}, },
HOMEBREW_NO_ANALYTICS: { HOMEBREW_NO_ANALYTICS: {
description: "If set, do not send analytics. See: <https://docs.brew.sh/Analytics>.", description: "If set, do not send analytics. For more information, see: <https://docs.brew.sh/Analytics>",
boolean: true, boolean: true,
}, },
HOMEBREW_NO_AUTO_UPDATE: { HOMEBREW_NO_AUTO_UPDATE: {
@ -226,18 +226,18 @@ module Homebrew
}, },
HOMEBREW_NO_EMOJI: { HOMEBREW_NO_EMOJI: {
description: "If set, do not print `HOMEBREW_INSTALL_BADGE` on a successful build." \ description: "If set, do not print `HOMEBREW_INSTALL_BADGE` on a successful build." \
"\n\n *Note:* Only tries to print emoji on OS X Lion or newer.", "\n\n *Note:* Will only try to print emoji on OS X Lion or newer.",
boolean: true, boolean: true,
}, },
HOMEBREW_NO_GITHUB_API: { HOMEBREW_NO_GITHUB_API: {
description: "If set, do not use the GitHub API, e.g. for searches or fetching relevant issues " \ description: "If set, do not use the GitHub API, e.g. for searches or fetching relevant issues " \
"on a failed install.", "after a failed install.",
boolean: true, boolean: true,
}, },
HOMEBREW_NO_INSECURE_REDIRECT: { HOMEBREW_NO_INSECURE_REDIRECT: {
description: "If set, forbid redirects from secure HTTPS to insecure HTTP." \ description: "If set, forbid redirects from secure HTTPS to insecure HTTP." \
"\n\n *Note:* While ensuring your downloads are fully secure, this is likely to cause " \ "\n\n *Note:* While ensuring your downloads are fully secure, this is likely to cause " \
"from-source SourceForge, some GNU & GNOME based formulae to fail to download.", "from-source SourceForge, some GNU & GNOME-hosted formulae to fail to download.",
boolean: true, boolean: true,
}, },
HOMEBREW_NO_INSTALL_CLEANUP: { HOMEBREW_NO_INSTALL_CLEANUP: {
@ -250,12 +250,12 @@ module Homebrew
boolean: true, boolean: true,
}, },
HOMEBREW_SKIP_OR_LATER_BOTTLES: { HOMEBREW_SKIP_OR_LATER_BOTTLES: {
description: "If set with `HOMEBREW_DEVELOPER`, do not use bottles from older versions " \ description: "If set along with `HOMEBREW_DEVELOPER`, do not use bottles from older versions " \
"of macOS. This is useful in development on new macOS versions.", "of macOS. This is useful in development on new macOS versions.",
boolean: true, boolean: true,
}, },
HOMEBREW_SORBET_RUNTIME: { HOMEBREW_SORBET_RUNTIME: {
description: "Enable runtime typechecking using Sorbet.", description: "If set, enable runtime typechecking using Sorbet.",
boolean: true, boolean: true,
}, },
HOMEBREW_SVN: { HOMEBREW_SVN: {
@ -272,7 +272,7 @@ module Homebrew
default: HOMEBREW_DEFAULT_TEMP, default: HOMEBREW_DEFAULT_TEMP,
}, },
HOMEBREW_UPDATE_REPORT_ONLY_INSTALLED: { HOMEBREW_UPDATE_REPORT_ONLY_INSTALLED: {
description: "If set, `brew update` only outputs updates to installed software.", description: "If set, `brew update` only lists updates to installed software.",
boolean: true, boolean: true,
}, },
HOMEBREW_UPDATE_TO_TAG: { HOMEBREW_UPDATE_TO_TAG: {
@ -310,7 +310,7 @@ module Homebrew
"from proxying by `curl`(1), `git`(1) and `svn`(1) when downloading through Homebrew.", "from proxying by `curl`(1), `git`(1) and `svn`(1) when downloading through Homebrew.",
}, },
SUDO_ASKPASS: { SUDO_ASKPASS: {
description: "When this variable is set, the `-A` option is passed when calling `sudo`(8)", description: "If set, pass the `-A` option when calling `sudo`(8).",
}, },
}.freeze }.freeze