summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHomu <homu@barosl.com>2016-08-09 04:12:30 +0900
committerHomu <homu@barosl.com>2016-08-09 04:12:30 +0900
commit086f79921378c6aaeb31a614ccf6a8862ea3acb3 (patch)
treec8b661a0cf3801c05b0f4dbd7cc6acd4d443851f
parente23ea1519cfd9164053cb0eca84c3447ed6a2d57 (diff)
parent7f4691a5427bd106833fc946526e5b7b831b4fbf (diff)
downloadbundler-086f79921378c6aaeb31a614ccf6a8862ea3acb3.tar.gz
Auto merge of #4847 - Zorbash:binstubs-manpage, r=indirect
Add manpage for bundle-binstubs This PR is intended to resolve https://github.com/bundler/bundler/issues/4000.
-rw-r--r--man/bundle-binstubs.ronn29
1 files changed, 29 insertions, 0 deletions
diff --git a/man/bundle-binstubs.ronn b/man/bundle-binstubs.ronn
new file mode 100644
index 0000000000..98dcce66e0
--- /dev/null
+++ b/man/bundle-binstubs.ronn
@@ -0,0 +1,29 @@
+bundle-binstubs(1) -- Install the binstubs of the listed gems
+=============================================================
+
+## SYNOPSIS
+
+`bundle binstubs` <GEM_NAME> [--force] [--path PATH] [--standalone]
+
+## DESCRIPTION
+
+This command generates binstubs for executables in `GEM_NAME`.
+Binstubs are put into `bin`, or the `--path` directory if one has been set.
+Calling binstubs with [GEM [GEM]] will create binstubs for all given gems.
+
+## OPTIONS
+
+* `--force`:
+ Overwrite existing binstubs if they exist.
+
+* `--path`:
+ The location to install the specified binstubs to. This defaults to `bin`.
+
+* `--standalone`:
+ Makes binstubs that can work without depending on Rubygems or Bundler at
+ runtime.
+
+## BUNDLE INSTALL --BINSTUBS
+
+To create binstubs for all the gems in the bundle you can use the `--binstubs`
+flag in [bundle install(1)][bundle-install].