Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

Added a ruby-install manpage. #8

Merged
merged 1 commit into from

2 participants

@havenwood
Collaborator

Issue #6: Added a ruby-install manpage. What else should I add the the Environment section? Any additional sections needed or existing made more robust?

@postmodern postmodern merged commit fd11741 into postmodern:master
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Apr 2, 2013
  1. @havenwood

    initial commit

    havenwood authored
This page is out of date. Refresh to see the latest.
Showing with 163 additions and 0 deletions.
  1. +80 −0 doc/man/ruby-install.1.md
  2. +83 −0 share/man/man1/ruby-install.1
View
80 doc/man/ruby-install.1.md
@@ -0,0 +1,80 @@
+# ruby-install(1) -- Installs Ruby, JRuby or Rubinius.
+
+## SYNOPSIS
+
+`ruby-install` RUBY [VERSION] -- CONFIGURE_OPTS
+
+## ARGUMENTS
+
+*RUBY*
+ Install Ruby by name.
+
+*VERSION*
+ Optionally select the version of selected Ruby.
+
+*CONFIGURE_OPTS*
+ Additional optional configure arguements.
+
+## OPTIONS
+
+`-h`, `--help`
+ Prints a synopsis of ruby-install usage.
+
+`-v`, `--version`
+ Prints the current ruby-install version.
+
+`--src-dir DIR`
+ Specifies the directory for downloading and unpacking Ruby source.
+
+`--install-dir DIR`
+ Specifies the dirctory where Ruby will be installed.
+
+`--patch FILE`
+ Specifies any additional patches to apply.
+
+`--skip-sync`
+ Skips syncing of package manager updates.
+
+`--skip-dependencies`
+ Skips installation of Ruby dependencies (implies `--skip-sync`).
+
+`--skip-verify`
+ Skips verification of downloaded Ruby MD5 sums.
+
+## DESCRIPTION
+Installs Ruby, JRuby or Rubinius.
+
+[https://github.com/postmodern/ruby-install#readme](https://github.com/postmodern/ruby-install#readme)
+
+## EXAMPLES
+
+Install the current stable version of Ruby:
+ $ ruby-install ruby
+
+Install a specific version of Ruby:
+ $ ruby-install ruby 1.9.3-p395
+
+##FILES
+
+*/usr/local/src*
+ Default root user source directory.
+
+*~/src*
+ Default non-root user source directory.
+
+*/usr/local*
+ Default root user installation directory.
+
+*~/.local*
+ Default non-root user installation directory.
+
+##ENVIRONMENT
+
+*RUBY_INSTALL_VERSION*
+ Curennt version of ruby-install.
+
+##AUTHOR
+Postmodern [postmodern.mod3\@gmail.com](mailto:postmodern.mod3\@gmail.com).
+
+##SEE ALSO
+ruby(1), gem(1), chruby(1), chruby-exec(1)
View
83 share/man/man1/ruby-install.1
@@ -0,0 +1,83 @@
+.TH
+.BR ruby-install (1)
+\-\- Installs Ruby, JRuby or Rubinius.
+.SH SYNOPSIS
+.PP
+\fB\fCruby-install\fR RUBY [VERSION] \-\- CONFIGURE_OPTS
+.SH ARGUMENTS
+.PP
+\fIRUBY\fP
+ Install Ruby by name.
+.PP
+\fIVERSION\fP
+ Optionally select the version of selected Ruby.
+.PP
+\fICONFIGURE_OPTS\fP
+ Additional optional configure arguements.
+.SH OPTIONS
+.PP
+\fB\fC-h\fR, \fB\fC--help\fR
+ Prints a synopsis of ruby\-install usage.
+.PP
+\fB\fC-v\fR, \fB\fC--version\fR
+ Prints the current ruby\-install version.
+.PP
+\fB\fC--src-dir DIR\fR
+ Specifies the directory for downloading and unpacking Ruby source.
+.PP
+\fB\fC--install-dir DIR\fR
+ Specifies the dirctory where Ruby will be installed.
+.PP
+\fB\fC--patch FILE\fR
+ Specifies any additional patches to apply.
+.PP
+\fB\fC--skip-sync\fR
+ Skips syncing of package manager updates.
+.PP
+\fB\fC--skip-dependencies\fR
+ Skips installation of Ruby dependencies (implies \fB\fC--skip-sync\fR).
+.PP
+\fB\fC--skip-verify\fR
+ Skips verification of downloaded Ruby MD5 sums.
+.SH DESCRIPTION
+.PP
+Installs Ruby, JRuby or Rubinius.
+.PP
+https://github.com/postmodern/ruby\-install#readme
+.UR https://github.com/postmodern/ruby-install#readme
+.UE
+.SH EXAMPLES
+.PP
+Install the current stable version of Ruby:
+ $ ruby\-install ruby
+.PP
+Install a specific version of Ruby:
+ $ ruby\-install ruby 1.9.3\-p395
+.SH FILES
+.PP
+\fI/usr/local/src\fP
+ Default root user source directory.
+.PP
+\fI~/src\fP
+ Default non\-root user source directory.
+.PP
+\fI/usr/local\fP
+ Default root user installation directory.
+.PP
+\fI~/.local\fP
+ Default non\-root user installation directory.
+.SH ENVIRONMENT
+.PP
+\fIRUBY\fIINSTALL\fPVERSION\fP
+ Curennt version of ruby\-install.
+.SH AUTHOR
+.PP
+Postmodern postmodern.mod3\@gmail.com
+.MT postmodern.mod3@gmail.com
+.ME .
+.SH SEE ALSO
+.PP
+.BR ruby (1),
+.BR gem (1),
+.BR chruby (1),
+.BR chruby-exec (1)
Something went wrong with that request. Please try again.