mirrors/rbenv
1
0
Fork 0
mirror of https://github.com/rbenv/rbenv.git synced 2024-12-29 13:15:42 +01:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #1453 from rbenv/update-manpage

Browse source 
Consistent syntax in man page
This commit is contained in:
Mislav Marohnić 2022-10-09 14:47:57 +02:00 committed by GitHub
commit 90c0357682
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 11 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
share/man/man1/rbenv.1 generated
View file

@ -2,12 +2,12 @@
.\" Title: rbenv .\" Title: rbenv
.\" Author: Mislav Marohnić .\" Author: Mislav Marohnić
.\" Generator: Asciidoctor 2.0.17 .\" Generator: Asciidoctor 2.0.17
.\" Date: 2022-09-26 .\" Date: 2022-10-09
.\" Manual: Rbenv Manual .\" Manual: Rbenv Manual
.\" Source: rbenv 1.2.0-29-g7c7c4dc .\" Source: rbenv 1.2.0-36-g6b1cc34
.\" Language: English .\" Language: English
.\" .\"
.TH "RBENV" "1" "2022-09-26" "rbenv 1.2.0\-29\-g7c7c4dc" "Rbenv Manual" .TH "RBENV" "1" "2022-10-09" "rbenv 1.2.0\-36\-g6b1cc34" "Rbenv Manual"
.ie \n(.g .ds Aq \(aq .ie \n(.g .ds Aq \(aq
.el .ds Aq ' .el .ds Aq '
.ss \n[.ss] 0 .ss \n[.ss] 0
@ -38,7 +38,7 @@ rbenv respects the \fI.ruby\-version\fP file in a project directory by making su
.sp .sp
It does so by generating shims for all Ruby executables. As long as rbenv shims directory is prepended to PATH, rbenv automatically ensures transparent switching between Ruby versions. It does so by generating shims for all Ruby executables. As long as rbenv shims directory is prepended to PATH, rbenv automatically ensures transparent switching between Ruby versions.
.sp .sp
rbenv looks for available Ruby versions in the \fI{RBENV_ROOT}/versions/\fP directory. rbenv looks for available Ruby versions in the \fI$RBENV_ROOT/versions/\fP directory.
.SH "COMMANDS" .SH "COMMANDS"
.sp .sp
\fBrbenv global\fP [\fI<version>\fP] \fBrbenv global\fP [\fI<version>\fP]
@ -112,15 +112,15 @@ Activates printing debug information about rbenv internals to standard error
Colon\-separated list of paths searched for rbenv plugin scripts Colon\-separated list of paths searched for rbenv plugin scripts
.RE .RE
.sp .sp
\fBRBENV_DIR\fP (default: \fI{PWD}\fP) \fBRBENV_DIR\fP (default: \fI$PWD\fP)
.RS 4 .RS 4
Directory to traverse bottom\-up to locate the \fI.ruby\-version\fP file Directory to traverse bottom\-up to locate the \fI.ruby\-version\fP file
.RE .RE
.SH "PLUGINS" .SH "PLUGINS"
.sp .sp
rbenv only performs Ruby version switching as its core functionality, but offers a plugin mechanism to hook into and override almost any aspect of its functionality. As its core functionality, rbenv only switches between Ruby versions and does nothing else, but offers a plugin mechanism to hook into and override almost any aspect of its default behavior.
.sp .sp
The most common plugin for rbenv is \fBruby\-build\fP which facilitates installing new Ruby versions into the \fI{RBENV_ROOT}/versions/\fP directory. The most common plugin for rbenv is \fBruby\-build\fP which facilitates installing new Ruby versions into the \fI$RBENV_ROOT/versions/\fP directory.
.sp .sp
Read more at \c Read more at \c
.URL "https://github.com/rbenv/rbenv/wiki/Plugins" "" "" .URL "https://github.com/rbenv/rbenv/wiki/Plugins" "" ""

8
share/man/man1/rbenv.1.adoc
View file

@ -19,7 +19,7 @@ rbenv respects the _.ruby-version_ file in a project directory by making sure th
It does so by generating shims for all Ruby executables. As long as rbenv shims directory is prepended to PATH, rbenv automatically ensures transparent switching between Ruby versions. It does so by generating shims for all Ruby executables. As long as rbenv shims directory is prepended to PATH, rbenv automatically ensures transparent switching between Ruby versions.
rbenv looks for available Ruby versions in the _{RBENV_ROOT}/versions/_ directory. rbenv looks for available Ruby versions in the _$RBENV_ROOT/versions_ directory.
== Commands == Commands
@ -67,14 +67,14 @@ rbenv looks for available Ruby versions in the _{RBENV_ROOT}/versions/_ director
*RBENV_HOOK_PATH*:: *RBENV_HOOK_PATH*::
Colon-separated list of paths searched for rbenv plugin scripts Colon-separated list of paths searched for rbenv plugin scripts
*RBENV_DIR* (default: _{PWD}_):: *RBENV_DIR* (default: _$PWD_)::
Directory to traverse bottom-up to locate the _.ruby-version_ file Directory to traverse bottom-up to locate the _.ruby-version_ file
== Plugins == Plugins
rbenv only performs Ruby version switching as its core functionality, but offers a plugin mechanism to hook into and override almost any aspect of its functionality. As its core functionality, rbenv only switches between Ruby versions and does nothing else, but offers a plugin mechanism to hook into and override almost any aspect of its default behavior.
The most common plugin for rbenv is *ruby-build* which facilitates installing new Ruby versions into the _{RBENV_ROOT}/versions/_ directory. The most common plugin for rbenv is *ruby-build* which facilitates installing new Ruby versions into the _$RBENV_ROOT/versions_ directory.
Read more at https://github.com/rbenv/rbenv/wiki/Plugins Read more at https://github.com/rbenv/rbenv/wiki/Plugins