Skip to content

Commit

Permalink
Update the manpage
Browse files Browse the repository at this point in the history
  • Loading branch information
alebcay committed Mar 4, 2014
1 parent 9082eb4 commit a8c7360
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 15 deletions.
16 changes: 11 additions & 5 deletions cooler.7
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
\fBcooler\fR \- import and export homebrew settings
.
.SH "SYNOPSIS"
\fBcooler [action] name_of_cooler_bundle <flags>\fR
\fBcooler [action] /path/to/cooler/bundle\.cb <flags>\fR
.
.SH "ACTIONS AND FLAGS"
Actions:
Expand All @@ -19,6 +19,9 @@ Actions:
\fBexport\fR \- Exports the packages from a cooler bundle
.
.IP "\(bu" 4
\fBlist\fR \- Lists contents of a cooler bundle
.
.IP "\(bu" 4
\fBupdate\fR \- Updates Cooler to the latest version available
.
.IP "" 0
Expand All @@ -38,16 +41,19 @@ Flags:
.IP "" 0
.
.SH "EXAMPLES"
\fBcooler import bundle \-\-no\-brew\fR
\fBcooler import /foo/bar/bundle\.cb \-\-no\-brew\fR
.
.P
\fBcooler export /foo/bar/bundle\.cb \-\-no\-port\fR
.
.P
\fBcooler import bundle \-\-no\-ports\fR
\fBcooler list /foo/bar/bundle\.cb\fR
.
.P
where the bundle file is named \fBbundle\.cb\fR located in the current working directory\. No support for other directories at this time\.
where the bundle file is named \fBbundle\.cb\fR located in the current working directory\.
.
.SH "DESCRIPTION"
cooler is a tool for importing and exporting the list of Homebrew taps, Homebrew packages currently installed, and Homebrew Cask applications\. Three records containing this information is then compressed with with GZip and the resulting file with \fB\.cb\fR extension can be transferred to another computer, and then be imported to install the packages on the first computer onto other computers\.
.
.SH "INTERNAL PACKAGE STRUCTURE"
cooler bundles are stored in \fB\.cb\fR files (short for \fBC\fRooler \fBB\fRundle), which are secretly just \fB\.tar\.gz\fR archives, but a custom extension is used to avoid accidental decompression and tampering\. cooler bundles contain three \fB\.cr\fR files: \fBbrew\.cr\fR, \fBcask\.cr\fR, and \fBtap\.cr\fR (\fB\.cr\fR is short for \fBC\fRooler \fBR\fResource)\. Each contains a list of packages (or taps) installed on the machine at export time\. The files are then compressed and bundled\.
cooler bundles are stored in \fB\.cb\fR files (short for \fBC\fRooler \fBB\fRundle), which are secretly just \fB\.tar\.gz\fR archives, but a custom extension is used to avoid accidental decompression and tampering\. cooler bundles contain four \fB\.cr\fR files: \fBbrew\.cr\fR, \fBcask\.cr\fR, \fBtap\.cr\fR, and \fBport\.cr\fR (\fB\.cr\fR is short for \fBC\fRooler \fBR\fResource)\. Each contains a list of packages (or taps) installed on the machine at export time\. The files are then compressed and bundled\.
13 changes: 8 additions & 5 deletions cooler.7.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 9 additions & 5 deletions cooler.7.ronn
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ cooler(7) -- import and export homebrew settings

## SYNOPSIS

`cooler [action] name_of_cooler_bundle <flags>`
`cooler [action] /path/to/cooler/bundle.cb <flags>`

## ACTIONS AND FLAGS

Expand All @@ -13,6 +13,8 @@ Actions:

* `export` - Exports the packages from a cooler bundle

* `list` - Lists contents of a cooler bundle

* `update` - Updates Cooler to the latest version available

Flags:
Expand All @@ -25,16 +27,18 @@ Flags:

## EXAMPLES

`cooler import bundle --no-brew`
`cooler import /foo/bar/bundle.cb --no-brew`

`cooler export /foo/bar/bundle.cb --no-port`

`cooler import bundle --no-ports`
`cooler list /foo/bar/bundle.cb`

where the bundle file is named `bundle.cb` located in the current working directory. No support for other directories at this time.
where the bundle file is named `bundle.cb` located in the current working directory.

## DESCRIPTION

cooler is a tool for importing and exporting the list of Homebrew taps, Homebrew packages currently installed, and Homebrew Cask applications. Three records containing this information is then compressed with with GZip and the resulting file with `.cb` extension can be transferred to another computer, and then be imported to install the packages on the first computer onto other computers.

## INTERNAL PACKAGE STRUCTURE

cooler bundles are stored in `.cb` files (short for **C**ooler **B**undle), which are secretly just `.tar.gz` archives, but a custom extension is used to avoid accidental decompression and tampering. cooler bundles contain three `.cr` files: `brew.cr`, `cask.cr`, and `tap.cr` (`.cr` is short for **C**ooler **R**esource). Each contains a list of packages (or taps) installed on the machine at export time. The files are then compressed and bundled.
cooler bundles are stored in `.cb` files (short for **C**ooler **B**undle), which are secretly just `.tar.gz` archives, but a custom extension is used to avoid accidental decompression and tampering. cooler bundles contain four `.cr` files: `brew.cr`, `cask.cr`, `tap.cr`, and `port.cr` (`.cr` is short for **C**ooler **R**esource). Each contains a list of packages (or taps) installed on the machine at export time. The files are then compressed and bundled.

0 comments on commit a8c7360

Please sign in to comment.