|
Hi all, We add a man page for ruby gem when we integrated ruby into Open Solaris ( Indiana ). As there's no official man page for gem, we made it according to the documents from rubygem and also add some solaris specified information, such as solaris specified repository and package informations. The man page is attached as a put back for the gem community, and we hope there will be an official man page delivered in ruby someday, as man is the commonest way of learning on unix. Regards Chris Sun Microsystems Here's the text version, which the gem man page on open solairs looks like: User Commands gem(1) NAME gem -- Command-line interface to RubyGems SYNOPSIS gem -h|--help gem -v|--version DESCRIPTION A gem is a packaged Ruby application or library, whileFEATURES * Easy Installation and removal of RubyGems packages and OPTIONS -h | --help command SunOS 5.10 Last change: 16 June 2008 (v0.9.4) 1 User Commands gem(1) build Build a gem from a gemspec contents Display the contents of the installed gems dependency Show the dependencies of an installed environment Display information about the RubyGemsgem environment install Install a gem into the local repositoryhelp Provide help on the 'gem' command list Display all gems whose name starts with STRING outdated Display all gems that need updates pristine Restores gem directories to pristine condition from files located in the gem SunOS 5.10 Last change: 16 June 2008 (v0.9.4) 2 User Commands gem(1) query Query gem information in local or remote repositories rdoc Generates RDoc for pre-installed gems unpack Unpack an installed gem to the current For more detail help on a particular command with its # gem help install ENVIRONMENT GEMCACHE Name of user defined cache file to use when the site wide cache file is unwritable. SunOS 5.10 Last change: 16 June 2008 (v0.9.4) 3 User Commands gem(1) GEM_HOME make Name of the make program that should be used to buildextensions. HOME Home directory of the user (see below). USERPROFILE Home directory of the user (used if HOME is not HOMEDRIVE EXAMPLES Example 1: Install 'rake', either from local directory or # gem install rake
SunOS 5.10 Last change: 16 June 2008 (v0.9.4) 4 User Commands gem(1) # gem install rake --remote Example 3: Install 'rake' from remote server, and run unit Example 7: List only remote gems whose name contains 'log' SEE ALSO ruby(1) FILES The following files specify the installation locations for SunOS 5.10 Last change: 16 June 2008 (v0.9.4) 5 User Commands gem(1) from /usr/bin/gem1.8, and may be linked from ATTRIBUTES See attributes(5) for descriptions of the following attri- ____________________________________ NOTES Source code for RubyGems is available on |
'\" t .\"RubyGems is copyrighted free software by Chad Fowler, Rich Kilmer, Jim Weirich and others. .\" .\" CDDL HEADER START .\" .\" The contents of this file are subject to the terms of the .\" Common Development and Distribution License (the "License"). .\" You may not use this file except in compliance with the License. .\" .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE .\" or http://www.opensolaris.org/os/licensing. .\" See the License for the specific language governing permissions .\" and limitations under the License. .\" .\" When distributing Covered Code, include this CDDL HEADER in each .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE. .\" If applicable, add the following below this CDDL HEADER, with the .\" fields enclosed by brackets "[]" replaced with your own identifying .\" information: Portions Copyright [yyyy] [name of copyright owner] .\" .\" CDDL HEADER END .\" .\" Copyright 2008 Sun Microsystems, Inc. All rights reserved. .\" Use is subject to license terms. .\" .\" #ident "@(#)gem.1 1.1 08/06/18 SMI" .\" .TH gem 1 "16 June 2008 (v0.9.4)" "" "" .SH NAME gem \-\- Command-line interface to RubyGems .SH SYNOPSIS .B gem .RB \-h | \-\-help .PP .B gem .RB \-v | \-\-version .PP .B gem .I command [ arguments\.\.\. ] [ options\.\.\. ] .SH DESCRIPTION A gem is a packaged Ruby application or library, while RubyGems is the premier ruby packaging system which is used to manage gems.
Gems are managed on your computer using the
.I gem
command. You can install, remove, and query gem packages using the
.I gem
command.
.SH FEATURES
* Easy Installation and removal of RubyGems packages and their dependencies
* Management and control of local packages
* Package dependency management
* Query, search and list local and remote packages
* Multiple version support for installed packages
* Web-based interface to view the documentation for your installed gems
* Easy to use interface for building gem packages
* Simple server for distributing your own gem packages
.SH OPTIONS
.TP
\fB\-h | \-\-help\fP
Get the basic help message for
.I gem
command.
.TP
\fB\-v | \-\-version\fP
Get the version of
.I gem
command.
.TP
.I command
.sp
.ne 2
.mk
\fBbuild\fP
.in +16n
.rt
Build a gem from a gemspec
.sp
.sp 1
.in -16n
.sp
.ne 2
.mk
\fBcert\fP
.in +16n
.rt
Adjust RubyGems certificate settings
.sp
.sp 1
.in -16n
.sp
.ne 2
.mk
\fBcheck\fP
.in +16n
.rt
Check installed gems
.sp
.sp 1
.in -16n
.sp
.ne 2
.mk
\fBcleanup\fP
.in +16n
.rt
Clean up old versions of installed gems in the local repository
.sp
.sp 1
.in -16n
.sp
.ne 2
.mk
\fBcontents\fP
.in +16n
.rt
Display the contents of the installed gems
.sp
.sp 1
.in -16n
.sp
.ne 2
.mk
\fBdependency\fP
.in +16n
.rt
Show the dependencies of an installed gem
.sp
.sp 1
.in -16n
.sp
.ne 2
.mk
\fBenvironment\fP
.in +16n
.rt
Display information about the RubyGems environment
.sp
.sp 1
.in -16n
.sp
.ne 2
.mk
\fBhelp\fP
.in +16n
.rt
Provide help on the 'gem' command
.sp
.sp 1
.in -16n
.sp
.ne 2
.mk
\fBinstall\fP
.in +16n
.rt
Install a gem into the local repository
.sp
.sp 1
.in -16n
.sp
.ne 2
.mk
\fBlist\fP
.in +16n
.rt
Display all gems whose name starts with STRING
.sp
.sp 1
.in -16n
.sp
.ne 2
.mk
\fBoutdated\fP
.in +16n
.rt
Display all gems that need updates
.sp
.sp 1
.in -16n
.sp
.ne 2
.mk
\fBpristine\fP
.in +16n
.rt
Restores gem directories to pristine condition from files located in the gem
cache
.sp
.sp 1
.in -16n
.sp
.ne 2
.mk
\fBquery\fP
.in +16n
.rt
Query gem information in local or remote repositories
.sp
.sp 1
.in -16n
.sp
.ne 2
.mk
\fBrdoc\fP
.in +16n
.rt
Generates RDoc for pre-installed gems
.sp
.sp 1
.in -16n
.sp
.ne 2
.mk
\fBsearch\fP
.in +16n
.rt
Display all gems whose name contains STRING
.sp
.sp 1
.in -16n
.sp
.ne 2
.mk
\fBsources\fP
.in +16n
.rt
Manage the sources RubyGems will search for gems
.sp
.sp 1
.in -16n
.sp
.ne 2
.mk
\fBspecification\fP
.in +16n
.rt
Display gem specification (in yaml)
.sp
.sp 1
.in -16n
.sp
.ne 2
.mk
\fBuninstall\fP
.in +16n
.rt
Uninstall gems from the local repository
.sp
.sp 1
.in -16n
.sp
.ne 2
.mk
\fBunpack\fP
.in +16n
.rt
Unpack an installed gem to the current directory
.sp
.sp 1
.in -16n
.sp
.ne 2
.mk
\fBupdate\fP
.in +16n
.rt
Update the named gem (or all installed gems) in the local repository
.sp
.sp 1
.in -16n
.sp
.ne 2
.mk
For more detail help on a particular command with its arguments and options,
using 'gem help
.I command
\'.
For example:
# gem help install
.SH ENVIRONMENT
.TP
.B GEMCACHE
Name of user defined cache file to use when the site wide cache file is
unwritable.
.TP
.B GEM_HOME
Directory containing the master gem repository.
.TP
.B GEM_PATH
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 ':'
.TP
.B GEM_SKIP
List of gems should should not be loaded (normally used for development). The
list should be delimited by the appropriate path separator ':'
.TP
.B http_proxy / HTTP_PROXY
URL of the HTTP protocol proxy to be used to get out of the firewall. The lower
case version will be used first.
.TP
.B make
Name of the make program that should be used to build extensions.
.TP
.B HOME
Home directory of the user (see below).
.TP
.B USERPROFILE
Home directory of the user (used if HOME is not defined)
.TP
.B HOMEDRIVE
Drive containing the user's home directory.
.TP
.B HOMEPATH
Path to the user's home directory.
.SH EXAMPLES
.PP
\fBExample 1: Install 'rake', either from local directory or remote server
.PP
.nf
# gem install rake
.fi
.PP
\fBExample 2: Install 'rake', only from remote server
.PP
.nf
# gem install rake --remote
.fi
.PP
\fBExample 3: Install 'rake' from remote server, and run unit tests, and
generate RDocs
.PP
.nf
# gem install --remote rake --test --rdoc --ri
.fi
.PP
\fBExample 4: Install 'rake', but only version 0.3.1, even if dependencies are
not met, and into a specific directory
.PP
.nf
# gem install rake --version 0.3.1 --force --install-dir $HOME/.gems
.fi
.PP
\fBExample 5: List local gems whose name begins with 'D'
.PP
.nf
# gem list D
.fi
.PP
\fBExample 6: List local and remote gems whose name contains 'log'
.PP
.nf
# gem search log --both
.fi
.PP
\fBExample 7: List only remote gems whose name contains 'log'
.PP
.nf
# gem search log --remote
.fi
.PP
\fBExample 8: Uninstall 'rake'
.PP
.nf
# gem uninstall rake
.fi
.PP
\fBExample 9: See information about RubyGems
.PP
.nf
# gem environment
.TE
.sp
.SH SEE ALSO
\fBruby\fR(1)
.sp
.SH FILES
The following files specify the installation locations for Ruby:
.PP
.TP
/var/ruby/1.8/gem_home
Contains the Rubygems repository. Configure the GEM_HOME environment variable
to point to /var/ruby/1.8/gem_home as the installationof Rubygems repository.
.PP
.TP
/usr/ruby/1.8/bin
Contains the Rubygems programs with all other Ruby related programs. These
programs are linked from /usr/bin.
For example: /usr/ruby/1.8/bin/gem is linked from /usr/bin/gem1.8, and may be
linked from /usr/bin/gem if 1.8 is the latest version of Ruby installed on this
system.
.PP
.\" Begin Sun update
.SH ATTRIBUTES
See
.BR attributes (5)
for descriptions of the following attributes:
.sp
.TS
box;
cbp-1 | cbp-1
l | l .
ATTRIBUTE TYPE ATTRIBUTE VALUE
=
Availability SUNWruby18r
=
SUNWruby18u
=
Interface Stability Uncommitted
.TE
.PP
.SH NOTES
Source code for RubyGems is available on http://rubyforge.org/projects/rubygems/
And you can find more detail documents on http://docs.rubygems.org/
_______________________________________________ Rubygems-developers mailing list [email protected] http://rubyforge.org/mailman/listinfo/rubygems-developers
