| blob | 08f43334a43f55e618896c542200364958ef3c5c |
1 '\" t
2 .\"RubyGems is copyrighted free software by Chad Fowler, Rich Kilmer, Jim Weirich and others.
3 .\"
4 .\" CDDL HEADER START
5 .\"
6 .\" The contents of this file are subject to the terms of the
7 .\" Common Development and Distribution License (the "License").
8 .\" You may not use this file except in compliance with the License.
9 .\"
10 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
11 .\" or http://www.opensolaris.org/os/licensing.
12 .\" See the License for the specific language governing permissions
13 .\" and limitations under the License.
14 .\"
15 .\" When distributing Covered Code, include this CDDL HEADER in each
16 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
17 .\" If applicable, add the following below this CDDL HEADER, with the
18 .\" fields enclosed by brackets "[]" replaced with your own identifying
19 .\" information: Portions Copyright [yyyy] [name of copyright owner]
20 .\"
21 .\" CDDL HEADER END
22 .\"
23 .\" Copyright (c) 2009, 2016, Oracle and/or its affiliates. All rights reserved.
24 .\"
25 .\" gem.1
26 .\"
27 .TH gem 1 "26 October 2016" "" ""
28 .SH NAME
29 gem \-\- Command-line interface to RubyGems
30 .SH SYNOPSIS
31 .B gem
32 .RB \-h | \-\-help
33 .PP
34 .B gem
35 .RB \-v | \-\-version
36 .PP
37 .B gem
38 .I command
39 [ arguments\.\.\. ]
40 [ options\.\.\. ]
41 .SH DESCRIPTION
42 A gem is a packaged Ruby application or library, while RubyGems is the premier ruby packaging system which is used to manage gems.
44 Gems are managed on your computer using the
45 .I gem
46 command. You can install, remove, and query gem packages using the
47 .I gem
48 command.
50 .SH FEATURES
52 * Easy Installation and removal of RubyGems packages and their dependencies
54 * Management and control of local packages
56 * Package dependency management
58 * Query, search and list local and remote packages
60 * Multiple version support for installed packages
62 * Web-based interface to view the documentation for your installed gems
64 * Easy to use interface for building gem packages
66 * Simple server for distributing your own gem packages
68 .SH OPTIONS
69 .TP
70 \fB\-h | \-\-help\fP
71 Get the basic help message for
72 .I gem
73 command.
75 .TP
76 \fB\-v | \-\-version\fP
77 Get the version of
78 .I gem
79 command.
81 .TP
82 .I command
83 .sp
84 .ne 2
85 .mk
86 \fBbuild\fP
87 .in +16n
88 .rt
89 Build a gem from a gemspec
90 .sp
91 .sp 1
92 .in -16n
93 .sp
94 .ne 2
95 .mk
96 \fBcert\fP
97 .in +16n
98 .rt
99 Manage RubyGems certificates and signing settings
100 .sp
101 .sp 1
102 .in -16n
103 .sp
104 .ne 2
105 .mk
106 \fBcheck\fP
107 .in +16n
108 .rt
109 Check a gem repository for added or missing files
110 .sp
111 .sp 1
112 .in -16n
113 .sp
114 .ne 2
115 .mk
116 \fBcleanup\fP
117 .in +16n
118 .rt
119 Clean up old versions of installed gems
120 .sp
121 .sp 1
122 .in -16n
123 .sp
124 .ne 2
125 .mk
126 \fBcontents\fP
127 .in +16n
128 .rt
129 Display the contents of the installed gems
130 .sp
131 .sp 1
132 .in -16n
133 .sp
134 .ne 2
135 .mk
136 \fBdependency\fP
137 .in +16n
138 .rt
139 Show the dependencies of an installed gem
140 .sp
141 .sp 1
142 .in -16n
143 .sp
144 .ne 2
145 .mk
146 \fBenvironment\fP
147 .in +16n
148 .rt
149 Display information about the RubyGems environment
150 .sp
151 .sp 1
152 .in -16n
153 .sp
154 .ne 2
155 .mk
156 \fBfetch\fP
157 .in +16n
158 .rt
159 Download a gem and place it in the current directory
160 .sp
161 .sp 1
162 .in -16n
163 .sp
164 .ne 2
165 .mk
166 \fBgenerate_index\fP
167 .in +16n
168 .rt
169 Generates the index files for a gem server directory
170 .sp
171 .sp 1
172 .in -16n
173 .sp
174 .ne 2
175 .mk
176 \fBhelp\fP
177 .in +16n
178 .rt
179 Provide help on the 'gem' command
180 .sp
181 .sp 1
182 .in -16n
183 .sp
184 .ne 2
185 .mk
186 \fBinstall\fP
187 .in +16n
188 .rt
189 Install a gem into the local repository
190 .sp
191 .sp 1
192 .in -16n
193 .sp
194 .ne 2
195 .mk
196 \fBlist\fP
197 .in +16n
198 .rt
199 Display local gems whose name matches REGEXP
200 .sp
201 .sp 1
202 .in -16n
203 .sp
204 .ne 2
205 .mk
206 \fBlock\fP
207 .in +16n
208 .rt
209 Generate a lockdown list of gems
210 .sp
211 .sp 1
212 .in -16n
213 .sp
214 .ne 2
215 .mk
216 \fBmirror\fP
217 .in +16n
218 .rt
219 Mirror all gem files (requires rubygems-mirror)
220 .sp
221 .sp 1
222 .in -16n
223 .sp
224 .ne 2
225 .mk
226 \fBopen\fP
227 .in +16n
228 .rt
229 Open gem sources in editor
230 .sp
231 .sp 1
232 .in -16n
233 .sp
234 .ne 2
235 .mk
236 \fBoutdated\fP
237 .in +16n
238 .rt
239 Display all gems that need updates
240 .sp
241 .sp 1
242 .in -16n
243 .sp
244 .ne 2
245 .mk
246 \fBowner\fP
247 .in +16n
248 .rt
249 Manage gem owners of a gem on the push server
250 .sp
251 .sp 1
252 .in -16n
253 .sp
254 .ne 2
255 .mk
256 \fBpristine\fP
257 .in +16n
258 .rt
259 Restores installed gems to pristine condition from files located in the gem cache
260 .sp
261 .sp 1
262 .in -16n
263 .sp
264 .ne 2
265 .mk
266 \fBpush\fP
267 .in +16n
268 .rt
269 Push a gem up to the gem server
270 .sp
271 .sp 1
272 .in -16n
273 .sp
274 .ne 2
275 .mk
276 \fBquery\fP
277 .in +16n
278 .rt
279 Query gem information in local or remote repositories
280 .sp
281 .sp 1
282 .in -16n
283 .sp
284 .ne 2
285 .mk
286 \fBrdoc\fP
287 .in +16n
288 .rt
289 Generates RDoc for pre-installed gems
290 .sp
291 .sp 1
292 .in -16n
293 .sp
294 .ne 2
295 .mk
296 \fBsearch\fP
297 .in +16n
298 .rt
299 Display remote gems whose name matches REGEXP
300 .sp
301 .sp 1
302 .in -16n
303 .sp
304 .ne 2
305 .mk
306 \fBserver\fP
307 .in +16n
308 .rt
309 Documentation and gem repository HTTP server
310 .sp
311 .sp 1
312 .in -16n
313 .sp
314 .ne 2
315 .mk
316 \fBsources\fP
317 .in +16n
318 .rt
319 Manage the sources and cache file RubyGems will search for gems
320 .sp
321 .sp 1
322 .in -16n
323 .sp
324 .ne 2
325 .mk
326 \fBspecification\fP
327 .in +16n
328 .rt
329 Display gem specification (in yaml)
330 .sp
331 .sp 1
332 .in -16n
333 .sp
334 .ne 2
335 .mk
336 \fBstale\fP
337 .in +16n
338 .rt
339 List gems along with access times
340 .sp
341 .sp 1
342 .in -16n
343 .sp
344 .ne 2
345 .mk
346 \fBuninstall\fP
347 .in +16n
348 .rt
349 Uninstall gems from the local repository
350 .sp
351 .sp 1
352 .in -16n
353 .sp
354 .ne 2
355 .mk
356 \fBunpack\fP
357 .in +16n
358 .rt
359 Unpack an installed gem to the current directory
360 .sp
361 .sp 1
362 .in -16n
363 .sp
364 .ne 2
365 .mk
366 \fBupdate\fP
367 .in +16n
368 .rt
369 Update installed gems to the latest version
370 .sp
371 .sp 1
372 .in -16n
373 .sp
374 .ne 2
375 .mk
376 \fBwhich\fP
377 .in +16n
378 .rt
379 Find the location of a library file you can require
380 .sp
381 .sp 1
382 .in -16n
383 .sp
384 .ne 2
385 .mk
386 \fByank\fP
387 .in +16n
388 .rt
389 Remove a pushed gem from the index
390 .sp
391 .sp 1
392 .in -16n
393 .sp
394 .ne 2
395 .mk
396 For more detailed help on a particular command with its arguments and options,
397 use 'gem help
398 .I command
399 \'.
401 For example:
403 # gem help install
405 Commands may be abbreviated, so long as they are unambiguous.
406 e.g. 'gem i thor' is short for 'gem install thor'.
408 .SH ENVIRONMENT
409 .TP
410 .B GEM_HOME
411 Directory containing the master gem repository.
413 .TP
414 .B GEM_PATH
415 Path list of directories containing gem repositories to be searched in addition to the GEM_HOME directory. The list should be delimited by the appropriate path separator ':'
417 .TP
418 .B http_proxy / HTTP_PROXY
419 URL of the HTTP protocol proxy to be used to get out of the firewall. The lower case version will be used first.
421 .TP
422 .B MAKE / make
423 Name of the make program that should be used to build extensions.
425 .TP
426 .B HOME
427 Home directory of the user (see below).
429 .SH EXAMPLES
430 .PP
431 \fBExample 1: Install 'thor', either from local directory or remote server
432 .PP
433 .nf
434 # gem install thor
435 .fi
436 .PP
437 \fBExample 2: Install 'thor', only from remote server
438 .PP
439 .nf
440 # gem install thor --remote
441 .fi
442 .PP
443 \fBExample 3: Install 'thor' from remote server and generate documentation
444 .PP
445 .nf
446 # gem install thor --remote --document
447 .fi
448 .PP
449 \fBExample 4: Install 'thor', but only version 0.18.1, even if dependencies are not met, and into a specific directory
450 .PP
451 .nf
452 # gem install thor --version 0.18.1 --force --install-dir $HOME/.gem/ruby/RUBY_LIB_VER
453 .fi
454 .PP
455 \fBExample 5: List local gems whose name begins with 'r'
456 .PP
457 .nf
458 # gem list ^r
459 .fi
460 .PP
461 \fBExample 6: List local and remote gems whose name contains 'log'
462 .PP
463 .nf
464 # gem search log --both
465 .fi
466 .PP
467 \fBExample 7: List only remote gems whose name contains 'log'
468 .PP
469 .nf
470 # gem search log --remote
471 .fi
472 .PP
473 \fBExample 8: Uninstall 'thor'
474 .PP
475 .nf
476 # gem uninstall thor
477 .fi
478 .PP
479 \fBExample 9: See information about RubyGems
480 .PP
481 .nf
482 # gem environment
483 .TE
484 .sp
485 .SH SEE ALSO
486 \fBruby\fR(1)
487 .sp
488 .SH FILES
489 The following files specify the installation locations for Ruby:
490 .PP
491 .TP
492 /usr/ruby/RUBY_VER/lib/ruby/gems/RUBY_LIB_VER
493 Default installation location for Ruby gems
494 .PP
495 .TP
496 ~/.gem/ruby/RUBY_LIB_VER
497 Per user location to install gems. This is automatically added to GEM_PATH.
498 .PP
499 .TP
500 /usr/ruby/RUBY_VER/lib/ruby/vendor_ruby/gems/RUBY_LIB_VER
501 Location of gems installed by Solaris packages.
502 .PP
503 .TP
504 ~/.gem/ruby/RUBY_LIB_VER/bin
505 Per user location for gem executables.
506 .PP
507 .TP
508 /usr/ruby/RUBY_VER/bin
509 Contains the Rubygems program with all other Ruby related programs. These programs are linked from /usr/bin.
510 For example: /usr/ruby/RUBY_VER/bin/gem is linked from /usr/bin/gemRUBY_VER_NO_DOT, and may be linked from /usr/bin/gem if the package mediator "ruby" is version "RUBY_VER" (see pkg(1)).
511 Also contains executables for any installed gems that supply them (i.e.: thor, rails, etc).
512 .PP
513 .PP
514 .SH NOTES
515 Detailed documentation for RubyGems is available at http://guides.rubygems.org/