Commit 87ed96dc by Mislav Marohnić

Merge pull request #879 from jasonkarns/usage

Clean up usage documentation
parents 0cd6f9fb 29a987c9
...@@ -2,9 +2,10 @@ ...@@ -2,9 +2,10 @@
# #
# Summary: Install a Ruby version using ruby-build # Summary: Install a Ruby version using ruby-build
# #
# Usage: rbenv install [-f] [-kvp] <version> # Usage: rbenv install [-f|-s] [-kpv] <version>
# rbenv install [-f] [-kvp] <definition-file> # rbenv install [-f|-s] [-kpv] <definition-file>
# rbenv install -l|--list # rbenv install -l|--list
# rbenv install --version
# #
# -l/--list List all available versions # -l/--list List all available versions
# -f/--force Install even if the version appears to be installed already # -f/--force Install even if the version appears to be installed already
...@@ -14,8 +15,9 @@ ...@@ -14,8 +15,9 @@
# #
# -k/--keep Keep source tree in $RBENV_BUILD_ROOT after installation # -k/--keep Keep source tree in $RBENV_BUILD_ROOT after installation
# (defaults to $RBENV_ROOT/sources) # (defaults to $RBENV_ROOT/sources)
# -v/--verbose Verbose mode: print compilation status to stdout
# -p/--patch Apply a patch from stdin before building # -p/--patch Apply a patch from stdin before building
# -v/--verbose Verbose mode: print compilation status to stdout
# --version Show version of ruby-build
# #
# For detailed information on installing Ruby versions with # For detailed information on installing Ruby versions with
# ruby-build, including a list of environment variables for adjusting # ruby-build, including a list of environment variables for adjusting
...@@ -43,8 +45,9 @@ if [ "$1" = "--complete" ]; then ...@@ -43,8 +45,9 @@ if [ "$1" = "--complete" ]; then
echo --force echo --force
echo --skip-existing echo --skip-existing
echo --keep echo --keep
echo --verbose
echo --patch echo --patch
echo --verbose
echo --version
exec ruby-build --definitions exec ruby-build --definitions
fi fi
......
#!/usr/bin/env bash #!/usr/bin/env bash
# #
# Usage: ruby-build [-kvp] <definition> <prefix> # Usage: ruby-build [-kpv] <definition> <prefix>
# ruby-build --definitions # ruby-build --definitions
# ruby-build --version
# #
# -k/--keep Do not remove source tree after installation # -k/--keep Do not remove source tree after installation
# -v/--verbose Verbose mode: print compilation status to stdout
# -p/--patch Apply a patch from stdin before building # -p/--patch Apply a patch from stdin before building
# -v/--verbose Verbose mode: print compilation status to stdout
# -4/--ipv4 Resolve names to IPv4 addresses only # -4/--ipv4 Resolve names to IPv4 addresses only
# -6/--ipv6 Resolve names to IPv6 addresses only # -6/--ipv6 Resolve names to IPv6 addresses only
# --definitions List all built-in definitions # --definitions List all built-in definitions
# --version Show version of ruby-build
# #
RUBY_BUILD_VERSION="20160111" RUBY_BUILD_VERSION="20160111"
......
...@@ -145,8 +145,9 @@ OUT ...@@ -145,8 +145,9 @@ OUT
--force --force
--skip-existing --skip-existing
--keep --keep
--verbose
--patch --patch
--verbose
--version
${RBENV_ROOT}/plugins/bar/share/ruby-build ${RBENV_ROOT}/plugins/bar/share/ruby-build
${RBENV_ROOT}/plugins/foo/share/ruby-build ${RBENV_ROOT}/plugins/foo/share/ruby-build
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment