From 19f3acea41956ac87714f0ebbfa925b16b6ecbf2 Mon Sep 17 00:00:00 2001 From: EricFromCanada Date: Thu, 12 Nov 2020 11:55:42 -0500 Subject: [PATCH] manpage: update instructions & description in template file --- Library/Homebrew/manpages/brew.1.md.erb | 40 ++++++++++++++----------- 1 file changed, 23 insertions(+), 17 deletions(-) diff --git a/Library/Homebrew/manpages/brew.1.md.erb b/Library/Homebrew/manpages/brew.1.md.erb index 6d4773cd77..98333ba688 100644 --- a/Library/Homebrew/manpages/brew.1.md.erb +++ b/Library/Homebrew/manpages/brew.1.md.erb @@ -1,16 +1,20 @@ <% # To make changes to this man page: # -# - For changes to a specific command (appears in the `COMMANDS` section): -# - Edit the top comment in `Library/Homebrew/cmd/.{rb,sh}`. -# - Make sure to use the line prefix `#:` for the comments to be recognized as -# documentation. If in doubt, compare with already documented commands. +# - For changes to a command under `COMMANDS` or `DEVELOPER COMMANDS` sections): +# - Find the source file in `Library/Homebrew/[dev-]cmd/.{rb,sh}`. +# - For `.rb` files, edit the `_args` method. +# - For `.sh` files, edit the top comment, being sure to use the line prefix +# `#:` for the comments to be recognized as documentation. If in doubt, +# compare with already documented commands. +# - For global options: Edit `Library/Homebrew/cli/parser.rb`. +# - For environment variables: Edit `Library/Homebrew/env_config.rb`. # - For other changes: Edit this file. # # When done, regenerate the man page and its HTML version by running `brew man`. %> -brew(1) -- The Missing Package Manager for macOS -================================================ +brew(1) -- The Missing Package Manager for macOS (or Linux) +=========================================================== ## SYNOPSIS @@ -20,21 +24,23 @@ brew(1) -- The Missing Package Manager for macOS ## DESCRIPTION Homebrew is the easiest and most flexible way to install the UNIX tools Apple -didn't include with macOS. +didn't include with macOS. It can also install software not packaged for your +Linux distribution to your home directory without requiring `sudo`. ## ESSENTIAL COMMANDS For the full command list, see the [COMMANDS](#commands) section. -With `--verbose` or `--debug`, many commands print extra debugging information. Note that -these options should only appear after a command. +With `--verbose` or `--debug`, many commands print extra debugging information. +Note that these options should only appear after a command. ### `install` : Install . - is usually the name of the formula to install, but it has other syntaxes which -are listed in the [SPECIFYING FORMULAE](#specifying-formulae) section. + is usually the name of the formula to install, but it has other +syntaxes which are listed in the [SPECIFYING FORMULAE](#specifying-formulae) +section. ### `uninstall` : @@ -46,8 +52,8 @@ List all installed formulae. ### `search` (|`/``/`): -Perform a substring search of cask tokens and formula names for . If -is flanked by slashes, it is interpreted as a regular expression. +Perform a substring search of cask tokens and formula names for . If + is flanked by slashes, it is interpreted as a regular expression. The search for is extended online to `homebrew/core` and `homebrew/cask`. If no search term is provided, all locally available formulae are listed. @@ -75,8 +81,8 @@ If no search term is provided, all locally available formulae are listed. Homebrew, like `git`(1), supports external commands. These are executable scripts that reside somewhere in the `PATH`, named `brew-` or -`brew-``.rb`, which can be invoked like `brew` . This allows you -to create your own commands without modifying Homebrew's internals. +`brew-``.rb`, which can be invoked like `brew` . This allows +you to create your own commands without modifying Homebrew's internals. Instructions for creating your own commands can be found in the docs: @@ -107,8 +113,8 @@ specified the same way as the arguments described in ## ENVIRONMENT -Note that environment variables must have a value set to be detected. For example, run -`export HOMEBREW_NO_INSECURE_REDIRECT=1` rather than just +Note that environment variables must have a value set to be detected. For +example, run `export HOMEBREW_NO_INSECURE_REDIRECT=1` rather than just `export HOMEBREW_NO_INSECURE_REDIRECT`. <%= environment_variables %>