diff options
| author | Adam Vandenberg | 2011-05-27 22:09:35 -0700 |
|---|---|---|
| committer | Adam Vandenberg | 2011-05-27 22:09:35 -0700 |
| commit | beb4eff5bf19110affe81d04c3cfc90edc2fa2ca (patch) | |
| tree | 01ffab0fa76d2c2a379ac74b533c9f122077147a /share/man | |
| parent | d854b04b82b8387ecdf734c413836d87b9ccedee (diff) | |
| download | homebrew-beb4eff5bf19110affe81d04c3cfc90edc2fa2ca.tar.bz2 | |
Document audit return code
Diffstat (limited to 'share/man')
| -rw-r--r-- | share/man/man1/brew-man.1 | 2 | ||||
| -rw-r--r-- | share/man/man1/brew.1 | 10 |
2 files changed, 9 insertions, 3 deletions
diff --git a/share/man/man1/brew-man.1 b/share/man/man1/brew-man.1 index 24bd05a4e..bbf4194f2 100644 --- a/share/man/man1/brew-man.1 +++ b/share/man/man1/brew-man.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "BREW\-MAN" "1" "March 2011" "Homebrew" "brew" +.TH "BREW\-MAN" "1" "May 2011" "Homebrew" "brew" . .SH "NAME" \fBbrew\-man\fR \- Generate man pages for Homebrew diff --git a/share/man/man1/brew.1 b/share/man/man1/brew.1 index 2b5f928a2..1a811bd22 100644 --- a/share/man/man1/brew.1 +++ b/share/man/man1/brew.1 @@ -190,12 +190,18 @@ If \fB\-\-force\fR is passed, remove a previously cached version and re\-fetch\. If \fB\-\-deps\fR is passed, also download dependencies for any listed \fIformulae\fR\. . .TP -\fBaudit [\-\-strict]\fR -Check formulae for Homebrew coding style violations\. This should be run before submitting a new formula for inclusion\. +\fBaudit [\-\-strict]\fR [\fIformulae\fR] +Check \fIformulae\fR for Homebrew coding style violations\. This should be run before submitting a new formula\. +. +.IP +If no \fIformulae\fR are provided, all of them are checked\. . .IP If \fB\-\-strict\fR is passed, perform additional stricter checks that may not need to be fixed before submitting\. . +.IP +\fBaudit\fR exits with a non\-zero status if any errors are found\. This is useful, for instance, for implementing pre\-commit hooks\. +. .TP \fBoptions [\-\-compact] [\-\-all]\fR \fIformula\fR Display install options specific to \fIformula\fR\. |