Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

Create a manpage for chruby-exec(1). #124

Merged
merged 5 commits into from

2 participants

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
This page is out of date. Refresh to see the latest.
View
1  .gitignore
@@ -1,4 +1,3 @@
-doc/
pkg/*.tar.gz
pkg/*.tar.bz2
pkg/*.zip
View
6 Makefile
@@ -22,9 +22,15 @@ pkg:
share/man/man1/chruby.1: doc/man/chruby.1.md
md2man doc/man/chruby.1.md > share/man/man1/chruby.1
+share/man/man1/chruby-exec.1: doc/man/chruby-exec.1.md
+ md2man doc/man/chruby-exec.1.md > share/man/man1/chruby-exec.1
+
man: share/man/man1/chruby.1
git commit -m "Updated the man pages" doc/man/chruby.1.md share/man/man1/chruby.1
+man: share/man/man1/chruby-exec.1
+ git commit -m "Updated the man pages" doc/man/chruby-exec.1.md share/man/man1/chruby-exec.1
+
download: pkg
wget -O $(PKG) $(URL)/archive/v$(VERSION).tar.gz
View
76 doc/man/chruby-exec.1.md
@@ -0,0 +1,76 @@
+# chruby-exec(1) -- Run a command with selected Ruby.
+
+## SYNOPSIS
+
+`chruby-exec` RUBY [RUBYOPTS] -- COMMAND
+
+## ARGUMENTS
+
+*RUBY*
+ Change current Ruby based on fuzzy matching of Ruby by name.
+
+*RUBYOPTS*
+ Additional optional arguements to pass to Ruby.
+
+*COMMAND*
+ Command to run under the selected Ruby.
+
+## OPTIONS
+
+`-h`, `--help`
+
+`-v`, `--version`
+
+## DESCRIPTION
+Run a command with the selected Ruby version by correctly setting the appropriate environment variables.
+
+[https://github.com/postmodern/chruby/blob/master/README.md](https://github.com/postmodern/chruby/blob/master/README.md)
+
+## EXAMPLES
+
+Run the command `gem update` under JRuby:
+ $ chruby-exec jruby -- gem update
+
+##FILES
+
+*/opt/rubies*
+ Primary default Ruby install location.
+
+*~/.rubies/*
+ Secondary default Ruby install location.
+
+*/etc/profile.d/chruby.sh*
+ Application environment settings for chruby.
+
+*~/.gem/$ruby/$version*
+ Default gem install location.
+
+##ENVIRONMENT
+
+*PATH*
+ Updates the PATH environment variable to include Rubies and RubyGems bin/ directories.
+
+*GEM_HOME*
+ Default repository location for gem installation.
+
+*GEM_PATH*
+ A colon-separated list of gem repository directories.
+
+*GEM_ROOT*
+
+*RUBY_ROOT*
+
+*RUBY_ENGINE*
+ Name of Ruby implementation.
+
+*RUBY_VERSION*
+ Ruby version number.
+
+*RUBYOPT*
+ Optionally set if additional Ruby options are given.
+
+##AUTHOR
+Postmodern [postmodern.mod3\@gmail.com](mailto:postmodern.mod3\@gmail.com).
+
+##SEE ALSO
+chruby(1), ruby(1), gem(1)
View
2  doc/man/chruby.1.md
@@ -92,4 +92,4 @@ Switch to an arbitrary Ruby on the fly:
Postmodern [postmodern.mod3\@gmail.com](mailto:postmodern.mod3\@gmail.com).
##SEE ALSO
-ruby(1), gem(1)
+chruby-exec(1), ruby(1), gem(1)
View
78 share/man/man1/chruby-exec.1
@@ -0,0 +1,78 @@
+.TH
+.BR chruby-exec (1)
+\-\- Run a command with selected Ruby.
+.SH SYNOPSIS
+.PP
+\fB\fCchruby-exec\fR RUBY [RUBYOPTS] \-\- COMMAND
+.SH ARGUMENTS
+.PP
+\fIRUBY\fP
+ Change current Ruby based on fuzzy matching of Ruby by name.
+.PP
+\fIRUBYOPTS\fP
+ Additional optional arguements to pass to Ruby.
+.PP
+\fICOMMAND\fP
+ Command to run under the selected Ruby.
+.SH OPTIONS
+.PP
+\fB\fC-h\fR, \fB\fC--help\fR
+.PP
+\fB\fC-v\fR, \fB\fC--version\fR
+.SH DESCRIPTION
+.PP
+Run a command with the selected Ruby version by correctly setting the appropriate environment variables.
+.PP
+https://github.com/postmodern/chruby/blob/master/README.md
+.UR https://github.com/postmodern/chruby/blob/master/README.md
+.UE
+.SH EXAMPLES
+.PP
+Run the command \fB\fCgem update\fR under JRuby:
+ $ chruby\-exec jruby \-\- gem update
+.SH FILES
+.PP
+\fI/opt/rubies\fP
+ Primary default Ruby install location.
+.PP
+\fI~/.rubies/\fP
+ Secondary default Ruby install location.
+.PP
+\fI/etc/profile.d/chruby.sh\fP
+ Application environment settings for chruby.
+.PP
+\fI~/.gem/$ruby/$version\fP
+ Default gem install location.
+.SH ENVIRONMENT
+.PP
+\fIPATH\fP
+ Updates the PATH environment variable to include Rubies and RubyGems bin/ directories.
+.PP
+\fIGEM_HOME\fP
+ Default repository location for gem installation.
+.PP
+\fIGEM_PATH\fP
+ A colon\-separated list of gem repository directories.
+.PP
+\fIGEM_ROOT\fP
+.PP
+\fIRUBY_ROOT\fP
+.PP
+\fIRUBY_ENGINE\fP
+ Name of Ruby implementation.
+.PP
+\fIRUBY_VERSION\fP
+ Ruby version number.
+.PP
+\fIRUBYOPT\fP
+ Optionally set if additional Ruby options are given.
+.SH AUTHOR
+.PP
+Postmodern postmodern.mod3\@gmail.com
+.MT postmodern.mod3@gmail.com
+.ME .
+.SH SEE ALSO
+.PP
+.BR chruby (1),
+.BR ruby (1),
+.BR gem (1)
Something went wrong with that request. Please try again.