/usr/share/doc/rubygems/html/classes/Gem/Commands/HelpCommand.html is in rubygems 1.8.24-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 | <?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Class: Gem::Commands::HelpCommand</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript">
// <![CDATA[
function popupCode( url ) {
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
}
function toggleCode( id ) {
if ( document.getElementById )
elem = document.getElementById( id );
else if ( document.all )
elem = eval( "document.all." + id );
else
return false;
elemStyle = elem.style;
if ( elemStyle.display != "block" ) {
elemStyle.display = "block"
} else {
elemStyle.display = "none"
}
return true;
}
// Make codeblocks hidden by default
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
// ]]>
</script>
</head>
<body>
<div id="classHeader">
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Class</strong></td>
<td class="class-name-in-header">Gem::Commands::HelpCommand</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../../../files/lib/rubygems/commands/help_command_rb.html">
lib/rubygems/commands/help_command.rb
</a>
<br />
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Parent:</strong></td>
<td>
<a href="../Command.html">
Gem::Command
</a>
</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000201">execute</a>
<a href="#M000200">new</a>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Class methods</h3>
<div id="method-M000200" class="method-detail">
<a name="M000200"></a>
<div class="method-heading">
<a href="#M000200" class="method-signature">
<span class="method-name">new</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000200-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000200-source">
<pre>
<span class="ruby-comment cmt"># File lib/rubygems/commands/help_command.rb, line 83</span>
83: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
84: <span class="ruby-keyword kw">super</span> <span class="ruby-value str">'help'</span>, <span class="ruby-value str">"Provide help on the 'gem' command"</span>
85: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000201" class="method-detail">
<a name="M000201"></a>
<div class="method-heading">
<a href="#M000201" class="method-signature">
<span class="method-name">execute</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000201-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000201-source">
<pre>
<span class="ruby-comment cmt"># File lib/rubygems/commands/help_command.rb, line 101</span>
101: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">execute</span>
102: <span class="ruby-identifier">command_manager</span> = <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">CommandManager</span>.<span class="ruby-identifier">instance</span>
103: <span class="ruby-identifier">arg</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:args</span>][<span class="ruby-value">0</span>]
104:
105: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">begins?</span> <span class="ruby-value str">"commands"</span>, <span class="ruby-identifier">arg</span> <span class="ruby-keyword kw">then</span>
106: <span class="ruby-identifier">out</span> = []
107: <span class="ruby-identifier">out</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">"GEM commands are:"</span>
108: <span class="ruby-identifier">out</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword kw">nil</span>
109:
110: <span class="ruby-identifier">margin_width</span> = <span class="ruby-value">4</span>
111:
112: <span class="ruby-identifier">desc_width</span> = <span class="ruby-identifier">command_manager</span>.<span class="ruby-identifier">command_names</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">n</span><span class="ruby-operator">|</span> <span class="ruby-identifier">n</span>.<span class="ruby-identifier">size</span> }.<span class="ruby-identifier">max</span> <span class="ruby-operator">+</span> <span class="ruby-value">4</span>
113:
114: <span class="ruby-identifier">summary_width</span> = <span class="ruby-value">80</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">margin_width</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">desc_width</span>
115: <span class="ruby-identifier">wrap_indent</span> = <span class="ruby-value str">' '</span> <span class="ruby-operator">*</span> (<span class="ruby-identifier">margin_width</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">desc_width</span>)
116: <span class="ruby-identifier">format</span> = <span class="ruby-node">"#{' ' * margin_width}%-#{desc_width}s%s"</span>
117:
118: <span class="ruby-identifier">command_manager</span>.<span class="ruby-identifier">command_names</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">cmd_name</span><span class="ruby-operator">|</span>
119: <span class="ruby-identifier">summary</span> = <span class="ruby-identifier">command_manager</span>[<span class="ruby-identifier">cmd_name</span>].<span class="ruby-identifier">summary</span>
120: <span class="ruby-identifier">summary</span> = <span class="ruby-identifier">wrap</span>(<span class="ruby-identifier">summary</span>, <span class="ruby-identifier">summary_width</span>).<span class="ruby-identifier">split</span> <span class="ruby-value str">"\n"</span>
121: <span class="ruby-identifier">out</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">sprintf</span>(<span class="ruby-identifier">format</span>, <span class="ruby-identifier">cmd_name</span>, <span class="ruby-identifier">summary</span>.<span class="ruby-identifier">shift</span>)
122: <span class="ruby-keyword kw">until</span> <span class="ruby-identifier">summary</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-keyword kw">do</span>
123: <span class="ruby-identifier">out</span> <span class="ruby-operator"><<</span> <span class="ruby-node">"#{wrap_indent}#{summary.shift}"</span>
124: <span class="ruby-keyword kw">end</span>
125: <span class="ruby-keyword kw">end</span>
126:
127: <span class="ruby-identifier">out</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword kw">nil</span>
128: <span class="ruby-identifier">out</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">"For help on a particular command, use 'gem help COMMAND'."</span>
129: <span class="ruby-identifier">out</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword kw">nil</span>
130: <span class="ruby-identifier">out</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">"Commands may be abbreviated, so long as they are unambiguous."</span>
131: <span class="ruby-identifier">out</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">"e.g. 'gem i rake' is short for 'gem install rake'."</span>
132:
133: <span class="ruby-identifier">say</span> <span class="ruby-identifier">out</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">"\n"</span>)
134:
135: <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">begins?</span> <span class="ruby-value str">"options"</span>, <span class="ruby-identifier">arg</span> <span class="ruby-keyword kw">then</span>
136: <span class="ruby-identifier">say</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Command</span><span class="ruby-operator">::</span><span class="ruby-constant">HELP</span>
137:
138: <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">begins?</span> <span class="ruby-value str">"examples"</span>, <span class="ruby-identifier">arg</span> <span class="ruby-keyword kw">then</span>
139: <span class="ruby-identifier">say</span> <span class="ruby-constant">EXAMPLES</span>
140:
141: <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">begins?</span> <span class="ruby-value str">"platforms"</span>, <span class="ruby-identifier">arg</span> <span class="ruby-keyword kw">then</span>
142: <span class="ruby-identifier">say</span> <span class="ruby-constant">PLATFORMS</span>
143:
144: <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:help</span>] <span class="ruby-keyword kw">then</span>
145: <span class="ruby-identifier">command</span> = <span class="ruby-identifier">command_manager</span>[<span class="ruby-identifier">options</span>[<span class="ruby-identifier">:help</span>]]
146: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">command</span>
147: <span class="ruby-comment cmt"># help with provided command</span>
148: <span class="ruby-identifier">command</span>.<span class="ruby-identifier">invoke</span>(<span class="ruby-value str">"--help"</span>)
149: <span class="ruby-keyword kw">else</span>
150: <span class="ruby-identifier">alert_error</span> <span class="ruby-node">"Unknown command #{options[:help]}. Try 'gem help commands'"</span>
151: <span class="ruby-keyword kw">end</span>
152:
153: <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">arg</span> <span class="ruby-keyword kw">then</span>
154: <span class="ruby-identifier">possibilities</span> = <span class="ruby-identifier">command_manager</span>.<span class="ruby-identifier">find_command_possibilities</span>(<span class="ruby-identifier">arg</span>.<span class="ruby-identifier">downcase</span>)
155: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">possibilities</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span>
156: <span class="ruby-identifier">command</span> = <span class="ruby-identifier">command_manager</span>[<span class="ruby-identifier">possibilities</span>.<span class="ruby-identifier">first</span>]
157: <span class="ruby-identifier">command</span>.<span class="ruby-identifier">invoke</span>(<span class="ruby-value str">"--help"</span>)
158: <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">possibilities</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">1</span>
159: <span class="ruby-identifier">alert_warning</span> <span class="ruby-node">"Ambiguous command #{arg} (#{possibilities.join(', ')})"</span>
160: <span class="ruby-keyword kw">else</span>
161: <span class="ruby-identifier">alert_warning</span> <span class="ruby-node">"Unknown command #{arg}. Try gem help commands"</span>
162: <span class="ruby-keyword kw">end</span>
163:
164: <span class="ruby-keyword kw">else</span>
165: <span class="ruby-identifier">say</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">Command</span><span class="ruby-operator">::</span><span class="ruby-constant">HELP</span>
166: <span class="ruby-keyword kw">end</span>
167: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
</div>
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>
</body>
</html>
|