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

Add manpages/docs for extract command

Browse Source
This commit is contained in:
Caleb Xu 2018-07-29 20:53:14 -04:00
parent 055460884b
commit 1dff2f141c
2 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/Manpage.md
View File

@ -790,6 +790,18 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
* `edit` `formula`: * `edit` `formula`:
Open `formula` in the editor. Open `formula` in the editor.
* `extract` [`--force`] [`--stdout`] `formula` `version` [`tap`]:
Looks through repository history to find the `version` of `formula` and
creates a copy in `tap`/Formula/`formula`@`version`.rb. If the tap is
not installed yet, attempts to install/clone the tap before continuing.
If `--force` is passed, the file at the destination will be overwritten
if it already exists. Otherwise, existing files will be preserved.
If `--stdout` is passed, the file will be written to stdout on the
terminal instead of written to a file. A `tap` cannot be passed when
using `--stdout`.
* `formula` `formula`: * `formula` `formula`:
Display the path where `formula` is located. Display the path where `formula` is located.

10
manpages/brew.1
View File

@ -727,6 +727,16 @@ Open all of Homebrew for editing\.
Open \fIformula\fR in the editor\. Open \fIformula\fR in the editor\.
. .
.TP .TP
\fBextract\fR [\fB\-\-force\fR] [\fB\-\-stdout\fR] \fIformula\fR \fIversion\fR [\fItap\fR]
Looks through repository history to find the \fIversion\fR of \fIformula\fR and creates a copy in \fItap\fR/Formula/\fIformula\fR@\fIversion\fR\.rb\. If the tap is not installed yet, attempts to install/clone the tap before continuing\.
.
.IP
If \fB\-\-force\fR is passed, the file at the destination will be overwritten if it already exists\. Otherwise, existing files will be preserved\.
.
.IP
If \fB\-\-stdout\fR is passed, the file will be written to stdout on the terminal instead of written to a file\. A \fItap\fR cannot be passed when using \fB\-\-stdout\fR\.
.
.TP
\fBformula\fR \fIformula\fR \fBformula\fR \fIformula\fR
Display the path where \fIformula\fR is located\. Display the path where \fIformula\fR is located\.
. .