summaryrefslogtreecommitdiff
path: root/man/ruby.1
diff options
context:
space:
mode:
Diffstat (limited to 'man/ruby.1')
-rw-r--r--man/ruby.138
1 files changed, 33 insertions, 5 deletions
diff --git a/man/ruby.1 b/man/ruby.1
index a6c50bd23a..8141a6d7ef 100644
--- a/man/ruby.1
+++ b/man/ruby.1
@@ -287,6 +287,8 @@ to the standard output.
.It Fl -debug
Turns on debug mode.
.Li "$DEBUG"
+and
+.Li "$VERBOSE"
will be set to true.
.Pp
.It Fl e Ar command
@@ -521,6 +523,13 @@ variable is not defined, Ruby refers to
If set, Ruby tries to free all dynamically allocated memories.
Introduced in Ruby 3.3, default: unset.
.Pp
+.It Ev RUBY_BOX
+If set to
+.Li 1 ,
+Ruby Box is enabled and users will be able to execute
+.Li Ruby::Box.new .
+Ruby Box is an experimental feature introduced in Ruby 4.0.
+.Pp
.It Ev RUBY_IO_BUFFER_DEFAULT_SIZE
The custom default buffer size of
.Li IO::Buffer .
@@ -543,6 +552,10 @@ Introduced in Ruby 3.0, default:
.Ev PAGER
environment variable.
.Pp
+.It Ev RUBY_THREAD_TIMESLICE
+Sets the default thread time slice (thread quantum) in milliseconds.
+Introduced in Ruby 3.4, default: 100ms.
+.Pp
.It Ev PATH
Ruby refers to the
.Ev PATH
@@ -588,10 +601,14 @@ Reaching the old malloc limit.
.Pp
There are currently 4 possible areas where the GC may be tuned by
the following environment variables:
-.Bl -hang -compact -width "RUBY_GC_HEAP_%d_INIT_SLOTS"
-.It Ev RUBY_GC_HEAP_ Ns Ar %d Ns Ev _INIT_SLOTS
+.Bl -hang -compact -width "RUBY_GC_HEAP_n_INIT_SLOTS"
+.Pp
+.It Ev RUBY_GC_HEAP_ Ns Ar n Ns Ev _INIT_SLOTS
Initial allocation of slots in a specific heap.
-The available heaps can be found in the keys of `GC.stat_heap`.
+The available heaps can be found in the keys of
+.Li GC.stat_heap .
+.Ar n
+is a decimal number between 0 and 4.
Introduced in Ruby 3.3.
.Pp
.It Ev RUBY_GC_HEAP_FREE_SLOTS
@@ -698,11 +715,11 @@ All values are specified in bytes.
.Bl -hang -compact -width "RUBY_THREAD_MACHINE_STACK_SIZE"
.It Ev RUBY_THREAD_VM_STACK_SIZE
VM stack size used at thread creation.
-default: 524288 (32-bit CPU) or 1048575 (64-bit)
+default: 524288 (32-bit CPU) or 1048576 (64-bit)
.Pp
.It Ev RUBY_THREAD_MACHINE_STACK_SIZE
Machine stack size used at thread creation.
-default: 524288 or 1048575
+default: 524288 or 1048576
.Pp
.It Ev RUBY_FIBER_VM_STACK_SIZE
VM stack size used at fiber creation.
@@ -768,6 +785,17 @@ a program (or script) that is to be executed.
.Pp
The pipe template is split on spaces into an argument list before the
template parameters are expanded.
+.Sh MISC ENVIRONMENT
+.Pp
+.Bl -hang -compact -width "RUBY_TCP_NO_FAST_FALLBACK"
+.It Ev RUBY_TCP_NO_FAST_FALLBACK
+If set to
+.Li 1 ,
+disables the fast fallback feature by default in TCPSocket.new and Socket.tcp.
+When set to
+.Li 0
+or left unset, the fast fallback feature is enabled.
+Introduced in Ruby 3.4, default: unset.
.Sh SEE ALSO
.Bl -hang -compact -width "https://www.ruby-toolbox.com/"
.It Lk https://www.ruby-lang.org/