diff options
Diffstat (limited to 'man/bundle-binstubs.ronn')
-rw-r--r-- | man/bundle-binstubs.ronn | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/man/bundle-binstubs.ronn b/man/bundle-binstubs.ronn new file mode 100644 index 0000000000..c1ae0988cd --- /dev/null +++ b/man/bundle-binstubs.ronn @@ -0,0 +1,43 @@ +bundle-binstubs(1) -- Install the binstubs of the listed gems +============================================================= + +## SYNOPSIS + +`bundle binstubs` <GEM_NAME> [--force] [--path PATH] [--standalone] + +## DESCRIPTION + +Binstubs are scripts that wrap around executables. Bundler creates a +small Ruby file (a binstub) that loads Bundler, runs the command, +and puts it into `bin/`. Binstubs are a shortcut-or alternative- +to always using `bundle exec`. This gives you a file that can by run +directly, and one that will always run the correct gem version +used by the application. + +For example, if you run `bundle binstubs rspec-core`, Bundler will create +the file `bin/rspec`. That file will contain enough code to load Bundler, +tell it to load the bundled gems, and then run rspec. + +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. + +* `--shebang`: + Specify a different shebang executable name than the default (default 'ruby') + +## 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.1.html). |