diff options
Diffstat (limited to 'man/bundle-config.1')
| -rw-r--r-- | man/bundle-config.1 | 62 |
1 files changed, 34 insertions, 28 deletions
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 . |