Skip to content
Browse files

Add options to command reference

  • Loading branch information...
1 parent ae82489 commit 164f34d3b7b5ae6626752cd3ca03671c85eb546e @ffmike committed Jan 9, 2012
Showing with 680 additions and 0 deletions.
  1. +30 −0 Rakefile
  2. +2 −0 command-reference.erb
  3. +648 −0 command-reference.md
View
30 Rakefile
@@ -51,6 +51,36 @@ task :command_guide do
htmlify("* #{string}")
end
+ def options_list(command)
+ # Invoke the Ruby options parser by asking for help. Otherwise the options
+ # list in the parser will never be initialized.
+ # TODO: Figure out how to avoid dumping help to stdout when running this rake task
+ command.show_help
+ parser = command.send(:parser)
+ options = ''
+ helplines = parser.summarize
+ helplines.each do |helpline|
+ break if (helpline =~ /Arguments/) || (helpline =~ /Summary/)
+ unless helpline.gsub(/\n/, '').strip == ''
+ # Use zero-width space to prevent "helpful" change of -- to –
+ helpline = helpline.gsub('--', '-​-')
+ if helpline =~ /^\s{10,}(.*)/
+ options = options[0..-2] + " #{$1}\n"
+ else
+ if helpline =~ /^(.*)\s{3,}(.*)/
+ helpline = "#{$1} - #{$2}"
+ end
+ if helpline =~ /options/i
+ options += "\n### #{helpline}\n"
+ else
+ options += "* #{helpline}\n"
+ end
+ end
+ end
+ end
+ options
+ end
+
erbio = RDoc::ERBIO.new File.read("command-reference.erb"), nil, nil
open 'command-reference.md', 'w' do |io|
erbio.result binding
View
2 command-reference.erb
@@ -19,6 +19,8 @@ What each `gem` command does, and how to use it.
<%= command.usage %> [options]
+<%= options_list(command) %>
+
<% if command.arguments != "" %>
### Arguments
View
648 command-reference.md
@@ -46,6 +46,17 @@ Build a gem from a gemspec
gem build GEMSPEC_FILE [options]
+
+### Common Options:
+
+* -h, -&#8203;-help - Get help on this command
+* -V, -&#8203;-[no-]verbose - Set the verbose level of output
+* -q, -&#8203;-quiet - Silence commands
+* -&#8203;-config-file FILE - Use this config file instead of default
+* -&#8203;-backtrace - Show stack backtrace on errors
+* -&#8203;-debug - Turn on Ruby debugging
+
+
### Arguments
@@ -64,6 +75,27 @@ Manage RubyGems certificates and signing settings
gem cert [options]
+
+### Options:
+
+* -a, -&#8203;-add CERT - Add a trusted certificate.
+* -l, -&#8203;-list - List trusted certificates.
+* -r, -&#8203;-remove STRING - Remove trusted certificates containing STRING.
+* -b, -&#8203;-build EMAIL_ADDR - Build private key and self-signed certificate for EMAIL_ADDR.
+* -C, -&#8203;-certificate CERT - Certificate for -&#8203;-sign command.
+* -K, -&#8203;-private-key KEY - Private key for -&#8203;-sign command.
+* -s, -&#8203;-sign NEWCERT - Sign a certificate with my key and certificate.
+
+### Common Options:
+
+* -h, -&#8203;-help - Get help on this command
+* -V, -&#8203;-[no-]verbose - Set the verbose level of output
+* -q, -&#8203;-quiet - Silence commands
+* -&#8203;-config-file FILE - Use this config file instead of default
+* -&#8203;-backtrace - Show stack backtrace on errors
+* -&#8203;-debug - Turn on Ruby debugging
+
+
@@ -76,6 +108,23 @@ Check installed gems
gem check [options]
+
+### Options:
+
+* -&#8203;-verify FILE - Verify gem file against its internal checksum
+* -a, -&#8203;-alien - Report 'unmanaged' or rogue files in the gem repository
+* -v, -&#8203;-version VERSION - Specify version of gem to check
+
+### Common Options:
+
+* -h, -&#8203;-help - Get help on this command
+* -V, -&#8203;-[no-]verbose - Set the verbose level of output
+* -q, -&#8203;-quiet - Silence commands
+* -&#8203;-config-file FILE - Use this config file instead of default
+* -&#8203;-backtrace - Show stack backtrace on errors
+* -&#8203;-debug - Turn on Ruby debugging
+
+
@@ -88,6 +137,21 @@ Clean up old versions of installed gems in the local repository
gem cleanup [GEMNAME ...] [options]
+
+### Options:
+
+* - -d, -&#8203;-dryrun
+
+### Common Options:
+
+* -h, -&#8203;-help - Get help on this command
+* -V, -&#8203;-[no-]verbose - Set the verbose level of output
+* -q, -&#8203;-quiet - Silence commands
+* -&#8203;-config-file FILE - Use this config file instead of default
+* -&#8203;-backtrace - Show stack backtrace on errors
+* -&#8203;-debug - Turn on Ruby debugging
+
+
### Arguments
@@ -112,6 +176,25 @@ Display the contents of the installed gems
gem contents GEMNAME [GEMNAME ...] [options]
+
+### Options:
+
+* -v, -&#8203;-version VERSION - Specify version of gem to contents
+* -&#8203;-all - Contents for all gems
+* -s, -&#8203;-spec-dir a,b,c - Search for gems under specific paths
+* -l, -&#8203;-[no-]lib-only - Only return files in the Gem's lib_dirs
+* -&#8203;-[no-]prefix - Don't include installed path prefix
+
+### Common Options:
+
+* -h, -&#8203;-help - Get help on this command
+* -V, -&#8203;-[no-]verbose - Set the verbose level of output
+* -q, -&#8203;-quiet - Silence commands
+* -&#8203;-config-file FILE - Use this config file instead of default
+* -&#8203;-backtrace - Show stack backtrace on errors
+* -&#8203;-debug - Turn on Ruby debugging
+
+
### Arguments
@@ -130,6 +213,39 @@ Show the dependencies of an installed gem
gem dependency GEMNAME [options]
+
+### Options:
+
+* -v, -&#8203;-version VERSION - Specify version of gem to dependency
+* -&#8203;-platform PLATFORM - Specify the platform of gem to dependency
+* -&#8203;-[no-]prerelease - Allow prerelease versions of a gem
+* - -R, -&#8203;-[no-]reverse-dependencies Include reverse dependencies in the output
+* -&#8203;-pipe - Pipe Format (name -&#8203;-version ver)
+
+### Deprecated Options:
+
+* -u, -&#8203;-[no-]update-sources - Update local source cache
+
+### Local/Remote Options:
+
+* -l, -&#8203;-local - Restrict operations to the LOCAL domain
+* -r, -&#8203;-remote - Restrict operations to the REMOTE domain
+* -b, -&#8203;-both - Allow LOCAL and REMOTE operations
+* -B, -&#8203;-bulk-threshold COUNT - Threshold for switching to bulk synchronization (default 1000)
+* -&#8203;-clear-sources - Clear the gem sources
+* -&#8203;-source URL - Add URL as a remote source for gems
+* -p, -&#8203;-[no-]http-proxy [URL] - Use HTTP proxy for remote operations
+
+### Common Options:
+
+* -h, -&#8203;-help - Get help on this command
+* -V, -&#8203;-[no-]verbose - Set the verbose level of output
+* -q, -&#8203;-quiet - Silence commands
+* -&#8203;-config-file FILE - Use this config file instead of default
+* -&#8203;-backtrace - Show stack backtrace on errors
+* -&#8203;-debug - Turn on Ruby debugging
+
+
### Arguments
@@ -148,6 +264,17 @@ Display information about the RubyGems environment
gem environment [arg] [options]
+
+### Common Options:
+
+* -h, -&#8203;-help - Get help on this command
+* -V, -&#8203;-[no-]verbose - Set the verbose level of output
+* -q, -&#8203;-quiet - Silence commands
+* -&#8203;-config-file FILE - Use this config file instead of default
+* -&#8203;-backtrace - Show stack backtrace on errors
+* -&#8203;-debug - Turn on Ruby debugging
+
+
### Arguments
@@ -209,6 +336,29 @@ Download a gem and place it in the current directory
gem fetch GEMNAME [GEMNAME ...] [options]
+
+### Options:
+
+* -v, -&#8203;-version VERSION - Specify version of gem to fetch
+* -&#8203;-platform PLATFORM - Specify the platform of gem to fetch
+* -&#8203;-[no-]prerelease - Allow prerelease versions of a gem
+
+### Local/Remote Options:
+
+* -B, -&#8203;-bulk-threshold COUNT - Threshold for switching to bulk synchronization (default 1000)
+* -p, -&#8203;-[no-]http-proxy [URL] - Use HTTP proxy for remote operations
+* -&#8203;-source URL - Add URL as a remote source for gems
+
+### Common Options:
+
+* -h, -&#8203;-help - Get help on this command
+* -V, -&#8203;-[no-]verbose - Set the verbose level of output
+* -q, -&#8203;-quiet - Silence commands
+* -&#8203;-config-file FILE - Use this config file instead of default
+* -&#8203;-backtrace - Show stack backtrace on errors
+* -&#8203;-debug - Turn on Ruby debugging
+
+
### Arguments
@@ -227,6 +377,30 @@ Generates the index files for a gem server directory
gem generate_index [options]
+
+### Options:
+
+* -d, -&#8203;-directory=DIRNAME - repository base dir containing gems subdir
+* -&#8203;-[no-]legacy - Generate Marshal.4.8
+* -&#8203;-[no-]modern - Generate indexes for RubyGems newer than 1.2.0
+* -&#8203;-update - Update modern indexes with gems added since the last update
+
+### RSS Options:
+
+* -&#8203;-rss-gems-host=GEM_HOST - Host name where gems are served from, used for GUID and enclosure values
+* -&#8203;-rss-host=HOST - Host name for more gems information, used for RSS feed link
+* -&#8203;-rss-title=TITLE - Set title for RSS feed
+
+### Common Options:
+
+* -h, -&#8203;-help - Get help on this command
+* -V, -&#8203;-[no-]verbose - Set the verbose level of output
+* -q, -&#8203;-quiet - Silence commands
+* -&#8203;-config-file FILE - Use this config file instead of default
+* -&#8203;-backtrace - Show stack backtrace on errors
+* -&#8203;-debug - Turn on Ruby debugging
+
+
@@ -271,6 +445,17 @@ Provide help on the 'gem' command
gem help ARGUMENT [options]
+
+### Common Options:
+
+* -h, -&#8203;-help - Get help on this command
+* -V, -&#8203;-[no-]verbose - Set the verbose level of output
+* -q, -&#8203;-quiet - Silence commands
+* -&#8203;-config-file FILE - Use this config file instead of default
+* -&#8203;-backtrace - Show stack backtrace on errors
+* -&#8203;-debug - Turn on Ruby debugging
+
+
### Arguments
@@ -291,6 +476,54 @@ Install a gem into the local repository
gem install GEMNAME [GEMNAME ...] [options] -- --build-flags [options]
+
+### Options:
+
+* -&#8203;-platform PLATFORM - Specify the platform of gem to install
+* -v, -&#8203;-version VERSION - Specify version of gem to install
+* -&#8203;-[no-]prerelease - Allow prerelease versions of a gem to be installed. (Only for listed gems)
+
+### Deprecated Options:
+
+* -u, -&#8203;-[no-]update-sources - Update local source cache
+
+### Install/Update Options:
+
+* -i, -&#8203;-install-dir DIR - Gem repository directory to get installed gems
+* -n, -&#8203;-bindir DIR - Directory where binary files are located
+* -d, -&#8203;-[no-]rdoc - Generate RDoc documentation for the gem on install
+* -&#8203;-[no-]ri - Generate RI documentation for the gem on install
+* -E, -&#8203;-[no-]env-shebang - Rewrite the shebang line on installed scripts to use /usr/bin/env
+* -f, -&#8203;-[no-]force - Force gem to install, bypassing dependency checks
+* -w, -&#8203;-[no-]wrappers - Use bin wrappers for executables Not available on dosish platforms
+* -P, -&#8203;-trust-policy POLICY - Specify gem trust policy
+* -&#8203;-ignore-dependencies - Do not install any required dependent gems
+* -y, -&#8203;-include-dependencies - Unconditionally install the required dependent gems
+* -&#8203;-[no-]format-executable - Make installed executable names match ruby. If ruby is ruby18, foo_exec will be foo_exec18
+* -&#8203;-[no-]user-install - Install in user's home directory instead of GEM_HOME.
+* -&#8203;-development - Install any additional development dependencies
+* -&#8203;-conservative - Don't attempt to upgrade gems already meeting version requirement
+
+### Local/Remote Options:
+
+* -l, -&#8203;-local - Restrict operations to the LOCAL domain
+* -r, -&#8203;-remote - Restrict operations to the REMOTE domain
+* -b, -&#8203;-both - Allow LOCAL and REMOTE operations
+* -B, -&#8203;-bulk-threshold COUNT - Threshold for switching to bulk synchronization (default 1000)
+* -&#8203;-clear-sources - Clear the gem sources
+* -&#8203;-source URL - Add URL as a remote source for gems
+* -p, -&#8203;-[no-]http-proxy [URL] - Use HTTP proxy for remote operations
+
+### Common Options:
+
+* -h, -&#8203;-help - Get help on this command
+* -V, -&#8203;-[no-]verbose - Set the verbose level of output
+* -q, -&#8203;-quiet - Silence commands
+* -&#8203;-config-file FILE - Use this config file instead of default
+* -&#8203;-backtrace - Show stack backtrace on errors
+* -&#8203;-debug - Turn on Ruby debugging
+
+
### Arguments
@@ -361,6 +594,40 @@ Display gems whose name starts with STRING
gem list [STRING] [options]
+
+### Options:
+
+* -i, -&#8203;-[no-]installed - Check for installed gem
+* -v, -&#8203;-version VERSION - Specify version of gem to list for use with -&#8203;-installed
+* -d, -&#8203;-[no-]details - Display detailed information of gem(s)
+* -&#8203;-[no-]versions - Display only gem names
+* -a, -&#8203;-all - Display all gem versions
+* -&#8203;-[no-]prerelease - Display prerelease versions
+
+### Deprecated Options:
+
+* -u, -&#8203;-[no-]update-sources - Update local source cache
+
+### Local/Remote Options:
+
+* -l, -&#8203;-local - Restrict operations to the LOCAL domain
+* -r, -&#8203;-remote - Restrict operations to the REMOTE domain
+* -b, -&#8203;-both - Allow LOCAL and REMOTE operations
+* -B, -&#8203;-bulk-threshold COUNT - Threshold for switching to bulk synchronization (default 1000)
+* -&#8203;-clear-sources - Clear the gem sources
+* -&#8203;-source URL - Add URL as a remote source for gems
+* -p, -&#8203;-[no-]http-proxy [URL] - Use HTTP proxy for remote operations
+
+### Common Options:
+
+* -h, -&#8203;-help - Get help on this command
+* -V, -&#8203;-[no-]verbose - Set the verbose level of output
+* -q, -&#8203;-quiet - Silence commands
+* -&#8203;-config-file FILE - Use this config file instead of default
+* -&#8203;-backtrace - Show stack backtrace on errors
+* -&#8203;-debug - Turn on Ruby debugging
+
+
### Arguments
@@ -379,6 +646,21 @@ Generate a lockdown list of gems
gem lock GEMNAME-VERSION [GEMNAME-VERSION ...] [options]
+
+### Options:
+
+* -s, -&#8203;-[no-]strict - fail if unable to satisfy a dependency
+
+### Common Options:
+
+* -h, -&#8203;-help - Get help on this command
+* -V, -&#8203;-[no-]verbose - Set the verbose level of output
+* -q, -&#8203;-quiet - Silence commands
+* -&#8203;-config-file FILE - Use this config file instead of default
+* -&#8203;-backtrace - Show stack backtrace on errors
+* -&#8203;-debug - Turn on Ruby debugging
+
+
### Arguments
@@ -430,6 +712,35 @@ Display all gems that need updates
gem outdated [options]
+
+### Options:
+
+* -&#8203;-platform PLATFORM - Specify the platform of gem to outdated
+
+### Deprecated Options:
+
+* -u, -&#8203;-[no-]update-sources - Update local source cache
+
+### Local/Remote Options:
+
+* -l, -&#8203;-local - Restrict operations to the LOCAL domain
+* -r, -&#8203;-remote - Restrict operations to the REMOTE domain
+* -b, -&#8203;-both - Allow LOCAL and REMOTE operations
+* -B, -&#8203;-bulk-threshold COUNT - Threshold for switching to bulk synchronization (default 1000)
+* -&#8203;-clear-sources - Clear the gem sources
+* -&#8203;-source URL - Add URL as a remote source for gems
+* -p, -&#8203;-[no-]http-proxy [URL] - Use HTTP proxy for remote operations
+
+### Common Options:
+
+* -h, -&#8203;-help - Get help on this command
+* -V, -&#8203;-[no-]verbose - Set the verbose level of output
+* -q, -&#8203;-quiet - Silence commands
+* -&#8203;-config-file FILE - Use this config file instead of default
+* -&#8203;-backtrace - Show stack backtrace on errors
+* -&#8203;-debug - Turn on Ruby debugging
+
+
@@ -442,6 +753,27 @@ Manage gem owners on RubyGems.org.
gem owner [options]
+
+### Options:
+
+* -k, -&#8203;-key KEYNAME - Use the given API key from ~/.gem/credentials
+* -a, -&#8203;-add EMAIL - Add an owner
+* -r, -&#8203;-remove EMAIL - Remove an owner
+
+### Local/Remote Options:
+
+* -p, -&#8203;-[no-]http-proxy [URL] - Use HTTP proxy for remote operations
+
+### Common Options:
+
+* -h, -&#8203;-help - Get help on this command
+* -V, -&#8203;-[no-]verbose - Set the verbose level of output
+* -q, -&#8203;-quiet - Silence commands
+* -&#8203;-config-file FILE - Use this config file instead of default
+* -&#8203;-backtrace - Show stack backtrace on errors
+* -&#8203;-debug - Turn on Ruby debugging
+
+
### Arguments
@@ -464,6 +796,23 @@ Restores installed gems to pristine condition from files located in the gem cach
gem pristine [args] [options]
+
+### Options:
+
+* -&#8203;-all - Restore all installed gems to pristine condition
+* -&#8203;-[no-]extensions - Restore gems with extensions
+* -v, -&#8203;-version VERSION - Specify version of gem to restore to pristine condition
+
+### Common Options:
+
+* -h, -&#8203;-help - Get help on this command
+* -V, -&#8203;-[no-]verbose - Set the verbose level of output
+* -q, -&#8203;-quiet - Silence commands
+* -&#8203;-config-file FILE - Use this config file instead of default
+* -&#8203;-backtrace - Show stack backtrace on errors
+* -&#8203;-debug - Turn on Ruby debugging
+
+
### Arguments
@@ -498,6 +847,26 @@ Push a gem up to RubyGems.org
gem push GEM [options]
+
+### Options:
+
+* -k, -&#8203;-key KEYNAME - Use the given API key from ~/.gem/credentials
+* -&#8203;-host HOST - Push to another gemcutter-compatible host
+
+### Local/Remote Options:
+
+* -p, -&#8203;-[no-]http-proxy [URL] - Use HTTP proxy for remote operations
+
+### Common Options:
+
+* -h, -&#8203;-help - Get help on this command
+* -V, -&#8203;-[no-]verbose - Set the verbose level of output
+* -q, -&#8203;-quiet - Silence commands
+* -&#8203;-config-file FILE - Use this config file instead of default
+* -&#8203;-backtrace - Show stack backtrace on errors
+* -&#8203;-debug - Turn on Ruby debugging
+
+
### Arguments
@@ -520,6 +889,41 @@ Query gem information in local or remote repositories
gem query [options]
+
+### Options:
+
+* -i, -&#8203;-[no-]installed - Check for installed gem
+* -v, -&#8203;-version VERSION - Specify version of gem to query for use with -&#8203;-installed
+* -n, -&#8203;-name-matches REGEXP - Name of gem(s) to query on matches the provided REGEXP
+* -d, -&#8203;-[no-]details - Display detailed information of gem(s)
+* -&#8203;-[no-]versions - Display only gem names
+* -a, -&#8203;-all - Display all gem versions
+* -&#8203;-[no-]prerelease - Display prerelease versions
+
+### Deprecated Options:
+
+* -u, -&#8203;-[no-]update-sources - Update local source cache
+
+### Local/Remote Options:
+
+* -l, -&#8203;-local - Restrict operations to the LOCAL domain
+* -r, -&#8203;-remote - Restrict operations to the REMOTE domain
+* -b, -&#8203;-both - Allow LOCAL and REMOTE operations
+* -B, -&#8203;-bulk-threshold COUNT - Threshold for switching to bulk synchronization (default 1000)
+* -&#8203;-clear-sources - Clear the gem sources
+* -&#8203;-source URL - Add URL as a remote source for gems
+* -p, -&#8203;-[no-]http-proxy [URL] - Use HTTP proxy for remote operations
+
+### Common Options:
+
+* -h, -&#8203;-help - Get help on this command
+* -V, -&#8203;-[no-]verbose - Set the verbose level of output
+* -q, -&#8203;-quiet - Silence commands
+* -&#8203;-config-file FILE - Use this config file instead of default
+* -&#8203;-backtrace - Show stack backtrace on errors
+* -&#8203;-debug - Turn on Ruby debugging
+
+
@@ -532,6 +936,25 @@ Generates RDoc for pre-installed gems
gem rdoc [args] [options]
+
+### Options:
+
+* -&#8203;-all - Generate RDoc/RI documentation for all installed gems
+* -&#8203;-[no-]rdoc - Generate RDoc HTML
+* -&#8203;-[no-]ri - Generate RI data
+* -&#8203;-[no-]overwrite - Overwrite installed documents
+* -v, -&#8203;-version VERSION - Specify version of gem to rdoc
+
+### Common Options:
+
+* -h, -&#8203;-help - Get help on this command
+* -V, -&#8203;-[no-]verbose - Set the verbose level of output
+* -q, -&#8203;-quiet - Silence commands
+* -&#8203;-config-file FILE - Use this config file instead of default
+* -&#8203;-backtrace - Show stack backtrace on errors
+* -&#8203;-debug - Turn on Ruby debugging
+
+
### Arguments
@@ -556,6 +979,40 @@ Display all gems whose name contains STRING
gem search [STRING] [options]
+
+### Options:
+
+* -i, -&#8203;-[no-]installed - Check for installed gem
+* -v, -&#8203;-version VERSION - Specify version of gem to search for use with -&#8203;-installed
+* -d, -&#8203;-[no-]details - Display detailed information of gem(s)
+* -&#8203;-[no-]versions - Display only gem names
+* -a, -&#8203;-all - Display all gem versions
+* -&#8203;-[no-]prerelease - Display prerelease versions
+
+### Deprecated Options:
+
+* -u, -&#8203;-[no-]update-sources - Update local source cache
+
+### Local/Remote Options:
+
+* -l, -&#8203;-local - Restrict operations to the LOCAL domain
+* -r, -&#8203;-remote - Restrict operations to the REMOTE domain
+* -b, -&#8203;-both - Allow LOCAL and REMOTE operations
+* -B, -&#8203;-bulk-threshold COUNT - Threshold for switching to bulk synchronization (default 1000)
+* -&#8203;-clear-sources - Clear the gem sources
+* -&#8203;-source URL - Add URL as a remote source for gems
+* -p, -&#8203;-[no-]http-proxy [URL] - Use HTTP proxy for remote operations
+
+### Common Options:
+
+* -h, -&#8203;-help - Get help on this command
+* -V, -&#8203;-[no-]verbose - Set the verbose level of output
+* -q, -&#8203;-quiet - Silence commands
+* -&#8203;-config-file FILE - Use this config file instead of default
+* -&#8203;-backtrace - Show stack backtrace on errors
+* -&#8203;-debug - Turn on Ruby debugging
+
+
### Arguments
@@ -574,6 +1031,25 @@ Documentation and gem repository HTTP server
gem server [options]
+
+### Options:
+
+* -p, -&#8203;-port=PORT - port to listen on
+* -d, -&#8203;-dir=GEMDIR - directories from which to serve gems multiple directories may be provided
+* -&#8203;-[no-]daemon - run as a daemon
+* -b, -&#8203;-bind=HOST,HOST - addresses to bind
+* -l, -&#8203;-launch[=COMMAND] - launches a browser window COMMAND defaults to 'start' on Windows and 'open' on all other platforms
+
+### Common Options:
+
+* -h, -&#8203;-help - Get help on this command
+* -V, -&#8203;-[no-]verbose - Set the verbose level of output
+* -q, -&#8203;-quiet - Silence commands
+* -&#8203;-config-file FILE - Use this config file instead of default
+* -&#8203;-backtrace - Show stack backtrace on errors
+* -&#8203;-debug - Turn on Ruby debugging
+
+
@@ -605,6 +1081,29 @@ Manage the sources and cache file RubyGems uses to search for gems
gem sources [options]
+
+### Options:
+
+* -a, -&#8203;-add SOURCE_URI - Add source
+* -l, -&#8203;-list - List sources
+* -r, -&#8203;-remove SOURCE_URI - Remove source
+* -c, -&#8203;-clear-all - Remove all sources (clear the cache)
+* -u, -&#8203;-update - Update source cache
+
+### Local/Remote Options:
+
+* -p, -&#8203;-[no-]http-proxy [URL] - Use HTTP proxy for remote operations
+
+### Common Options:
+
+* -h, -&#8203;-help - Get help on this command
+* -V, -&#8203;-[no-]verbose - Set the verbose level of output
+* -q, -&#8203;-quiet - Silence commands
+* -&#8203;-config-file FILE - Use this config file instead of default
+* -&#8203;-backtrace - Show stack backtrace on errors
+* -&#8203;-debug - Turn on Ruby debugging
+
+
@@ -617,6 +1116,40 @@ Display gem specification (in yaml)
gem specification [GEMFILE] [FIELD] [options]
+
+### Options:
+
+* -v, -&#8203;-version VERSION - Specify version of gem to examine
+* -&#8203;-platform PLATFORM - Specify the platform of gem to specification
+* -&#8203;-all - Output specifications for all versions of the gem
+* -&#8203;-ruby - Output ruby format
+* -&#8203;-yaml - Output RUBY format
+* -&#8203;-marshal - Output Marshal format
+
+### Deprecated Options:
+
+* -u, -&#8203;-[no-]update-sources - Update local source cache
+
+### Local/Remote Options:
+
+* -l, -&#8203;-local - Restrict operations to the LOCAL domain
+* -r, -&#8203;-remote - Restrict operations to the REMOTE domain
+* -b, -&#8203;-both - Allow LOCAL and REMOTE operations
+* -B, -&#8203;-bulk-threshold COUNT - Threshold for switching to bulk synchronization (default 1000)
+* -&#8203;-clear-sources - Clear the gem sources
+* -&#8203;-source URL - Add URL as a remote source for gems
+* -p, -&#8203;-[no-]http-proxy [URL] - Use HTTP proxy for remote operations
+
+### Common Options:
+
+* -h, -&#8203;-help - Get help on this command
+* -V, -&#8203;-[no-]verbose - Set the verbose level of output
+* -q, -&#8203;-quiet - Silence commands
+* -&#8203;-config-file FILE - Use this config file instead of default
+* -&#8203;-backtrace - Show stack backtrace on errors
+* -&#8203;-debug - Turn on Ruby debugging
+
+
### Arguments
@@ -636,6 +1169,17 @@ List gems along with access times
gem stale [options]
+
+### Common Options:
+
+* -h, -&#8203;-help - Get help on this command
+* -V, -&#8203;-[no-]verbose - Set the verbose level of output
+* -q, -&#8203;-quiet - Silence commands
+* -&#8203;-config-file FILE - Use this config file instead of default
+* -&#8203;-backtrace - Show stack backtrace on errors
+* -&#8203;-debug - Turn on Ruby debugging
+
+
@@ -648,6 +1192,29 @@ Uninstall gems from the local repository
gem uninstall GEMNAME [GEMNAME ...] [options]
+
+### Options:
+
+* -a, -&#8203;-[no-]all - Uninstall all matching versions
+* -I, -&#8203;-[no-]ignore-dependencies - Ignore dependency requirements while uninstalling
+* -x, -&#8203;-[no-]executables - Uninstall applicable executables without confirmation
+* -i, -&#8203;-install-dir DIR - Directory to uninstall gem from
+* -n, -&#8203;-bindir DIR - Directory to remove binaries from
+* -&#8203;-[no-]user-install - Uninstall from user's home directory in addition to GEM_HOME.
+* -&#8203;-[no-]format-executable - Assume executable names match Ruby's prefix and suffix.
+* -v, -&#8203;-version VERSION - Specify version of gem to uninstall
+* -&#8203;-platform PLATFORM - Specify the platform of gem to uninstall
+
+### Common Options:
+
+* -h, -&#8203;-help - Get help on this command
+* -V, -&#8203;-[no-]verbose - Set the verbose level of output
+* -q, -&#8203;-quiet - Silence commands
+* -&#8203;-config-file FILE - Use this config file instead of default
+* -&#8203;-backtrace - Show stack backtrace on errors
+* -&#8203;-debug - Turn on Ruby debugging
+
+
### Arguments
@@ -666,6 +1233,23 @@ Unpack an installed gem to the current directory
gem unpack GEMNAME [options]
+
+### Options:
+
+* -&#8203;-target=DIR - target directory for unpacking
+* -&#8203;-spec - unpack the gem specification
+* -v, -&#8203;-version VERSION - Specify version of gem to unpack
+
+### Common Options:
+
+* -h, -&#8203;-help - Get help on this command
+* -V, -&#8203;-[no-]verbose - Set the verbose level of output
+* -q, -&#8203;-quiet - Silence commands
+* -&#8203;-config-file FILE - Use this config file instead of default
+* -&#8203;-backtrace - Show stack backtrace on errors
+* -&#8203;-debug - Turn on Ruby debugging
+
+
### Arguments
@@ -684,6 +1268,54 @@ Update the named gems (or all installed gems) in the local repository
gem update GEMNAME [GEMNAME ...] [options]
+
+### Options:
+
+* -&#8203;-system [VERSION] - Update the RubyGems system software
+* -&#8203;-platform PLATFORM - Specify the platform of gem to update
+* -&#8203;-[no-]prerelease - Allow prerelease versions of a gem as update targets
+
+### Deprecated Options:
+
+* -u, -&#8203;-[no-]update-sources - Update local source cache
+
+### Install/Update Options:
+
+* -i, -&#8203;-install-dir DIR - Gem repository directory to get installed gems
+* -n, -&#8203;-bindir DIR - Directory where binary files are located
+* -d, -&#8203;-[no-]rdoc - Generate RDoc documentation for the gem on install
+* -&#8203;-[no-]ri - Generate RI documentation for the gem on install
+* -E, -&#8203;-[no-]env-shebang - Rewrite the shebang line on installed scripts to use /usr/bin/env
+* -f, -&#8203;-[no-]force - Force gem to install, bypassing dependency checks
+* -w, -&#8203;-[no-]wrappers - Use bin wrappers for executables Not available on dosish platforms
+* -P, -&#8203;-trust-policy POLICY - Specify gem trust policy
+* -&#8203;-ignore-dependencies - Do not install any required dependent gems
+* -y, -&#8203;-include-dependencies - Unconditionally install the required dependent gems
+* -&#8203;-[no-]format-executable - Make installed executable names match ruby. If ruby is ruby18, foo_exec will be foo_exec18
+* -&#8203;-[no-]user-install - Install in user's home directory instead of GEM_HOME.
+* -&#8203;-development - Install any additional development dependencies
+* -&#8203;-conservative - Don't attempt to upgrade gems already meeting version requirement
+
+### Local/Remote Options:
+
+* -l, -&#8203;-local - Restrict operations to the LOCAL domain
+* -r, -&#8203;-remote - Restrict operations to the REMOTE domain
+* -b, -&#8203;-both - Allow LOCAL and REMOTE operations
+* -B, -&#8203;-bulk-threshold COUNT - Threshold for switching to bulk synchronization (default 1000)
+* -&#8203;-clear-sources - Clear the gem sources
+* -&#8203;-source URL - Add URL as a remote source for gems
+* -p, -&#8203;-[no-]http-proxy [URL] - Use HTTP proxy for remote operations
+
+### Common Options:
+
+* -h, -&#8203;-help - Get help on this command
+* -V, -&#8203;-[no-]verbose - Set the verbose level of output
+* -q, -&#8203;-quiet - Silence commands
+* -&#8203;-config-file FILE - Use this config file instead of default
+* -&#8203;-backtrace - Show stack backtrace on errors
+* -&#8203;-debug - Turn on Ruby debugging
+
+
### Arguments
@@ -702,6 +1334,22 @@ Find the location of a library file you can require
gem which FILE [FILE ...] [options]
+
+### Options:
+
+* -a, -&#8203;-[no-]all - show all matching files
+* -g, -&#8203;-[no-]gems-first - search gems before non-gems
+
+### Common Options:
+
+* -h, -&#8203;-help - Get help on this command
+* -V, -&#8203;-[no-]verbose - Set the verbose level of output
+* -q, -&#8203;-quiet - Silence commands
+* -&#8203;-config-file FILE - Use this config file instead of default
+* -&#8203;-backtrace - Show stack backtrace on errors
+* -&#8203;-debug - Turn on Ruby debugging
+
+
### Arguments

0 comments on commit 164f34d

Please sign in to comment.
Something went wrong with that request. Please try again.