File: C:/Ruby27-x64/share/doc/ruby/html/Gem/InstallUpdateOptions.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module Gem::InstallUpdateOptions - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="module">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="includes-section" class="nav-section">
<h3>Included Modules</h3>
<ul class="link-list">
<li><a class="include" href="SecurityOption.html">Gem::SecurityOption</a>
</ul>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-i-add_install_update_options">#add_install_update_options</a>
<li ><a href="#method-i-install_update_defaults_str">#install_update_defaults_str</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-Gem::InstallUpdateOptions">
<h1 id="module-Gem::InstallUpdateOptions" class="module">
module Gem::InstallUpdateOptions
</h1>
<section class="description">
<p>Mixin methods for install and update options for <a href="Commands.html"><code>Gem::Commands</code></a></p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-add_install_update_options" class="method-detail ">
<div class="method-heading">
<span class="method-name">add_install_update_options</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Add the install/update options to the option parser.</p>
<div class="method-source-code" id="add_install_update_options-source">
<pre><span class="ruby-comment"># File lib/rubygems/install_update_options.rb, line 20</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">add_install_update_options</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-value">:"Install/Update"</span>, <span class="ruby-string">'-i'</span>, <span class="ruby-string">'--install-dir DIR'</span>,
<span class="ruby-string">'Gem repository directory to get installed'</span>,
<span class="ruby-string">'gems'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span>, <span class="ruby-identifier">options</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:install_dir</span>] = <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">value</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-value">:"Install/Update"</span>, <span class="ruby-string">'-n'</span>, <span class="ruby-string">'--bindir DIR'</span>,
<span class="ruby-string">'Directory where executables are'</span>,
<span class="ruby-string">'located'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span>, <span class="ruby-identifier">options</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:bin_dir</span>] = <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">value</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-value">:"Install/Update"</span>, <span class="ruby-string">'--document [TYPES]'</span>, <span class="ruby-constant">Array</span>,
<span class="ruby-string">'Generate documentation for installed gems'</span>,
<span class="ruby-string">'List the documentation types you wish to'</span>,
<span class="ruby-string">'generate. For example: rdoc,ri'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span>, <span class="ruby-identifier">options</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:document</span>] = <span class="ruby-keyword">case</span> <span class="ruby-identifier">value</span>
<span class="ruby-keyword">when</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">then</span> <span class="ruby-node">%w[ri]</span>
<span class="ruby-keyword">when</span> <span class="ruby-keyword">false</span> <span class="ruby-keyword">then</span> []
<span class="ruby-keyword">else</span> <span class="ruby-identifier">value</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-value">:"Install/Update"</span>, <span class="ruby-string">'--build-root DIR'</span>,
<span class="ruby-string">'Temporary installation root. Useful for building'</span>,
<span class="ruby-string">'packages. Do not use this when installing remote gems.'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span>, <span class="ruby-identifier">options</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:build_root</span>] = <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">value</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-value">:"Install/Update"</span>, <span class="ruby-string">'--vendor'</span>,
<span class="ruby-string">'Install gem into the vendor directory.'</span>,
<span class="ruby-string">'Only for use by gem repackagers.'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span>, <span class="ruby-identifier">options</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">unless</span> <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">vendor_dir</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">OptionParser</span><span class="ruby-operator">::</span><span class="ruby-constant">InvalidOption</span>.<span class="ruby-identifier">new</span> <span class="ruby-string">'your platform is not supported'</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:vendor</span>] = <span class="ruby-keyword">true</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:install_dir</span>] = <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">vendor_dir</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-value">:"Install/Update"</span>, <span class="ruby-string">'-N'</span>, <span class="ruby-string">'--no-document'</span>,
<span class="ruby-string">'Disable documentation generation'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span>, <span class="ruby-identifier">options</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:document</span>] = []
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-value">:"Install/Update"</span>, <span class="ruby-string">'-E'</span>, <span class="ruby-string">'--[no-]env-shebang'</span>,
<span class="ruby-string">"Rewrite the shebang line on installed"</span>,
<span class="ruby-string">"scripts to use /usr/bin/env"</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span>, <span class="ruby-identifier">options</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:env_shebang</span>] = <span class="ruby-identifier">value</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-value">:"Install/Update"</span>, <span class="ruby-string">'-f'</span>, <span class="ruby-string">'--[no-]force'</span>,
<span class="ruby-string">'Force gem to install, bypassing dependency'</span>,
<span class="ruby-string">'checks'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span>, <span class="ruby-identifier">options</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:force</span>] = <span class="ruby-identifier">value</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-value">:"Install/Update"</span>, <span class="ruby-string">'-w'</span>, <span class="ruby-string">'--[no-]wrappers'</span>,
<span class="ruby-string">'Use bin wrappers for executables'</span>,
<span class="ruby-string">'Not available on dosish platforms'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span>, <span class="ruby-identifier">options</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:wrappers</span>] = <span class="ruby-identifier">value</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_security_option</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-value">:"Install/Update"</span>, <span class="ruby-string">'--ignore-dependencies'</span>,
<span class="ruby-string">'Do not install any required dependent gems'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span>, <span class="ruby-identifier">options</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:ignore_dependencies</span>] = <span class="ruby-identifier">value</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-value">:"Install/Update"</span>, <span class="ruby-string">'--[no-]format-executable'</span>,
<span class="ruby-string">'Make installed executable names match Ruby.'</span>,
<span class="ruby-string">'If Ruby is ruby18, foo_exec will be'</span>,
<span class="ruby-string">'foo_exec18'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span>, <span class="ruby-identifier">options</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:format_executable</span>] = <span class="ruby-identifier">value</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-value">:"Install/Update"</span>, <span class="ruby-string">'--[no-]user-install'</span>,
<span class="ruby-string">'Install in user\'s home directory instead'</span>,
<span class="ruby-string">'of GEM_HOME.'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span>, <span class="ruby-identifier">options</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:user_install</span>] = <span class="ruby-identifier">value</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-value">:"Install/Update"</span>, <span class="ruby-string">"--development"</span>,
<span class="ruby-string">"Install additional development"</span>,
<span class="ruby-string">"dependencies"</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span>, <span class="ruby-identifier">options</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:development</span>] = <span class="ruby-keyword">true</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:dev_shallow</span>] = <span class="ruby-keyword">true</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-value">:"Install/Update"</span>, <span class="ruby-string">"--development-all"</span>,
<span class="ruby-string">"Install development dependencies for all"</span>,
<span class="ruby-string">"gems (including dev deps themselves)"</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span>, <span class="ruby-identifier">options</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:development</span>] = <span class="ruby-keyword">true</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:dev_shallow</span>] = <span class="ruby-keyword">false</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-value">:"Install/Update"</span>, <span class="ruby-string">"--conservative"</span>,
<span class="ruby-string">"Don't attempt to upgrade gems already"</span>,
<span class="ruby-string">"meeting version requirement"</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span>, <span class="ruby-identifier">options</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:conservative</span>] = <span class="ruby-keyword">true</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:minimal_deps</span>] = <span class="ruby-keyword">true</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-value">:"Install/Update"</span>, <span class="ruby-string">"--minimal-deps"</span>,
<span class="ruby-string">"Don't upgrade any dependencies that already"</span>,
<span class="ruby-string">"meet version requirements"</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span>, <span class="ruby-identifier">options</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:minimal_deps</span>] = <span class="ruby-keyword">true</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-value">:"Install/Update"</span>, <span class="ruby-string">"--[no-]post-install-message"</span>,
<span class="ruby-string">"Print post install message"</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span>, <span class="ruby-identifier">options</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:post_install_message</span>] = <span class="ruby-identifier">value</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-value">:"Install/Update"</span>, <span class="ruby-string">'-g'</span>, <span class="ruby-string">'--file [FILE]'</span>,
<span class="ruby-string">'Read from a gem dependencies API file and'</span>,
<span class="ruby-string">'install the listed gems'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">v</span>,<span class="ruby-identifier">o</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">v</span> = <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">GEM_DEP_FILES</span>.<span class="ruby-identifier">find</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">file</span><span class="ruby-operator">|</span>
<span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span> <span class="ruby-identifier">file</span>
<span class="ruby-keyword">end</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">v</span>
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">v</span>
<span class="ruby-identifier">message</span> = <span class="ruby-identifier">v</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">v</span> <span class="ruby-operator">:</span> <span class="ruby-node">"(tried #{Gem::GEM_DEP_FILES.join ', '})"</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">OptionParser</span><span class="ruby-operator">::</span><span class="ruby-constant">InvalidArgument</span>,
<span class="ruby-node">"cannot find gem dependencies file #{message}"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:gemdeps</span>] = <span class="ruby-identifier">v</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-value">:"Install/Update"</span>, <span class="ruby-string">'--without GROUPS'</span>, <span class="ruby-constant">Array</span>,
<span class="ruby-string">'Omit the named groups (comma separated)'</span>,
<span class="ruby-string">'when installing from a gem dependencies'</span>,
<span class="ruby-string">'file'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">v</span>,<span class="ruby-identifier">o</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:without_groups</span>].<span class="ruby-identifier">concat</span> <span class="ruby-identifier">v</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">without</span><span class="ruby-operator">|</span> <span class="ruby-identifier">without</span>.<span class="ruby-identifier">intern</span> }
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-value">:"Install/Update"</span>, <span class="ruby-string">'--default'</span>,
<span class="ruby-string">'Add the gem\'s full specification to'</span>,
<span class="ruby-string">'specifications/default and extract only its bin'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">v</span>,<span class="ruby-identifier">o</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:install_as_default</span>] = <span class="ruby-identifier">v</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-value">:"Install/Update"</span>, <span class="ruby-string">'--explain'</span>,
<span class="ruby-string">'Rather than install the gems, indicate which would'</span>,
<span class="ruby-string">'be installed'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">v</span>,<span class="ruby-identifier">o</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:explain</span>] = <span class="ruby-identifier">v</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-value">:"Install/Update"</span>, <span class="ruby-string">'--[no-]lock'</span>,
<span class="ruby-string">'Create a lock file (when used with -g/--file)'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">v</span>,<span class="ruby-identifier">o</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:lock</span>] = <span class="ruby-identifier">v</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">add_option</span>(<span class="ruby-value">:"Install/Update"</span>, <span class="ruby-string">'--[no-]suggestions'</span>,
<span class="ruby-string">'Suggest alternates when gems are not found'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">v</span>,<span class="ruby-identifier">o</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:suggest_alternate</span>] = <span class="ruby-identifier">v</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-install_update_defaults_str" class="method-detail ">
<div class="method-heading">
<span class="method-name">install_update_defaults_str</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Default options for the gem install command.</p>
<div class="method-source-code" id="install_update_defaults_str-source">
<pre><span class="ruby-comment"># File lib/rubygems/install_update_options.rb, line 186</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">install_update_defaults_str</span>
<span class="ruby-string">'--document=rdoc,ri --wrappers'</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>