manpages: sentence rewording for readability

Use active voice when applicable, better verbs & adjectives, preposition usage, proper tense, etc.

Library/Homebrew/cmd/--env.rb

@@ -13,7 +13,7 @@ module Homebrew
       usage_banner <<~EOS
         `--env` [<options>]
 
-        Show a summary of the Homebrew build environment as a plain list.
+        Summarize Homebrew's build environment as a plain list.
 
         If the command's output is sent through a pipe and no shell is specified,
         the list is formatted for export to `bash`(1) unless `--plain` is passed.
@@ -22,7 +22,7 @@ module Homebrew
              description: "Generate a list of environment variables for the specified shell, " \
                           "or `--shell=auto` to detect the current shell."
       switch "--plain",
-             description: "Plain output even when piped."
+             description: "Generate plain output even when piped."
     end
   end
 

Library/Homebrew/cmd/--version.rb

@@ -11,7 +11,7 @@ module Homebrew
         `--version`
 
         Print the version numbers of Homebrew, Homebrew/homebrew-core and Homebrew/homebrew-cask
-        (if tapped) to standard output and exit.
+        (if tapped) to standard output.
       EOS
     end
   end

Library/Homebrew/cmd/analytics.rb

@@ -12,7 +12,7 @@ module Homebrew
 
         If `on` or `off` is passed, turn Homebrew's analytics on or off respectively.
 
-        If `state` is passed, display anonymous user behaviour analytics state.
+        If `state` is passed, display the current anonymous user behaviour analytics state.
         Read more at <https://docs.brew.sh/Analytics>.
 
         If `regenerate-uuid` is passed, regenerate the UUID used in Homebrew's analytics.

Library/Homebrew/cmd/cleanup.rb

@@ -11,9 +11,9 @@ module Homebrew
       usage_banner <<~EOS
         `cleanup` [<options>] [<formula>|<cask>]
 
-        Remove stale lock files and outdated downloads for formulae and casks,
+        Remove stale lock files and outdated downloads for all formulae and casks,
         and remove old versions of installed formulae. If arguments are specified,
-        only do this for the specified formulae and casks.
+        only do this for the given formulae and casks.
       EOS
       flag   "--prune=",
              description: "Remove all cache files older than specified <days>."

Library/Homebrew/cmd/command.rb

@@ -11,7 +11,7 @@ module Homebrew
       usage_banner <<~EOS
         `command` <cmd>
 
-        Display the path to the file which is used when invoking `brew` <cmd>.
+        Display the path to the file being used when invoking `brew` <cmd>.
       EOS
       switch :verbose
       switch :debug

Library/Homebrew/cmd/commands.rb

@@ -16,7 +16,7 @@ module Homebrew
              description: "List only the names of commands without category headers."
       switch "--include-aliases",
              depends_on:  "--quiet",
-             description: "Include the aliases of internal commands."
+             description: "Include aliases of internal commands."
       switch :verbose
       switch :debug
     end

Library/Homebrew/cmd/deps.rb

@@ -17,7 +17,7 @@ module Homebrew
         show the intersection of dependencies for each formula.
       EOS
       switch "-n",
-             description: "Show dependencies in topological order."
+             description: "Sort dependencies in topological order."
       switch "--1",
              description: "Only show dependencies one level down, instead of recursing."
       switch "--union",
@@ -47,7 +47,7 @@ module Homebrew
              description: "List dependencies for all available formulae."
       switch "--for-each",
              description: "Switch into the mode used by the `--all` option, but only list dependencies "\
-                          "for the specified <formula>, one formula per line. This is used for "\
+                          "for each provided <formula>, one formula per line. This is used for "\
                           "debugging the `--installed`/`--all` display mode."
       switch :verbose
       switch :debug

Library/Homebrew/cmd/desc.rb

@@ -20,13 +20,13 @@ module Homebrew
         first search, making that search slower than subsequent ones.
       EOS
       flag   "-s", "--search=",
-             description: "Search both name and description for provided <text>. If <text> is flanked by "\
+             description: "Search both names and descriptions for <text>. If <text> is flanked by "\
                           "slashes, it is interpreted as a regular expression."
       flag   "-n", "--name=",
-             description: "Search just the names for provided <text>. If <text> is flanked by slashes, it is "\
+             description: "Search just names for <text>. If <text> is flanked by slashes, it is "\
                           "interpreted as a regular expression."
       flag   "-d", "--description=",
-             description: "Search just the descriptions for provided <text>. If <text> is flanked by slashes, "\
+             description: "Search just descriptions for <text>. If <text> is flanked by slashes, "\
                           "it is interpreted as a regular expression."
       switch :verbose
       conflicts "--search=", "--name=", "--description="

Library/Homebrew/cmd/diy.rb

@@ -16,9 +16,9 @@ module Homebrew
         the Cellar and then link it into Homebrew's prefix with `brew link`.
       EOS
       flag   "--name=",
-             description: "Explicitly set the provided <name> of the package being installed."
+             description: "Explicitly set the <name> of the package being installed."
       flag   "--version=",
-             description: "Explicitly set the provided <version> of the package being installed."
+             description: "Explicitly set the <version> of the package being installed."
       switch :verbose
       switch :debug
     end

Library/Homebrew/cmd/doctor.rb

@@ -11,7 +11,7 @@ module Homebrew
       usage_banner <<~EOS
         `doctor` [<options>]
 
-        Check your system for potential problems. Doctor exits with a non-zero status
+        Check your system for potential problems. Will exit with a non-zero status
         if any potential problems are found. Please note that these warnings are just
         used to help the Homebrew maintainers with debugging if you file an issue. If
         everything you use Homebrew for is working fine: please don't worry or file

Library/Homebrew/cmd/fetch.rb

@@ -25,10 +25,10 @@ module Homebrew
              description: "Do a verbose VCS checkout, if the URL represents a VCS. This is useful for "\
                           "seeing if an existing VCS cache has been updated."
       switch "--retry",
-             description: "Retry if a download fails or re-download if the checksum of a previously cached "\
+             description: "Retry if downloading fails or re-download if the checksum of a previously cached "\
                           "version no longer matches."
       switch "--deps",
-             description: "Download dependencies for any listed <formula>."
+             description: "Also download dependencies for any listed <formula>."
       switch "-s", "--build-from-source",
              description: "Download source packages rather than a bottle."
       switch "--build-bottle",

Library/Homebrew/cmd/gist-logs.rb

@@ -15,18 +15,17 @@ module Homebrew
       usage_banner <<~EOS
         `gist-logs` [<options>] <formula>
 
-        Upload logs for a failed build of <formula> to a new Gist.
-
-        If no logs are found, an error message is presented.
+        Upload logs for a failed build of <formula> to a new Gist. Presents an
+        error message if no logs are found.
       EOS
       switch "--with-hostname",
              description: "Include the hostname in the Gist."
       switch "-n", "--new-issue",
-             description: "Automatically create a new issue in the appropriate GitHub repository as "\
-                          "well as creating the Gist."
+             description: "Automatically create a new issue in the appropriate GitHub repository "\
+                          "after creating the Gist."
       switch "-p", "--private",
              description: "The Gist will be marked private and will not appear in listings but will "\
-                          "be accessible with the link."
+                          "be accessible with its link."
       switch :verbose
       switch :debug
     end

Library/Homebrew/cmd/home.rb

@@ -10,8 +10,8 @@ module Homebrew
       usage_banner <<~EOS
         `home` [<formula>]
 
-        Open <formula>'s homepage in a browser. If no formula is provided,
-        open Homebrew's own homepage in a browser.
+        Open <formula>'s homepage in a browser, or open Homebrew's own homepage
+        if no formula is provided.
       EOS
       switch :debug
     end

Library/Homebrew/cmd/info.rb

@@ -19,10 +19,10 @@ module Homebrew
 
         Display brief statistics for your Homebrew installation.
 
-        If <formula> is specified, show summary of information about <formula>.
+        If <formula> is provided, show summary of information about <formula>.
       EOS
       switch "--analytics",
-             description: "Display global Homebrew analytics data or, if specified, installation and "\
+             description: "List global Homebrew analytics data or, if specified, installation and "\
                           "build error data for <formula> (provided neither `HOMEBREW_NO_ANALYTICS` "\
                           "nor `HOMEBREW_NO_GITHUB_API` are set)."
       flag   "--days",
@@ -35,7 +35,7 @@ module Homebrew
                           "The value for <category> must be `install`, `install-on-request`, "\
                           "`cask-install`, `build-error` or `os-version`. The default is `install`."
       switch "--github",
-             description: "Open a browser to the GitHub source page for <formula>. "\
+             description: "Open the GitHub source page for <formula> in a browser. "\
                           "To view formula history locally: `brew log -p` <formula>"
       flag   "--json",
              description: "Print a JSON representation of <formula>. Currently the default and only accepted "\

Library/Homebrew/cmd/install.rb

@@ -20,7 +20,7 @@ module Homebrew
 
         Install <formula>. Additional options specific to <formula> may be appended to the command.
 
-        Unless `HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will be run for the
+        Unless `HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will then be run for the
         installed formulae or, every 30 days, for all formulae.
       EOS
       switch :debug,
@@ -37,16 +37,16 @@ module Homebrew
                           "using this flag."
       switch "--only-dependencies",
              description: "Install the dependencies with specified options but do not install the "\
-                          "specified formula."
+                          "formula itself."
       flag   "--cc=",
-             description: "Attempt to compile using provided <compiler>. <compiler> should be the "\
-                          "name of the compiler's executable, for instance `gcc-7` for GCC 7. "\
-                          "In order to use LLVM's clang, use `llvm_clang`. To specify the "\
-                          "Apple-provided clang, use `clang`. This option will only accept "\
+             description: "Attempt to compile using the specified <compiler>, which should be the "\
+                          "name of the compiler's executable, e.g. `gcc-7` for GCC 7. "\
+                          "In order to use LLVM's clang, specify `llvm_clang`. To use the "\
+                          "Apple-provided clang, specify `clang`. This option will only accept "\
                           "compilers that are provided by Homebrew or bundled with macOS. "\
                           "Please do not file issues if you encounter errors while using this option."
       switch "-s", "--build-from-source",
-             description: "Compile the specified <formula> from source even if a bottle is provided. "\
+             description: "Compile <formula> from source even if a bottle is provided. "\
                           "Dependencies will still be installed from bottles if they are available."
       switch "--force-bottle",
              description: "Install from a bottle if it exists for the current or newest version of "\
@@ -59,16 +59,16 @@ module Homebrew
              description: "If <formula> defines it, install the HEAD version, aka. master, trunk, unstable."
       switch "--fetch-HEAD",
              description: "Fetch the upstream repository to detect if the HEAD installation of the "\
-                          "formula is outdated. Otherwise, the repository's HEAD will be checked for "\
+                          "formula is outdated. Otherwise, the repository's HEAD will only be checked for "\
                           "updates when a new stable or development version has been released."
       switch "--keep-tmp",
-             description: "Don't delete the temporary files created during installation."
+             description: "Retain the temporary files created during installation."
       switch "--build-bottle",
              description: "Prepare the formula for eventual bottling during installation, skipping any "\
                           "post-install steps."
       flag   "--bottle-arch=",
              depends_on:  "--build-bottle",
-             description: "Optimise bottles for the given architecture rather than the oldest "\
+             description: "Optimise bottles for the specified architecture rather than the oldest "\
                           "architecture supported by the version of macOS the bottles are built on."
       switch :force,
              description: "Install without checking for previously installed keg-only or "\

Library/Homebrew/cmd/link.rb

@@ -12,15 +12,15 @@ module Homebrew
       usage_banner <<~EOS
         `link`, `ln` [<options>] <formula>
 
-        Symlink all of <formula>'s installed files into the Homebrew prefix. This
+        Symlink all of <formula>'s installed files into Homebrew's prefix. This
         is done automatically when you install formulae but can be useful for DIY
         installations.
       EOS
       switch "--overwrite",
-             description: "Delete files already existing in the prefix while linking."
+             description: "Delete files that already exist in the prefix while linking."
       switch "-n", "--dry-run",
-             description: "List all files which would be linked or deleted by "\
-                          "`brew link --overwrite`, but will not actually link or delete any files."
+             description: "List files which would be linked or deleted by "\
+                          "`brew link --overwrite` without actually linking or deleting any files."
       switch :force,
              description: "Allow keg-only formulae to be linked."
       switch :verbose

Library/Homebrew/cmd/list.rb

@@ -21,27 +21,27 @@ module Homebrew
                           "passed, other options (i.e. `-1`, `-l`, `-r` and `-t`) are passed to `ls`(1) "\
                           "which produces the actual output."
       switch "--unbrewed",
-             description: "List all files in the Homebrew prefix not installed by Homebrew."
+             description: "List files in Homebrew's prefix not installed by Homebrew."
       switch "--versions",
              description: "Show the version number for installed formulae, or only the specified "\
-                          "formulae if <formula> are given."
+                          "formulae if <formula> are provided."
       switch "--multiple",
              depends_on:  "--versions",
              description: "Only show formulae with multiple versions installed."
       switch "--pinned",
              description: "Show the versions of pinned formulae, or only the specified (pinned) "\
-                          "formulae if <formula> are given. See also `pin`, `unpin`."
+                          "formulae if <formula> are provided. See also `pin`, `unpin`."
       # passed through to ls
       switch "-1",
              description: "Force output to be one entry per line. " \
                           "This is the default when output is not to a terminal."
       switch "-l",
              description: "List in long format. If the output is to a terminal, "\
-                          "a total sum for all the file sizes is output on a line before the long listing."
+                          "a total sum for all the file sizes is printed before the long listing."
       switch "-r",
-             description: "Reverse the order of the sort to get the oldest entries first."
+             description: "Reverse the order of the sort to list the oldest entries first."
       switch "-t",
-             description: "Sort by time modified (most recently modified first)."
+             description: "Sort by time modified, listing most recently modified first."
       switch :verbose
       switch :debug
     end

Library/Homebrew/cmd/log.rb

@@ -15,11 +15,11 @@ module Homebrew
         if no formula is provided.
       EOS
       switch "-p", "-u", "--patch",
-             description: "Also output patch from commit."
+             description: "Also print patch from commit."
       switch "--stat",
-             description: "Also output diffstat from commit."
+             description: "Also print diffstat from commit."
       switch "--oneline",
-             description: "Output only one line per commit."
+             description: "Print only one line per commit."
       flag   "-1", "--max-count",
              description: "Print only one or a specified number of commits."
     end

Library/Homebrew/cmd/migrate.rb

@@ -15,7 +15,7 @@ module Homebrew
         packages.
       EOS
       switch :force,
-             description: "Treat installed <formula> and passed <formula> as if they are from "\
+             description: "Treat installed <formula> and provided <formula> as if they are from "\
                           "the same taps and migrate them anyway."
       switch :verbose
       switch :debug

Library/Homebrew/cmd/missing.rb

@@ -13,13 +13,12 @@ module Homebrew
       usage_banner <<~EOS
         `missing` [<options>] [<formula>]
 
-        Check the given <formula> for missing dependencies. If no <formula> are
-        given, check all installed brews.
-
-        `missing` exits with a non-zero status if any formulae are missing dependencies.
+        Check the given <formula> kegs for missing dependencies. If no <formula> are
+        provided, check all kegs. Will exit with a non-zero status if any kegs are found
+        to be missing dependencies.
       EOS
       comma_array "--hide",
-                  description: "Act as if none of the provided <hidden> are installed. <hidden> should be "\
+                  description: "Act as if none of the specified <hidden> are installed. <hidden> should be "\
                                "a comma-separated list of formulae."
       switch :verbose
       switch :debug