Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

Add man page for ruby-build #118

Closed
wants to merge 2 commits into from

2 participants

@sometimesfood

Here's a simple man page for ruby-build.

I like to use ronn(1) for writing manpages, hope that's ok with you. (Of course ronn is only needed when editing the man page, not for regular installation.)

@sometimesfood

@sstephenson Is there anything you'd like to see fixed in the manpage's contents or the format, or do you simply prefer not having to maintain a manpage at all?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Jan 7, 2012
  1. @sometimesfood
Commits on Jan 9, 2012
  1. @sometimesfood
This page is out of date. Refresh to see the latest.
Showing with 178 additions and 0 deletions.
  1. +7 −0 install.sh
  2. +106 −0 man/ruby-build.1
  3. +65 −0 man/ruby-build.1.ronn
View
7 install.sh
@@ -8,9 +8,11 @@ fi
BIN_PATH="${PREFIX}/bin"
SHARE_PATH="${PREFIX}/share/ruby-build"
+MAN_PATH="${PREFIX}/share/man/man1"
mkdir -p "${BIN_PATH}"
mkdir -p "${SHARE_PATH}"
+mkdir -p "${MAN_PATH}"
for file in bin/*; do
cp "${file}" "${BIN_PATH}"
@@ -20,4 +22,9 @@ for file in share/ruby-build/*; do
cp "${file}" "${SHARE_PATH}"
done
+for file in man/*.1; do
+ command -v ronn >/dev/null && ronn --roff "${file}".ronn 2>/dev/null
+ cp "${file}" "${MAN_PATH}"
+done
+
echo "Installed ruby-build at ${PREFIX}"
View
106 man/ruby-build.1
@@ -0,0 +1,106 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "RUBY\-BUILD" "1" "January 2012" "" ""
+.
+.SH "NAME"
+\fBruby\-build\fR \- compile and install Rubies
+.
+.SH "SYNOPSIS"
+\fBruby\-build\fR [\fB\-v\fR|\fB\-\-verbose\fR] \fIdefinition\fR \fIprefix\fR
+.
+.br
+\fBruby\-build\fR \fB\-\-definitions\fR
+.
+.br
+\fBruby\-build\fR \fB\-\-version\fR
+.
+.br
+\fBruby\-build\fR [\fB\-h\fR|\fB\-\-help\fR]
+.
+.br
+\fBrbenv install\fR \fIdefinition\fR
+.
+.br
+.
+.SH "DESCRIPTION"
+\fBruby\-build\fR provides a simple way to compile and install different versions of Ruby on UNIX\-like systems\.
+.
+.P
+\fBruby\-build\fR downloads, builds and installs the Ruby version specified in a \fIdefinition\fR into a \fIprefix\fR directory\. Definitions can be chosen from the list of installed definitions or by specifying a file path for a definition\.
+.
+.P
+rbenv(1) users can also use the provided \fBrbenv install\fR command, which installs Rubies into the \fBrbenv\fR directory\.
+.
+.SH "OPTIONS"
+.
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+Display compiler messages on standard output\.
+.
+.TP
+\fB\-\-definitions\fR
+List available definitions\.
+.
+.TP
+\fB\-\-version\fR
+Show \fBruby\-build\fR version and exit\.
+.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Show usage information and exit\.
+.
+.SH "EXAMPLES"
+Install Ruby 1\.9\.3 (MRI, patch level 0) to \fB~/rubies/mri\-1\.9\.3\fR
+.
+.IP "" 4
+.
+.nf
+
+$ ruby\-build 1\.9\.3\-p0 ~/rubies/mri\-1\.9\.3
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Install Ruby Enterprise Edition 1\.8\.7 (patch level 2011\.03) for rbenv(1):
+.
+.IP "" 4
+.
+.nf
+
+$ rbenv install ree\-1\.8\.7\-2011\.03
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Install Ruby from a custom definition into \fB~/your\-ruby\fR:
+.
+.IP "" 4
+.
+.nf
+
+$ rbenv install /path/to/your/own/ruby/definition ~/your\-ruby
+.
+.fi
+.
+.IP "" 0
+.
+.SH "ENVIRONMENT"
+.
+.TP
+\fBMAKE_OPTS\fR
+Options that are passed to make when building a Ruby\.
+.
+.TP
+\fBMAKEOPTS\fR
+Used instead of \fBMAKE_OPTS\fR when \fBMAKE_OPTS\fR is not defined\.
+.
+.SH "AUTHORS"
+ruby\-build is developed by Sam Stephenson <\fIsam@37signals\.com\fR>\.
+.
+.SH "SEE ALSO"
+rbenv(1)
View
65 man/ruby-build.1.ronn
@@ -0,0 +1,65 @@
+ruby-build(1) -- compile and install Rubies
+===========================================
+
+## SYNOPSIS
+
+`ruby-build` [`-v`|`--verbose`] <definition> <prefix><br>
+`ruby-build` `--definitions`<br>
+`ruby-build` `--version`<br>
+`ruby-build` [`-h`|`--help`]<br>
+`rbenv install` <definition><br>
+
+## DESCRIPTION
+
+**ruby-build** provides a simple way to compile and install different
+versions of Ruby on UNIX-like systems.
+
+`ruby-build` downloads, builds and installs the Ruby version specified
+in a <definition> into a <prefix> directory. Definitions can be chosen
+from the list of installed definitions or by specifying a file path
+for a definition.
+
+rbenv(1) users can also use the provided `rbenv install`
+command, which installs Rubies into the `rbenv` directory.
+
+## OPTIONS
+
+ * `-v`, `--verbose`:
+ Display compiler messages on standard output.
+
+ * `--definitions`:
+ List available definitions.
+
+ * `--version`:
+ Show `ruby-build` version and exit.
+
+ * `-h`, `--help`:
+ Show usage information and exit.
+
+## EXAMPLES
+
+Install Ruby 1.9.3 (MRI, patch level 0) to `~/rubies/mri-1.9.3`
+
+ $ ruby-build 1.9.3-p0 ~/rubies/mri-1.9.3
+
+Install Ruby Enterprise Edition 1.8.7 (patch level 2011.03) for rbenv(1):
+ $ rbenv install ree-1.8.7-2011.03
+
+Install Ruby from a custom definition into `~/your-ruby`:
+ $ rbenv install /path/to/your/own/ruby/definition ~/your-ruby
+
+## ENVIRONMENT
+
+ * `MAKE_OPTS`:
+ Options that are passed to make when building a Ruby.
+
+ * `MAKEOPTS`:
+ Used instead of `MAKE_OPTS` when `MAKE_OPTS` is not defined.
+
+## AUTHORS
+
+ruby-build is developed by Sam Stephenson <<sam@37signals.com>>.
+
+## SEE ALSO
+
+rbenv(1)
Something went wrong with that request. Please try again.