From 1dff2f141ca7398ade175d8a1da85df3fc561350 Mon Sep 17 00:00:00 2001 From: Caleb Xu Date: Sun, 29 Jul 2018 20:53:14 -0400 Subject: [PATCH] Add manpages/docs for extract command --- docs/Manpage.md | 12 ++++++++++++ manpages/brew.1 | 10 ++++++++++ 2 files changed, 22 insertions(+) diff --git a/docs/Manpage.md b/docs/Manpage.md index d716efd57a..b4268f7096 100644 --- a/docs/Manpage.md +++ b/docs/Manpage.md @@ -790,6 +790,18 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note * `edit` `formula`: 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`: Display the path where `formula` is located. diff --git a/manpages/brew.1 b/manpages/brew.1 index fee4bd3757..3c75e869e1 100644 --- a/manpages/brew.1 +++ b/manpages/brew.1 @@ -727,6 +727,16 @@ Open all of Homebrew for editing\. Open \fIformula\fR in the editor\. . .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 Display the path where \fIformula\fR is located\. .