diff options
| author | hsbt <hsbt@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2019-04-14 06:01:35 +0000 |
|---|---|---|
| committer | hsbt <hsbt@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2019-04-14 06:01:35 +0000 |
| commit | 68ddd4d300e9a88737c4f37af74e1a0312949b2f (patch) | |
| tree | 787e1e83d76934ce039eb336995a8d5bb53a89e6 /man | |
| parent | d636809c057432e8d42abe30c6c6785eb0721d77 (diff) | |
| download | ruby-68ddd4d300e9a88737c4f37af74e1a0312949b2f.tar.gz | |
Merge Bundler 2.1.0.pre.1 as developed version from upstream.
https://github.com/bundler/bundler/commit/a53709556b95a914e874b22ed2116a46b0528852
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@67539 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'man')
56 files changed, 1412 insertions, 1382 deletions
diff --git a/man/bundle-add.1 b/man/bundle-add.1 index 3adf3e8163..e7ef637458 100644 --- a/man/bundle-add.1 +++ b/man/bundle-add.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "BUNDLE\-ADD" "1" "November 2018" "" "" +.TH "BUNDLE\-ADD" "1" "March 2019" "" "" . .SH "NAME" \fBbundle\-add\fR \- Add gem to the Gemfile and run bundle install diff --git a/man/bundle-add.1.txt b/man/bundle-add.1.txt index ccc101a552..59c4b82c49 100644 --- a/man/bundle-add.1.txt +++ b/man/bundle-add.1.txt @@ -2,16 +2,16 @@ BUNDLE-ADD(1) BUNDLE-ADD(1) -1mNAME0m - 1mbundle-add 22m- Add gem to the Gemfile and run bundle install +NAME + bundle-add - Add gem to the Gemfile and run bundle install -1mSYNOPSIS0m - 1mbundle add 4m22mGEM_NAME24m [--group=GROUP] [--version=VERSION] +SYNOPSIS + bundle add GEM_NAME [--group=GROUP] [--version=VERSION] [--source=SOURCE] [--skip-install] [--strict] [--optimistic] -1mDESCRIPTION0m - Adds the named gem to the Gemfile and run 1mbundle install22m. 1mbundle in-0m - 1mstall 22mcan be avoided by using the flag 1m--skip-install22m. +DESCRIPTION + Adds the named gem to the Gemfile and run bundle install. bundle + install can be avoided by using the flag --skip-install. Example: @@ -26,27 +26,27 @@ BUNDLE-ADD(1) BUNDLE-ADD(1) bundle add rails --group "development, test" -1mOPTIONS0m - 1m--version22m, 1m-v0m +OPTIONS + --version, -v Specify version requirements(s) for the added gem. - 1m--group22m, 1m-g0m + --group, -g Specify the group(s) for the added gem. Multiple groups should be separated by commas. - 1m--source22m, , 1m-s0m + --source, , -s Specify the source for the added gem. - 1m--skip-install0m + --skip-install Adds the gem to the Gemfile but does not install it. - 1m--optimistic0m + --optimistic Adds optimistic declaration of version - 1m--strict0m + --strict Adds strict declaration of version - November 2018 BUNDLE-ADD(1) + March 2019 BUNDLE-ADD(1) diff --git a/man/bundle-binstubs.1 b/man/bundle-binstubs.1 index 583ab83abc..884d0dc569 100644 --- a/man/bundle-binstubs.1 +++ b/man/bundle-binstubs.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "BUNDLE\-BINSTUBS" "1" "November 2018" "" "" +.TH "BUNDLE\-BINSTUBS" "1" "March 2019" "" "" . .SH "NAME" \fBbundle\-binstubs\fR \- Install the binstubs of the listed gems diff --git a/man/bundle-binstubs.1.txt b/man/bundle-binstubs.1.txt index f15a875e2d..3000d53876 100644 --- a/man/bundle-binstubs.1.txt +++ b/man/bundle-binstubs.1.txt @@ -2,47 +2,47 @@ BUNDLE-BINSTUBS(1) BUNDLE-BINSTUBS(1) -1mNAME0m - 1mbundle-binstubs 22m- Install the binstubs of the listed gems +NAME + bundle-binstubs - Install the binstubs of the listed gems -1mSYNOPSIS0m - 1mbundle binstubs 4m22mGEM_NAME24m [--force] [--path PATH] [--standalone] +SYNOPSIS + bundle binstubs GEM_NAME [--force] [--path PATH] [--standalone] -1mDESCRIPTION0m +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 1mbin/22m. Binstubs are a shortcut-or alternative- to always - using 1mbundle exec22m. This gives you a file that can by run directly, 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 applica- tion. - For example, if you run 1mbundle binstubs rspec-core22m, Bundler will create - the file 1mbin/rspec22m. That file will contain enough code to load Bundler, + 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 1mGEM_NAME22m. Binstubs - are put into 1mbin22m, or the 1m--path 22mdirectory if one has been set. Calling + 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. -1mOPTIONS0m - 1m--force0m +OPTIONS + --force Overwrite existing binstubs if they exist. - 1m--path 22mThe location to install the specified binstubs to. This defaults - to 1mbin22m. + --path The location to install the specified binstubs to. This defaults + to bin. - 1m--standalone0m + --standalone Makes binstubs that can work without depending on Rubygems or Bundler at runtime. - 1m--shebang0m + --shebang Specify a different shebang executable name than the default (default 'ruby') -1mBUNDLE INSTALL --BINSTUBS0m +BUNDLE INSTALL --BINSTUBS To create binstubs for all the gems in the bundle you can use the - 1m--binstubs 22mflag in bundle install(1) 4mbundle-install.1.html24m. + --binstubs flag in bundle install(1) bundle-install.1.html. - November 2018 BUNDLE-BINSTUBS(1) + March 2019 BUNDLE-BINSTUBS(1) diff --git a/man/bundle-check.1 b/man/bundle-check.1 index 35431972d5..1fedfb2c56 100644 --- a/man/bundle-check.1 +++ b/man/bundle-check.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "BUNDLE\-CHECK" "1" "November 2018" "" "" +.TH "BUNDLE\-CHECK" "1" "March 2019" "" "" . .SH "NAME" \fBbundle\-check\fR \- Verifies if dependencies are satisfied by installed gems diff --git a/man/bundle-check.1.txt b/man/bundle-check.1.txt index afb3fb84f6..02165ab885 100644 --- a/man/bundle-check.1.txt +++ b/man/bundle-check.1.txt @@ -2,32 +2,32 @@ BUNDLE-CHECK(1) BUNDLE-CHECK(1) -1mNAME0m - 1mbundle-check 22m- Verifies if dependencies are satisfied by installed gems +NAME + bundle-check - Verifies if dependencies are satisfied by installed gems -1mSYNOPSIS0m - 1mbundle check 22m[--dry-run] [--gemfile=FILE] [--path=PATH] +SYNOPSIS + bundle check [--dry-run] [--gemfile=FILE] [--path=PATH] -1mDESCRIPTION0m - 1mcheck 22msearches the local machine for each of the gems requested in the - Gemfile. If all gems are found, Bundler prints a success message and +DESCRIPTION + check searches the local machine for each of the gems requested in the + Gemfile. If all gems are found, Bundler prints a success message and exits with a status of 0. If not, the first missing gem is listed and Bundler exits status 1. -1mOPTIONS0m - 1m--dry-run0m - Locks the [1mGemfile(5)22m][Gemfile(5)] before running the command. +OPTIONS + --dry-run + Locks the [Gemfile(5)][Gemfile(5)] before running the command. - 1m--gemfile0m - Use the specified gemfile instead of the [1mGemfile(5)22m][Gem- + --gemfile + Use the specified gemfile instead of the [Gemfile(5)][Gem- file(5)]. - 1m--path 22mSpecify a different path than the system default (1m$BUNDLE_PATH0m - or 1m$GEM_HOME22m). Bundler will remember this value for future in- - stalls on this machine. + --path Specify a different path than the system default ($BUNDLE_PATH + or $GEM_HOME). Bundler will remember this value for future + installs on this machine. - November 2018 BUNDLE-CHECK(1) + March 2019 BUNDLE-CHECK(1) diff --git a/man/bundle-clean.1 b/man/bundle-clean.1 index 681f41effc..712b259372 100644 --- a/man/bundle-clean.1 +++ b/man/bundle-clean.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "BUNDLE\-CLEAN" "1" "November 2018" "" "" +.TH "BUNDLE\-CLEAN" "1" "March 2019" "" "" . .SH "NAME" \fBbundle\-clean\fR \- Cleans up unused gems in your bundler directory diff --git a/man/bundle-clean.1.txt b/man/bundle-clean.1.txt index f4b507db65..1cfda2150e 100644 --- a/man/bundle-clean.1.txt +++ b/man/bundle-clean.1.txt @@ -2,25 +2,25 @@ BUNDLE-CLEAN(1) BUNDLE-CLEAN(1) -1mNAME0m - 1mbundle-clean 22m- Cleans up unused gems in your bundler directory +NAME + bundle-clean - Cleans up unused gems in your bundler directory -1mSYNOPSIS0m - 1mbundle clean 22m[--dry-run] [--force] +SYNOPSIS + bundle clean [--dry-run] [--force] -1mDESCRIPTION0m +DESCRIPTION This command will remove all unused gems in your bundler directory. This is useful when you have made many changes to your gem dependen- cies. -1mOPTIONS0m - 1m--dry-run0m +OPTIONS + --dry-run Print the changes, but do not clean the unused gems. - 1m--force0m - Force a clean even if 1m--path 22mis not set. + --force + Force a clean even if --path is not set. - November 2018 BUNDLE-CLEAN(1) + March 2019 BUNDLE-CLEAN(1) diff --git a/man/bundle-config.1 b/man/bundle-config.1 index 9f6faa1201..6de75c0528 100644 --- a/man/bundle-config.1 +++ b/man/bundle-config.1 @@ -1,13 +1,13 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "BUNDLE\-CONFIG" "1" "January 2019" "" "" +.TH "BUNDLE\-CONFIG" "1" "April 2019" "" "" . .SH "NAME" \fBbundle\-config\fR \- Set bundler configuration options . .SH "SYNOPSIS" -\fBbundle config\fR [\fIname\fR [\fIvalue\fR]] +\fBbundle config\fR [list|get|set|unset] [\fIname\fR [\fIvalue\fR]] . .SH "DESCRIPTION" This command allows you to interact with Bundler\'s configuration system\. @@ -30,31 +30,37 @@ Bundler default config .IP "" 0 . .P -Executing \fBbundle config\fR with no parameters will print a list of all bundler configuration for the current bundle, and where that configuration was set\. +Executing \fBbundle config list\fR with will print a list of all bundler configuration for the current bundle, and where that configuration was set\. . .P -Executing \fBbundle config <name>\fR will print the value of that configuration setting, and where it was set\. +Executing \fBbundle config get <name>\fR will print the value of that configuration setting, and where it was set\. . .P -Executing \fBbundle config <name> <value>\fR will set that configuration to the value specified for all bundles executed as the current user\. The configuration will be stored in \fB~/\.bundle/config\fR\. If \fIname\fR already is set, \fIname\fR will be overridden and user will be warned\. +Executing \fBbundle config set <name> <value>\fR will set that configuration to the value specified for all bundles executed as the current user\. The configuration will be stored in \fB~/\.bundle/config\fR\. If \fIname\fR already is set, \fIname\fR will be overridden and user will be warned\. . .P -Executing \fBbundle config \-\-global <name> <value>\fR works the same as above\. +Executing \fBbundle config set \-\-global <name> <value>\fR works the same as above\. . .P -Executing \fBbundle config \-\-local <name> <value>\fR will set that configuration to the local application\. The configuration will be stored in \fBapp/\.bundle/config\fR\. +Executing \fBbundle config set \-\-local <name> <value>\fR will set that configuration to the local application\. The configuration will be stored in \fBapp/\.bundle/config\fR\. . .P -Executing \fBbundle config \-\-delete <name>\fR will delete the configuration in both local and global sources\. Not compatible with \-\-global or \-\-local flag\. +Executing \fBbundle config unset <name>\fR will delete the configuration in both local and global sources\. +. +.P +Executing \fBbundle config unset \-\-global <name>\fR will delete the configuration only from the user configuration\. +. +.P +Executing \fBbundle config unset \-\-local <name> <value>\fR will delete the configuration only from the local application\. . .P Executing bundle with the \fBBUNDLE_IGNORE_CONFIG\fR environment variable set will cause it to ignore all configuration\. . .P -Executing \fBbundle config disable_multisource true\fR upgrades the warning about the Gemfile containing multiple primary sources to an error\. Executing \fBbundle config \-\-delete disable_multisource\fR downgrades this error to a warning\. +Executing \fBbundle config set disable_multisource true\fR upgrades the warning about the Gemfile containing multiple primary sources to an error\. Executing \fBbundle config unset disable_multisource\fR downgrades this error to a warning\. . .SH "REMEMBERING OPTIONS" -Flags passed to \fBbundle install\fR or the Bundler runtime, such as \fB\-\-path foo\fR or \fB\-\-without production\fR, are not remembered between commands\. If these options must be remembered,they must be set using \fBbundle config\fR (e\.g\., \fBbundle config path foo\fR)\. +Flags passed to \fBbundle install\fR or the Bundler runtime, such as \fB\-\-path foo\fR or \fB\-\-without production\fR, are not remembered between commands\. If these options must be remembered, they must be set using \fBbundle config\fR (e\.g\., \fBbundle config set path foo\fR)\. . .P The options that can be configured are: @@ -102,7 +108,7 @@ Since the specific location of that executable can change from machine to machin . .nf -bundle config build\.mysql \-\-with\-mysql\-config=/usr/local/mysql/bin/mysql_config +bundle config set build\.mysql \-\-with\-mysql\-config=/usr/local/mysql/bin/mysql_config . .fi . @@ -175,7 +181,7 @@ The following is a list of all configuration keys and their purpose\. You can le \fBdisable_local_branch_check\fR (\fBBUNDLE_DISABLE_LOCAL_BRANCH_CHECK\fR): Allow Bundler to use a local git override without a branch specified in the Gemfile\. . .IP "\(bu" 4 -\fBdisable_multisource\fR (\fBBUNDLE_DISABLE_MULTISOURCE\fR): When set, Gemfiles containing multiple sources will produce errors instead of warnings\. Use \fBbundle config \-\-delete disable_multisource\fR to unset\. +\fBdisable_multisource\fR (\fBBUNDLE_DISABLE_MULTISOURCE\fR): When set, Gemfiles containing multiple sources will produce errors instead of warnings\. Use \fBbundle config unset disable_multisource\fR to unset\. . .IP "\(bu" 4 \fBdisable_platform_warnings\fR (\fBBUNDLE_DISABLE_PLATFORM_WARNINGS\fR): Disable warnings during bundle install when a dependency is unused on the current platform\. @@ -217,12 +223,6 @@ The following is a list of all configuration keys and their purpose\. You can le \fBjobs\fR (\fBBUNDLE_JOBS\fR): The number of gems Bundler can install in parallel\. Defaults to 1\. . .IP "\(bu" 4 -\fBlist_command\fR (\fBBUNDLE_LIST_COMMAND\fR) Enable new list command feature -. -.IP "\(bu" 4 -\fBmajor_deprecations\fR (\fBBUNDLE_MAJOR_DEPRECATIONS\fR): Whether Bundler should print deprecation warnings for behavior that will be changed in the next major version\. -. -.IP "\(bu" 4 \fBno_install\fR (\fBBUNDLE_NO_INSTALL\fR): Whether \fBbundle package\fR should skip installing gems\. . .IP "\(bu" 4 @@ -238,7 +238,7 @@ The following is a list of all configuration keys and their purpose\. You can le \fBpath\.system\fR (\fBBUNDLE_PATH__SYSTEM\fR): Whether Bundler will install gems into the default system path (\fBGem\.dir\fR)\. . .IP "\(bu" 4 -\fBpath_relative_to_cwd\fR (\fBPATH_RELATIVE_TO_CWD\fR) Makes \fB\-\-path\fR relative to the CWD instead of the \fBGemfile\fR\. +\fBpath_relative_to_cwd\fR (\fBBUNDLE_PATH_RELATIVE_TO_CWD\fR) Makes \fB\-\-path\fR relative to the CWD instead of the \fBGemfile\fR\. . .IP "\(bu" 4 \fBplugins\fR (\fBBUNDLE_PLUGINS\fR): Enable Bundler\'s experimental plugin system\. @@ -247,6 +247,9 @@ The following is a list of all configuration keys and their purpose\. You can le \fBprefer_gems_rb\fR (\fBBUNDLE_PREFER_GEMS_RB\fR) Prefer \fBgems\.rb\fR to \fBGemfile\fR when Bundler is searching for a Gemfile\. . .IP "\(bu" 4 +\fBprefer_patch\fR (BUNDLE_PREFER_PATCH): Prefer updating only to next patch version during updates\. Makes \fBbundle update\fR calls equivalent to \fBbundler update \-\-patch\fR\. +. +.IP "\(bu" 4 \fBprint_only_version_number\fR (\fBBUNDLE_PRINT_ONLY_VERSION_NUMBER\fR) Print only version number from \fBbundler \-\-version\fR\. . .IP "\(bu" 4 @@ -262,6 +265,9 @@ The following is a list of all configuration keys and their purpose\. You can le \fBshebang\fR (\fBBUNDLE_SHEBANG\fR): The program name that should be invoked for generated binstubs\. Defaults to the ruby install name used to generate the binstub\. . .IP "\(bu" 4 +\fBsilence_deprecations\fR (\fBBUNDLE_SILENCE_DEPRECATIONS\fR): Whether Bundler should silence deprecation warnings for behavior that will be changed in the next major version\. +. +.IP "\(bu" 4 \fBsilence_root_warning\fR (\fBBUNDLE_SILENCE_ROOT_WARNING\fR): Silence the warning Bundler prints when installing gems as root\. . .IP "\(bu" 4 @@ -318,7 +324,7 @@ Bundler also allows you to work against a git repository locally instead of usin . .nf -bundle config local\.GEM_NAME /path/to/local/git/repository +bundle config set local\.GEM_NAME /path/to/local/git/repository . .fi . @@ -331,7 +337,7 @@ For example, in order to use a local Rack repository, a developer could call: . .nf -bundle config local\.rack ~/Work/git/rack +bundle config set local\.rack ~/Work/git/rack . .fi . @@ -353,7 +359,7 @@ Bundler supports overriding gem sources with mirrors\. This allows you to config . .nf -bundle config mirror\.SOURCE_URL MIRROR_URL +bundle config set mirror\.SOURCE_URL MIRROR_URL . .fi . @@ -366,7 +372,7 @@ For example, to use a mirror of rubygems\.org hosted at rubygems\-mirror\.org: . .nf -bundle config mirror\.http://rubygems\.org http://rubygems\-mirror\.org +bundle config set mirror\.http://rubygems\.org http://rubygems\-mirror\.org . .fi . @@ -379,7 +385,7 @@ Each mirror also provides a fallback timeout setting\. If the mirror does not re . .nf -bundle config mirror\.SOURCE_URL\.fallback_timeout TIMEOUT +bundle config set mirror\.SOURCE_URL\.fallback_timeout TIMEOUT . .fi . @@ -392,7 +398,7 @@ For example, to fall back to rubygems\.org after 3 seconds: . .nf -bundle config mirror\.https://rubygems\.org\.fallback_timeout 3 +bundle config set mirror\.https://rubygems\.org\.fallback_timeout 3 . .fi . @@ -408,7 +414,7 @@ Bundler allows you to configure credentials for any gem source, which allows you . .nf -bundle config SOURCE_HOSTNAME USERNAME:PASSWORD +bundle config set SOURCE_HOSTNAME USERNAME:PASSWORD . .fi . @@ -421,7 +427,7 @@ For example, to save the credentials of user \fBclaudette\fR for the gem source . .nf -bundle config gems\.longerous\.com claudette:s00pers3krit +bundle config set gems\.longerous\.com claudette:s00pers3krit . .fi . @@ -447,7 +453,7 @@ For gems with a git source with HTTP(S) URL you can specify credentials like so: . .nf -bundle config https://github\.com/bundler/bundler\.git username:password +bundle config set https://github\.com/bundler/bundler\.git username:password . .fi . diff --git a/man/bundle-config.1.txt b/man/bundle-config.1.txt index 648edc1b0c..86deec54b5 100644 --- a/man/bundle-config.1.txt +++ b/man/bundle-config.1.txt @@ -2,101 +2,106 @@ BUNDLE-CONFIG(1) BUNDLE-CONFIG(1) -1mNAME0m - 1mbundle-config 22m- Set bundler configuration options +NAME + bundle-config - Set bundler configuration options -1mSYNOPSIS0m - 1mbundle config 22m[4mname24m [4mvalue24m]] +SYNOPSIS + bundle config [list|get|set|unset] [name [value]] -1mDESCRIPTION0m +DESCRIPTION This command allows you to interact with Bundler's configuration sys- tem. Bundler loads configuration settings in this order: - 1. Local config (1mapp/.bundle/config22m) + 1. Local config (app/.bundle/config) - 2. Environmental variables (1mENV22m) + 2. Environmental variables (ENV) - 3. Global config (1m~/.bundle/config22m) + 3. Global config (~/.bundle/config) 4. Bundler default config - Executing 1mbundle config 22mwith no parameters will print a list of all - bundler configuration for the current bundle, and where that configura- - tion was set. + Executing bundle config list with will print a list of all bundler con- + figuration for the current bundle, and where that configuration was + set. - Executing 1mbundle config <name> 22mwill print the value of that configura- - tion setting, and where it was set. + Executing bundle config get <name> will print the value of that config- + uration setting, and where it was set. - Executing 1mbundle config <name> <value> 22mwill set that configuration to - the value specified for all bundles executed as the current user. The - configuration will be stored in 1m~/.bundle/config22m. If 4mname24m already is - set, 4mname24m will be overridden and user will be warned. + Executing bundle config set <name> <value> will set that configuration + to the value specified for all bundles executed as the current user. + The configuration will be stored in ~/.bundle/config. If name already + is set, name will be overridden and user will be warned. - Executing 1mbundle config --global <name> <value> 22mworks the same as + Executing bundle config set --global <name> <value> works the same as above. - Executing 1mbundle config --local <name> <value> 22mwill set that configura- - tion to the local application. The configuration will be stored in - 1mapp/.bundle/config22m. + Executing bundle config set --local <name> <value> will set that con- + figuration to the local application. The configuration will be stored + in app/.bundle/config. - Executing 1mbundle config --delete <name> 22mwill delete the configuration - in both local and global sources. Not compatible with --global or --lo- - cal flag. + Executing bundle config unset <name> will delete the configuration in + both local and global sources. - Executing bundle with the 1mBUNDLE_IGNORE_CONFIG 22menvironment variable set + Executing bundle config unset --global <name> will delete the configu- + ration only from the user configuration. + + Executing bundle config unset --local <name> <value> will delete the + configuration only from the local application. + + Executing bundle with the BUNDLE_IGNORE_CONFIG environment variable set will cause it to ignore all configuration. - Executing 1mbundle config disable_multisource true 22mupgrades the warning - about the Gemfile containing multiple primary sources to an error. Exe- - cuting 1mbundle config --delete disable_multisource 22mdowngrades this error + Executing bundle config set disable_multisource true upgrades the warn- + ing about the Gemfile containing multiple primary sources to an error. + Executing bundle config unset disable_multisource downgrades this error to a warning. -1mREMEMBERING OPTIONS0m - Flags passed to 1mbundle install 22mor the Bundler runtime, such as 1m--path0m - 1mfoo 22mor 1m--without production22m, are not remembered between commands. If - these options must be remembered,they must be set using 1mbundle config0m - (e.g., 1mbundle config path foo22m). +REMEMBERING OPTIONS + Flags passed to bundle install or the Bundler runtime, such as --path + foo or --without production, are not remembered between commands. If + these options must be remembered, they must be set using bundle config + (e.g., bundle config set path foo). The options that can be configured are: - 1mbin 22mCreates a directory (defaults to 1m~/bin22m) and place any executa- + bin Creates a directory (defaults to ~/bin) and place any executa- bles from the gem there. These executables run in Bundler's con- - text. If used, you might add this directory to your environ- - ment's 1mPATH 22mvariable. For instance, if the 1mrails 22mgem comes with - a 1mrails 22mexecutable, this flag will create a 1mbin/rails 22mexecutable - that ensures that all referred dependencies will be resolved us- - ing the bundled gems. - - 1mdeployment0m - In deployment mode, Bundler will 'roll-out' the bundle for 1mpro-0m - 1mduction 22muse. Please check carefully if you want to have this op- - tion enabled in 1mdevelopment 22mor 1mtest 22menvironments. - - 1mpath 22mThe location to install the specified gems to. This defaults to - Rubygems' setting. Bundler shares this location with Rubygems, - 1mgem install ... 22mwill have gem installed there, too. Therefore, - gems installed without a 1m--path ... 22msetting will show up by - calling 1mgem list22m. Accordingly, gems installed to other locations + text. If used, you might add this directory to your environ- + ment's PATH variable. For instance, if the rails gem comes with + a rails executable, this flag will create a bin/rails executable + that ensures that all referred dependencies will be resolved + using the bundled gems. + + deployment + In deployment mode, Bundler will 'roll-out' the bundle for pro- + duction use. Please check carefully if you want to have this + option enabled in development or test environments. + + path The location to install the specified gems to. This defaults to + Rubygems' setting. Bundler shares this location with Rubygems, + gem install ... will have gem installed there, too. Therefore, + gems installed without a --path ... setting will show up by + calling gem list. Accordingly, gems installed to other locations will not get listed. - 1mwithout0m + without A space-separated list of groups referencing gems to skip during installation. - 1mwith 22mA space-separated list of groups referencing gems to include + with A space-separated list of groups referencing gems to include during installation. -1mBUILD OPTIONS0m - You can use 1mbundle config 22mto give Bundler the flags to pass to the gem +BUILD OPTIONS + You can use bundle config to give Bundler the flags to pass to the gem installer every time bundler tries to install a particular gem. - A very common example, the 1mmysql 22mgem, requires Snow Leopard users to - pass configuration flags to 1mgem install 22mto specify where to find the - 1mmysql_config 22mexecutable. + A very common example, the mysql gem, requires Snow Leopard users to + pass configuration flags to gem install to specify where to find the + mysql_config executable. @@ -104,280 +109,283 @@ BUNDLE-CONFIG(1) BUNDLE-CONFIG(1) - Since the specific location of that executable can change from machine + Since the specific location of that executable can change from machine to machine, you can specify these flags on a per-machine basis. - bundle config build.mysql --with-mysql-config=/usr/local/mysql/bin/mysql_config + bundle config set build.mysql --with-mysql-config=/usr/local/mysql/bin/mysql_config - After running this command, every time bundler needs to install the - 1mmysql 22mgem, it will pass along the flags you specified. + After running this command, every time bundler needs to install the + mysql gem, it will pass along the flags you specified. -1mCONFIGURATION KEYS0m - Configuration keys in bundler have two forms: the canonical form and +CONFIGURATION KEYS + Configuration keys in bundler have two forms: the canonical form and the environment variable form. - For instance, passing the 1m--without 22mflag to bundle install(1) 4mbun-0m - 4mdle-install.1.html24m prevents Bundler from installing certain groups - specified in the Gemfile(5). Bundler persists this value in 1mapp/.bun-0m - 1mdle/config 22mso that calls to 1mBundler.setup 22mdo not try to find gems from - the 1mGemfile 22mthat you didn't install. Additionally, subsequent calls to - bundle install(1) 4mbundle-install.1.html24m remember this setting and skip + For instance, passing the --without flag to bundle install(1) bun- + dle-install.1.html prevents Bundler from installing certain groups + specified in the Gemfile(5). Bundler persists this value in app/.bun- + dle/config so that calls to Bundler.setup do not try to find gems from + the Gemfile that you didn't install. Additionally, subsequent calls to + bundle install(1) bundle-install.1.html remember this setting and skip those groups. - The canonical form of this configuration is 1m"without"22m. To convert the - canonical form to the environment variable form, capitalize it, and - prepend 1mBUNDLE_22m. The environment variable form of 1m"without" 22mis 1mBUN-0m - 1mDLE_WITHOUT22m. + The canonical form of this configuration is "without". To convert the + canonical form to the environment variable form, capitalize it, and + prepend BUNDLE_. The environment variable form of "without" is BUN- + DLE_WITHOUT. - Any periods in the configuration keys must be replaced with two under- + Any periods in the configuration keys must be replaced with two under- scores when setting it via environment variables. The configuration key - 1mlocal.rack 22mbecomes the environment variable 1mBUNDLE_LOCAL__RACK22m. + local.rack becomes the environment variable BUNDLE_LOCAL__RACK. -1mLIST OF AVAILABLE KEYS0m - The following is a list of all configuration keys and their purpose. - You can learn more about their operation in bundle install(1) 4mbun-0m - 4mdle-install.1.html24m. +LIST OF AVAILABLE KEYS + The following is a list of all configuration keys and their purpose. + You can learn more about their operation in bundle install(1) bun- + dle-install.1.html. - o 1mallow_bundler_dependency_conflicts 22m(1mBUNDLE_ALLOW_BUNDLER_DEPEN-0m - 1mDENCY_CONFLICTS22m): Allow resolving to specifications that have de- - pendencies on 1mbundler 22mthat are incompatible with the running + o allow_bundler_dependency_conflicts (BUNDLE_ALLOW_BUNDLER_DEPEN- + DENCY_CONFLICTS): Allow resolving to specifications that have + dependencies on bundler that are incompatible with the running Bundler version. - o 1mallow_deployment_source_credential_changes 22m(1mBUNDLE_ALLOW_DEPLOY-0m - 1mMENT_SOURCE_CREDENTIAL_CHANGES22m): When in deployment mode, allow - changing the credentials to a gem's source. Ex: - 1mhttps://some.host.com/gems/path/ 22m-> 1mhttps://user_name:pass-0m - 1mword@some.host.com/gems/path0m + o allow_deployment_source_credential_changes (BUNDLE_ALLOW_DEPLOY- + MENT_SOURCE_CREDENTIAL_CHANGES): When in deployment mode, allow + changing the credentials to a gem's source. Ex: + https://some.host.com/gems/path/ -> https://user_name:pass- + word@some.host.com/gems/path - o 1mallow_offline_install 22m(1mBUNDLE_ALLOW_OFFLINE_INSTALL22m): Allow Bundler + o allow_offline_install (BUNDLE_ALLOW_OFFLINE_INSTALL): Allow Bundler to use cached data when installing without network access. - o 1mauto_clean_without_path 22m(1mBUNDLE_AUTO_CLEAN_WITHOUT_PATH22m): Automati- - cally run 1mbundle clean 22mafter installing when an explicit 1mpath 22mhas + o auto_clean_without_path (BUNDLE_AUTO_CLEAN_WITHOUT_PATH): Automati- + cally run bundle clean after installing when an explicit path has not been set and Bundler is not installing into the system gems. - o 1mauto_install 22m(1mBUNDLE_AUTO_INSTALL22m): Automatically run 1mbundle in-0m - 1mstall 22mwhen gems are missing. + o auto_install (BUNDLE_AUTO_INSTALL): Automatically run bundle + install when gems are missing. - o 1mbin 22m(1mBUNDLE_BIN22m): Install executables from gems in the bundle to - the specified directory. Defaults to 1mfalse22m. + o bin (BUNDLE_BIN): Install executables from gems in the bundle to + the specified directory. Defaults to false. - o 1mcache_all 22m(1mBUNDLE_CACHE_ALL22m): Cache all gems, including path and + o cache_all (BUNDLE_CACHE_ALL): Cache all gems, including path and git gems. - o 1mcache_all_platforms 22m(1mBUNDLE_CACHE_ALL_PLATFORMS22m): Cache gems for + o cache_all_platforms (BUNDLE_CACHE_ALL_PLATFORMS): Cache gems for all platforms. - o 1mcache_path 22m(1mBUNDLE_CACHE_PATH22m): The directory that bundler will - place cached gems in when running 1mbundle package22m, and that bundler - will look in when installing gems. Defaults to 1mvendor/bundle22m. + o cache_path (BUNDLE_CACHE_PATH): The directory that bundler will + place cached gems in when running bundle package, and that bundler + will look in when installing gems. Defaults to vendor/bundle. - o 1mclean 22m(1mBUNDLE_CLEAN22m): Whether Bundler should run 1mbundle clean 22mauto- - matically after 1mbundle install22m. + o clean (BUNDLE_CLEAN): Whether Bundler should run bundle clean auto- + matically after bundle install. - o 1mconsole 22m(1mBUNDLE_CONSOLE22m): The console that 1mbundle console 22mstarts. - Defaults to 1mirb22m. + o console (BUNDLE_CONSOLE): The console that bundle console starts. + Defaults to irb. - o 1mdefault_install_uses_path 22m(1mBUNDLE_DEFAULT_INSTALL_USES_PATH22m): - Whether a 1mbundle install 22mwithout an explicit 1m--path 22margument de- - faults to installing gems in 1m.bundle22m. + o default_install_uses_path (BUNDLE_DEFAULT_INSTALL_USES_PATH): + Whether a bundle install without an explicit --path argument + defaults to installing gems in .bundle. - o 1mdeployment 22m(1mBUNDLE_DEPLOYMENT22m): Disallow changes to the 1mGemfile22m. - When the 1mGemfile 22mis changed and the lockfile has not been updated, + o deployment (BUNDLE_DEPLOYMENT): Disallow changes to the Gemfile. + When the Gemfile is changed and the lockfile has not been updated, running Bundler commands will be blocked. - o 1mdisable_checksum_validation 22m(1mBUNDLE_DISABLE_CHECKSUM_VALIDATION22m): - Allow installing gems even if they do not match the checksum pro- + o disable_checksum_validation (BUNDLE_DISABLE_CHECKSUM_VALIDATION): + Allow installing gems even if they do not match the checksum pro- vided by RubyGems. - o 1mdisable_exec_load 22m(1mBUNDLE_DISABLE_EXEC_LOAD22m): Stop Bundler from us- - ing 1mload 22mto launch an executable in-process in 1mbundle exec22m. + o disable_exec_load (BUNDLE_DISABLE_EXEC_LOAD): Stop Bundler from + using load to launch an executable in-process in bundle exec. - o 1mdisable_local_branch_check 22m(1mBUNDLE_DISABLE_LOCAL_BRANCH_CHECK22m): Al- - low Bundler to use a local git override without a branch specified - in the Gemfile. + o disable_local_branch_check (BUNDLE_DISABLE_LOCAL_BRANCH_CHECK): + Allow Bundler to use a local git override without a branch speci- + fied in the Gemfile. - o 1mdisable_multisource 22m(1mBUNDLE_DISABLE_MULTISOURCE22m): When set, Gem- - files containing multiple sources will produce errors instead of - warnings. Use 1mbundle config --delete disable_multisource 22mto unset. + o disable_multisource (BUNDLE_DISABLE_MULTISOURCE): When set, Gem- + files containing multiple sources will produce errors instead of + warnings. Use bundle config unset disable_multisource to unset. - o 1mdisable_platform_warnings 22m(1mBUNDLE_DISABLE_PLATFORM_WARNINGS22m): Dis- - able warnings during bundle install when a dependency is unused on + o disable_platform_warnings (BUNDLE_DISABLE_PLATFORM_WARNINGS): Dis- + able warnings during bundle install when a dependency is unused on the current platform. - o 1mdisable_shared_gems 22m(1mBUNDLE_DISABLE_SHARED_GEMS22m): Stop Bundler from + o disable_shared_gems (BUNDLE_DISABLE_SHARED_GEMS): Stop Bundler from accessing gems installed to RubyGems' normal location. - o 1mdisable_version_check 22m(1mBUNDLE_DISABLE_VERSION_CHECK22m): Stop Bundler - from checking if a newer Bundler version is available on + o disable_version_check (BUNDLE_DISABLE_VERSION_CHECK): Stop Bundler + from checking if a newer Bundler version is available on rubygems.org. - o 1merror_on_stderr 22m(1mBUNDLE_ERROR_ON_STDERR22m): Print Bundler errors to + o error_on_stderr (BUNDLE_ERROR_ON_STDERR): Print Bundler errors to stderr. - o 1mforce_ruby_platform 22m(1mBUNDLE_FORCE_RUBY_PLATFORM22m): Ignore the cur- - rent machine's platform and install only 1mruby 22mplatform gems. As a + o force_ruby_platform (BUNDLE_FORCE_RUBY_PLATFORM): Ignore the cur- + rent machine's platform and install only ruby platform gems. As a result, gems with native extensions will be compiled from source. - o 1mfrozen 22m(1mBUNDLE_FROZEN22m): Disallow changes to the 1mGemfile22m. When the - 1mGemfile 22mis changed and the lockfile has not been updated, running - Bundler commands will be blocked. Defaults to 1mtrue 22mwhen 1m--deploy-0m - 1mment 22mis used. + o frozen (BUNDLE_FROZEN): Disallow changes to the Gemfile. When the + Gemfile is changed and the lockfile has not been updated, running + Bundler commands will be blocked. Defaults to true when --deploy- + ment is used. - o 1mgem.push_key 22m(1mBUNDLE_GEM__PUSH_KEY22m): Sets the 1m--key 22mparameter for - 1mgem push 22mwhen using the 1mrake release 22mcommand with a private gem- + o gem.push_key (BUNDLE_GEM__PUSH_KEY): Sets the --key parameter for + gem push when using the rake release command with a private gem- stash server. - o 1mgemfile 22m(1mBUNDLE_GEMFILE22m): The name of the file that bundler should - use as the 1mGemfile22m. This location of this file also sets the root - of the project, which is used to resolve relative paths in the 1mGem-0m - 1mfile22m, among other things. By default, bundler will search up from - the current working directory until it finds a 1mGemfile22m. + o gemfile (BUNDLE_GEMFILE): The name of the file that bundler should + use as the Gemfile. This location of this file also sets the root + of the project, which is used to resolve relative paths in the Gem- + file, among other things. By default, bundler will search up from + the current working directory until it finds a Gemfile. - o 1mglobal_gem_cache 22m(1mBUNDLE_GLOBAL_GEM_CACHE22m): Whether Bundler should + o global_gem_cache (BUNDLE_GLOBAL_GEM_CACHE): Whether Bundler should cache all gems globally, rather than locally to the installing Ruby installation. - o 1mglobal_path_appends_ruby_scope 22m(1mBUNDLE_GLOBAL_PATH_AP-0m - 1mPENDS_RUBY_SCOPE22m): Whether Bundler should append the Ruby scope - (e.g. engine and ABI version) to a globally-configured path. + o global_path_appends_ruby_scope (BUN- + DLE_GLOBAL_PATH_APPENDS_RUBY_SCOPE): Whether Bundler should append + the Ruby scope (e.g. engine and ABI version) to a globally-config- + ured path. - o 1mignore_messages 22m(1mBUNDLE_IGNORE_MESSAGES22m): When set, no post install + o ignore_messages (BUNDLE_IGNORE_MESSAGES): When set, no post install messages will be printed. To silence a single gem, use dot notation - like 1mignore_messages.httparty true22m. + like ignore_messages.httparty true. - o 1minit_gems_rb 22m(1mBUNDLE_INIT_GEMS_RB22m) Generate a 1mgems.rb 22minstead of a - 1mGemfile 22mwhen running 1mbundle init22m. + o init_gems_rb (BUNDLE_INIT_GEMS_RB) Generate a gems.rb instead of a + Gemfile when running bundle init. - o 1mjobs 22m(1mBUNDLE_JOBS22m): The number of gems Bundler can install in par- + o jobs (BUNDLE_JOBS): The number of gems Bundler can install in par- allel. Defaults to 1. - o 1mlist_command 22m(1mBUNDLE_LIST_COMMAND22m) Enable new list command feature - - o 1mmajor_deprecations 22m(1mBUNDLE_MAJOR_DEPRECATIONS22m): Whether Bundler - should print deprecation warnings for behavior that will be changed - in the next major version. - - o 1mno_install 22m(1mBUNDLE_NO_INSTALL22m): Whether 1mbundle package 22mshould skip + o no_install (BUNDLE_NO_INSTALL): Whether bundle package should skip installing gems. - o 1mno_prune 22m(1mBUNDLE_NO_PRUNE22m): Whether Bundler should leave outdated + o no_prune (BUNDLE_NO_PRUNE): Whether Bundler should leave outdated gems unpruned when caching. - o 1monly_update_to_newer_versions 22m(1mBUNDLE_ONLY_UPDATE_TO_NEWER_VER-0m - 1mSIONS22m): During 1mbundle update22m, only resolve to newer versions of the + o only_update_to_newer_versions (BUNDLE_ONLY_UPDATE_TO_NEWER_VER- + SIONS): During bundle update, only resolve to newer versions of the gems in the lockfile. - o 1mpath 22m(1mBUNDLE_PATH22m): The location on disk where all gems in your - bundle will be located regardless of 1m$GEM_HOME 22mor 1m$GEM_PATH 22mvalues. - Bundle gems not found in this location will be installed by 1mbundle0m - 1minstall22m. Defaults to 1mGem.dir22m. When --deployment is used, defaults + o path (BUNDLE_PATH): The location on disk where all gems in your + bundle will be located regardless of $GEM_HOME or $GEM_PATH values. + Bundle gems not found in this location will be installed by bundle + install. Defaults to Gem.dir. When --deployment is used, defaults to vendor/bundle. - o 1mpath.system 22m(1mBUNDLE_PATH__SYSTEM22m): Whether Bundler will install - gems into the default system path (1mGem.dir22m). + o path.system (BUNDLE_PATH__SYSTEM): Whether Bundler will install + gems into the default system path (Gem.dir). - o 1mpath_relative_to_cwd 22m(1mPATH_RELATIVE_TO_CWD22m) Makes 1m--path 22mrelative - to the CWD instead of the 1mGemfile22m. + o path_relative_to_cwd (BUNDLE_PATH_RELATIVE_TO_CWD) Makes --path + relative to the CWD instead of the Gemfile. - o 1mplugins 22m(1mBUNDLE_PLUGINS22m): Enable Bundler's experimental plugin sys- + o plugins (BUNDLE_PLUGINS): Enable Bundler's experimental plugin sys- tem. - o 1mprefer_gems_rb 22m(1mBUNDLE_PREFER_GEMS_RB22m) Prefer 1mgems.rb 22mto 1mGemfile0m + o prefer_gems_rb (BUNDLE_PREFER_GEMS_RB) Prefer gems.rb to Gemfile when Bundler is searching for a Gemfile. - o 1mprint_only_version_number 22m(1mBUNDLE_PRINT_ONLY_VERSION_NUMBER22m) Print - only version number from 1mbundler --version22m. + o prefer_patch (BUNDLE_PREFER_PATCH): Prefer updating only to next + patch version during updates. Makes bundle update calls equivalent + to bundler update --patch. + + o print_only_version_number (BUNDLE_PRINT_ONLY_VERSION_NUMBER) Print + only version number from bundler --version. - o 1mredirect 22m(1mBUNDLE_REDIRECT22m): The number of redirects allowed for - network requests. Defaults to 1m522m. + o redirect (BUNDLE_REDIRECT): The number of redirects allowed for + network requests. Defaults to 5. - o 1mretry 22m(1mBUNDLE_RETRY22m): The number of times to retry failed network - requests. Defaults to 1m322m. + o retry (BUNDLE_RETRY): The number of times to retry failed network + requests. Defaults to 3. - o 1msetup_makes_kernel_gem_public 22m(1mBUNDLE_SETUP_MAKES_KERNEL_GEM_PUB-0m - 1mLIC22m): Have 1mBundler.setup 22mmake the 1mKernel#gem 22mmethod public, even + o setup_makes_kernel_gem_public (BUNDLE_SETUP_MAKES_KERNEL_GEM_PUB- + LIC): Have Bundler.setup make the Kernel#gem method public, even though RubyGems declares it as private. - o 1mshebang 22m(1mBUNDLE_SHEBANG22m): The program name that should be invoked + o shebang (BUNDLE_SHEBANG): The program name that should be invoked for generated binstubs. Defaults to the ruby install name used to generate the binstub. - o 1msilence_root_warning 22m(1mBUNDLE_SILENCE_ROOT_WARNING22m): Silence the + o silence_deprecations (BUNDLE_SILENCE_DEPRECATIONS): Whether Bundler + should silence deprecation warnings for behavior that will be + changed in the next major version. + + o silence_root_warning (BUNDLE_SILENCE_ROOT_WARNING): Silence the warning Bundler prints when installing gems as root. - o 1mskip_default_git_sources 22m(1mBUNDLE_SKIP_DEFAULT_GIT_SOURCES22m): Whether + o skip_default_git_sources (BUNDLE_SKIP_DEFAULT_GIT_SOURCES): Whether Bundler should skip adding default git source shortcuts to the Gem- file DSL. - o 1mspecific_platform 22m(1mBUNDLE_SPECIFIC_PLATFORM22m): Allow bundler to re- - solve for the specific running platform and store it in the lock- + o specific_platform (BUNDLE_SPECIFIC_PLATFORM): Allow bundler to + resolve for the specific running platform and store it in the lock- file, instead of only using a generic platform. A specific platform - is the exact platform triple reported by 1mGem::Platform.local22m, such - as 1mx86_64-darwin-16 22mor 1muniversal-java-1.822m. On the other hand, - generic platforms are those such as 1mruby22m, 1mmswin22m, or 1mjava22m. In this - example, 1mx86_64-darwin-16 22mwould map to 1mruby 22mand 1muniversal-java-1.80m - to 1mjava22m. + is the exact platform triple reported by Gem::Platform.local, such + as x86_64-darwin-16 or universal-java-1.8. On the other hand, + generic platforms are those such as ruby, mswin, or java. In this + example, x86_64-darwin-16 would map to ruby and universal-java-1.8 + to java. - o 1mssl_ca_cert 22m(1mBUNDLE_SSL_CA_CERT22m): Path to a designated CA certifi- + o ssl_ca_cert (BUNDLE_SSL_CA_CERT): Path to a designated CA certifi- cate file or folder containing multiple certificates for trusted CAs in PEM format. - o 1mssl_client_cert 22m(1mBUNDLE_SSL_CLIENT_CERT22m): Path to a designated file + o ssl_client_cert (BUNDLE_SSL_CLIENT_CERT): Path to a designated file containing a X.509 client certificate and key in PEM format. - o 1mssl_verify_mode 22m(1mBUNDLE_SSL_VERIFY_MODE22m): The SSL verification mode + o ssl_verify_mode (BUNDLE_SSL_VERIFY_MODE): The SSL verification mode Bundler uses when making HTTPS requests. Defaults to verify peer. - o 1msuppress_install_using_messages 22m(1mBUNDLE_SUPPRESS_INSTALL_USING_MES-0m - 1mSAGES22m): Avoid printing 1mUsing ... 22mmessages during installation when + o suppress_install_using_messages (BUNDLE_SUPPRESS_INSTALL_USING_MES- + SAGES): Avoid printing Using ... messages during installation when the version of a gem has not changed. - o 1msystem_bindir 22m(1mBUNDLE_SYSTEM_BINDIR22m): The location where RubyGems - installs binstubs. Defaults to 1mGem.bindir22m. + o system_bindir (BUNDLE_SYSTEM_BINDIR): The location where RubyGems + installs binstubs. Defaults to Gem.bindir. - o 1mtimeout 22m(1mBUNDLE_TIMEOUT22m): The seconds allowed before timing out for - network requests. Defaults to 1m1022m. + o timeout (BUNDLE_TIMEOUT): The seconds allowed before timing out for + network requests. Defaults to 10. - o 1munlock_source_unlocks_spec 22m(1mBUNDLE_UNLOCK_SOURCE_UNLOCKS_SPEC22m): - Whether running 1mbundle update --source NAME 22munlocks a gem with the - given name. Defaults to 1mtrue22m. + o unlock_source_unlocks_spec (BUNDLE_UNLOCK_SOURCE_UNLOCKS_SPEC): + Whether running bundle update --source NAME unlocks a gem with the + given name. Defaults to true. - o 1mupdate_requires_all_flag 22m(1mBUNDLE_UPDATE_REQUIRES_ALL_FLAG22m) Require - passing 1m--all 22mto 1mbundle update 22mwhen everything should be updated, - and disallow passing no options to 1mbundle update22m. + o update_requires_all_flag (BUNDLE_UPDATE_REQUIRES_ALL_FLAG) Require + passing --all to bundle update when everything should be updated, + and disallow passing no options to bundle update. - o 1muser_agent 22m(1mBUNDLE_USER_AGENT22m): The custom user agent fragment + o user_agent (BUNDLE_USER_AGENT): The custom user agent fragment Bundler includes in API requests. - o 1mwith 22m(1mBUNDLE_WITH22m): A 1m:22m-separated list of groups whose gems bundler + o with (BUNDLE_WITH): A :-separated list of groups whose gems bundler should install. - o 1mwithout 22m(1mBUNDLE_WITHOUT22m): A 1m:22m-separated list of groups whose gems + o without (BUNDLE_WITHOUT): A :-separated list of groups whose gems bundler should not install. In general, you should set these settings per-application by using the - applicable flag to the bundle install(1) 4mbundle-install.1.html24m or bun- - dle package(1) 4mbundle-package.1.html24m command. + applicable flag to the bundle install(1) bundle-install.1.html or bun- + dle package(1) bundle-package.1.html command. - You can set them globally either via environment variables or 1mbundle0m - 1mconfig22m, whichever is preferable for your setup. If you use both, envi- + You can set them globally either via environment variables or bundle + config, whichever is preferable for your setup. If you use both, envi- ronment variables will take preference over global settings. -1mLOCAL GIT REPOS0m - Bundler also allows you to work against a git repository locally in- - stead of using the remote version. This can be achieved by setting up a - local override: +LOCAL GIT REPOS + Bundler also allows you to work against a git repository locally + instead of using the remote version. This can be achieved by setting up + a local override: - bundle config local.GEM_NAME /path/to/local/git/repository + bundle config set local.GEM_NAME /path/to/local/git/repository @@ -386,7 +394,7 @@ BUNDLE-CONFIG(1) BUNDLE-CONFIG(1) - bundle config local.rack ~/Work/git/rack + bundle config set local.rack ~/Work/git/rack @@ -394,32 +402,32 @@ BUNDLE-CONFIG(1) BUNDLE-CONFIG(1) ride will be used. Similar to a path source, every time the local git repository change, changes will be automatically picked up by Bundler. This means a commit in the local git repo will update the revision in - the 1mGemfile.lock 22mto the local git repo revision. This requires the same + the Gemfile.lock to the local git repo revision. This requires the same attention as git submodules. Before pushing to the remote, you need to ensure the local override was pushed, otherwise you may point to a com- - mit that only exists in your local machine. You'll also need to CGI es- - cape your usernames and passwords as well. + mit that only exists in your local machine. You'll also need to CGI + escape your usernames and passwords as well. Bundler does many checks to ensure a developer won't work with invalid references. Particularly, we force a developer to specify a branch in - the 1mGemfile 22min order to use this feature. If the branch specified in - the 1mGemfile 22mand the current branch in the local git repository do not + the Gemfile in order to use this feature. If the branch specified in + the Gemfile and the current branch in the local git repository do not match, Bundler will abort. This ensures that a developer is always working against the correct branches, and prevents accidental locking to a different branch. - Finally, Bundler also ensures that the current revision in the 1mGem-0m - 1mfile.lock 22mexists in the local git repository. By doing this, Bundler + Finally, Bundler also ensures that the current revision in the Gem- + file.lock exists in the local git repository. By doing this, Bundler forces you to fetch the latest changes in the remotes. -1mMIRRORS OF GEM SOURCES0m +MIRRORS OF GEM SOURCES Bundler supports overriding gem sources with mirrors. This allows you to configure rubygems.org as the gem source in your Gemfile while still using your mirror to fetch gems. - bundle config mirror.SOURCE_URL MIRROR_URL + bundle config set mirror.SOURCE_URL MIRROR_URL @@ -428,7 +436,7 @@ BUNDLE-CONFIG(1) BUNDLE-CONFIG(1) - bundle config mirror.http://rubygems.org http://rubygems-mirror.org + bundle config set mirror.http://rubygems.org http://rubygems-mirror.org @@ -438,7 +446,7 @@ BUNDLE-CONFIG(1) BUNDLE-CONFIG(1) - bundle config mirror.SOURCE_URL.fallback_timeout TIMEOUT + bundle config set mirror.SOURCE_URL.fallback_timeout TIMEOUT @@ -446,29 +454,29 @@ BUNDLE-CONFIG(1) BUNDLE-CONFIG(1) - bundle config mirror.https://rubygems.org.fallback_timeout 3 + bundle config set mirror.https://rubygems.org.fallback_timeout 3 The default fallback timeout is 0.1 seconds, but the setting can cur- rently only accept whole seconds (for example, 1, 15, or 30). -1mCREDENTIALS FOR GEM SOURCES0m +CREDENTIALS FOR GEM SOURCES Bundler allows you to configure credentials for any gem source, which allows you to avoid putting secrets into your Gemfile. - bundle config SOURCE_HOSTNAME USERNAME:PASSWORD + bundle config set SOURCE_HOSTNAME USERNAME:PASSWORD - For example, to save the credentials of user 1mclaudette 22mfor the gem - source at 1mgems.longerous.com22m, you would run: + For example, to save the credentials of user claudette for the gem + source at gems.longerous.com, you would run: - bundle config gems.longerous.com claudette:s00pers3krit + bundle config set gems.longerous.com claudette:s00pers3krit @@ -485,7 +493,7 @@ BUNDLE-CONFIG(1) BUNDLE-CONFIG(1) - bundle config https://github.com/bundler/bundler.git username:password + bundle config set https://github.com/bundler/bundler.git username:password @@ -506,10 +514,10 @@ BUNDLE-CONFIG(1) BUNDLE-CONFIG(1) -1mCONFIGURE BUNDLER DIRECTORIES0m +CONFIGURE BUNDLER DIRECTORIES Bundler's home, config, cache and plugin directories are able to be configured through environment variables. The default location for - Bundler's home directory is 1m~/.bundle22m, which all directories inherit + Bundler's home directory is ~/.bundle, which all directories inherit from by default. The following outlines the available environment vari- ables and their default values @@ -525,4 +533,4 @@ BUNDLE-CONFIG(1) BUNDLE-CONFIG(1) - January 2019 BUNDLE-CONFIG(1) + April 2019 BUNDLE-CONFIG(1) diff --git a/man/bundle-config.ronn b/man/bundle-config.ronn index b5c97ae82d..86c4e21819 100644 --- a/man/bundle-config.ronn +++ b/man/bundle-config.ronn @@ -3,7 +3,7 @@ bundle-config(1) -- Set bundler configuration options ## SYNOPSIS -`bundle config` [<name> [<value>]] +`bundle config` [list|get|set|unset] [<name> [<value>]] ## DESCRIPTION @@ -16,39 +16,45 @@ Bundler loads configuration settings in this order: 3. Global config (`~/.bundle/config`) 4. Bundler default config -Executing `bundle config` with no parameters will print a list of all -bundler configuration for the current bundle, and where that configuration +Executing `bundle config list` with will print a list of all bundler +configuration for the current bundle, and where that configuration was set. -Executing `bundle config <name>` will print the value of that configuration +Executing `bundle config get <name>` will print the value of that configuration setting, and where it was set. -Executing `bundle config <name> <value>` will set that configuration to the +Executing `bundle config set <name> <value>` will set that configuration to the value specified for all bundles executed as the current user. The configuration will be stored in `~/.bundle/config`. If <name> already is set, <name> will be overridden and user will be warned. -Executing `bundle config --global <name> <value>` works the same as above. +Executing `bundle config set --global <name> <value>` works the same as above. -Executing `bundle config --local <name> <value>` will set that configuration to +Executing `bundle config set --local <name> <value>` will set that configuration to the local application. The configuration will be stored in `app/.bundle/config`. -Executing `bundle config --delete <name>` will delete the configuration in both -local and global sources. Not compatible with --global or --local flag. +Executing `bundle config unset <name>` will delete the configuration in both +local and global sources. + +Executing `bundle config unset --global <name>` will delete the configuration +only from the user configuration. + +Executing `bundle config unset --local <name> <value>` will delete the +configuration only from the local application. Executing bundle with the `BUNDLE_IGNORE_CONFIG` environment variable set will cause it to ignore all configuration. -Executing `bundle config disable_multisource true` upgrades the warning about +Executing `bundle config set disable_multisource true` upgrades the warning about the Gemfile containing multiple primary sources to an error. Executing `bundle -config --delete disable_multisource` downgrades this error to a warning. +config unset disable_multisource` downgrades this error to a warning. ## REMEMBERING OPTIONS Flags passed to `bundle install` or the Bundler runtime, such as `--path foo` or `--without production`, are not remembered between commands. -If these options must be remembered,they must be set using `bundle config` -(e.g., `bundle config path foo`). +If these options must be remembered, they must be set using `bundle config` +(e.g., `bundle config set path foo`). The options that can be configured are: @@ -92,7 +98,7 @@ pass configuration flags to `gem install` to specify where to find the Since the specific location of that executable can change from machine to machine, you can specify these flags on a per-machine basis. - bundle config build.mysql --with-mysql-config=/usr/local/mysql/bin/mysql_config + bundle config set build.mysql --with-mysql-config=/usr/local/mysql/bin/mysql_config After running this command, every time bundler needs to install the `mysql` gem, it will pass along the flags you specified. @@ -169,7 +175,7 @@ learn more about their operation in [bundle install(1)](bundle-install.1.html). * `disable_multisource` (`BUNDLE_DISABLE_MULTISOURCE`): When set, Gemfiles containing multiple sources will produce errors instead of warnings. - Use `bundle config --delete disable_multisource` to unset. + Use `bundle config unset disable_multisource` to unset. * `disable_platform_warnings` (`BUNDLE_DISABLE_PLATFORM_WARNINGS`): Disable warnings during bundle install when a dependency is unused on the current platform. * `disable_shared_gems` (`BUNDLE_DISABLE_SHARED_GEMS`): @@ -208,11 +214,6 @@ learn more about their operation in [bundle install(1)](bundle-install.1.html). Generate a `gems.rb` instead of a `Gemfile` when running `bundle init`. * `jobs` (`BUNDLE_JOBS`): The number of gems Bundler can install in parallel. Defaults to 1. -* `list_command` (`BUNDLE_LIST_COMMAND`) - Enable new list command feature -* `major_deprecations` (`BUNDLE_MAJOR_DEPRECATIONS`): - Whether Bundler should print deprecation warnings for behavior that will - be changed in the next major version. * `no_install` (`BUNDLE_NO_INSTALL`): Whether `bundle package` should skip installing gems. * `no_prune` (`BUNDLE_NO_PRUNE`): @@ -227,12 +228,12 @@ learn more about their operation in [bundle install(1)](bundle-install.1.html). is used, defaults to vendor/bundle. * `path.system` (`BUNDLE_PATH__SYSTEM`): Whether Bundler will install gems into the default system path (`Gem.dir`). -* `path_relative_to_cwd` (`PATH_RELATIVE_TO_CWD`) +* `path_relative_to_cwd` (`BUNDLE_PATH_RELATIVE_TO_CWD`) Makes `--path` relative to the CWD instead of the `Gemfile`. * `plugins` (`BUNDLE_PLUGINS`): Enable Bundler's experimental plugin system. -* `prefer_gems_rb` (`BUNDLE_PREFER_GEMS_RB`) - Prefer `gems.rb` to `Gemfile` when Bundler is searching for a Gemfile. +* `prefer_patch` (BUNDLE_PREFER_PATCH): + Prefer updating only to next patch version during updates. Makes `bundle update` calls equivalent to `bundler update --patch`. * `print_only_version_number` (`BUNDLE_PRINT_ONLY_VERSION_NUMBER`) Print only version number from `bundler --version`. * `redirect` (`BUNDLE_REDIRECT`): @@ -245,6 +246,9 @@ learn more about their operation in [bundle install(1)](bundle-install.1.html). * `shebang` (`BUNDLE_SHEBANG`): The program name that should be invoked for generated binstubs. Defaults to the ruby install name used to generate the binstub. +* `silence_deprecations` (`BUNDLE_SILENCE_DEPRECATIONS`): + Whether Bundler should silence deprecation warnings for behavior that will + be changed in the next major version. * `silence_root_warning` (`BUNDLE_SILENCE_ROOT_WARNING`): Silence the warning Bundler prints when installing gems as root. * `skip_default_git_sources` (`BUNDLE_SKIP_DEFAULT_GIT_SOURCES`): @@ -300,11 +304,11 @@ Bundler also allows you to work against a git repository locally instead of using the remote version. This can be achieved by setting up a local override: - bundle config local.GEM_NAME /path/to/local/git/repository + bundle config set local.GEM_NAME /path/to/local/git/repository For example, in order to use a local Rack repository, a developer could call: - bundle config local.rack ~/Work/git/rack + bundle config set local.rack ~/Work/git/rack Now instead of checking out the remote git repository, the local override will be used. Similar to a path source, every time the local @@ -334,21 +338,21 @@ Bundler supports overriding gem sources with mirrors. This allows you to configure rubygems.org as the gem source in your Gemfile while still using your mirror to fetch gems. - bundle config mirror.SOURCE_URL MIRROR_URL + bundle config set mirror.SOURCE_URL MIRROR_URL For example, to use a mirror of rubygems.org hosted at rubygems-mirror.org: - bundle config mirror.http://rubygems.org http://rubygems-mirror.org + bundle config set mirror.http://rubygems.org http://rubygems-mirror.org Each mirror also provides a fallback timeout setting. If the mirror does not respond within the fallback timeout, Bundler will try to use the original server instead of the mirror. - bundle config mirror.SOURCE_URL.fallback_timeout TIMEOUT + bundle config set mirror.SOURCE_URL.fallback_timeout TIMEOUT For example, to fall back to rubygems.org after 3 seconds: - bundle config mirror.https://rubygems.org.fallback_timeout 3 + bundle config set mirror.https://rubygems.org.fallback_timeout 3 The default fallback timeout is 0.1 seconds, but the setting can currently only accept whole seconds (for example, 1, 15, or 30). @@ -358,12 +362,12 @@ only accept whole seconds (for example, 1, 15, or 30). Bundler allows you to configure credentials for any gem source, which allows you to avoid putting secrets into your Gemfile. - bundle config SOURCE_HOSTNAME USERNAME:PASSWORD + bundle config set SOURCE_HOSTNAME USERNAME:PASSWORD For example, to save the credentials of user `claudette` for the gem source at `gems.longerous.com`, you would run: - bundle config gems.longerous.com claudette:s00pers3krit + bundle config set gems.longerous.com claudette:s00pers3krit Or you can set the credentials as an environment variable like this: @@ -371,7 +375,7 @@ Or you can set the credentials as an environment variable like this: For gems with a git source with HTTP(S) URL you can specify credentials like so: - bundle config https://github.com/bundler/bundler.git username:password + bundle config set https://github.com/bundler/bundler.git username:password Or you can set the credentials as an environment variable like so: diff --git a/man/bundle-doctor.1 b/man/bundle-doctor.1 index 53291ba7b9..3dcbaa18cb 100644 --- a/man/bundle-doctor.1 +++ b/man/bundle-doctor.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "BUNDLE\-DOCTOR" "1" "November 2018" "" "" +.TH "BUNDLE\-DOCTOR" "1" "March 2019" "" "" . .SH "NAME" \fBbundle\-doctor\fR \- Checks the bundle for common problems diff --git a/man/bundle-doctor.1.txt b/man/bundle-doctor.1.txt index b21291ac0f..e3efa3bcbe 100644 --- a/man/bundle-doctor.1.txt +++ b/man/bundle-doctor.1.txt @@ -2,13 +2,13 @@ BUNDLE-DOCTOR(1) BUNDLE-DOCTOR(1) -1mNAME0m - 1mbundle-doctor 22m- Checks the bundle for common problems +NAME + bundle-doctor - Checks the bundle for common problems -1mSYNOPSIS0m - 1mbundle doctor 22m[--quiet] [--gemfile=GEMFILE] +SYNOPSIS + bundle doctor [--quiet] [--gemfile=GEMFILE] -1mDESCRIPTION0m +DESCRIPTION Checks your Gemfile and gem environment for common problems. If issues are detected, Bundler prints them and exits status 1. Otherwise, Bundler prints a success message and exits status 0. @@ -27,18 +27,18 @@ BUNDLE-DOCTOR(1) BUNDLE-DOCTOR(1) -1mOPTIONS0m - 1m--quiet0m +OPTIONS + --quiet Only output warnings and errors. - 1m--gemfile=<gemfile>0m + --gemfile=<gemfile> The location of the Gemfile(5) which Bundler should use. This defaults to a Gemfile(5) in the current working directory. In general, Bundler will assume that the location of the Gemfile(5) - is also the project's root and will try to find 1mGemfile.lock 22mand - 1mvendor/cache 22mrelative to this location. + is also the project's root and will try to find Gemfile.lock and + vendor/cache relative to this location. - November 2018 BUNDLE-DOCTOR(1) + March 2019 BUNDLE-DOCTOR(1) diff --git a/man/bundle-exec.1 b/man/bundle-exec.1 index e742141769..4d0fb7dc31 100644 --- a/man/bundle-exec.1 +++ b/man/bundle-exec.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "BUNDLE\-EXEC" "1" "November 2018" "" "" +.TH "BUNDLE\-EXEC" "1" "March 2019" "" "" . .SH "NAME" \fBbundle\-exec\fR \- Execute a command in the context of the bundle diff --git a/man/bundle-exec.1.txt b/man/bundle-exec.1.txt index 864eb0b485..179c3a7577 100644 --- a/man/bundle-exec.1.txt +++ b/man/bundle-exec.1.txt @@ -2,53 +2,53 @@ BUNDLE-EXEC(1) BUNDLE-EXEC(1) -1mNAME0m - 1mbundle-exec 22m- Execute a command in the context of the bundle +NAME + bundle-exec - Execute a command in the context of the bundle -1mSYNOPSIS0m - 1mbundle exec 22m[--keep-file-descriptors] 4mcommand0m +SYNOPSIS + bundle exec [--keep-file-descriptors] command -1mDESCRIPTION0m +DESCRIPTION This command executes the command, making all gems specified in the - [1mGemfile(5)22m][Gemfile(5)] available to 1mrequire 22min Ruby programs. + [Gemfile(5)][Gemfile(5)] available to require in Ruby programs. - Essentially, if you would normally have run something like 1mrspec0m - 1mspec/my_spec.rb22m, and you want to use the gems specified in the [1mGem-0m - 1mfile(5)22m][Gemfile(5)] and installed via bundle install(1) 4mbundle-in-0m - 4mstall.1.html24m, you should run 1mbundle exec rspec spec/my_spec.rb22m. + Essentially, if you would normally have run something like rspec + spec/my_spec.rb, and you want to use the gems specified in the [Gem- + file(5)][Gemfile(5)] and installed via bundle install(1) bun- + dle-install.1.html, you should run bundle exec rspec spec/my_spec.rb. - Note that 1mbundle exec 22mdoes not require that an executable is available - on your shell's 1m$PATH22m. + Note that bundle exec does not require that an executable is available + on your shell's $PATH. -1mOPTIONS0m - 1m--keep-file-descriptors0m +OPTIONS + --keep-file-descriptors Exec in Ruby 2.0 began discarding non-standard file descriptors. When this flag is passed, exec will revert to the 1.9 behaviour of passing all file descriptors to the new process. -1mBUNDLE INSTALL --BINSTUBS0m - If you use the 1m--binstubs 22mflag in bundle install(1) 4mbundle-in-0m - 4mstall.1.html24m, Bundler will automatically create a directory (which de- - faults to 1mapp_root/bin22m) containing all of the executables available - from gems in the bundle. +BUNDLE INSTALL --BINSTUBS + If you use the --binstubs flag in bundle install(1) bun- + dle-install.1.html, Bundler will automatically create a directory + (which defaults to app_root/bin) containing all of the executables + available from gems in the bundle. - After using 1m--binstubs22m, 1mbin/rspec spec/my_spec.rb 22mis identical to 1mbun-0m - 1mdle exec rspec spec/my_spec.rb22m. + After using --binstubs, bin/rspec spec/my_spec.rb is identical to bun- + dle exec rspec spec/my_spec.rb. -1mENVIRONMENT MODIFICATIONS0m - 1mbundle exec 22mmakes a number of changes to the shell environment, then +ENVIRONMENT MODIFICATIONS + bundle exec makes a number of changes to the shell environment, then executes the command you specify in full. - o make sure that it's still possible to shell out to 1mbundle 22mfrom in- - side a command invoked by 1mbundle exec 22m(using 1m$BUNDLE_BIN_PATH22m) + o make sure that it's still possible to shell out to bundle from + inside a command invoked by bundle exec (using $BUNDLE_BIN_PATH) - o put the directory containing executables (like 1mrails22m, 1mrspec22m, - 1mrackup22m) for your bundle on 1m$PATH0m + o put the directory containing executables (like rails, rspec, + rackup) for your bundle on $PATH o make sure that if bundler is invoked in the subshell, it uses the - same 1mGemfile 22m(by setting 1mBUNDLE_GEMFILE22m) + same Gemfile (by setting BUNDLE_GEMFILE) - o add 1m-rbundler/setup 22mto 1m$RUBYOPT22m, which makes sure that Ruby pro- + o add -rbundler/setup to $RUBYOPT, which makes sure that Ruby pro- grams invoked in the subshell can see the gems in the bundle @@ -57,43 +57,43 @@ BUNDLE-EXEC(1) BUNDLE-EXEC(1) o disallow loading additional gems not in the bundle - o modify the 1mgem 22mmethod to be a no-op if a gem matching the require- - ments is in the bundle, and to raise a 1mGem::LoadError 22mif it's not + o modify the gem method to be a no-op if a gem matching the require- + ments is in the bundle, and to raise a Gem::LoadError if it's not - o Define 1mGem.refresh 22mto be a no-op, since the source index is always + o Define Gem.refresh to be a no-op, since the source index is always frozen when using bundler, and to prevent gems from the system leaking into the environment - o Override 1mGem.bin_path 22mto use the gems in the bundle, making system + o Override Gem.bin_path to use the gems in the bundle, making system executables work o Add all gems in the bundle into Gem.loaded_specs - Finally, 1mbundle exec 22malso implicitly modifies 1mGemfile.lock 22mif the lock- + Finally, bundle exec also implicitly modifies Gemfile.lock if the lock- file and the Gemfile do not match. Bundler needs the Gemfile to deter- - mine things such as a gem's groups, 1mautorequire22m, and platforms, etc., + mine things such as a gem's groups, autorequire, and platforms, etc., and that information isn't stored in the lockfile. The Gemfile and - lockfile must be synced in order to 1mbundle exec 22msuccessfully, so 1mbundle0m - 1mexec 22mupdates the lockfile beforehand. + lockfile must be synced in order to bundle exec successfully, so bundle + exec updates the lockfile beforehand. - 1mLoading0m - By default, when attempting to 1mbundle exec 22mto a file with a ruby she- - bang, Bundler will 1mKernel.load 22mthat file instead of using 1mKernel.exec22m. + Loading + By default, when attempting to bundle exec to a file with a ruby she- + bang, Bundler will Kernel.load that file instead of using Kernel.exec. For the vast majority of cases, this is a performance improvement. In a - rare few cases, this could cause some subtle side-effects (such as de- - pendence on the exact contents of 1m$0 22mor 1m__FILE__22m) and the optimization - can be disabled by enabling the 1mdisable_exec_load 22msetting. + rare few cases, this could cause some subtle side-effects (such as + dependence on the exact contents of $0 or __FILE__) and the optimiza- + tion can be disabled by enabling the disable_exec_load setting. - 1mShelling out0m - Any Ruby code that opens a subshell (like 1msystem22m, backticks, or 1m%x{}22m) + Shelling out + Any Ruby code that opens a subshell (like system, backticks, or %x{}) will automatically use the current Bundler environment. If you need to shell out to a Ruby command that is not part of your current bundle, - use the 1mwith_clean_env 22mmethod with a block. Any subshells created in- - side the block will be given the environment present before Bundler was - activated. For example, Homebrew commands run Ruby, but don't work in- - side a bundle: + use the with_clean_env method with a block. Any subshells created + inside the block will be given the environment present before Bundler + was activated. For example, Homebrew commands run Ruby, but don't work + inside a bundle: @@ -103,10 +103,10 @@ BUNDLE-EXEC(1) BUNDLE-EXEC(1) - Using 1mwith_clean_env 22mis also necessary if you are shelling out to a + Using with_clean_env is also necessary if you are shelling out to a different bundle. Any Bundler commands run in a subshell will inherit the current Gemfile, so commands that need to run in the context of a - different bundle also need to use 1mwith_clean_env22m. + different bundle also need to use with_clean_env. @@ -118,7 +118,7 @@ BUNDLE-EXEC(1) BUNDLE-EXEC(1) - Bundler provides convenience helpers that wrap 1msystem 22mand 1mexec22m, and + Bundler provides convenience helpers that wrap system and exec, and they can be used like this: @@ -128,24 +128,24 @@ BUNDLE-EXEC(1) BUNDLE-EXEC(1) -1mRUBYGEMS PLUGINS0m +RUBYGEMS PLUGINS At present, the Rubygems plugin system requires all files named - 1mrubygems_plugin.rb 22mon the load path of 4many24m installed gem when any Ruby - code requires 1mrubygems.rb22m. This includes executables installed into the - system, like 1mrails22m, 1mrackup22m, and 1mrspec22m. + rubygems_plugin.rb on the load path of any installed gem when any Ruby + code requires rubygems.rb. This includes executables installed into the + system, like rails, rackup, and rspec. Since Rubygems plugins can contain arbitrary Ruby code, they commonly end up activating themselves or their dependencies. - For instance, the 1mgemcutter 0.5 22mgem depended on 1mjson_pure22m. If you had - that version of gemcutter installed (even if you 4malso24m had a newer ver- - sion without this problem), Rubygems would activate 1mgemcutter 0.5 22mand - 1mjson_pure <latest>22m. + For instance, the gemcutter 0.5 gem depended on json_pure. If you had + that version of gemcutter installed (even if you also had a newer ver- + sion without this problem), Rubygems would activate gemcutter 0.5 and + json_pure <latest>. - If your Gemfile(5) also contained 1mjson_pure 22m(or a gem with a dependency - on 1mjson_pure22m), the latest version on your system might conflict with - the version in your Gemfile(5), or the snapshot version in your 1mGem-0m - 1mfile.lock22m. + If your Gemfile(5) also contained json_pure (or a gem with a dependency + on json_pure), the latest version on your system might conflict with + the version in your Gemfile(5), or the snapshot version in your Gem- + file.lock. If this happens, bundler will say: @@ -158,7 +158,7 @@ BUNDLE-EXEC(1) BUNDLE-EXEC(1) In this situation, you almost certainly want to remove the underlying gem with the problematic gem plugin. In general, the authors of these - plugins (in this case, the 1mgemcutter 22mgem) have released newer versions + plugins (in this case, the gemcutter gem) have released newer versions that are more careful in their plugins. You can find a list of all the gems containing gem plugins by running @@ -170,9 +170,9 @@ BUNDLE-EXEC(1) BUNDLE-EXEC(1) At the very least, you should remove all but the newest version of each - gem plugin, and also remove all gem plugins that you aren't using (1mgem0m - 1muninstall gem_name22m). + gem plugin, and also remove all gem plugins that you aren't using (gem + uninstall gem_name). - November 2018 BUNDLE-EXEC(1) + March 2019 BUNDLE-EXEC(1) diff --git a/man/bundle-gem.1 b/man/bundle-gem.1 index 1087a0888c..08e544cd8a 100644 --- a/man/bundle-gem.1 +++ b/man/bundle-gem.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "BUNDLE\-GEM" "1" "November 2018" "" "" +.TH "BUNDLE\-GEM" "1" "March 2019" "" "" . .SH "NAME" \fBbundle\-gem\fR \- Generate a project skeleton for creating a rubygem diff --git a/man/bundle-gem.1.txt b/man/bundle-gem.1.txt index a951d5b4b6..806939df4f 100644 --- a/man/bundle-gem.1.txt +++ b/man/bundle-gem.1.txt @@ -2,90 +2,90 @@ BUNDLE-GEM(1) BUNDLE-GEM(1) -1mNAME0m - 1mbundle-gem 22m- Generate a project skeleton for creating a rubygem +NAME + bundle-gem - Generate a project skeleton for creating a rubygem -1mSYNOPSIS0m - 1mbundle gem 4m22mGEM_NAME24m 4mOPTIONS0m +SYNOPSIS + bundle gem GEM_NAME OPTIONS -1mDESCRIPTION0m - Generates a directory named 1mGEM_NAME 22mwith a 1mRakefile22m, 1mGEM_NAME.gemspec22m, +DESCRIPTION + Generates a directory named GEM_NAME with a Rakefile, GEM_NAME.gemspec, and other supporting files and directories that can be used to develop a rubygem with that name. - Run 1mrake -T 22min the resulting project for a list of Rake tasks that can + Run rake -T in the resulting project for a list of Rake tasks that can be used to test and publish the gem to rubygems.org. - The generated project skeleton can be customized with OPTIONS, as ex- - plained below. Note that these options can also be specified via + The generated project skeleton can be customized with OPTIONS, as + explained below. Note that these options can also be specified via Bundler's global configuration file using the following names: - o 1mgem.coc0m + o gem.coc - o 1mgem.mit0m + o gem.mit - o 1mgem.test0m + o gem.test -1mOPTIONS0m - 1m--exe 22mor 1m-b 22mor 1m--bin0m +OPTIONS + --exe or -b or --bin Specify that Bundler should create a binary executable (as - 1mexe/GEM_NAME22m) in the generated rubygem project. This binary will - also be added to the 1mGEM_NAME.gemspec 22mmanifest. This behavior is + exe/GEM_NAME) in the generated rubygem project. This binary will + also be added to the GEM_NAME.gemspec manifest. This behavior is disabled by default. - 1m--no-exe0m - Do not create a binary (overrides 1m--exe 22mspecified in the global + --no-exe + Do not create a binary (overrides --exe specified in the global config). - 1m--coc 22mAdd a 1mCODE_OF_CONDUCT.md 22mfile to the root of the generated + --coc Add a CODE_OF_CONDUCT.md file to the root of the generated project. If this option is unspecified, an interactive prompt will be displayed and the answer will be saved in Bundler's - global config for future 1mbundle gem 22muse. + global config for future bundle gem use. - 1m--no-coc0m - Do not create a 1mCODE_OF_CONDUCT.md 22m(overrides 1m--coc 22mspecified in + --no-coc + Do not create a CODE_OF_CONDUCT.md (overrides --coc specified in the global config). - 1m--ext 22mAdd boilerplate for C extension code to the generated project. + --ext Add boilerplate for C extension code to the generated project. This behavior is disabled by default. - 1m--no-ext0m - Do not add C extension code (overrides 1m--ext 22mspecified in the + --no-ext + Do not add C extension code (overrides --ext specified in the global config). - 1m--mit 22mAdd an MIT license to a 1mLICENSE.txt 22mfile in the root of the gen- + --mit Add an MIT license to a LICENSE.txt file in the root of the gen- erated project. Your name from the global git config is used for - the copyright statement. If this option is unspecified, an in- - teractive prompt will be displayed and the answer will be saved - in Bundler's global config for future 1mbundle gem 22muse. + the copyright statement. If this option is unspecified, an + interactive prompt will be displayed and the answer will be + saved in Bundler's global config for future bundle gem use. - 1m--no-mit0m - Do not create a 1mLICENSE.txt 22m(overrides 1m--mit 22mspecified in the + --no-mit + Do not create a LICENSE.txt (overrides --mit specified in the global config). - 1m-t22m, 1m--test=minitest22m, 1m--test=rspec0m + -t, --test=minitest, --test=rspec Specify the test framework that Bundler should use when generat- - ing the project. Acceptable values are 1mminitest 22mand 1mrspec22m. The - 1mGEM_NAME.gemspec 22mwill be configured and a skeleton test/spec di- - rectory will be created based on this option. If this option is - unspecified, an interactive prompt will be displayed and the an- - swer will be saved in Bundler's global config for future 1mbundle0m - 1mgem 22muse. If no option is specified, the default testing frame- - work is RSpec. - - 1m-e22m, 1m--edit[=EDITOR]0m + ing the project. Acceptable values are minitest and rspec. The + GEM_NAME.gemspec will be configured and a skeleton test/spec + directory will be created based on this option. If this option + is unspecified, an interactive prompt will be displayed and the + answer will be saved in Bundler's global config for future bun- + dle gem use. If no option is specified, the default testing + framework is RSpec. + + -e, --edit[=EDITOR] Open the resulting GEM_NAME.gemspec in EDITOR, or the default - editor if not specified. The default is 1m$BUNDLER_EDITOR22m, 1m$VIS-0m - 1mUAL22m, or 1m$EDITOR22m. + editor if not specified. The default is $BUNDLER_EDITOR, + $VISUAL, or $EDITOR. -1mSEE ALSO0m - o bundle config(1) 4mbundle-config.1.html0m +SEE ALSO + o bundle config(1) bundle-config.1.html - November 2018 BUNDLE-GEM(1) + March 2019 BUNDLE-GEM(1) diff --git a/man/bundle-info.1 b/man/bundle-info.1 index 9140d27c73..d1db7aa70f 100644 --- a/man/bundle-info.1 +++ b/man/bundle-info.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "BUNDLE\-INFO" "1" "November 2018" "" "" +.TH "BUNDLE\-INFO" "1" "March 2019" "" "" . .SH "NAME" \fBbundle\-info\fR \- Show information for the given gem in your bundle diff --git a/man/bundle-info.1.txt b/man/bundle-info.1.txt index 4d328416e7..7057249188 100644 --- a/man/bundle-info.1.txt +++ b/man/bundle-info.1.txt @@ -2,20 +2,20 @@ BUNDLE-INFO(1) BUNDLE-INFO(1) -1mNAME0m - 1mbundle-info 22m- Show information for the given gem in your bundle +NAME + bundle-info - Show information for the given gem in your bundle -1mSYNOPSIS0m - 1mbundle info 22m[GEM] [--path] +SYNOPSIS + bundle info [GEM] [--path] -1mDESCRIPTION0m +DESCRIPTION Print the basic information about the provided GEM such as homepage, version, path and summary. -1mOPTIONS0m - 1m--path 22mPrint the path of the given gem +OPTIONS + --path Print the path of the given gem - November 2018 BUNDLE-INFO(1) + March 2019 BUNDLE-INFO(1) diff --git a/man/bundle-init.1 b/man/bundle-init.1 index 70519fda39..67bce69023 100644 --- a/man/bundle-init.1 +++ b/man/bundle-init.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "BUNDLE\-INIT" "1" "November 2018" "" "" +.TH "BUNDLE\-INIT" "1" "April 2019" "" "" . .SH "NAME" \fBbundle\-init\fR \- Generates a Gemfile into the current working directory @@ -22,4 +22,4 @@ Use the specified \.gemspec to create the [\fBGemfile(5)\fR][Gemfile(5)] Included in the default [\fBGemfile(5)\fR][Gemfile(5)] generated is the line \fB# frozen_string_literal: true\fR\. This is a magic comment supported for the first time in Ruby 2\.3\. The presence of this line results in all string literals in the file being implicitly frozen\. . .SH "SEE ALSO" -Gemfile(5) \fIhttp://bundler\.io/man/gemfile\.5\.html\fR +Gemfile(5) \fIhttps://bundler\.io/man/gemfile\.5\.html\fR diff --git a/man/bundle-init.1.txt b/man/bundle-init.1.txt index eb6091bab2..47c996944b 100644 --- a/man/bundle-init.1.txt +++ b/man/bundle-init.1.txt @@ -2,33 +2,33 @@ BUNDLE-INIT(1) BUNDLE-INIT(1) -1mNAME0m - 1mbundle-init 22m- Generates a Gemfile into the current working directory +NAME + bundle-init - Generates a Gemfile into the current working directory -1mSYNOPSIS0m - 1mbundle init 22m[--gemspec=FILE] +SYNOPSIS + bundle init [--gemspec=FILE] -1mDESCRIPTION0m - Init generates a default [1mGemfile(5)22m][Gemfile(5)] in the current work- - ing directory. When adding a [1mGemfile(5)22m][Gemfile(5)] to a gem with a - gemspec, the 1m--gemspec 22moption will automatically add each dependency - listed in the gemspec file to the newly created [1mGemfile(5)22m][Gem- +DESCRIPTION + Init generates a default [Gemfile(5)][Gemfile(5)] in the current work- + ing directory. When adding a [Gemfile(5)][Gemfile(5)] to a gem with a + gemspec, the --gemspec option will automatically add each dependency + listed in the gemspec file to the newly created [Gemfile(5)][Gem- file(5)]. -1mOPTIONS0m - 1m--gemspec0m - Use the specified .gemspec to create the [1mGemfile(5)22m][Gem- +OPTIONS + --gemspec + Use the specified .gemspec to create the [Gemfile(5)][Gem- file(5)] -1mFILES0m - Included in the default [1mGemfile(5)22m][Gemfile(5)] generated is the line - 1m# frozen_string_literal: true22m. This is a magic comment supported for +FILES + Included in the default [Gemfile(5)][Gemfile(5)] generated is the line + # frozen_string_literal: true. This is a magic comment supported for the first time in Ruby 2.3. The presence of this line results in all string literals in the file being implicitly frozen. -1mSEE ALSO0m - Gemfile(5) 4mhttp://bundler.io/man/gemfile.5.html0m +SEE ALSO + Gemfile(5) https://bundler.io/man/gemfile.5.html - November 2018 BUNDLE-INIT(1) + April 2019 BUNDLE-INIT(1) diff --git a/man/bundle-init.ronn b/man/bundle-init.ronn index 7504af7bab..9d3d97deea 100644 --- a/man/bundle-init.ronn +++ b/man/bundle-init.ronn @@ -26,4 +26,4 @@ results in all string literals in the file being implicitly frozen. ## SEE ALSO -[Gemfile(5)](http://bundler.io/man/gemfile.5.html) +[Gemfile(5)](https://bundler.io/man/gemfile.5.html) diff --git a/man/bundle-inject.1 b/man/bundle-inject.1 index 4f663e1a85..b88e012182 100644 --- a/man/bundle-inject.1 +++ b/man/bundle-inject.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "BUNDLE\-INJECT" "1" "November 2018" "" "" +.TH "BUNDLE\-INJECT" "1" "March 2019" "" "" . .SH "NAME" \fBbundle\-inject\fR \- Add named gem(s) with version requirements to Gemfile diff --git a/man/bundle-inject.1.txt b/man/bundle-inject.1.txt index 0011dea0c1..7baea1c972 100644 --- a/man/bundle-inject.1.txt +++ b/man/bundle-inject.1.txt @@ -2,17 +2,17 @@ BUNDLE-INJECT(1) BUNDLE-INJECT(1) -1mNAME0m - 1mbundle-inject 22m- Add named gem(s) with version requirements to Gemfile +NAME + bundle-inject - Add named gem(s) with version requirements to Gemfile -1mSYNOPSIS0m - 1mbundle inject 22m[GEM] [VERSION] +SYNOPSIS + bundle inject [GEM] [VERSION] -1mDESCRIPTION0m +DESCRIPTION Adds the named gem(s) with their version requirements to the resolved - [1mGemfile(5)22m][Gemfile(5)]. + [Gemfile(5)][Gemfile(5)]. - This command will add the gem to both your [1mGemfile(5)22m][Gemfile(5)] and + This command will add the gem to both your [Gemfile(5)][Gemfile(5)] and Gemfile.lock if it isn't listed yet. Example: @@ -25,8 +25,8 @@ BUNDLE-INJECT(1) BUNDLE-INJECT(1) This will inject the 'rack' gem with a version greater than 0 in your - [1mGemfile(5)22m][Gemfile(5)] and Gemfile.lock + [Gemfile(5)][Gemfile(5)] and Gemfile.lock - November 2018 BUNDLE-INJECT(1) + March 2019 BUNDLE-INJECT(1) diff --git a/man/bundle-install.1 b/man/bundle-install.1 index 8bd0a7fa3d..dbb0d21c1c 100644 --- a/man/bundle-install.1 +++ b/man/bundle-install.1 @@ -1,13 +1,13 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "BUNDLE\-INSTALL" "1" "January 2019" "" "" +.TH "BUNDLE\-INSTALL" "1" "April 2019" "" "" . .SH "NAME" \fBbundle\-install\fR \- Install the dependencies specified in your Gemfile . .SH "SYNOPSIS" -\fBbundle install\fR [\-\-binstubs[=DIRECTORY]] [\-\-clean] [\-\-deployment] [\-\-force] [\-\-frozen] [\-\-full\-index] [\-\-gemfile=GEMFILE] [\-\-jobs=NUMBER] [\-\-local] [\-\-no\-cache] [\-\-no\-prune] [\-\-path PATH] [\-\-quiet] [\-\-retry=NUMBER] [\-\-shebang] [\-\-standalone[=GROUP[ GROUP\.\.\.]]] [\-\-system] [\-\-trust\-policy=POLICY] [\-\-with=GROUP[ GROUP\.\.\.]] [\-\-without=GROUP[ GROUP\.\.\.]] +\fBbundle install\fR [\-\-binstubs[=DIRECTORY]] [\-\-clean] [\-\-deployment] [\-\-frozen] [\-\-full\-index] [\-\-gemfile=GEMFILE] [\-\-jobs=NUMBER] [\-\-local] [\-\-no\-cache] [\-\-no\-prune] [\-\-path PATH] [\-\-quiet] [\-\-redownload] [\-\-retry=NUMBER] [\-\-shebang] [\-\-standalone[=GROUP[ GROUP\.\.\.]]] [\-\-system] [\-\-trust\-policy=POLICY] [\-\-with=GROUP[ GROUP\.\.\.]] [\-\-without=GROUP[ GROUP\.\.\.]] . .SH "DESCRIPTION" Install the gems specified in your Gemfile(5)\. If this is the first time you run bundle install (and a \fBGemfile\.lock\fR does not exist), Bundler will fetch all remote sources, resolve dependencies and install all needed gems\. @@ -23,7 +23,10 @@ To apply any of \fB\-\-binstubs\fR, \fB\-\-deployment\fR, \fB\-\-path\fR, or \fB . .TP \fB\-\-binstubs[=<directory>]\fR -Creates a directory (defaults to \fB~/bin\fR) and place any executables from the gem there\. These executables run in Bundler\'s context\. If used, you might add this directory to your environment\'s \fBPATH\fR variable\. For instance, if the \fBrails\fR gem comes with a \fBrails\fR executable, this flag will create a \fBbin/rails\fR executable that ensures that all referred dependencies will be resolved using the bundled gems\. +Binstubs are scripts that wrap around executables\. Bundler creates a small Ruby file (a binstub) that loads Bundler, runs the command, and puts it in \fBbin/\fR\. This lets you link the binstub inside of an application to the exact gem version the application needs\. +. +.IP +Creates a directory (defaults to \fB~/bin\fR) and places any executables from the gem there\. These executables run in Bundler\'s context\. If used, you might add this directory to your environment\'s \fBPATH\fR variable\. For instance, if the \fBrails\fR gem comes with a \fBrails\fR executable, this flag will create a \fBbin/rails\fR executable that ensures that all referred dependencies will be resolved using the bundled gems\. . .TP \fB\-\-clean\fR @@ -34,8 +37,8 @@ On finishing the installation Bundler is going to remove any gems not present in In \fIdeployment mode\fR, Bundler will \'roll\-out\' the bundle for production or CI use\. Please check carefully if you want to have this option enabled in your development environment\. . .TP -\fB\-\-force\fR -Force download every gem, even if the required versions are already available locally\. \fB\-\-redownload\fR is an alias of this option\. +\fB\-\-redownload\fR +Force download every gem, even if the required versions are already available locally\. . .TP \fB\-\-frozen\fR diff --git a/man/bundle-install.1.txt b/man/bundle-install.1.txt index 7637aeb8b7..72499f3d2d 100644 --- a/man/bundle-install.1.txt +++ b/man/bundle-install.1.txt @@ -2,245 +2,250 @@ BUNDLE-INSTALL(1) BUNDLE-INSTALL(1) -1mNAME0m - 1mbundle-install 22m- Install the dependencies specified in your Gemfile +NAME + bundle-install - Install the dependencies specified in your Gemfile -1mSYNOPSIS0m - 1mbundle install 22m[--binstubs[=DIRECTORY]] [--clean] [--deployment] - [--force] [--frozen] [--full-index] [--gemfile=GEMFILE] [--jobs=NUMBER] - [--local] [--no-cache] [--no-prune] [--path PATH] [--quiet] +SYNOPSIS + bundle install [--binstubs[=DIRECTORY]] [--clean] [--deployment] + [--frozen] [--full-index] [--gemfile=GEMFILE] [--jobs=NUMBER] [--local] + [--no-cache] [--no-prune] [--path PATH] [--quiet] [--redownload] [--retry=NUMBER] [--shebang] [--standalone[=GROUP[ GROUP...]]] [--sys- tem] [--trust-policy=POLICY] [--with=GROUP[ GROUP...]] [--with- out=GROUP[ GROUP...]] -1mDESCRIPTION0m +DESCRIPTION Install the gems specified in your Gemfile(5). If this is the first - time you run bundle install (and a 1mGemfile.lock 22mdoes not exist), + time you run bundle install (and a Gemfile.lock does not exist), Bundler will fetch all remote sources, resolve dependencies and install all needed gems. - If a 1mGemfile.lock 22mdoes exist, and you have not updated your Gemfile(5), + If a Gemfile.lock does exist, and you have not updated your Gemfile(5), Bundler will fetch all remote sources, but use the dependencies speci- - fied in the 1mGemfile.lock 22minstead of resolving dependencies. + fied in the Gemfile.lock instead of resolving dependencies. - If a 1mGemfile.lock 22mdoes exist, and you have updated your Gemfile(5), - Bundler will use the dependencies in the 1mGemfile.lock 22mfor all gems that + If a Gemfile.lock does exist, and you have updated your Gemfile(5), + Bundler will use the dependencies in the Gemfile.lock for all gems that you did not update, but will re-resolve the dependencies of gems that you did update. You can find more information about this update process - below under 4mCONSERVATIVE24m 4mUPDATING24m. + below under CONSERVATIVE UPDATING. -1mOPTIONS0m - To apply any of 1m--binstubs22m, 1m--deployment22m, 1m--path22m, or 1m--without 22mevery - time 1mbundle install 22mis run, use 1mbundle config 22m(see bundle-config(1)). +OPTIONS + To apply any of --binstubs, --deployment, --path, or --without every + time bundle install is run, use bundle config (see bundle-config(1)). - 1m--binstubs[=<directory>]0m - Creates a directory (defaults to 1m~/bin22m) and place any executa- + --binstubs[=<directory>] + Binstubs are scripts that wrap around executables. Bundler cre- + ates a small Ruby file (a binstub) that loads Bundler, runs the + command, and puts it in bin/. This lets you link the binstub + inside of an application to the exact gem version the applica- + tion needs. + + Creates a directory (defaults to ~/bin) and places any executa- bles from the gem there. These executables run in Bundler's con- text. If used, you might add this directory to your environ- - ment's 1mPATH 22mvariable. For instance, if the 1mrails 22mgem comes with - a 1mrails 22mexecutable, this flag will create a 1mbin/rails 22mexecutable - that ensures that all referred dependencies will be resolved us- - ing the bundled gems. + ment's PATH variable. For instance, if the rails gem comes with + a rails executable, this flag will create a bin/rails executable + that ensures that all referred dependencies will be resolved + using the bundled gems. - 1m--clean0m + --clean On finishing the installation Bundler is going to remove any gems not present in the current Gemfile(5). Don't worry, gems currently in use will not be removed. - 1m--deployment0m - In 4mdeployment24m 4mmode24m, Bundler will 'roll-out' the bundle for pro- + --deployment + In deployment mode, Bundler will 'roll-out' the bundle for pro- duction or CI use. Please check carefully if you want to have this option enabled in your development environment. - 1m--force0m - Force download every gem, even if the required versions are al- - ready available locally. 1m--redownload 22mis an alias of this op- - tion. + --redownload + Force download every gem, even if the required versions are + already available locally. - 1m--frozen0m - Do not allow the Gemfile.lock to be updated after this install. - Exits non-zero if there are going to be changes to the Gem- + --frozen + Do not allow the Gemfile.lock to be updated after this install. + Exits non-zero if there are going to be changes to the Gem- file.lock. - 1m--full-index0m + --full-index Bundler will not call Rubygems' API endpoint (default) but down- load and cache a (currently big) index file of all gems. Perfor- - mance can be improved for large bundles that seldom change by + mance can be improved for large bundles that seldom change by enabling this option. - 1m--gemfile=<gemfile>0m - The location of the Gemfile(5) which Bundler should use. This - defaults to a Gemfile(5) in the current working directory. In + --gemfile=<gemfile> + The location of the Gemfile(5) which Bundler should use. This + defaults to a Gemfile(5) in the current working directory. In general, Bundler will assume that the location of the Gemfile(5) - is also the project's root and will try to find 1mGemfile.lock 22mand - 1mvendor/cache 22mrelative to this location. - - 1m--jobs=[<number>]22m, 1m-j[<number>]0m - The maximum number of parallel download and install jobs. The - default is 1m122m. - - 1m--local0m - Do not attempt to connect to 1mrubygems.org22m. Instead, Bundler will - use the gems already present in Rubygems' cache or in 1mven-0m - 1mdor/cache22m. Note that if a appropriate platform-specific gem ex- - ists on 1mrubygems.org 22mit will not be found. - - 1m--no-cache0m - Do not update the cache in 1mvendor/cache 22mwith the newly bundled - gems. This does not remove any gems in the cache but keeps the + is also the project's root and will try to find Gemfile.lock and + vendor/cache relative to this location. + + --jobs=[<number>], -j[<number>] + The maximum number of parallel download and install jobs. The + default is 1. + + --local + Do not attempt to connect to rubygems.org. Instead, Bundler will + use the gems already present in Rubygems' cache or in ven- + dor/cache. Note that if a appropriate platform-specific gem + exists on rubygems.org it will not be found. + + --no-cache + Do not update the cache in vendor/cache with the newly bundled + gems. This does not remove any gems in the cache but keeps the newly bundled gems from being cached during the install. - 1m--no-prune0m - Don't remove stale gems from the cache when the installation + --no-prune + Don't remove stale gems from the cache when the installation finishes. - 1m--path=<path>0m - The location to install the specified gems to. This defaults to - Rubygems' setting. Bundler shares this location with Rubygems, - 1mgem install ... 22mwill have gem installed there, too. Therefore, - gems installed without a 1m--path ... 22msetting will show up by - calling 1mgem list22m. Accordingly, gems installed to other locations + --path=<path> + The location to install the specified gems to. This defaults to + Rubygems' setting. Bundler shares this location with Rubygems, + gem install ... will have gem installed there, too. Therefore, + gems installed without a --path ... setting will show up by + calling gem list. Accordingly, gems installed to other locations will not get listed. - 1m--quiet0m - Do not print progress information to the standard output. In- - stead, Bundler will exit using a status code (1m$?22m). - - 1m--retry=[<number>]0m - Retry failed network or git requests for 4mnumber24m times. - - 1m--shebang=<ruby-executable>0m - Uses the specified ruby executable (usually 1mruby22m) to execute the - scripts created with 1m--binstubs22m. In addition, if you use 1m--bin-0m - 1mstubs 22mtogether with 1m--shebang jruby 22mthese executables will be - changed to execute 1mjruby 22minstead. - - 1m--standalone[=<list>]0m - Makes a bundle that can work without depending on Rubygems or - Bundler at runtime. A space separated list of groups to install - has to be specified. Bundler creates a directory named 1mbundle0m - and installs the bundle there. It also generates a 1mbun-0m - 1mdle/bundler/setup.rb 22mfile to replace Bundler's own setup in the - manner required. Using this option implicitly sets 1mpath22m, which + --quiet + Do not print progress information to the standard output. + Instead, Bundler will exit using a status code ($?). + + --retry=[<number>] + Retry failed network or git requests for number times. + + --shebang=<ruby-executable> + Uses the specified ruby executable (usually ruby) to execute the + scripts created with --binstubs. In addition, if you use --bin- + stubs together with --shebang jruby these executables will be + changed to execute jruby instead. + + --standalone[=<list>] + Makes a bundle that can work without depending on Rubygems or + Bundler at runtime. A space separated list of groups to install + has to be specified. Bundler creates a directory named bundle + and installs the bundle there. It also generates a bun- + dle/bundler/setup.rb file to replace Bundler's own setup in the + manner required. Using this option implicitly sets path, which is a [remembered option][REMEMBERED OPTIONS]. - 1m--system0m - Installs the gems specified in the bundle to the system's - Rubygems location. This overrides any previous configuration of - 1m--path22m. + --system + Installs the gems specified in the bundle to the system's + Rubygems location. This overrides any previous configuration of + --path. - 1m--trust-policy=[<policy>]0m - Apply the Rubygems security policy 4mpolicy24m, where policy is one - of 1mHighSecurity22m, 1mMediumSecurity22m, 1mLowSecurity22m, 1mAlmostNoSecurity22m, - or 1mNoSecurity22m. For more details, please see the Rubygems signing - documentation linked below in 4mSEE24m 4mALSO24m. + --trust-policy=[<policy>] + Apply the Rubygems security policy policy, where policy is one + of HighSecurity, MediumSecurity, LowSecurity, AlmostNoSecurity, + or NoSecurity. For more details, please see the Rubygems signing + documentation linked below in SEE ALSO. - 1m--with=<list>0m + --with=<list> A space-separated list of groups referencing gems to install. If - an optional group is given it is installed. If a group is given - that is in the remembered list of groups given to --without, it + an optional group is given it is installed. If a group is given + that is in the remembered list of groups given to --without, it is removed from that list. - 1m--without=<list>0m + --without=<list> A space-separated list of groups referencing gems to skip during installation. If a group is given that is in the remembered list of groups given to --with, it is removed from that list. -1mDEPLOYMENT MODE0m +DEPLOYMENT MODE Bundler's defaults are optimized for development. To switch to defaults - optimized for deployment and for CI, use the 1m--deployment 22mflag. Do not - activate deployment mode on development machines, as it will cause an + optimized for deployment and for CI, use the --deployment flag. Do not + activate deployment mode on development machines, as it will cause an error when the Gemfile(5) is modified. - 1. A 1mGemfile.lock 22mis required. + 1. A Gemfile.lock is required. To ensure that the same versions of the gems you developed with and - tested with are also used in deployments, a 1mGemfile.lock 22mis re- - quired. + tested with are also used in deployments, a Gemfile.lock is + required. - This is mainly to ensure that you remember to check your 1mGem-0m - 1mfile.lock 22minto version control. + This is mainly to ensure that you remember to check your Gem- + file.lock into version control. - 2. The 1mGemfile.lock 22mmust be up to date + 2. The Gemfile.lock must be up to date - In development, you can modify your Gemfile(5) and re-run 1mbundle0m - 1minstall 22mto 4mconservatively24m 4mupdate24m your 1mGemfile.lock 22msnapshot. + In development, you can modify your Gemfile(5) and re-run bundle + install to conservatively update your Gemfile.lock snapshot. - In deployment, your 1mGemfile.lock 22mshould be up-to-date with changes + In deployment, your Gemfile.lock should be up-to-date with changes made in your Gemfile(5). - 3. Gems are installed to 1mvendor/bundle 22mnot your default system loca- + 3. Gems are installed to vendor/bundle not your default system loca- tion - In development, it's convenient to share the gems used in your ap- - plication with other applications and other scripts that run on the - system. + In development, it's convenient to share the gems used in your + application with other applications and other scripts that run on + the system. - In deployment, isolation is a more important default. In addition, - the user deploying the application may not have permission to in- - stall gems to the system, or the web server may not have permission - to read them. + In deployment, isolation is a more important default. In addition, + the user deploying the application may not have permission to + install gems to the system, or the web server may not have permis- + sion to read them. - As a result, 1mbundle install --deployment 22minstalls gems to the 1mven-0m - 1mdor/bundle 22mdirectory in the application. This may be overridden us- - ing the 1m--path 22moption. + As a result, bundle install --deployment installs gems to the ven- + dor/bundle directory in the application. This may be overridden + using the --path option. -1mSUDO USAGE0m - By default, Bundler installs gems to the same location as 1mgem install22m. +SUDO USAGE + By default, Bundler installs gems to the same location as gem install. In some cases, that location may not be writable by your Unix user. In that case, Bundler will stage everything in a temporary directory, then - ask you for your 1msudo 22mpassword in order to copy the gems into their + ask you for your sudo password in order to copy the gems into their system location. - From your perspective, this is identical to installing the gems di- - rectly into the system. + From your perspective, this is identical to installing the gems + directly into the system. - You should never use 1msudo bundle install22m. This is because several other - steps in 1mbundle install 22mmust be performed as the current user: + You should never use sudo bundle install. This is because several other + steps in bundle install must be performed as the current user: - o Updating your 1mGemfile.lock0m + o Updating your Gemfile.lock - o Updating your 1mvendor/cache22m, if necessary + o Updating your vendor/cache, if necessary o Checking out private git repositories using your user's SSH keys Of these three, the first two could theoretically be performed by - 1mchown22ming the resulting files to 1m$SUDO_USER22m. The third, however, can - only be performed by invoking the 1mgit 22mcommand as the current user. - Therefore, git gems are downloaded and installed into 1m~/.bundle 22mrather + chowning the resulting files to $SUDO_USER. The third, however, can + only be performed by invoking the git command as the current user. + Therefore, git gems are downloaded and installed into ~/.bundle rather than $GEM_HOME or $BUNDLE_PATH. - As a result, you should run 1mbundle install 22mas the current user, and + As a result, you should run bundle install as the current user, and Bundler will ask for your password if it is needed to put the gems into their final location. -1mINSTALLING GROUPS0m - By default, 1mbundle install 22mwill install all gems in all groups in your +INSTALLING GROUPS + By default, bundle install will install all gems in all groups in your Gemfile(5), except those declared for a different platform. However, you can explicitly tell Bundler to skip installing certain - groups with the 1m--without 22moption. This option takes a space-separated + groups with the --without option. This option takes a space-separated list of groups. - While the 1m--without 22moption will skip 4minstalling24m the gems in the speci- - fied groups, it will still 4mdownload24m those gems and use them to resolve + While the --without option will skip installing the gems in the speci- + fied groups, it will still download those gems and use them to resolve the dependencies of every gem in your Gemfile(5). This is so that installing a different set of groups on another machine (such as a production server) will not change the gems and versions that you have already developed and tested against. - 1mBundler offers a rock-solid guarantee that the third-party code you are0m - 1mrunning in development and testing is also the third-party code you are0m - 1mrunning in production. You can choose to exclude some of that code in0m - 1mdifferent environments, but you will never be caught flat-footed by0m - 1mdifferent versions of third-party code being used in different environ-0m - 1mments.0m + Bundler offers a rock-solid guarantee that the third-party code you are + running in development and testing is also the third-party code you are + running in production. You can choose to exclude some of that code in + different environments, but you will never be caught flat-footed by + different versions of third-party code being used in different environ- + ments. For a simple illustration, consider the following Gemfile(5): @@ -256,18 +261,18 @@ BUNDLE-INSTALL(1) BUNDLE-INSTALL(1) - In this case, 1msinatra 22mdepends on any version of Rack (1m>= 1.022m), while - 1mrack-perftools-profiler 22mdepends on 1.x (1m~> 1.022m). + In this case, sinatra depends on any version of Rack (>= 1.0), while + rack-perftools-profiler depends on 1.x (~> 1.0). - When you run 1mbundle install --without production 22min development, we - look at the dependencies of 1mrack-perftools-profiler 22mas well. That way, + When you run bundle install --without production in development, we + look at the dependencies of rack-perftools-profiler as well. That way, you do not spend all your time developing against Rack 2.0, using new APIs unavailable in Rack 1.x, only to have Bundler switch to Rack 1.2 - when the 1mproduction 22mgroup 4mis24m used. + when the production group is used. - This should not cause any problems in practice, because we do not at- - tempt to 1minstall 22mthe gems in the excluded groups, and only evaluate as - part of the dependency resolution process. + This should not cause any problems in practice, because we do not + attempt to install the gems in the excluded groups, and only evaluate + as part of the dependency resolution process. This also means that you cannot include different versions of the same gem in different groups, because doing so would result in different @@ -276,12 +281,12 @@ BUNDLE-INSTALL(1) BUNDLE-INSTALL(1) more than the gems you list in your Gemfile(5), and can (surprisingly) radically change the gems you are using. -1mTHE GEMFILE.LOCK0m - When you run 1mbundle install22m, Bundler will persist the full names and +THE GEMFILE.LOCK + When you run bundle install, Bundler will persist the full names and versions of all gems that you used (including dependencies of the gems - specified in the Gemfile(5)) into a file called 1mGemfile.lock22m. + specified in the Gemfile(5)) into a file called Gemfile.lock. - Bundler uses this file in all subsequent calls to 1mbundle install22m, which + Bundler uses this file in all subsequent calls to bundle install, which guarantees that you always use the same exact code, even as your appli- cation moves across machines. @@ -290,29 +295,29 @@ BUNDLE-INSTALL(1) BUNDLE-INSTALL(1) gem in your Gemfile(5)) can result in radically different gems being needed to satisfy all dependencies. - As a result, you 1mSHOULD 22mcheck your 1mGemfile.lock 22minto version control, + As a result, you SHOULD check your Gemfile.lock into version control, in both applications and gems. If you do not, every machine that checks out your repository (including your production server) will resolve all dependencies again, which will result in different versions of - third-party code being used if 1many 22mof the gems in the Gemfile(5) or any + third-party code being used if any of the gems in the Gemfile(5) or any of their dependencies have been updated. - When Bundler first shipped, the 1mGemfile.lock 22mwas included in the 1m.git-0m - 1mignore 22mfile included with generated gems. Over time, however, it became + When Bundler first shipped, the Gemfile.lock was included in the .git- + ignore file included with generated gems. Over time, however, it became clear that this practice forces the pain of broken dependencies onto - new contributors, while leaving existing contributors potentially un- - aware of the problem. Since 1mbundle install 22mis usually the first step + new contributors, while leaving existing contributors potentially + unaware of the problem. Since bundle install is usually the first step towards a contribution, the pain of broken dependencies would discour- age new contributors from contributing. As a result, we have revised our guidance for gem authors to now recommend checking in the lock for gems. -1mCONSERVATIVE UPDATING0m - When you make a change to the Gemfile(5) and then run 1mbundle install22m, +CONSERVATIVE UPDATING + When you make a change to the Gemfile(5) and then run bundle install, Bundler will update only the gems that you modified. - In other words, if a gem that you 1mdid not modify 22mworked before you - called 1mbundle install22m, it will continue to use the exact same versions + In other words, if a gem that you did not modify worked before you + called bundle install, it will continue to use the exact same versions of all dependencies as it used before the update. Let's take a look at an example. Here's your original Gemfile(5): @@ -326,13 +331,13 @@ BUNDLE-INSTALL(1) BUNDLE-INSTALL(1) - In this case, both 1mactionpack 22mand 1mactivemerchant 22mdepend on 1mactivesup-0m - 1mport22m. The 1mactionpack 22mgem depends on 1mactivesupport 2.3.8 22mand 1mrack ~>0m - 1m1.1.022m, while the 1mactivemerchant 22mgem depends on 1mactivesupport >= 2.3.222m, - 1mbraintree >= 2.0.022m, and 1mbuilder >= 2.0.022m. + In this case, both actionpack and activemerchant depend on activesup- + port. The actionpack gem depends on activesupport 2.3.8 and rack ~> + 1.1.0, while the activemerchant gem depends on activesupport >= 2.3.2, + braintree >= 2.0.0, and builder >= 2.0.0. - When the dependencies are first resolved, Bundler will select 1mac-0m - 1mtivesupport 2.3.822m, which satisfies the requirements of both gems in + When the dependencies are first resolved, Bundler will select + activesupport 2.3.8, which satisfies the requirements of both gems in your Gemfile(5). Next, you modify your Gemfile(5) to: @@ -346,51 +351,51 @@ BUNDLE-INSTALL(1) BUNDLE-INSTALL(1) - The 1mactionpack 3.0.0.rc 22mgem has a number of new dependencies, and up- - dates the 1mactivesupport 22mdependency to 1m= 3.0.0.rc 22mand the 1mrack 22mdepen- - dency to 1m~> 1.2.122m. + The actionpack 3.0.0.rc gem has a number of new dependencies, and + updates the activesupport dependency to = 3.0.0.rc and the rack depen- + dency to ~> 1.2.1. - When you run 1mbundle install22m, Bundler notices that you changed the 1mac-0m - 1mtionpack 22mgem, but not the 1mactivemerchant 22mgem. It evaluates the gems + When you run bundle install, Bundler notices that you changed the + actionpack gem, but not the activemerchant gem. It evaluates the gems currently being used to satisfy its requirements: - 1mactivesupport 2.3.80m - also used to satisfy a dependency in 1mactivemerchant22m, which is + activesupport 2.3.8 + also used to satisfy a dependency in activemerchant, which is not being updated - 1mrack ~> 1.1.00m + rack ~> 1.1.0 not currently being used to satisfy another dependency - Because you did not explicitly ask to update 1mactivemerchant22m, you would - not expect it to suddenly stop working after updating 1mactionpack22m. How- - ever, satisfying the new 1mactivesupport 3.0.0.rc 22mdependency of action- + Because you did not explicitly ask to update activemerchant, you would + not expect it to suddenly stop working after updating actionpack. How- + ever, satisfying the new activesupport 3.0.0.rc dependency of action- pack requires updating one of its dependencies. - Even though 1mactivemerchant 22mdeclares a very loose dependency that theo- - retically matches 1mactivesupport 3.0.0.rc22m, Bundler treats gems in your + Even though activemerchant declares a very loose dependency that theo- + retically matches activesupport 3.0.0.rc, Bundler treats gems in your Gemfile(5) that have not changed as an atomic unit together with their - dependencies. In this case, the 1mactivemerchant 22mdependency is treated as - 1mactivemerchant 1.7.1 + activesupport 2.3.822m, so 1mbundle install 22mwill re- - port that it cannot update 1mactionpack22m. + dependencies. In this case, the activemerchant dependency is treated as + activemerchant 1.7.1 + activesupport 2.3.8, so bundle install will + report that it cannot update actionpack. - To explicitly update 1mactionpack22m, including its dependencies which other - gems in the Gemfile(5) still depend on, run 1mbundle update actionpack0m - (see 1mbundle update(1)22m). + To explicitly update actionpack, including its dependencies which other + gems in the Gemfile(5) still depend on, run bundle update actionpack + (see bundle update(1)). - 1mSummary22m: In general, after making a change to the Gemfile(5) , you - should first try to run 1mbundle install22m, which will guarantee that no + Summary: In general, after making a change to the Gemfile(5) , you + should first try to run bundle install, which will guarantee that no other gem in the Gemfile(5) is impacted by the change. If that does not - work, run bundle update(1) 4mbundle-update.1.html24m. + work, run bundle update(1) bundle-update.1.html. -1mSEE ALSO0m - o Gem install docs 4mhttp://guides.rubygems.org/rubygems-basics/#in-0m - 4mstalling-gems0m +SEE ALSO + o Gem install docs + http://guides.rubygems.org/rubygems-basics/#installing-gems - o Rubygems signing docs 4mhttp://guides.rubygems.org/security/0m + o Rubygems signing docs http://guides.rubygems.org/security/ - January 2019 BUNDLE-INSTALL(1) + April 2019 BUNDLE-INSTALL(1) diff --git a/man/bundle-install.ronn b/man/bundle-install.ronn index a9e375c87c..2ba82f27a5 100644 --- a/man/bundle-install.ronn +++ b/man/bundle-install.ronn @@ -6,7 +6,6 @@ bundle-install(1) -- Install the dependencies specified in your Gemfile `bundle install` [--binstubs[=DIRECTORY]] [--clean] [--deployment] - [--force] [--frozen] [--full-index] [--gemfile=GEMFILE] @@ -16,6 +15,7 @@ bundle-install(1) -- Install the dependencies specified in your Gemfile [--no-prune] [--path PATH] [--quiet] + [--redownload] [--retry=NUMBER] [--shebang] [--standalone[=GROUP[ GROUP...]]] @@ -47,7 +47,12 @@ To apply any of `--binstubs`, `--deployment`, `--path`, or `--without` every time `bundle install` is run, use `bundle config` (see bundle-config(1)). * `--binstubs[=<directory>]`: - Creates a directory (defaults to `~/bin`) and place any executables from the + Binstubs are scripts that wrap around executables. Bundler creates a small Ruby + file (a binstub) that loads Bundler, runs the command, and puts it in `bin/`. + This lets you link the binstub inside of an application to the exact gem + version the application needs. + + Creates a directory (defaults to `~/bin`) and places any executables from the gem there. These executables run in Bundler's context. If used, you might add this directory to your environment's `PATH` variable. For instance, if the `rails` gem comes with a `rails` executable, this flag will create a @@ -64,9 +69,9 @@ time `bundle install` is run, use `bundle config` (see bundle-config(1)). production or CI use. Please check carefully if you want to have this option enabled in your development environment. -* `--force`: +* `--redownload`: Force download every gem, even if the required versions are already available - locally. `--redownload` is an alias of this option. + locally. * `--frozen`: Do not allow the Gemfile.lock to be updated after this install. Exits diff --git a/man/bundle-list.1 b/man/bundle-list.1 index c41948f1b5..d282228be2 100644 --- a/man/bundle-list.1 +++ b/man/bundle-list.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "BUNDLE\-LIST" "1" "November 2018" "" "" +.TH "BUNDLE\-LIST" "1" "March 2019" "" "" . .SH "NAME" \fBbundle\-list\fR \- List all the gems in the bundle diff --git a/man/bundle-list.1.txt b/man/bundle-list.1.txt index aa20d4ebea..7ef2427608 100644 --- a/man/bundle-list.1.txt +++ b/man/bundle-list.1.txt @@ -2,14 +2,14 @@ BUNDLE-LIST(1) BUNDLE-LIST(1) -1mNAME0m - 1mbundle-list 22m- List all the gems in the bundle +NAME + bundle-list - List all the gems in the bundle -1mSYNOPSIS0m - 1mbundle list 22m[--name-only] [--paths] [--without-group=GROUP] +SYNOPSIS + bundle list [--name-only] [--paths] [--without-group=GROUP] [--only-group=GROUP] -1mDESCRIPTION0m +DESCRIPTION Prints a list of all the gems in the bundle including their version. Example: @@ -24,20 +24,20 @@ BUNDLE-LIST(1) BUNDLE-LIST(1) bundle list --only-group dev --paths -1mOPTIONS0m - 1m--name-only0m +OPTIONS + --name-only Print only the name of each gem. - 1m--paths0m + --paths Print the path to each gem in the bundle. - 1m--without-group0m + --without-group Print all gems expect from a group. - 1m--only-group0m + --only-group Print gems from a particular group. - November 2018 BUNDLE-LIST(1) + March 2019 BUNDLE-LIST(1) diff --git a/man/bundle-lock.1 b/man/bundle-lock.1 index 03b7e8f9cc..bec1cb5200 100644 --- a/man/bundle-lock.1 +++ b/man/bundle-lock.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "BUNDLE\-LOCK" "1" "November 2018" "" "" +.TH "BUNDLE\-LOCK" "1" "March 2019" "" "" . .SH "NAME" \fBbundle\-lock\fR \- Creates / Updates a lockfile without installing diff --git a/man/bundle-lock.1.txt b/man/bundle-lock.1.txt index 838c1baae5..3da8b29ab3 100644 --- a/man/bundle-lock.1.txt +++ b/man/bundle-lock.1.txt @@ -2,92 +2,92 @@ BUNDLE-LOCK(1) BUNDLE-LOCK(1) -1mNAME0m - 1mbundle-lock 22m- Creates / Updates a lockfile without installing +NAME + bundle-lock - Creates / Updates a lockfile without installing -1mSYNOPSIS0m - 1mbundle lock 22m[--update] [--local] [--print] [--lockfile=PATH] +SYNOPSIS + bundle lock [--update] [--local] [--print] [--lockfile=PATH] [--full-index] [--add-platform] [--remove-platform] [--patch] [--minor] [--major] [--strict] [--conservative] -1mDESCRIPTION0m +DESCRIPTION Lock the gems specified in Gemfile. -1mOPTIONS0m - 1m--update=<*gems>0m +OPTIONS + --update=<*gems> Ignores the existing lockfile. Resolve then updates lockfile. - Taking a list of gems or updating all gems if no list is given. + Taking a list of gems or updating all gems if no list is given. - 1m--local0m - Do not attempt to connect to 1mrubygems.org22m. Instead, Bundler will - use the gems already present in Rubygems' cache or in 1mven-0m - 1mdor/cache22m. Note that if a appropriate platform-specific gem ex- - ists on 1mrubygems.org 22mit will not be found. + --local + Do not attempt to connect to rubygems.org. Instead, Bundler will + use the gems already present in Rubygems' cache or in ven- + dor/cache. Note that if a appropriate platform-specific gem + exists on rubygems.org it will not be found. - 1m--print0m - Prints the lockfile to STDOUT instead of writing to the file + --print + Prints the lockfile to STDOUT instead of writing to the file system. - 1m--lockfile=<path>0m + --lockfile=<path> The path where the lockfile should be written to. - 1m--full-index0m + --full-index Fall back to using the single-file index of all gems. - 1m--add-platform0m - Add a new platform to the lockfile, re-resolving for the addi- + --add-platform + Add a new platform to the lockfile, re-resolving for the addi- tion of that platform. - 1m--remove-platform0m + --remove-platform Remove a platform from the lockfile. - 1m--patch0m + --patch If updating, prefer updating only to next patch version. - 1m--minor0m + --minor If updating, prefer updating only to next minor version. - 1m--major0m + --major If updating, prefer updating to next major version (default). - 1m--strict0m - If updating, do not allow any gem to be updated past latest + --strict + If updating, do not allow any gem to be updated past latest --patch | --minor | --major. - 1m--conservative0m + --conservative If updating, use bundle install conservative update behavior and do not allow shared dependencies to be updated. -1mUPDATING ALL GEMS0m - If you run 1mbundle lock 22mwith 1m--update 22moption without list of gems, - bundler will ignore any previously installed gems and resolve all de- - pendencies again based on the latest versions of all gems available in - the sources. +UPDATING ALL GEMS + If you run bundle lock with --update option without list of gems, + bundler will ignore any previously installed gems and resolve all + dependencies again based on the latest versions of all gems available + in the sources. -1mUPDATING A LIST OF GEMS0m +UPDATING A LIST OF GEMS Sometimes, you want to update a single gem in the Gemfile(5), and leave - the rest of the gems that you specified locked to the versions in the - 1mGemfile.lock22m. + the rest of the gems that you specified locked to the versions in the + Gemfile.lock. - For instance, you only want to update 1mnokogiri22m, run 1mbundle lock --up-0m - 1mdate nokogiri22m. + For instance, you only want to update nokogiri, run bundle lock + --update nokogiri. - Bundler will update 1mnokogiri 22mand any of its dependencies, but leave the - rest of the gems that you specified locked to the versions in the 1mGem-0m - 1mfile.lock22m. + Bundler will update nokogiri and any of its dependencies, but leave the + rest of the gems that you specified locked to the versions in the Gem- + file.lock. -1mSUPPORTING OTHER PLATFORMS0m - If you want your bundle to support platforms other than the one you're - running locally, you can run 1mbundle lock --add-platform PLATFORM 22mto add - PLATFORM to the lockfile, force bundler to re-resolve and consider the - new platform when picking gems, all without needing to have a machine +SUPPORTING OTHER PLATFORMS + If you want your bundle to support platforms other than the one you're + running locally, you can run bundle lock --add-platform PLATFORM to add + PLATFORM to the lockfile, force bundler to re-resolve and consider the + new platform when picking gems, all without needing to have a machine that matches PLATFORM handy to install those platform-specific gems on. - For a full explanation of gem platforms, see 1mgem help platform22m. + For a full explanation of gem platforms, see gem help platform. -1mPATCH LEVEL OPTIONS0m - See bundle update(1) 4mbundle-update.1.html24m for details. +PATCH LEVEL OPTIONS + See bundle update(1) bundle-update.1.html for details. - November 2018 BUNDLE-LOCK(1) + March 2019 BUNDLE-LOCK(1) diff --git a/man/bundle-open.1 b/man/bundle-open.1 index 6301cb1fbc..9d8e390265 100644 --- a/man/bundle-open.1 +++ b/man/bundle-open.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "BUNDLE\-OPEN" "1" "November 2018" "" "" +.TH "BUNDLE\-OPEN" "1" "March 2019" "" "" . .SH "NAME" \fBbundle\-open\fR \- Opens the source directory for a gem in your bundle diff --git a/man/bundle-open.1.txt b/man/bundle-open.1.txt index 833744ae5e..ac289aa97d 100644 --- a/man/bundle-open.1.txt +++ b/man/bundle-open.1.txt @@ -2,16 +2,16 @@ BUNDLE-OPEN(1) BUNDLE-OPEN(1) -1mNAME0m - 1mbundle-open 22m- Opens the source directory for a gem in your bundle +NAME + bundle-open - Opens the source directory for a gem in your bundle -1mSYNOPSIS0m - 1mbundle open 22m[GEM] +SYNOPSIS + bundle open [GEM] -1mDESCRIPTION0m +DESCRIPTION Opens the source directory of the provided GEM in your editor. - For this to work the 1mEDITOR 22mor 1mBUNDLER_EDITOR 22menvironment variable has + For this to work the EDITOR or BUNDLER_EDITOR environment variable has to be set. Example: @@ -26,4 +26,4 @@ BUNDLE-OPEN(1) BUNDLE-OPEN(1) - November 2018 BUNDLE-OPEN(1) + March 2019 BUNDLE-OPEN(1) diff --git a/man/bundle-outdated.1 b/man/bundle-outdated.1 index cde4bb09a1..cbb88905ed 100644 --- a/man/bundle-outdated.1 +++ b/man/bundle-outdated.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "BUNDLE\-OUTDATED" "1" "November 2018" "" "" +.TH "BUNDLE\-OUTDATED" "1" "March 2019" "" "" . .SH "NAME" \fBbundle\-outdated\fR \- List installed gems with newer versions available diff --git a/man/bundle-outdated.1.txt b/man/bundle-outdated.1.txt index dc9d7a06c7..493ded1646 100644 --- a/man/bundle-outdated.1.txt +++ b/man/bundle-outdated.1.txt @@ -2,80 +2,80 @@ BUNDLE-OUTDATED(1) BUNDLE-OUTDATED(1) -1mNAME0m - 1mbundle-outdated 22m- List installed gems with newer versions available +NAME + bundle-outdated - List installed gems with newer versions available -1mSYNOPSIS0m - 1mbundle outdated 22m[GEM] [--local] [--pre] [--source] [--strict] - [--parseable | --porcelain] [--group=GROUP] [--groups] [--up- - date-strict] [--patch|--minor|--major] [--filter-major] [--filter-mi- - nor] [--filter-patch] [--only-explicit] +SYNOPSIS + bundle outdated [GEM] [--local] [--pre] [--source] [--strict] + [--parseable | --porcelain] [--group=GROUP] [--groups] + [--update-strict] [--patch|--minor|--major] [--filter-major] [--fil- + ter-minor] [--filter-patch] [--only-explicit] -1mDESCRIPTION0m +DESCRIPTION Outdated lists the names and versions of gems that have a newer version available in the given source. Calling outdated with [GEM [GEM]] will only check for newer versions of the given gems. Prerelease gems are ignored by default. If your gems are up to date, Bundler will exit with a status of 0. Otherwise, it will exit 1. -1mOPTIONS0m - 1m--local0m - Do not attempt to fetch gems remotely and use the gem cache in- - stead. +OPTIONS + --local + Do not attempt to fetch gems remotely and use the gem cache + instead. - 1m--pre 22mCheck for newer pre-release gems. + --pre Check for newer pre-release gems. - 1m--source0m + --source Check against a specific source. - 1m--strict0m + --strict Only list newer versions allowed by your Gemfile requirements. - 1m--parseable22m, 1m--porcelain0m + --parseable, --porcelain Use minimal formatting for more parseable output. - 1m--group0m + --group List gems from a specific group. - 1m--groups0m + --groups List gems organized by groups. - 1m--update-strict0m - Strict conservative resolution, do not allow any gem to be up- - dated past latest --patch | --minor| --major. + --update-strict + Strict conservative resolution, do not allow any gem to be + updated past latest --patch | --minor| --major. - 1m--minor0m + --minor Prefer updating only to next minor version. - 1m--major0m + --major Prefer updating to next major version (default). - 1m--patch0m + --patch Prefer updating only to next patch version. - 1m--filter-major0m + --filter-major Only list major newer versions. - 1m--filter-minor0m + --filter-minor Only list minor newer versions. - 1m--filter-patch0m + --filter-patch Only list patch newer versions. - 1m--only-explicit0m + --only-explicit Only list gems specified in your Gemfile, not their dependen- cies. -1mPATCH LEVEL OPTIONS0m - See bundle update(1) 4mbundle-update.1.html24m for details. +PATCH LEVEL OPTIONS + See bundle update(1) bundle-update.1.html for details. - One difference between the patch level options in 1mbundle update 22mand - here is the 1m--strict 22moption. 1m--strict 22mwas already an option on outdated - before the patch level options were added. 1m--strict 22mwasn't altered, and - the 1m--update-strict 22moption on 1moutdated 22mreflects what 1m--strict 22mdoes on - 1mbundle update22m. + One difference between the patch level options in bundle update and + here is the --strict option. --strict was already an option on outdated + before the patch level options were added. --strict wasn't altered, and + the --update-strict option on outdated reflects what --strict does on + bundle update. -1mFILTERING OUTPUT0m +FILTERING OUTPUT The 3 filtering options do not affect the resolution of versions, merely what versions are shown in the output. @@ -89,7 +89,7 @@ BUNDLE-OUTDATED(1) BUNDLE-OUTDATED(1) - 1m--filter-major 22mwould only show: + --filter-major would only show: @@ -97,7 +97,7 @@ BUNDLE-OUTDATED(1) BUNDLE-OUTDATED(1) - 1m--filter-minor 22mwould only show: + --filter-minor would only show: @@ -105,7 +105,7 @@ BUNDLE-OUTDATED(1) BUNDLE-OUTDATED(1) - 1m--filter-patch 22mwould only show: + --filter-patch would only show: @@ -113,7 +113,7 @@ BUNDLE-OUTDATED(1) BUNDLE-OUTDATED(1) - Filter options can be combined. 1m--filter-minor 22mand 1m--filter-patch 22mwould + Filter options can be combined. --filter-minor and --filter-patch would show: @@ -123,9 +123,9 @@ BUNDLE-OUTDATED(1) BUNDLE-OUTDATED(1) - Combining all three 1mfilter 22moptions would be the same result as provid- + Combining all three filter options would be the same result as provid- ing none of them. - November 2018 BUNDLE-OUTDATED(1) + March 2019 BUNDLE-OUTDATED(1) diff --git a/man/bundle-package.1 b/man/bundle-package.1 index db0447be83..d3988935e5 100644 --- a/man/bundle-package.1 +++ b/man/bundle-package.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "BUNDLE\-PACKAGE" "1" "November 2018" "" "" +.TH "BUNDLE\-PACKAGE" "1" "March 2019" "" "" . .SH "NAME" \fBbundle\-package\fR \- Package your needed \fB\.gem\fR files into your application diff --git a/man/bundle-package.1.txt b/man/bundle-package.1.txt index 56b977f0ca..140b7a97b4 100644 --- a/man/bundle-package.1.txt +++ b/man/bundle-package.1.txt @@ -2,36 +2,36 @@ BUNDLE-PACKAGE(1) BUNDLE-PACKAGE(1) -1mNAME0m - 1mbundle-package 22m- Package your needed 1m.gem 22mfiles into your application +NAME + bundle-package - Package your needed .gem files into your application -1mSYNOPSIS0m - 1mbundle package0m +SYNOPSIS + bundle package -1mDESCRIPTION0m - Copy all of the 1m.gem 22mfiles needed to run the application into the 1mven-0m - 1mdor/cache 22mdirectory. In the future, when running [bundle in- - stall(1)][bundle-install], use the gems in the cache in preference to - the ones on 1mrubygems.org22m. +DESCRIPTION + Copy all of the .gem files needed to run the application into the ven- + dor/cache directory. In the future, when running [bundle + install(1)][bundle-install], use the gems in the cache in preference to + the ones on rubygems.org. -1mGIT AND PATH GEMS0m - Since Bundler 1.2, the 1mbundle package 22mcommand can also package 1m:git 22mand - 1m:path 22mdependencies besides .gem files. This needs to be explicitly en- - abled via the 1m--all 22moption. Once used, the 1m--all 22moption will be remem- - bered. +GIT AND PATH GEMS + Since Bundler 1.2, the bundle package command can also package :git and + :path dependencies besides .gem files. This needs to be explicitly + enabled via the --all option. Once used, the --all option will be + remembered. -1mSUPPORT FOR MULTIPLE PLATFORMS0m +SUPPORT FOR MULTIPLE PLATFORMS When using gems that have different packages for different platforms, Bundler 1.8 and newer support caching of gems for other platforms where - the Gemfile has been resolved (i.e. present in the lockfile) in 1mven-0m - 1mdor/cache22m. This needs to be enabled via the 1m--all-platforms 22moption. + the Gemfile has been resolved (i.e. present in the lockfile) in ven- + dor/cache. This needs to be enabled via the --all-platforms option. This setting will be remembered in your local bundler configuration. -1mREMOTE FETCHING0m - By default, if you run 1mbundle install(1)22m](bundle-install.1.html) after - running bundle package(1) 4mbundle-package.1.html24m, bundler will still - connect to 1mrubygems.org 22mto check whether a platform-specific gem exists - for any of the gems in 1mvendor/cache22m. +REMOTE FETCHING + By default, if you run bundle install(1)](bundle-install.1.html) after + running bundle package(1) bundle-package.1.html, bundler will still + connect to rubygems.org to check whether a platform-specific gem exists + for any of the gems in vendor/cache. For instance, consider this Gemfile(5): @@ -43,37 +43,37 @@ BUNDLE-PACKAGE(1) BUNDLE-PACKAGE(1) - If you run 1mbundle package 22munder C Ruby, bundler will retrieve the ver- - sion of 1mnokogiri 22mfor the 1m"ruby" 22mplatform. If you deploy to JRuby and - run 1mbundle install22m, bundler is forced to check to see whether a 1m"java"0m - platformed 1mnokogiri 22mexists. + If you run bundle package under C Ruby, bundler will retrieve the ver- + sion of nokogiri for the "ruby" platform. If you deploy to JRuby and + run bundle install, bundler is forced to check to see whether a "java" + platformed nokogiri exists. - Even though the 1mnokogiri 22mgem for the Ruby platform is 4mtechnically24m ac- - ceptable on JRuby, it has a C extension that does not run on JRuby. As - a result, bundler will, by default, still connect to 1mrubygems.org 22mto + Even though the nokogiri gem for the Ruby platform is technically + acceptable on JRuby, it has a C extension that does not run on JRuby. + As a result, bundler will, by default, still connect to rubygems.org to check whether it has a version of one of your gems more specific to your platform. - This problem is also not limited to the 1m"java" 22mplatform. A similar + This problem is also not limited to the "java" platform. A similar (common) problem can happen when developing on Windows and deploying to Linux, or even when developing on OSX and deploying to Linux. - If you know for sure that the gems packaged in 1mvendor/cache 22mare appro- - priate for the platform you are on, you can run 1mbundle install --local0m - to skip checking for more appropriate gems, and use the ones in 1mven-0m - 1mdor/cache22m. + If you know for sure that the gems packaged in vendor/cache are appro- + priate for the platform you are on, you can run bundle install --local + to skip checking for more appropriate gems, and use the ones in ven- + dor/cache. One way to be sure that you have the right platformed versions of all - your gems is to run 1mbundle package 22mon an identical machine and check in - the gems. For instance, you can run 1mbundle package 22mon an identical - staging box during your staging process, and check in the 1mvendor/cache0m + your gems is to run bundle package on an identical machine and check in + the gems. For instance, you can run bundle package on an identical + staging box during your staging process, and check in the vendor/cache before deploying to production. - By default, bundle package(1) 4mbundle-package.1.html24m fetches and also + By default, bundle package(1) bundle-package.1.html fetches and also installs the gems to the default location. To package the dependencies - to 1mvendor/cache 22mwithout installing them to the local install location, - you can run 1mbundle package --no-install22m. + to vendor/cache without installing them to the local install location, + you can run bundle package --no-install. - November 2018 BUNDLE-PACKAGE(1) + March 2019 BUNDLE-PACKAGE(1) diff --git a/man/bundle-platform.1 b/man/bundle-platform.1 index 94b5e13cc1..ed3ddc1baf 100644 --- a/man/bundle-platform.1 +++ b/man/bundle-platform.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "BUNDLE\-PLATFORM" "1" "November 2018" "" "" +.TH "BUNDLE\-PLATFORM" "1" "March 2019" "" "" . .SH "NAME" \fBbundle\-platform\fR \- Displays platform compatibility information diff --git a/man/bundle-platform.1.txt b/man/bundle-platform.1.txt index 26079cc3d5..353b2dfe17 100644 --- a/man/bundle-platform.1.txt +++ b/man/bundle-platform.1.txt @@ -2,14 +2,14 @@ BUNDLE-PLATFORM(1) BUNDLE-PLATFORM(1) -1mNAME0m - 1mbundle-platform 22m- Displays platform compatibility information +NAME + bundle-platform - Displays platform compatibility information -1mSYNOPSIS0m - 1mbundle platform 22m[--ruby] +SYNOPSIS + bundle platform [--ruby] -1mDESCRIPTION0m - 1mplatform 22mwill display information from your Gemfile, Gemfile.lock, and +DESCRIPTION + platform will display information from your Gemfile, Gemfile.lock, and Ruby VM about your platform. For instance, using this Gemfile(5): @@ -24,7 +24,7 @@ BUNDLE-PLATFORM(1) BUNDLE-PLATFORM(1) - If you run 1mbundle platform 22mon Ruby 1.9.3, it will display the following + If you run bundle platform on Ruby 1.9.3, it will display the following output: @@ -41,17 +41,17 @@ BUNDLE-PLATFORM(1) BUNDLE-PLATFORM(1) - 1mplatform 22mwill list all the platforms in your 1mGemfile.lock 22mas well as - the 1mruby 22mdirective if applicable from your Gemfile(5). It will also let - you know if the 1mruby 22mdirective requirement has been met. If 1mruby 22mdirec- + platform will list all the platforms in your Gemfile.lock as well as + the ruby directive if applicable from your Gemfile(5). It will also let + you know if the ruby directive requirement has been met. If ruby direc- tive doesn't match the running Ruby VM, it will tell you what part does not. -1mOPTIONS0m - 1m--ruby 22mIt will display the ruby directive information, so you don't +OPTIONS + --ruby It will display the ruby directive information, so you don't have to parse it from the Gemfile(5). - November 2018 BUNDLE-PLATFORM(1) + March 2019 BUNDLE-PLATFORM(1) diff --git a/man/bundle-pristine.1 b/man/bundle-pristine.1 index d3881ade3d..bd6d2b2993 100644 --- a/man/bundle-pristine.1 +++ b/man/bundle-pristine.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "BUNDLE\-PRISTINE" "1" "November 2018" "" "" +.TH "BUNDLE\-PRISTINE" "1" "March 2019" "" "" . .SH "NAME" \fBbundle\-pristine\fR \- Restores installed gems to their pristine condition diff --git a/man/bundle-pristine.1.txt b/man/bundle-pristine.1.txt index 2fd320282a..25b6710d5f 100644 --- a/man/bundle-pristine.1.txt +++ b/man/bundle-pristine.1.txt @@ -2,43 +2,43 @@ BUNDLE-PRISTINE(1) BUNDLE-PRISTINE(1) -1mNAME0m - 1mbundle-pristine 22m- Restores installed gems to their pristine condition +NAME + bundle-pristine - Restores installed gems to their pristine condition -1mSYNOPSIS0m - 1mbundle pristine0m +SYNOPSIS + bundle pristine -1mDESCRIPTION0m - 1mpristine 22mrestores the installed gems in the bundle to their pristine +DESCRIPTION + pristine restores the installed gems in the bundle to their pristine condition using the local gem cache from RubyGems. For git gems, a forced checkout will be performed. - For further explanation, 1mbundle pristine 22mignores unpacked files on - disk. In other words, this command utilizes the local 1m.gem 22mcache or the + For further explanation, bundle pristine ignores unpacked files on + disk. In other words, this command utilizes the local .gem cache or the gem's git repository as if one were installing from scratch. Note: the Bundler gem cannot be restored to its original state with - 1mpristine22m. One also cannot use 1mbundle pristine 22mon gems with a 'path' op- - tion in the Gemfile, because bundler has no original copy it can re- - store from. + pristine. One also cannot use bundle pristine on gems with a 'path' + option in the Gemfile, because bundler has no original copy it can + restore from. - When is it practical to use 1mbundle pristine22m? + When is it practical to use bundle pristine? - It comes in handy when a developer is debugging a gem. 1mbundle pristine0m + It comes in handy when a developer is debugging a gem. bundle pristine is a great way to get rid of experimental changes to a gem that one may not want. - Why use 1mbundle pristine 22mover 1mgem pristine --all22m? + Why use bundle pristine over gem pristine --all? - Both commands are very similar. For context: 1mbundle pristine22m, without - arguments, cleans all gems from the lockfile. Meanwhile, 1mgem pristine0m - 1m--all 22mcleans all installed gems for that Ruby version. + Both commands are very similar. For context: bundle pristine, without + arguments, cleans all gems from the lockfile. Meanwhile, gem pristine + --all cleans all installed gems for that Ruby version. If a developer forgets which gems in their project they might have been - debugging, the Rubygems 1mgem pristine [GEMNAME] 22mcommand may be inconve- - nient. One can avoid waiting for 1mgem pristine --all22m, and instead run - 1mbundle pristine22m. + debugging, the Rubygems gem pristine [GEMNAME] command may be inconve- + nient. One can avoid waiting for gem pristine --all, and instead run + bundle pristine. - November 2018 BUNDLE-PRISTINE(1) + March 2019 BUNDLE-PRISTINE(1) diff --git a/man/bundle-remove.1 b/man/bundle-remove.1 index 8232ab2887..0b0279001c 100644 --- a/man/bundle-remove.1 +++ b/man/bundle-remove.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "BUNDLE\-REMOVE" "1" "November 2018" "" "" +.TH "BUNDLE\-REMOVE" "1" "March 2019" "" "" . .SH "NAME" \fBbundle\-remove\fR \- Removes gems from the Gemfile diff --git a/man/bundle-remove.1.txt b/man/bundle-remove.1.txt index 5248a0ee18..219c50f944 100644 --- a/man/bundle-remove.1.txt +++ b/man/bundle-remove.1.txt @@ -2,23 +2,23 @@ BUNDLE-REMOVE(1) BUNDLE-REMOVE(1) -1mNAME0m - 1mbundle-remove 22m- Removes gems from the Gemfile +NAME + bundle-remove - Removes gems from the Gemfile -1mSYNOPSIS0m - 1mbundle remove [GEM [GEM ...]] [--install]0m +SYNOPSIS + bundle remove [GEM [GEM ...]] [--install] -1mDESCRIPTION0m +DESCRIPTION Removes the given gems from the Gemfile while ensuring that the result- ing Gemfile is still valid. If a gem cannot be removed, a warning is printed. If a gem is already absent from the Gemfile, and error is raised. -1mOPTIONS0m - 1m--install0m - Runs 1mbundle install 22mafter the given gems have been removed from - the Gemfile, which ensures that both the lockfile and the in- - stalled gems on disk are also updated to remove the given +OPTIONS + --install + Runs bundle install after the given gems have been removed from + the Gemfile, which ensures that both the lockfile and the + installed gems on disk are also updated to remove the given gem(s). Example: @@ -31,4 +31,4 @@ BUNDLE-REMOVE(1) BUNDLE-REMOVE(1) - November 2018 BUNDLE-REMOVE(1) + March 2019 BUNDLE-REMOVE(1) diff --git a/man/bundle-show.1 b/man/bundle-show.1 index 72ce37aedd..d3387dcc2f 100644 --- a/man/bundle-show.1 +++ b/man/bundle-show.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "BUNDLE\-SHOW" "1" "November 2018" "" "" +.TH "BUNDLE\-SHOW" "1" "March 2019" "" "" . .SH "NAME" \fBbundle\-show\fR \- Shows all the gems in your bundle, or the path to a gem diff --git a/man/bundle-show.1.txt b/man/bundle-show.1.txt index 542ee55f78..b2851ff06e 100644 --- a/man/bundle-show.1.txt +++ b/man/bundle-show.1.txt @@ -2,26 +2,26 @@ BUNDLE-SHOW(1) BUNDLE-SHOW(1) -1mNAME0m - 1mbundle-show 22m- Shows all the gems in your bundle, or the path to a gem +NAME + bundle-show - Shows all the gems in your bundle, or the path to a gem -1mSYNOPSIS0m - 1mbundle show 22m[GEM] [--paths] +SYNOPSIS + bundle show [GEM] [--paths] -1mDESCRIPTION0m - Without the [GEM] option, 1mshow 22mwill print a list of the names and ver- - sions of all gems that are required by your [1mGemfile(5)22m][Gemfile(5)], +DESCRIPTION + Without the [GEM] option, show will print a list of the names and ver- + sions of all gems that are required by your [Gemfile(5)][Gemfile(5)], sorted by name. Calling show with [GEM] will list the exact location of that gem on your machine. -1mOPTIONS0m - 1m--paths0m - List the paths of all gems that are required by your [1mGem-0m - 1mfile(5)22m][Gemfile(5)], sorted by gem name. +OPTIONS + --paths + List the paths of all gems that are required by your [Gem- + file(5)][Gemfile(5)], sorted by gem name. - November 2018 BUNDLE-SHOW(1) + March 2019 BUNDLE-SHOW(1) diff --git a/man/bundle-update.1 b/man/bundle-update.1 index 513bc64905..f980563732 100644 --- a/man/bundle-update.1 +++ b/man/bundle-update.1 @@ -1,13 +1,13 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "BUNDLE\-UPDATE" "1" "January 2019" "" "" +.TH "BUNDLE\-UPDATE" "1" "April 2019" "" "" . .SH "NAME" \fBbundle\-update\fR \- Update your gems to the latest available versions . .SH "SYNOPSIS" -\fBbundle update\fR \fI*gems\fR [\-\-all] [\-\-group=NAME] [\-\-source=NAME] [\-\-local] [\-\-ruby] [\-\-bundler[=VERSION]] [\-\-full\-index] [\-\-jobs=JOBS] [\-\-quiet] [\-\-force] [\-\-patch|\-\-minor|\-\-major] [\-\-strict] [\-\-conservative] +\fBbundle update\fR \fI*gems\fR [\-\-all] [\-\-group=NAME] [\-\-source=NAME] [\-\-local] [\-\-ruby] [\-\-bundler[=VERSION]] [\-\-full\-index] [\-\-jobs=JOBS] [\-\-quiet] [\-\-patch|\-\-minor|\-\-major] [\-\-redownload] [\-\-strict] [\-\-conservative] . .SH "DESCRIPTION" Update the gems specified (all gems, if \fB\-\-all\fR flag is used), ignoring the previously installed gems specified in the \fBGemfile\.lock\fR\. In general, you should use bundle install(1) \fIbundle\-install\.1\.html\fR to install the same exact gems and versions across machines\. @@ -58,8 +58,8 @@ Retry failed network or git requests for \fInumber\fR times\. Only output warnings and errors\. . .TP -\fB\-\-force\fR -Force downloading every gem\. \fB\-\-redownload\fR is an alias of this option\. +\fB\-\-redownload\fR +Force downloading every gem\. . .TP \fB\-\-patch\fR diff --git a/man/bundle-update.1.txt b/man/bundle-update.1.txt index d40b05485a..98df74b09c 100644 --- a/man/bundle-update.1.txt +++ b/man/bundle-update.1.txt @@ -2,85 +2,84 @@ BUNDLE-UPDATE(1) BUNDLE-UPDATE(1) -1mNAME0m - 1mbundle-update 22m- Update your gems to the latest available versions +NAME + bundle-update - Update your gems to the latest available versions -1mSYNOPSIS0m - 1mbundle update 4m22m*gems24m [--all] [--group=NAME] [--source=NAME] [--local] +SYNOPSIS + bundle update *gems [--all] [--group=NAME] [--source=NAME] [--local] [--ruby] [--bundler[=VERSION]] [--full-index] [--jobs=JOBS] [--quiet] - [--force] [--patch|--minor|--major] [--strict] [--conservative] + [--patch|--minor|--major] [--redownload] [--strict] [--conservative] -1mDESCRIPTION0m - Update the gems specified (all gems, if 1m--all 22mflag is used), ignoring - the previously installed gems specified in the 1mGemfile.lock22m. In gen- - eral, you should use bundle install(1) 4mbundle-install.1.html24m to install +DESCRIPTION + Update the gems specified (all gems, if --all flag is used), ignoring + the previously installed gems specified in the Gemfile.lock. In gen- + eral, you should use bundle install(1) bundle-install.1.html to install the same exact gems and versions across machines. - You would use 1mbundle update 22mto explicitly update the version of a gem. + You would use bundle update to explicitly update the version of a gem. -1mOPTIONS0m - 1m--all 22mUpdate all gems specified in Gemfile. +OPTIONS + --all Update all gems specified in Gemfile. - 1m--group=<name>22m, 1m-g=[<name>]0m - Only update the gems in the specified group. For instance, you - can update all gems in the development group with 1mbundle update0m - 1m--group development22m. You can also call 1mbundle update rails0m - 1m--group test 22mto update the rails gem and all gems in the test + --group=<name>, -g=[<name>] + Only update the gems in the specified group. For instance, you + can update all gems in the development group with bundle update + --group development. You can also call bundle update rails + --group test to update the rails gem and all gems in the test group, for example. - 1m--source=<name>0m - The name of a 1m:git 22mor 1m:path 22msource used in the Gemfile(5). For - instance, with a 1m:git 22msource of - 1mhttp://github.com/rails/rails.git22m, you would call 1mbundle update0m - 1m--source rails0m + --source=<name> + The name of a :git or :path source used in the Gemfile(5). For + instance, with a :git source of + http://github.com/rails/rails.git, you would call bundle update + --source rails - 1m--local0m - Do not attempt to fetch gems remotely and use the gem cache in- - stead. + --local + Do not attempt to fetch gems remotely and use the gem cache + instead. - 1m--ruby 22mUpdate the locked version of Ruby to the current version of + --ruby Update the locked version of Ruby to the current version of Ruby. - 1m--bundler0m + --bundler Update the locked version of bundler to the invoked bundler ver- sion. - 1m--full-index0m + --full-index Fall back to using the single-file index of all gems. - 1m--jobs=[<number>]22m, 1m-j[<number>]0m - Specify the number of jobs to run in parallel. The default is 1m122m. + --jobs=[<number>], -j[<number>] + Specify the number of jobs to run in parallel. The default is 1. - 1m--retry=[<number>]0m - Retry failed network or git requests for 4mnumber24m times. + --retry=[<number>] + Retry failed network or git requests for number times. - 1m--quiet0m + --quiet Only output warnings and errors. - 1m--force0m - Force downloading every gem. 1m--redownload 22mis an alias of this - option. + --redownload + Force downloading every gem. - 1m--patch0m + --patch Prefer updating only to next patch version. - 1m--minor0m + --minor Prefer updating only to next minor version. - 1m--major0m + --major Prefer updating to next major version (default). - 1m--strict0m - Do not allow any gem to be updated past latest 1m--patch 22m| 1m--minor0m - | 1m--major22m. + --strict + Do not allow any gem to be updated past latest --patch | --minor + | --major. - 1m--conservative0m + --conservative Use bundle install conservative update behavior and do not allow shared dependencies to be updated. -1mUPDATING ALL GEMS0m - If you run 1mbundle update --all22m, bundler will ignore any previously in- - stalled gems and resolve all dependencies again based on the latest +UPDATING ALL GEMS + If you run bundle update --all, bundler will ignore any previously + installed gems and resolve all dependencies again based on the latest versions of all gems available in the sources. Consider the following Gemfile(5): @@ -94,9 +93,9 @@ BUNDLE-UPDATE(1) BUNDLE-UPDATE(1) - When you run bundle install(1) 4mbundle-install.1.html24m the first time, - bundler will resolve all of the dependencies, all the way down, and in- - stall what you need: + When you run bundle install(1) bundle-install.1.html the first time, + bundler will resolve all of the dependencies, all the way down, and + install what you need: @@ -134,44 +133,44 @@ BUNDLE-UPDATE(1) BUNDLE-UPDATE(1) - As you can see, even though you have two gems in the Gemfile(5), your - application needs 26 different gems in order to run. Bundler remembers - the exact versions it installed in 1mGemfile.lock22m. The next time you run - bundle install(1) 4mbundle-install.1.html24m, bundler skips the dependency + As you can see, even though you have two gems in the Gemfile(5), your + application needs 26 different gems in order to run. Bundler remembers + the exact versions it installed in Gemfile.lock. The next time you run + bundle install(1) bundle-install.1.html, bundler skips the dependency resolution and installs the same gems as it installed last time. - After checking in the 1mGemfile.lock 22minto version control and cloning it - on another machine, running bundle install(1) 4mbundle-install.1.html0m - will 4mstill24m install the gems that you installed last time. You don't - need to worry that a new release of 1merubis 22mor 1mmail 22mchanges the gems you + After checking in the Gemfile.lock into version control and cloning it + on another machine, running bundle install(1) bundle-install.1.html + will still install the gems that you installed last time. You don't + need to worry that a new release of erubis or mail changes the gems you use. - However, from time to time, you might want to update the gems you are - using to the newest versions that still match the gems in your Gem- + However, from time to time, you might want to update the gems you are + using to the newest versions that still match the gems in your Gem- file(5). - To do this, run 1mbundle update --all22m, which will ignore the 1mGem-0m - 1mfile.lock22m, and resolve all the dependencies again. Keep in mind that - this process can result in a significantly different set of the 25 - gems, based on the requirements of new gems that the gem authors re- - leased since the last time you ran 1mbundle update --all22m. + To do this, run bundle update --all, which will ignore the Gem- + file.lock, and resolve all the dependencies again. Keep in mind that + this process can result in a significantly different set of the 25 + gems, based on the requirements of new gems that the gem authors + released since the last time you ran bundle update --all. -1mUPDATING A LIST OF GEMS0m +UPDATING A LIST OF GEMS Sometimes, you want to update a single gem in the Gemfile(5), and leave - the rest of the gems that you specified locked to the versions in the - 1mGemfile.lock22m. + the rest of the gems that you specified locked to the versions in the + Gemfile.lock. - For instance, in the scenario above, imagine that 1mnokogiri 22mreleases - version 1m1.4.422m, and you want to update it 4mwithout24m updating Rails and all - of its dependencies. To do this, run 1mbundle update nokogiri22m. + For instance, in the scenario above, imagine that nokogiri releases + version 1.4.4, and you want to update it without updating Rails and all + of its dependencies. To do this, run bundle update nokogiri. - Bundler will update 1mnokogiri 22mand any of its dependencies, but leave + Bundler will update nokogiri and any of its dependencies, but leave alone Rails and its dependencies. -1mOVERLAPPING DEPENDENCIES0m - Sometimes, multiple gems declared in your Gemfile(5) are satisfied by - the same second-level dependency. For instance, consider the case of - 1mthin 22mand 1mrack-perftools-profiler22m. +OVERLAPPING DEPENDENCIES + Sometimes, multiple gems declared in your Gemfile(5) are satisfied by + the same second-level dependency. For instance, consider the case of + thin and rack-perftools-profiler. @@ -182,8 +181,8 @@ BUNDLE-UPDATE(1) BUNDLE-UPDATE(1) - The 1mthin 22mgem depends on 1mrack >= 1.022m, while 1mrack-perftools-profiler 22mde- - pends on 1mrack ~> 1.022m. If you run bundle install, you get: + The thin gem depends on rack >= 1.0, while rack-perftools-profiler + depends on rack ~> 1.0. If you run bundle install, you get: @@ -200,86 +199,86 @@ BUNDLE-UPDATE(1) BUNDLE-UPDATE(1) In this case, the two gems have their own set of dependencies, but they - share 1mrack 22min common. If you run 1mbundle update thin22m, bundler will up- - date 1mdaemons22m, 1meventmachine 22mand 1mrack22m, which are dependencies of 1mthin22m, - but not 1mopen4 22mor 1mperftools.rb22m, which are dependencies of - 1mrack-perftools_profiler22m. Note that 1mbundle update thin 22mwill update 1mrack0m - even though it's 4malso24m a dependency of 1mrack-perftools_profiler22m. - - In short, by default, when you update a gem using 1mbundle update22m, - bundler will update all dependencies of that gem, including those that + share rack in common. If you run bundle update thin, bundler will + update daemons, eventmachine and rack, which are dependencies of thin, + but not open4 or perftools.rb, which are dependencies of + rack-perftools_profiler. Note that bundle update thin will update rack + even though it's also a dependency of rack-perftools_profiler. + + In short, by default, when you update a gem using bundle update, + bundler will update all dependencies of that gem, including those that are also dependencies of another gem. To prevent updating shared dependencies, prior to version 1.14 the only - option was the 1mCONSERVATIVE UPDATING 22mbehavior in bundle install(1) 4mbun-0m - 4mdle-install.1.html24m: + option was the CONSERVATIVE UPDATING behavior in bundle install(1) bun- + dle-install.1.html: - In this scenario, updating the 1mthin 22mversion manually in the Gemfile(5), - and then running bundle install(1) 4mbundle-install.1.html24m will only up- - date 1mdaemons 22mand 1meventmachine22m, but not 1mrack22m. For more information, see - the 1mCONSERVATIVE UPDATING 22msection of bundle install(1) 4mbundle-in-0m - 4mstall.1.html24m. + In this scenario, updating the thin version manually in the Gemfile(5), + and then running bundle install(1) bundle-install.1.html will only + update daemons and eventmachine, but not rack. For more information, + see the CONSERVATIVE UPDATING section of bundle install(1) bun- + dle-install.1.html. - Starting with 1.14, specifying the 1m--conservative 22moption will also pre- + Starting with 1.14, specifying the --conservative option will also pre- vent shared dependencies from being updated. -1mPATCH LEVEL OPTIONS0m - Version 1.14 introduced 4 patch-level options that will influence how - gem versions are resolved. One of the following options can be used: - 1m--patch22m, 1m--minor 22mor 1m--major22m. 1m--strict 22mcan be added to further influence +PATCH LEVEL OPTIONS + Version 1.14 introduced 4 patch-level options that will influence how + gem versions are resolved. One of the following options can be used: + --patch, --minor or --major. --strict can be added to further influence resolution. - 1m--patch0m + --patch Prefer updating only to next patch version. - 1m--minor0m + --minor Prefer updating only to next minor version. - 1m--major0m + --major Prefer updating to next major version (default). - 1m--strict0m - Do not allow any gem to be updated past latest 1m--patch 22m| 1m--minor0m - | 1m--major22m. + --strict + Do not allow any gem to be updated past latest --patch | --minor + | --major. - When Bundler is resolving what versions to use to satisfy declared re- - quirements in the Gemfile or in parent gems, it looks up all available - versions, filters out any versions that don't satisfy the requirement, - and then, by default, sorts them from newest to oldest, considering - them in that order. + When Bundler is resolving what versions to use to satisfy declared + requirements in the Gemfile or in parent gems, it looks up all avail- + able versions, filters out any versions that don't satisfy the require- + ment, and then, by default, sorts them from newest to oldest, consider- + ing them in that order. - Providing one of the patch level options (e.g. 1m--patch22m) changes the - sort order of the satisfying versions, causing Bundler to consider the - latest 1m--patch 22mor 1m--minor 22mversion available before other versions. Note + Providing one of the patch level options (e.g. --patch) changes the + sort order of the satisfying versions, causing Bundler to consider the + latest --patch or --minor version available before other versions. Note that versions outside the stated patch level could still be resolved to if necessary to find a suitable dependency graph. - For example, if gem 'foo' is locked at 1.0.2, with no gem requirement - defined in the Gemfile, and versions 1.0.3, 1.0.4, 1.1.0, 1.1.1, 2.0.0 - all exist, the default order of preference by default (1m--major22m) will be + For example, if gem 'foo' is locked at 1.0.2, with no gem requirement + defined in the Gemfile, and versions 1.0.3, 1.0.4, 1.1.0, 1.1.1, 2.0.0 + all exist, the default order of preference by default (--major) will be "2.0.0, 1.1.1, 1.1.0, 1.0.4, 1.0.3, 1.0.2". - If the 1m--patch 22moption is used, the order of preference will change to + If the --patch option is used, the order of preference will change to "1.0.4, 1.0.3, 1.0.2, 1.1.1, 1.1.0, 2.0.0". - If the 1m--minor 22moption is used, the order of preference will change to + If the --minor option is used, the order of preference will change to "1.1.1, 1.1.0, 1.0.4, 1.0.3, 1.0.2, 2.0.0". - Combining the 1m--strict 22moption with any of the patch level options will - remove any versions beyond the scope of the patch level option, to en- - sure that no gem is updated that far. + Combining the --strict option with any of the patch level options will + remove any versions beyond the scope of the patch level option, to + ensure that no gem is updated that far. - To continue the previous example, if both 1m--patch 22mand 1m--strict 22moptions + To continue the previous example, if both --patch and --strict options are used, the available versions for resolution would be "1.0.4, 1.0.3, - 1.0.2". If 1m--minor 22mand 1m--strict 22mare used, it would be "1.1.1, 1.1.0, + 1.0.2". If --minor and --strict are used, it would be "1.1.1, 1.1.0, 1.0.4, 1.0.3, 1.0.2". - Gem requirements as defined in the Gemfile will still be the first de- - termining factor for what versions are available. If the gem require- - ment for 1mfoo 22min the Gemfile is '~> 1.0', that will accomplish the same - thing as providing the 1m--minor 22mand 1m--strict 22moptions. + Gem requirements as defined in the Gemfile will still be the first + determining factor for what versions are available. If the gem require- + ment for foo in the Gemfile is '~> 1.0', that will accomplish the same + thing as providing the --minor and --strict options. -1mPATCH LEVEL EXAMPLES0m +PATCH LEVEL EXAMPLES Given the following gem specifications: @@ -325,11 +324,11 @@ BUNDLE-UPDATE(1) BUNDLE-UPDATE(1) - In case 1, bar is upgraded to 2.1.1, a minor version increase, because + In case 1, bar is upgraded to 2.1.1, a minor version increase, because the dependency from foo 1.4.5 required it. - In case 2, only foo is requested to be unlocked, but bar is also al- - lowed to move because it's not a declared dependency in the Gemfile. + In case 2, only foo is requested to be unlocked, but bar is also + allowed to move because it's not a declared dependency in the Gemfile. In case 3, bar goes up a whole major release, because a minor increase is preferred now for foo, and when it goes to 1.5.1, it requires 3.0.0 @@ -343,7 +342,7 @@ BUNDLE-UPDATE(1) BUNDLE-UPDATE(1) from consideration because of the --strict flag, so the most they can move is up to 1.4.4 and 2.0.4. -1mRECOMMENDED WORKFLOW0m +RECOMMENDED WORKFLOW In general, when working with an application managed with bundler, you should use the following workflow: @@ -351,7 +350,7 @@ BUNDLE-UPDATE(1) BUNDLE-UPDATE(1) $ bundle install - o Check the resulting 1mGemfile.lock 22minto version control + o Check the resulting Gemfile.lock into version control $ git add Gemfile.lock @@ -369,11 +368,11 @@ BUNDLE-UPDATE(1) BUNDLE-UPDATE(1) $ bundle install - o Make sure to check the updated 1mGemfile.lock 22minto version control + o Make sure to check the updated Gemfile.lock into version control $ git add Gemfile.lock - o If bundle install(1) 4mbundle-install.1.html24m reports a conflict, man- + o If bundle install(1) bundle-install.1.html reports a conflict, man- ually update the specific gems that you changed in the Gemfile(5) $ bundle update rails thin @@ -388,4 +387,4 @@ BUNDLE-UPDATE(1) BUNDLE-UPDATE(1) - January 2019 BUNDLE-UPDATE(1) + April 2019 BUNDLE-UPDATE(1) diff --git a/man/bundle-update.ronn b/man/bundle-update.ronn index 481bb5b14e..397fecadcb 100644 --- a/man/bundle-update.ronn +++ b/man/bundle-update.ronn @@ -12,8 +12,8 @@ bundle-update(1) -- Update your gems to the latest available versions [--full-index] [--jobs=JOBS] [--quiet] - [--force] [--patch|--minor|--major] + [--redownload] [--strict] [--conservative] @@ -64,8 +64,8 @@ gem. * `--quiet`: Only output warnings and errors. -* `--force`: - Force downloading every gem. `--redownload` is an alias of this option. +* `--redownload`: + Force downloading every gem. * `--patch`: Prefer updating only to next patch version. diff --git a/man/bundle-viz.1 b/man/bundle-viz.1 index 70ad6835ee..3f4441f29f 100644 --- a/man/bundle-viz.1 +++ b/man/bundle-viz.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "BUNDLE\-VIZ" "1" "November 2018" "" "" +.TH "BUNDLE\-VIZ" "1" "March 2019" "" "" . .SH "NAME" \fBbundle\-viz\fR \- Generates a visual dependency graph for your Gemfile diff --git a/man/bundle-viz.1.txt b/man/bundle-viz.1.txt index ada88d89c6..045e837362 100644 --- a/man/bundle-viz.1.txt +++ b/man/bundle-viz.1.txt @@ -2,38 +2,38 @@ BUNDLE-VIZ(1) BUNDLE-VIZ(1) -1mNAME0m - 1mbundle-viz 22m- Generates a visual dependency graph for your Gemfile +NAME + bundle-viz - Generates a visual dependency graph for your Gemfile -1mSYNOPSIS0m - 1mbundle viz 22m[--file=FILE] [--format=FORMAT] [--requirements] [--version] +SYNOPSIS + bundle viz [--file=FILE] [--format=FORMAT] [--requirements] [--version] [--without=GROUP GROUP] -1mDESCRIPTION0m - 1mviz 22mgenerates a PNG file of the current 1mGemfile(5) 22mas a dependency - graph. 1mviz 22mrequires the ruby-graphviz gem (and its dependencies). +DESCRIPTION + viz generates a PNG file of the current Gemfile(5) as a dependency + graph. viz requires the ruby-graphviz gem (and its dependencies). - The associated gems must also be installed via 1mbundle install(1) 4m22mbun-0m - 4mdle-install.1.html24m. + The associated gems must also be installed via bundle install(1) bun- + dle-install.1.html. -1mOPTIONS0m - 1m--file22m, 1m-f0m - The name to use for the generated file. See 1m--format 22moption +OPTIONS + --file, -f + The name to use for the generated file. See --format option - 1m--format22m, 1m-F0m + --format, -F This is output format option. Supported format is png, jpg, svg, dot ... - 1m--requirements22m, 1m-R0m + --requirements, -R Set to show the version of each required dependency. - 1m--version22m, 1m-v0m + --version, -v Set to show each gem version. - 1m--without22m, 1m-W0m + --without, -W Exclude gems that are part of the specified named group. - November 2018 BUNDLE-VIZ(1) + March 2019 BUNDLE-VIZ(1) diff --git a/man/bundle.1 b/man/bundle.1 index cc777c9aab..81226d9339 100644 --- a/man/bundle.1 +++ b/man/bundle.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "BUNDLE" "1" "January 2019" "" "" +.TH "BUNDLE" "1" "April 2019" "" "" . .SH "NAME" \fBbundle\fR \- Ruby Dependency Management @@ -13,7 +13,7 @@ Bundler manages an \fBapplication\'s dependencies\fR through its entire life across many machines systematically and repeatably\. . .P -See the bundler website \fIhttp://bundler\.io\fR for information on getting started, and Gemfile(5) for more information on the \fBGemfile\fR format\. +See the bundler website \fIhttps://bundler\.io\fR for information on getting started, and Gemfile(5) for more information on the \fBGemfile\fR format\. . .SH "OPTIONS" . diff --git a/man/bundle.1.txt b/man/bundle.1.txt index 751411846f..bbf869d4c5 100644 --- a/man/bundle.1.txt +++ b/man/bundle.1.txt @@ -2,115 +2,115 @@ BUNDLE(1) BUNDLE(1) -1mNAME0m - 1mbundle 22m- Ruby Dependency Management +NAME + bundle - Ruby Dependency Management -1mSYNOPSIS0m - 1mbundle 22mCOMMAND [--no-color] [--verbose] [ARGS] +SYNOPSIS + bundle COMMAND [--no-color] [--verbose] [ARGS] -1mDESCRIPTION0m - Bundler manages an 1mapplication's dependencies 22mthrough its entire life +DESCRIPTION + Bundler manages an application's dependencies through its entire life across many machines systematically and repeatably. - See the bundler website 4mhttp://bundler.io24m for information on getting - started, and Gemfile(5) for more information on the 1mGemfile 22mformat. + See the bundler website https://bundler.io for information on getting + started, and Gemfile(5) for more information on the Gemfile format. -1mOPTIONS0m - 1m--no-color0m +OPTIONS + --no-color Print all output without color - 1m--retry22m, 1m-r0m + --retry, -r Specify the number of times you wish to attempt network commands - 1m--verbose22m, 1m-V0m + --verbose, -V Print out additional logging information -1mBUNDLE COMMANDS0m - We divide 1mbundle 22msubcommands into primary commands and utilities: +BUNDLE COMMANDS + We divide bundle subcommands into primary commands and utilities: -1mPRIMARY COMMANDS0m - 1mbundle install(1) 4m22mbundle-install.1.html0m - Install the gems specified by the 1mGemfile 22mor 1mGemfile.lock0m +PRIMARY COMMANDS + bundle install(1) bundle-install.1.html + Install the gems specified by the Gemfile or Gemfile.lock - 1mbundle update(1) 4m22mbundle-update.1.html0m + bundle update(1) bundle-update.1.html Update dependencies to their latest versions - 1mbundle package(1) 4m22mbundle-package.1.html0m - Package the .gem files required by your application into the - 1mvendor/cache 22mdirectory + bundle package(1) bundle-package.1.html + Package the .gem files required by your application into the + vendor/cache directory - 1mbundle exec(1) 4m22mbundle-exec.1.html0m + bundle exec(1) bundle-exec.1.html Execute a script in the current bundle - 1mbundle config(1) 4m22mbundle-config.1.html0m + bundle config(1) bundle-config.1.html Specify and read configuration options for Bundler - 1mbundle help(1)0m + bundle help(1) Display detailed help for each subcommand -1mUTILITIES0m - 1mbundle add(1) 4m22mbundle-add.1.html0m - Add the named gem to the Gemfile and run 1mbundle install0m +UTILITIES + bundle add(1) bundle-add.1.html + Add the named gem to the Gemfile and run bundle install - 1mbundle binstubs(1) 4m22mbundle-binstubs.1.html0m + bundle binstubs(1) bundle-binstubs.1.html Generate binstubs for executables in a gem - 1mbundle check(1) 4m22mbundle-check.1.html0m - Determine whether the requirements for your application are in- - stalled and available to Bundler + bundle check(1) bundle-check.1.html + Determine whether the requirements for your application are + installed and available to Bundler - 1mbundle show(1) 4m22mbundle-show.1.html0m + bundle show(1) bundle-show.1.html Show the source location of a particular gem in the bundle - 1mbundle outdated(1) 4m22mbundle-outdated.1.html0m + bundle outdated(1) bundle-outdated.1.html Show all of the outdated gems in the current bundle - 1mbundle console(1)0m + bundle console(1) Start an IRB session in the current bundle - 1mbundle open(1) 4m22mbundle-open.1.html0m + bundle open(1) bundle-open.1.html Open an installed gem in the editor - 1mbundle lock(1) 4m22mbundle-lock.1.hmtl0m + bundle lock(1) bundle-lock.1.hmtl Generate a lockfile for your dependencies - 1mbundle viz(1) 4m22mbundle-viz.1.html0m + bundle viz(1) bundle-viz.1.html Generate a visual representation of your dependencies - 1mbundle init(1) 4m22mbundle-init.1.html0m - Generate a simple 1mGemfile22m, placed in the current directory + bundle init(1) bundle-init.1.html + Generate a simple Gemfile, placed in the current directory - 1mbundle gem(1) 4m22mbundle-gem.1.html0m + bundle gem(1) bundle-gem.1.html Create a simple gem, suitable for development with Bundler - 1mbundle platform(1) 4m22mbundle-platform.1.html0m + bundle platform(1) bundle-platform.1.html Display platform compatibility information - 1mbundle clean(1) 4m22mbundle-clean.1.html0m + bundle clean(1) bundle-clean.1.html Clean up unused gems in your Bundler directory - 1mbundle doctor(1) 4m22mbundle-doctor.1.html0m + bundle doctor(1) bundle-doctor.1.html Display warnings about common problems - 1mbundle remove(1) 4m22mbundle-remove.1.html0m + bundle remove(1) bundle-remove.1.html Removes gems from the Gemfile -1mPLUGINS0m - When running a command that isn't listed in PRIMARY COMMANDS or UTILI- - TIES, Bundler will try to find an executable on your path named - 1mbundler-<command> 22mand execute it, passing down any extra arguments to +PLUGINS + When running a command that isn't listed in PRIMARY COMMANDS or UTILI- + TIES, Bundler will try to find an executable on your path named + bundler-<command> and execute it, passing down any extra arguments to it. -1mOBSOLETE0m +OBSOLETE These commands are obsolete and should no longer be used: - o 1mbundle cache(1)0m + o bundle cache(1) - o 1mbundle show(1)0m + o bundle show(1) - January 2019 BUNDLE(1) + April 2019 BUNDLE(1) diff --git a/man/bundle.ronn b/man/bundle.ronn index 0005692abd..b8ee4566b4 100644 --- a/man/bundle.ronn +++ b/man/bundle.ronn @@ -10,7 +10,7 @@ bundle(1) -- Ruby Dependency Management Bundler manages an `application's dependencies` through its entire life across many machines systematically and repeatably. -See [the bundler website](http://bundler.io) for information on getting +See [the bundler website](https://bundler.io) for information on getting started, and Gemfile(5) for more information on the `Gemfile` format. ## OPTIONS diff --git a/man/gemfile.5 b/man/gemfile.5 index c40ad9c71b..13fa60ee3d 100644 --- a/man/gemfile.5 +++ b/man/gemfile.5 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "GEMFILE" "5" "January 2019" "" "" +.TH "GEMFILE" "5" "April 2019" "" "" . .SH "NAME" \fBGemfile\fR \- A format for describing gem dependencies for Ruby programs @@ -238,7 +238,7 @@ After running \fBbundle install \-\-without test\fR, bundler will remember that Also, calling \fBBundler\.setup\fR with no parameters, or calling \fBrequire "bundler/setup"\fR will setup all groups except for the ones you excluded via \fB\-\-without\fR (since they are not available)\. . .P -Note that on \fBbundle install\fR, bundler downloads and evaluates all gems, in order to create a single canonical list of all of the required gems and their dependencies\. This means that you cannot list different versions of the same gems in different groups\. For more details, see Understanding Bundler \fIhttp://bundler\.io/rationale\.html\fR\. +Note that on \fBbundle install\fR, bundler downloads and evaluates all gems, in order to create a single canonical list of all of the required gems and their dependencies\. This means that you cannot list different versions of the same gems in different groups\. For more details, see Understanding Bundler \fIhttps://bundler\.io/rationale\.html\fR\. . .SS "PLATFORMS" If a gem should only be used in a particular platform or set of platforms, you can specify them\. Platforms are essentially identical to groups, except that you do not need to use the \fB\-\-without\fR install\-time flag to exclude groups of gems for other platforms\. diff --git a/man/gemfile.5.ronn b/man/gemfile.5.ronn index c941463edc..9fe4176a30 100644 --- a/man/gemfile.5.ronn +++ b/man/gemfile.5.ronn @@ -176,7 +176,7 @@ are not available). Note that on `bundle install`, bundler downloads and evaluates all gems, in order to create a single canonical list of all of the required gems and their dependencies. This means that you cannot list different versions of the same gems in different -groups. For more details, see [Understanding Bundler](http://bundler.io/rationale.html). +groups. For more details, see [Understanding Bundler](https://bundler.io/rationale.html). ### PLATFORMS diff --git a/man/gemfile.5.txt b/man/gemfile.5.txt index 0a01c045d7..4036072861 100644 --- a/man/gemfile.5.txt +++ b/man/gemfile.5.txt @@ -2,24 +2,24 @@ GEMFILE(5) GEMFILE(5) -1mNAME0m - 1mGemfile 22m- A format for describing gem dependencies for Ruby programs +NAME + Gemfile - A format for describing gem dependencies for Ruby programs -1mSYNOPSIS0m - A 1mGemfile 22mdescribes the gem dependencies required to execute associated +SYNOPSIS + A Gemfile describes the gem dependencies required to execute associated Ruby code. - Place the 1mGemfile 22min the root of the directory containing the associ- - ated code. For instance, in a Rails application, place the 1mGemfile 22min - the same directory as the 1mRakefile22m. + Place the Gemfile in the root of the directory containing the associ- + ated code. For instance, in a Rails application, place the Gemfile in + the same directory as the Rakefile. -1mSYNTAX0m - A 1mGemfile 22mis evaluated as Ruby code, in a context which makes available +SYNTAX + A Gemfile is evaluated as Ruby code, in a context which makes available a number of methods used to describe the gem requirements. -1mGLOBAL SOURCES0m - At the top of the 1mGemfile22m, add a line for the 1mRubygems 22msource that con- - tains the gems listed in the 1mGemfile22m. +GLOBAL SOURCES + At the top of the Gemfile, add a line for the Rubygems source that con- + tains the gems listed in the Gemfile. @@ -28,23 +28,23 @@ GEMFILE(5) GEMFILE(5) It is possible, but not recommended as of Bundler 1.7, to add multiple - global 1msource 22mlines. Each of these 1msource22ms 1mMUST 22mbe a valid Rubygems + global source lines. Each of these sources MUST be a valid Rubygems repository. Sources are checked for gems following the heuristics described in - 4mSOURCE24m 4mPRIORITY24m. If a gem is found in more than one global source, + SOURCE PRIORITY. If a gem is found in more than one global source, Bundler will print a warning after installing the gem indicating which source was used, and listing the other sources where the gem is avail- able. A specific source can be selected for gems that need to use a - non-standard repository, suppressing this warning, by using the 1m:source0m - option or a 1msource 22mblock. + non-standard repository, suppressing this warning, by using the :source + option or a source block. - 1mCREDENTIALS0m + CREDENTIALS Some gem sources require a username and password. Use bundle config(1) - 4mbundle-config.1.html24m to set the username and password for any of the + bundle-config.1.html to set the username and password for any of the sources that need it. The command must be run once on each computer - that will install the Gemfile, but this keeps the credentials from be- - ing stored in plain text in version control. + that will install the Gemfile, but this keeps the credentials from + being stored in plain text in version control. @@ -62,14 +62,14 @@ GEMFILE(5) GEMFILE(5) Credentials in the source URL will take precedence over credentials set - using 1mconfig22m. + using config. -1mRUBY0m +RUBY If your application requires a specific Ruby version or engine, specify - your requirements using the 1mruby 22mmethod, with the following arguments. - All parameters are 1mOPTIONAL 22munless otherwise specified. + your requirements using the ruby method, with the following arguments. + All parameters are OPTIONAL unless otherwise specified. - 1mVERSION (required)0m + VERSION (required) The version of Ruby that your application requires. If your application requires an alternate Ruby engine, such as JRuby, Rubinius or Truf- fleRuby, this should be the Ruby version that the engine is compatible @@ -81,32 +81,32 @@ GEMFILE(5) GEMFILE(5) - 1mENGINE0m - Each application 4mmay24m specify a Ruby engine. If an engine is specified, - an engine version 4mmust24m also be specified. + ENGINE + Each application may specify a Ruby engine. If an engine is specified, + an engine version must also be specified. What exactly is an Engine? - A Ruby engine is an implementation of the Ruby language. o For background: the reference or original implementation of the Ruby programming language is called Matz's Ruby Interpreter - 4mhttps://en.wikipedia.org/wiki/Ruby_MRI24m, or MRI for short. This is + https://en.wikipedia.org/wiki/Ruby_MRI, or MRI for short. This is named after Ruby creator Yukihiro Matsumoto, also known as Matz. MRI is also known as CRuby, because it is written in C. MRI is the most widely used Ruby engine. - o Other implementations 4mhttps://www.ruby-lang.org/en/about/24m of Ruby + o Other implementations https://www.ruby-lang.org/en/about/ of Ruby exist. Some of the more well-known implementations include Rubinius - 4mhttps://rubinius.com/24m, and JRuby 4mhttp://jruby.org/24m. Rubinius is an - alternative implementation of Ruby written in Ruby. JRuby is an im- - plementation of Ruby on the JVM, short for Java Virtual Machine. + https://rubinius.com/, and JRuby http://jruby.org/. Rubinius is an + alternative implementation of Ruby written in Ruby. JRuby is an + implementation of Ruby on the JVM, short for Java Virtual Machine. - 1mENGINE VERSION0m - Each application 4mmay24m specify a Ruby engine version. If an engine ver- - sion is specified, an engine 4mmust24m also be specified. If the engine is - "ruby" the engine version specified 4mmust24m match the Ruby version. + ENGINE VERSION + Each application may specify a Ruby engine version. If an engine ver- + sion is specified, an engine must also be specified. If the engine is + "ruby" the engine version specified must match the Ruby version. @@ -114,8 +114,8 @@ GEMFILE(5) GEMFILE(5) - 1mPATCHLEVEL0m - Each application 4mmay24m specify a Ruby patchlevel. + PATCHLEVEL + Each application may specify a Ruby patchlevel. @@ -123,12 +123,12 @@ GEMFILE(5) GEMFILE(5) -1mGEMS0m - Specify gem requirements using the 1mgem 22mmethod, with the following argu- - ments. All parameters are 1mOPTIONAL 22munless otherwise specified. +GEMS + Specify gem requirements using the gem method, with the following argu- + ments. All parameters are OPTIONAL unless otherwise specified. - 1mNAME (required)0m - For each gem requirement, list a single 4mgem24m line. + NAME (required) + For each gem requirement, list a single gem line. @@ -136,8 +136,8 @@ GEMFILE(5) GEMFILE(5) - 1mVERSION0m - Each 4mgem24m 1mMAY 22mhave one or more version specifiers. + VERSION + Each gem MAY have one or more version specifiers. @@ -146,10 +146,10 @@ GEMFILE(5) GEMFILE(5) - 1mREQUIRE AS0m - Each 4mgem24m 1mMAY 22mspecify files that should be used when autorequiring via - 1mBundler.require22m. You may pass an array with multiple files or 1mtrue 22mif - file you want 1mrequired 22mhas same name as 4mgem24m or 1mfalse 22mto prevent any + REQUIRE AS + Each gem MAY specify files that should be used when autorequiring via + Bundler.require. You may pass an array with multiple files or true if + file you want required has same name as gem or false to prevent any file from being autorequired. @@ -160,7 +160,7 @@ GEMFILE(5) GEMFILE(5) - The argument defaults to the name of the gem. For example, these are + The argument defaults to the name of the gem. For example, these are identical: @@ -171,9 +171,9 @@ GEMFILE(5) GEMFILE(5) - 1mGROUPS0m - Each 4mgem24m 1mMAY 22mspecify membership in one or more groups. Any 4mgem24m that - does not specify membership in any group is placed in the 1mdefault0m + GROUPS + Each gem MAY specify membership in one or more groups. Any gem that + does not specify membership in any group is placed in the default group. @@ -183,8 +183,8 @@ GEMFILE(5) GEMFILE(5) - The Bundler runtime allows its two main methods, 1mBundler.setup 22mand - 1mBundler.require22m, to limit their impact to particular groups. + The Bundler runtime allows its two main methods, Bundler.setup and + Bundler.require, to limit their impact to particular groups. @@ -203,9 +203,9 @@ GEMFILE(5) GEMFILE(5) - The Bundler CLI allows you to specify a list of groups whose gems 1mbun-0m - 1mdle install 22mshould not install with the 1m--without 22moption. To specify - multiple groups to ignore, specify a list of groups separated by spa- + The Bundler CLI allows you to specify a list of groups whose gems bun- + dle install should not install with the --without option. To specify + multiple groups to ignore, specify a list of groups separated by spa- ces. @@ -215,49 +215,49 @@ GEMFILE(5) GEMFILE(5) - After running 1mbundle install --without test22m, bundler will remember that + After running bundle install --without test, bundler will remember that you excluded the test group in the last installation. The next time you - run 1mbundle install22m, without any 1m--without option22m, bundler will recall + run bundle install, without any --without option, bundler will recall it. - Also, calling 1mBundler.setup 22mwith no parameters, or calling 1mrequire0m - 1m"bundler/setup" 22mwill setup all groups except for the ones you excluded - via 1m--without 22m(since they are not available). + Also, calling Bundler.setup with no parameters, or calling require + "bundler/setup" will setup all groups except for the ones you excluded + via --without (since they are not available). - Note that on 1mbundle install22m, bundler downloads and evaluates all gems, - in order to create a single canonical list of all of the required gems - and their dependencies. This means that you cannot list different ver- - sions of the same gems in different groups. For more details, see Un- - derstanding Bundler 4mhttp://bundler.io/rationale.html24m. + Note that on bundle install, bundler downloads and evaluates all gems, + in order to create a single canonical list of all of the required gems + and their dependencies. This means that you cannot list different ver- + sions of the same gems in different groups. For more details, see + Understanding Bundler https://bundler.io/rationale.html. - 1mPLATFORMS0m - If a gem should only be used in a particular platform or set of plat- - forms, you can specify them. Platforms are essentially identical to - groups, except that you do not need to use the 1m--without 22minstall-time + PLATFORMS + If a gem should only be used in a particular platform or set of plat- + forms, you can specify them. Platforms are essentially identical to + groups, except that you do not need to use the --without install-time flag to exclude groups of gems for other platforms. - There are a number of 1mGemfile 22mplatforms: + There are a number of Gemfile platforms: - 1mruby 22mC Ruby (MRI), Rubinius or TruffleRuby, but 1mNOT 22mWindows + ruby C Ruby (MRI), Rubinius or TruffleRuby, but NOT Windows - 1mmri 22mSame as 4mruby24m, but only C Ruby (MRI) + mri Same as ruby, but only C Ruby (MRI) - 1mmingw 22mWindows 32 bit 'mingw32' platform (aka RubyInstaller) + mingw Windows 32 bit 'mingw32' platform (aka RubyInstaller) - 1mx64_mingw0m + x64_mingw Windows 64 bit 'mingw32' platform (aka RubyInstaller x64) - 1mrbx 22mRubinius + rbx Rubinius - 1mjruby 22mJRuby + jruby JRuby - 1mtruffleruby0m + truffleruby TruffleRuby - 1mmswin 22mWindows + mswin Windows - You can restrict further by platform and version for all platforms 4mex-0m - 4mcept24m for 1mrbx22m, 1mjruby22m, 1mtruffleruby 22mand 1mmswin22m. + You can restrict further by platform and version for all platforms + except for rbx, jruby, truffleruby and mswin. To specify a version in addition to a platform, append the version num- ber without the delimiter to the platform. For example, to specify that @@ -271,13 +271,13 @@ GEMFILE(5) GEMFILE(5) The full list of platforms and supported versions includes: - 1mruby 22m1.8, 1.9, 2.0, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6 + ruby 1.8, 1.9, 2.0, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6 - 1mmri 22m1.8, 1.9, 2.0, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6 + mri 1.8, 1.9, 2.0, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6 - 1mmingw 22m1.8, 1.9, 2.0, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6 + mingw 1.8, 1.9, 2.0, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6 - 1mx64_mingw0m + x64_mingw 2.0, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6 As with groups, you can specify one or more platforms: @@ -290,12 +290,12 @@ GEMFILE(5) GEMFILE(5) - All operations involving groups (1mbundle install 4m22mbundle-install.1.html24m, - 1mBundler.setup22m, 1mBundler.require22m) behave exactly the same as if any + All operations involving groups (bundle install bundle-install.1.html, + Bundler.setup, Bundler.require) behave exactly the same as if any groups not matching the current platform were explicitly excluded. - 1mSOURCE0m - You can select an alternate Rubygems repository for a gem using the + SOURCE + You can select an alternate Rubygems repository for a gem using the ':source' option. @@ -304,60 +304,60 @@ GEMFILE(5) GEMFILE(5) - This forces the gem to be loaded from this source and ignores any - global sources declared at the top level of the file. If the gem does + This forces the gem to be loaded from this source and ignores any + global sources declared at the top level of the file. If the gem does not exist in this source, it will not be installed. Bundler will search for child dependencies of this gem by first looking in the source selected for the parent, but if they are not found there, - it will fall back on global sources using the ordering described in - 4mSOURCE24m 4mPRIORITY24m. + it will fall back on global sources using the ordering described in + SOURCE PRIORITY. - Selecting a specific source repository this way also suppresses the am- - biguous gem warning described above in 4mGLOBAL24m 4mSOURCES24m 4m(#source)24m. + Selecting a specific source repository this way also suppresses the + ambiguous gem warning described above in GLOBAL SOURCES (#source). - Using the 1m:source 22moption for an individual gem will also make that - source available as a possible global source for any other gems which - do not specify explicit sources. Thus, when adding gems with explicit - sources, it is recommended that you also ensure all other gems in the + Using the :source option for an individual gem will also make that + source available as a possible global source for any other gems which + do not specify explicit sources. Thus, when adding gems with explicit + sources, it is recommended that you also ensure all other gems in the Gemfile are using explicit sources. - 1mGIT0m + GIT If necessary, you can specify that a gem is located at a particular git - repository using the 1m:git 22mparameter. The repository can be accessed via + repository using the :git parameter. The repository can be accessed via several protocols: - 1mHTTP(S)0m + HTTP(S) gem "rails", :git => "https://github.com/rails/rails.git" - 1mSSH 22mgem "rails", :git => "git@github.com:rails/rails.git" + SSH gem "rails", :git => "git@github.com:rails/rails.git" - 1mgit 22mgem "rails", :git => "git://github.com/rails/rails.git" + git gem "rails", :git => "git://github.com/rails/rails.git" - If using SSH, the user that you use to run 1mbundle install MUST 22mhave the - appropriate keys available in their 1m$HOME/.ssh22m. + If using SSH, the user that you use to run bundle install MUST have the + appropriate keys available in their $HOME/.ssh. - 1mNOTE22m: 1mhttp:// 22mand 1mgit:// 22mURLs should be avoided if at all possible. - These protocols are unauthenticated, so a man-in-the-middle attacker - can deliver malicious code and compromise your system. HTTPS and SSH + NOTE: http:// and git:// URLs should be avoided if at all possible. + These protocols are unauthenticated, so a man-in-the-middle attacker + can deliver malicious code and compromise your system. HTTPS and SSH are strongly preferred. - The 1mgroup22m, 1mplatforms22m, and 1mrequire 22moptions are available and behave ex- - actly the same as they would for a normal gem. + The group, platforms, and require options are available and behave + exactly the same as they would for a normal gem. - A git repository 1mSHOULD 22mhave at least one file, at the root of the di- - rectory containing the gem, with the extension 1m.gemspec22m. This file 1mMUST0m - contain a valid gem specification, as expected by the 1mgem build 22mcom- - mand. + A git repository SHOULD have at least one file, at the root of the + directory containing the gem, with the extension .gemspec. This file + MUST contain a valid gem specification, as expected by the gem build + command. - If a git repository does not have a 1m.gemspec22m, bundler will attempt to + If a git repository does not have a .gemspec, bundler will attempt to create one, but it will not contain any dependencies, executables, or C - extension compilation instructions. As a result, it may fail to prop- + extension compilation instructions. As a result, it may fail to prop- erly integrate into your application. - If a git repository does have a 1m.gemspec 22mfor the gem you attached it - to, a version specifier, if provided, means that the git repository is - only valid if the 1m.gemspec 22mspecifies a version matching the version + If a git repository does have a .gemspec for the gem you attached it + to, a version specifier, if provided, means that the git repository is + only valid if the .gemspec specifies a version matching the version specifier. If not, bundler will print a warning. @@ -368,35 +368,35 @@ GEMFILE(5) GEMFILE(5) - If a git repository does 1mnot 22mhave a 1m.gemspec 22mfor the gem you attached - it to, a version specifier 1mMUST 22mbe provided. Bundler will use this ver- - sion in the simple 1m.gemspec 22mit creates. + If a git repository does not have a .gemspec for the gem you attached + it to, a version specifier MUST be provided. Bundler will use this ver- + sion in the simple .gemspec it creates. Git repositories support a number of additional options. - 1mbranch22m, 1mtag22m, and 1mref0m - You 1mMUST 22monly specify at most one of these options. The default - is 1m:branch => "master"0m + branch, tag, and ref + You MUST only specify at most one of these options. The default + is :branch => "master" For example: - git "https://github.com/rails/rails.git", :branch => "5-0-sta- + git "https://github.com/rails/rails.git", :branch => "5-0-sta- ble" do git "https://github.com/rails/rails.git", :tag => "v5.0.0" do git "https://github.com/rails/rails.git", :ref => "4aded" do - 1msubmodules0m - For reference, a git submodule - 4mhttps://git-scm.com/book/en/v2/Git-Tools-Submodules24m lets you - have another git repository within a subfolder of your reposi- - tory. Specify 1m:submodules => true 22mto cause bundler to expand any + submodules + For reference, a git submodule + https://git-scm.com/book/en/v2/Git-Tools-Submodules lets you + have another git repository within a subfolder of your reposi- + tory. Specify :submodules => true to cause bundler to expand any submodules included in the git repository - If a git repository contains multiple 1m.gemspecs22m, each 1m.gemspec 22mrepre- - sents a gem located at the same place in the file system as the 1m.gem-0m - 1mspec22m. + If a git repository contains multiple .gemspecs, each .gemspec repre- + sents a gem located at the same place in the file system as the .gem- + spec. @@ -410,17 +410,17 @@ GEMFILE(5) GEMFILE(5) - To install a gem located in a git repository, bundler changes to the - directory containing the gemspec, runs 1mgem build name.gemspec 22mand then - installs the resulting gem. The 1mgem build 22mcommand, which comes standard - with Rubygems, evaluates the 1m.gemspec 22min the context of the directory + To install a gem located in a git repository, bundler changes to the + directory containing the gemspec, runs gem build name.gemspec and then + installs the resulting gem. The gem build command, which comes standard + with Rubygems, evaluates the .gemspec in the context of the directory in which it is located. - 1mGIT SOURCE0m - A custom git source can be defined via the 1mgit_source 22mmethod. Provide - the source's name as an argument, and a block which receives a single - argument and interpolates it into a string to return the full repo ad- - dress: + GIT SOURCE + A custom git source can be defined via the git_source method. Provide + the source's name as an argument, and a block which receives a single + argument and interpolates it into a string to return the full repo + address: @@ -437,15 +437,15 @@ GEMFILE(5) GEMFILE(5) - 1mGITHUB0m - 1mNOTE22m: This shorthand should be avoided until Bundler 2.0, since it cur- - rently expands to an insecure 1mgit:// 22mURL. This allows a man-in-the-mid- + GITHUB + NOTE: This shorthand should be avoided until Bundler 2.0, since it cur- + rently expands to an insecure git:// URL. This allows a man-in-the-mid- dle attacker to compromise your system. - If the git repository you want to use is hosted on GitHub and is pub- - lic, you can use the :github shorthand to specify the github username - and repository name (without the trailing ".git"), separated by a - slash. If both the username and repository name are the same, you can + If the git repository you want to use is hosted on GitHub and is pub- + lic, you can use the :github shorthand to specify the github username + and repository name (without the trailing ".git"), separated by a + slash. If both the username and repository name are the same, you can omit one. @@ -463,12 +463,12 @@ GEMFILE(5) GEMFILE(5) - Since the 1mgithub 22mmethod is a specialization of 1mgit_source22m, it accepts a - 1m:branch 22mnamed argument. + Since the github method is a specialization of git_source, it accepts a + :branch named argument. - 1mGIST0m + GIST If the git repository you want to use is hosted as a Github Gist and is - public, you can use the :gist shorthand to specify the gist identifier + public, you can use the :gist shorthand to specify the gist identifier (without the trailing ".git"). @@ -485,14 +485,14 @@ GEMFILE(5) GEMFILE(5) - Since the 1mgist 22mmethod is a specialization of 1mgit_source22m, it accepts a - 1m:branch 22mnamed argument. + Since the gist method is a specialization of git_source, it accepts a + :branch named argument. - 1mBITBUCKET0m - If the git repository you want to use is hosted on Bitbucket and is - public, you can use the :bitbucket shorthand to specify the bitbucket - username and repository name (without the trailing ".git"), separated - by a slash. If both the username and repository name are the same, you + BITBUCKET + If the git repository you want to use is hosted on Bitbucket and is + public, you can use the :bitbucket shorthand to specify the bitbucket + username and repository name (without the trailing ".git"), separated + by a slash. If both the username and repository name are the same, you can omit one. @@ -510,19 +510,19 @@ GEMFILE(5) GEMFILE(5) - Since the 1mbitbucket 22mmethod is a specialization of 1mgit_source22m, it ac- - cepts a 1m:branch 22mnamed argument. + Since the bitbucket method is a specialization of git_source, it + accepts a :branch named argument. - 1mPATH0m - You can specify that a gem is located in a particular location on the + PATH + You can specify that a gem is located in a particular location on the file system. Relative paths are resolved relative to the directory con- - taining the 1mGemfile22m. + taining the Gemfile. - Similar to the semantics of the 1m:git 22moption, the 1m:path 22moption requires - that the directory in question either contains a 1m.gemspec 22mfor the gem, + Similar to the semantics of the :git option, the :path option requires + that the directory in question either contains a .gemspec for the gem, or that you specify an explicit version that bundler should use. - Unlike 1m:git22m, bundler does not compile C extensions for gems specified + Unlike :git, bundler does not compile C extensions for gems specified as paths. @@ -532,8 +532,8 @@ GEMFILE(5) GEMFILE(5) If you would like to use multiple local gems directly from the filesys- - tem, you can set a global 1mpath 22moption to the path containing the gem's - files. This will automatically load gemspec files from subdirectories. + tem, you can set a global path option to the path containing the gem's + files. This will automatically load gemspec files from subdirectories. @@ -544,8 +544,8 @@ GEMFILE(5) GEMFILE(5) -1mBLOCK FORM OF SOURCE, GIT, PATH, GROUP and PLATFORMS0m - The 1m:source22m, 1m:git22m, 1m:path22m, 1m:group22m, and 1m:platforms 22moptions may be applied +BLOCK FORM OF SOURCE, GIT, PATH, GROUP and PLATFORMS + The :source, :git, :path, :group, and :platforms options may be applied to a group of gems by using block form. @@ -573,22 +573,22 @@ GEMFILE(5) GEMFILE(5) In the case of the group block form the :optional option can be given - to prevent a group from being installed unless listed in the 1m--with 22mop- - tion given to the 1mbundle install 22mcommand. + to prevent a group from being installed unless listed in the --with + option given to the bundle install command. - In the case of the 1mgit 22mblock form, the 1m:ref22m, 1m:branch22m, 1m:tag22m, and 1m:sub-0m - 1mmodules 22moptions may be passed to the 1mgit 22mmethod, and all gems in the + In the case of the git block form, the :ref, :branch, :tag, and :sub- + modules options may be passed to the git method, and all gems in the block will inherit those options. - The presence of a 1msource 22mblock in a Gemfile also makes that source + The presence of a source block in a Gemfile also makes that source available as a possible global source for any other gems which do not specify explicit sources. Thus, when defining source blocks, it is rec- ommended that you also ensure all other gems in the Gemfile are using - explicit sources, either via source blocks or 1m:source 22mdirectives on in- - dividual gems. + explicit sources, either via source blocks or :source directives on + individual gems. -1mINSTALL_IF0m - The 1minstall_if 22mmethod allows gems to be installed based on a proc or +INSTALL_IF + The install_if method allows gems to be installed based on a proc or lambda. This is especially useful for optional gems that can only be used if certain software is installed or some other conditions are met. @@ -600,54 +600,54 @@ GEMFILE(5) GEMFILE(5) -1mGEMSPEC0m - The 1m.gemspec 4m22mhttp://guides.rubygems.org/specification-reference/24m file +GEMSPEC + The .gemspec http://guides.rubygems.org/specification-reference/ file is where you provide metadata about your gem to Rubygems. Some required - Gemspec attributes include the name, description, and homepage of your - gem. This is also where you specify the dependencies your gem needs to + Gemspec attributes include the name, description, and homepage of your + gem. This is also where you specify the dependencies your gem needs to run. If you wish to use Bundler to help install dependencies for a gem while - it is being developed, use the 1mgemspec 22mmethod to pull in the dependen- - cies listed in the 1m.gemspec 22mfile. - - The 1mgemspec 22mmethod adds any runtime dependencies as gem requirements in - the default group. It also adds development dependencies as gem re- - quirements in the 1mdevelopment 22mgroup. Finally, it adds a gem requirement - on your project (1m:path => '.'22m). In conjunction with 1mBundler.setup22m, this - allows you to require project files in your test code as you would if - the project were installed as a gem; you need not manipulate the load - path manually or require project files via relative paths. - - The 1mgemspec 22mmethod supports optional 1m:path22m, 1m:glob22m, 1m:name22m, and 1m:develop-0m - 1mment_group 22moptions, which control where bundler looks for the 1m.gemspec22m, - the glob it uses to look for the gemspec (defaults to: "{,4m,24m/*}.gem- - spec"), what named 1m.gemspec 22mit uses (if more than one is present), and + it is being developed, use the gemspec method to pull in the dependen- + cies listed in the .gemspec file. + + The gemspec method adds any runtime dependencies as gem requirements in + the default group. It also adds development dependencies as gem + requirements in the development group. Finally, it adds a gem require- + ment on your project (:path => '.'). In conjunction with Bundler.setup, + this allows you to require project files in your test code as you would + if the project were installed as a gem; you need not manipulate the + load path manually or require project files via relative paths. + + The gemspec method supports optional :path, :glob, :name, and :develop- + ment_group options, which control where bundler looks for the .gemspec, + the glob it uses to look for the gemspec (defaults to: "{,,/*}.gem- + spec"), what named .gemspec it uses (if more than one is present), and which group development dependencies are included in. - When a 1mgemspec 22mdependency encounters version conflicts during resolu- - tion, the local version under development will always be selected -- - even if there are remote versions that better match other requirements - for the 1mgemspec 22mgem. + When a gemspec dependency encounters version conflicts during resolu- + tion, the local version under development will always be selected -- + even if there are remote versions that better match other requirements + for the gemspec gem. -1mSOURCE PRIORITY0m - When attempting to locate a gem to satisfy a gem requirement, bundler +SOURCE PRIORITY + When attempting to locate a gem to satisfy a gem requirement, bundler uses the following priority order: - 1. The source explicitly attached to the gem (using 1m:source22m, 1m:path22m, or - 1m:git22m) + 1. The source explicitly attached to the gem (using :source, :path, or + :git) 2. For implicit gems (dependencies of explicit gems), any source, git, - or path repository declared on the parent. This results in bundler - prioritizing the ActiveSupport gem from the Rails git repository - over ones from 1mrubygems.org0m + or path repository declared on the parent. This results in bundler + prioritizing the ActiveSupport gem from the Rails git repository + over ones from rubygems.org - 3. The sources specified via global 1msource 22mlines, searching each - source in your 1mGemfile 22mfrom last added to first added. + 3. The sources specified via global source lines, searching each + source in your Gemfile from last added to first added. - January 2019 GEMFILE(5) + April 2019 GEMFILE(5) |