From 92a1fca6e407226491ef0a25d036ee842b8e2bf8 Mon Sep 17 00:00:00 2001 From: Andrew Janke Date: Sat, 5 Dec 2015 10:27:11 -0500 Subject: [PATCH] manpages: minor markup fixes Fixes a couple issues left behind by Homebrew/homebrew#46676. Closes Homebrew/homebrew#46706. Signed-off-by: Andrew Janke --- Library/Homebrew/manpages/brew.1.md | 10 +++++----- share/doc/homebrew/brew.1.html | 12 ++++++------ share/man/man1/brew.1 | 10 +++++----- 3 files changed, 16 insertions(+), 16 deletions(-) diff --git a/Library/Homebrew/manpages/brew.1.md b/Library/Homebrew/manpages/brew.1.md index 15f4b2add9..135561145e 100644 --- a/Library/Homebrew/manpages/brew.1.md +++ b/Library/Homebrew/manpages/brew.1.md @@ -189,7 +189,7 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note To view formula history locally: `brew log -p `. - * `info --json=`` (`--all`|`--installed`|`): + * `info --json=` (`--all`|`--installed`|): Print a JSON representation of . Currently the only accepted value for is `v1`. @@ -279,11 +279,11 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note If provided, `--local` will move them into the user's `~/Applications` directory instead of the system directory. It may need to be created, first. - * `ls`, `list` [`--full-name`] + * `ls`, `list` [`--full-name`]: List all installed formulae. If `--full-name` is passed, print formulae with full-qualified names. - * `ls`, `list --unbrewed` + * `ls`, `list --unbrewed`: List all files in the Homebrew prefix not installed by Homebrew. * `ls`, `list` [`--versions` [`--multiple`]] [`--pinned`] []: @@ -324,7 +324,7 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note If `--installed` is passed, show options for all installed formulae. - * `outdated` [`--quiet` | `--verbose` | `--json=v1` ]: + * `outdated` [`--quiet`|`--verbose`|`--json=v1`]: Show formulae that have an updated version available. By default, version information is displayed in interactive shells, and @@ -383,7 +383,7 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note + `tap` without arguments displays existing taps. - + `tap` `/`` taps a formula repository from GitHub using HTTPS. + + `tap` `/` taps a formula repository from GitHub using HTTPS. Since so many taps are hosted on GitHub, this command is a shortcut for `tap / https://github.com//homebrew-`. diff --git a/share/doc/homebrew/brew.1.html b/share/doc/homebrew/brew.1.html index e0e01df6f7..4a8b8bc2ec 100644 --- a/share/doc/homebrew/brew.1.html +++ b/share/doc/homebrew/brew.1.html @@ -168,7 +168,7 @@ Display information about formula.

Open a browser to the GitHub History page for formula formula.

To view formula history locally: brew log -p <formula>.

-

  • info --json=version(--all|--installed|formulae): +

  • info --json=version (--all|--installed|formulae): Print a JSON representation of formulae. Currently the only accepted value for version is v1.

    @@ -251,10 +251,10 @@ for easier access.

    If provided, --local will move them into the user's ~/Applications directory instead of the system directory. It may need to be created, first.

    • -

  • ls, list [--full-name] +

  • ls, list [--full-name]: List all installed formulae. If --full-name is passed, print formulae with full-qualified names.

    • -

  • ls, list --unbrewed +

  • ls, list --unbrewed: List all files in the Homebrew prefix not installed by Homebrew.

  • ls, list [--versions [--multiple]] [--pinned] [formulae]: List the installed files for formulae. Combined with --verbose, recursively @@ -289,7 +289,7 @@ spaces.

    If --all is passed, show options for all formulae.

    If --installed is passed, show options for all installed formulae.

    • -

  • outdated [--quiet | --verbose | --json=v1 ]: +

  • outdated [--quiet|--verbose|--json=v1]: Show formulae that have an updated version available.

    By default, version information is displayed in interactive shells, and @@ -338,9 +338,9 @@ in three ways.

    • tap without arguments displays existing taps.

      • -

    • tap user/repotaps a formula repository from GitHub using HTTPS. +

    • tap user/repo taps a formula repository from GitHub using HTTPS. Since so many taps are hosted on GitHub, this command is a shortcut for -tap user/repo https://github.com/user/homebrew-repo`.

      • +tap <user>/<repo> https://github.com/<user>/homebrew-<repo>.

    • tap user/repo URL taps a formula repository from anywhere, using any transport protocol that git handles. The one-argument form of tap simplifies but also limits. This two-argument command makes no diff --git a/share/man/man1/brew.1 b/share/man/man1/brew.1 index f7cb73ef85..391bf0a94c 100644 --- a/share/man/man1/brew.1 +++ b/share/man/man1/brew.1 @@ -188,7 +188,7 @@ If \fB\-\-force\-bottle\fR is passed, download a bottle if it exists for the cur To view formula history locally: \fBbrew log \-p \fR\. . .IP "\(bu" 4 -\fBinfo \-\-json=\fR\fIversion\fR\fB(\fR\-\-all\fB|\fR\-\-installed\fB|\fR\fIformulae\fR): Print a JSON representation of \fIformulae\fR\. Currently the only accepted value for \fIversion\fR is \fBv1\fR\. +\fBinfo \-\-json=\fR\fIversion\fR (\fB\-\-all\fR|\fB\-\-installed\fR|\fIformulae\fR): Print a JSON representation of \fIformulae\fR\. Currently the only accepted value for \fIversion\fR is \fBv1\fR\. . .IP Pass \fB\-\-all\fR to get information on all formulae, or \fB\-\-installed\fR to get information on all installed formulae\. @@ -272,10 +272,10 @@ If no \fIformulae\fR are provided, all of them will have their \.apps symlinked\ If provided, \fB\-\-local\fR will move them into the user\'s \fB~/Applications\fR directory instead of the system directory\. It may need to be created, first\. . .IP "\(bu" 4 -\fBls\fR, \fBlist\fR [\fB\-\-full\-name\fR] List all installed formulae\. If \fB\-\-full\-name\fR is passed, print formulae with full\-qualified names\. +\fBls\fR, \fBlist\fR [\fB\-\-full\-name\fR]: List all installed formulae\. If \fB\-\-full\-name\fR is passed, print formulae with full\-qualified names\. . .IP "\(bu" 4 -\fBls\fR, \fBlist \-\-unbrewed\fR List all files in the Homebrew prefix not installed by Homebrew\. +\fBls\fR, \fBlist \-\-unbrewed\fR: List all files in the Homebrew prefix not installed by Homebrew\. . .IP "\(bu" 4 \fBls\fR, \fBlist\fR [\fB\-\-versions\fR [\fB\-\-multiple\fR]] [\fB\-\-pinned\fR] [\fIformulae\fR]: List the installed files for \fIformulae\fR\. Combined with \fB\-\-verbose\fR, recursively list the contents of all subdirectories in each \fIformula\fR\'s keg\. @@ -314,7 +314,7 @@ If \fB\-\-all\fR is passed, show options for all formulae\. If \fB\-\-installed\fR is passed, show options for all installed formulae\. . .IP "\(bu" 4 -\fBoutdated\fR [\fB\-\-quiet\fR | \fB\-\-verbose\fR | \fB\-\-json=v1\fR ]: Show formulae that have an updated version available\. +\fBoutdated\fR [\fB\-\-quiet\fR|\fB\-\-verbose\fR|\fB\-\-json=v1\fR]: Show formulae that have an updated version available\. . .IP By default, version information is displayed in interactive shells, and suppressed otherwise\. @@ -365,7 +365,7 @@ If \fB\-\-force\fR is passed, and there are multiple versions of \fIformula\fR i \fBtap\fR without arguments displays existing taps\. . .IP "\(bu" 4 -\fBtap\fR \fIuser\fR\fB/\fR\fIrepo\fR\fBtaps a formula repository from GitHub using HTTPS\. Since so many taps are hosted on GitHub, this command is a shortcut for\fRtap \fIuser\fR/\fIrepo\fR https://github\.com/\fIuser\fR/homebrew\-\fIrepo\fR`\. +\fBtap\fR \fIuser\fR\fB/\fR\fIrepo\fR taps a formula repository from GitHub using HTTPS\. Since so many taps are hosted on GitHub, this command is a shortcut for \fBtap / https://github\.com//homebrew\-\fR\. . .IP "\(bu" 4 \fBtap\fR \fIuser\fR\fB/\fR\fIrepo\fR \fIURL\fR taps a formula repository from anywhere, using any transport protocol that \fBgit\fR handles\. The one\-argument form of \fBtap\fR simplifies but also limits\. This two\-argument command makes no assumptions, so taps can be cloned from places other than GitHub and using protocols other than HTTPS, e\.g\., SSH, GIT, HTTP, FTP(S), RSYNC\.