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

manpage: update instructions & description in template file

Browse Source
This commit is contained in:
EricFromCanada 2020-11-12 11:55:42 -05:00
parent eb16624c5f
commit 19f3acea41
1 changed files with 23 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
Library/Homebrew/manpages/brew.1.md.erb
View File

@ -1,16 +1,20 @@
<% <%
# To make changes to this man page: # To make changes to this man page:
# #
# - For changes to a specific command (appears in the `COMMANDS` section): # - For changes to a command under `COMMANDS` or `DEVELOPER COMMANDS` sections):
# - Edit the top comment in `Library/Homebrew/cmd/<command>.{rb,sh}`. # - Find the source file in `Library/Homebrew/[dev-]cmd/<command>.{rb,sh}`.
# - Make sure to use the line prefix `#:` for the comments to be recognized as # - For `.rb` files, edit the `<command>_args` method.
# documentation. If in doubt, compare with already documented commands. # - 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. # - For other changes: Edit this file.
# #
# When done, regenerate the man page and its HTML version by running `brew man`. # 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 ## SYNOPSIS
@ -20,21 +24,23 @@ brew(1) -- The Missing Package Manager for macOS
## DESCRIPTION ## DESCRIPTION
Homebrew is the easiest and most flexible way to install the UNIX tools Apple 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 ## ESSENTIAL COMMANDS
For the full command list, see the [COMMANDS](#commands) section. For the full command list, see the [COMMANDS](#commands) section.
With `--verbose` or `--debug`, many commands print extra debugging information. Note that With `--verbose` or `--debug`, many commands print extra debugging information.
these options should only appear after a command. Note that these options should only appear after a command.
### `install` <formula>: ### `install` <formula>:
Install <formula>. Install <formula>.
<formula> is usually the name of the formula to install, but it has other syntaxes which <formula> is usually the name of the formula to install, but it has other
are listed in the [SPECIFYING FORMULAE](#specifying-formulae) section. syntaxes which are listed in the [SPECIFYING FORMULAE](#specifying-formulae)
section.
### `uninstall` <formula>: ### `uninstall` <formula>:
@ -46,8 +52,8 @@ List all installed formulae.
### `search` (<text>|`/`<text>`/`): ### `search` (<text>|`/`<text>`/`):
Perform a substring search of cask tokens and formula names for <text>. If <text> Perform a substring search of cask tokens and formula names for <text>. If
is flanked by slashes, it is interpreted as a regular expression. <text> is flanked by slashes, it is interpreted as a regular expression.
The search for <text> is extended online to `homebrew/core` and `homebrew/cask`. The search for <text> is extended online to `homebrew/core` and `homebrew/cask`.
If no search term is provided, all locally available formulae are listed. 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 Homebrew, like `git`(1), supports external commands. These are executable
scripts that reside somewhere in the `PATH`, named `brew-`<cmdname> or scripts that reside somewhere in the `PATH`, named `brew-`<cmdname> or
`brew-`<cmdname>`.rb`, which can be invoked like `brew` <cmdname>. This allows you `brew-`<cmdname>`.rb`, which can be invoked like `brew` <cmdname>. This allows
to create your own commands without modifying Homebrew's internals. you to create your own commands without modifying Homebrew's internals.
Instructions for creating your own commands can be found in the docs: Instructions for creating your own commands can be found in the docs:
<https://docs.brew.sh/External-Commands> <https://docs.brew.sh/External-Commands>
@ -107,8 +113,8 @@ specified the same way as the <formula> arguments described in
## ENVIRONMENT ## ENVIRONMENT
Note that environment variables must have a value set to be detected. For example, run Note that environment variables must have a value set to be detected. For
`export HOMEBREW_NO_INSECURE_REDIRECT=1` rather than just example, run `export HOMEBREW_NO_INSECURE_REDIRECT=1` rather than just
`export HOMEBREW_NO_INSECURE_REDIRECT`. `export HOMEBREW_NO_INSECURE_REDIRECT`.
<%= environment_variables %> <%= environment_variables %>