forked from Homebrew/legacy-homebrew
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Also, revise main man page, and update brew-man command to handle multiple input files.
- Loading branch information
Showing
5 changed files
with
289 additions
and
166 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
brew-man(1) -- Generate man pages for Homebrew | ||
============================================== | ||
|
||
## SYNOPSIS | ||
|
||
`brew man` [--verbose] | ||
`brew man` --link | ||
`brew man` --server | ||
|
||
## DESCRIPTION | ||
|
||
Generates man pages for Homebrew using [`ronn`][ronn]. | ||
|
||
`brew man` by itself updates the man pages from the source files. | ||
|
||
With `--link`, symlinks generated man pages to `share/man` under | ||
the Homebrew Prefix. | ||
|
||
With `--server`, starts ronn's dev server. | ||
|
||
|
||
[ronn]: http://rtomayko.github.com/ronn/ | ||
"Ronn" | ||
|
||
## OPTIONS | ||
* `-v`, `--verbose`: | ||
Run `man brew` after generating man pages. | ||
|
||
* `-l`, `--link`: | ||
Creates symlinks from the generated man pages to the Homebrew Prefix, | ||
typically `/usr/local`. Useful when Homebrew itself is not installed | ||
directly into `/usr/local`. | ||
|
||
* `-s`, `--server`: | ||
Starts ronn's test server. | ||
|
||
## SEE ALSO | ||
|
||
`brew`(1) | ||
|
||
## BUGS | ||
|
||
See Issues on GitHub: <http://github.com/mxcl/homebrew/issues> |
Oops, something went wrong.