summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
Diffstat (limited to 'lib')
-rw-r--r--lib/bundler/man/bundle-cache.130
-rw-r--r--lib/bundler/man/bundle-cache.1.ronn31
2 files changed, 59 insertions, 2 deletions
diff --git a/lib/bundler/man/bundle-cache.1 b/lib/bundler/man/bundle-cache.1
index 18281637f8..afe5e3beb5 100644
--- a/lib/bundler/man/bundle-cache.1
+++ b/lib/bundler/man/bundle-cache.1
@@ -4,11 +4,39 @@
.SH "NAME"
\fBbundle\-cache\fR \- Package your needed \fB\.gem\fR files into your application
.SH "SYNOPSIS"
-\fBbundle cache\fR
+\fBbundle cache\fR [\fIOPTIONS\fR]
.P
alias: \fBpackage\fR, \fBpack\fR
.SH "DESCRIPTION"
Copy all of the \fB\.gem\fR files needed to run the application into the \fBvendor/cache\fR directory\. In the future, when running \fBbundle install(1)\fR \fIbundle\-install\.1\.html\fR, use the gems in the cache in preference to the ones on \fBrubygems\.org\fR\.
+.SH "OPTIONS"
+.TP
+\fB\-\-all\fR
+Include all sources (including path and git)\.
+.TP
+\fB\-\-all\-platforms\fR
+Include gems for all platforms present in the lockfile, not only the current one\.
+.TP
+\fB\-\-cache\-path=CACHE\-PATH\fR
+Specify a different cache path than the default (vendor/cache)\.
+.TP
+\fB\-\-gemfile=GEMFILE\fR
+Use the specified gemfile instead of Gemfile\.
+.TP
+\fB\-\-no\-install\fR
+Don't install the gems, only update the cache\.
+.TP
+\fB\-\-no\-prune\fR
+Don't remove stale gems from the cache\.
+.TP
+\fB\-\-path=PATH\fR
+Specify a different path than the system default ($BUNDLE_PATH or $GEM_HOME)\.
+.TP
+\fB\-\-quiet\fR
+Only output warnings and errors\.
+.TP
+\fB\-\-frozen\fR
+Do not allow the Gemfile\.lock to be updated after this bundle cache operation's install\.
.SH "GIT AND PATH GEMS"
The \fBbundle cache\fR command can also package \fB:git\fR and \fB:path\fR dependencies besides \.gem files\. This needs to be explicitly enabled via the \fB\-\-all\fR option\. Once used, the \fB\-\-all\fR option will be remembered\.
.SH "SUPPORT FOR MULTIPLE PLATFORMS"
diff --git a/lib/bundler/man/bundle-cache.1.ronn b/lib/bundler/man/bundle-cache.1.ronn
index 8fb77cf61a..ffcc07c7b1 100644
--- a/lib/bundler/man/bundle-cache.1.ronn
+++ b/lib/bundler/man/bundle-cache.1.ronn
@@ -3,7 +3,7 @@ bundle-cache(1) -- Package your needed `.gem` files into your application
## SYNOPSIS
-`bundle cache`
+`bundle cache` [*OPTIONS*]
alias: `package`, `pack`
@@ -13,6 +13,35 @@ Copy all of the `.gem` files needed to run the application into the
`vendor/cache` directory. In the future, when running [`bundle install(1)`](bundle-install.1.html),
use the gems in the cache in preference to the ones on `rubygems.org`.
+## OPTIONS
+
+* `--all`:
+ Include all sources (including path and git).
+
+* `--all-platforms`:
+ Include gems for all platforms present in the lockfile, not only the current one.
+
+* `--cache-path=CACHE-PATH`:
+ Specify a different cache path than the default (vendor/cache).
+
+* `--gemfile=GEMFILE`:
+ Use the specified gemfile instead of Gemfile.
+
+* `--no-install`:
+ Don't install the gems, only update the cache.
+
+* `--no-prune`:
+ Don't remove stale gems from the cache.
+
+* `--path=PATH`:
+ Specify a different path than the system default ($BUNDLE_PATH or $GEM_HOME).
+
+* `--quiet`:
+ Only output warnings and errors.
+
+* `--frozen`:
+ Do not allow the Gemfile.lock to be updated after this bundle cache operation's install.
+
## GIT AND PATH GEMS
The `bundle cache` command can also package `:git` and `:path` dependencies