diff options
Diffstat (limited to 'man')
| -rw-r--r-- | man/index.txt | 25 | ||||
| -rw-r--r-- | man/irb.1 | 257 | ||||
| -rw-r--r-- | man/ri.1 | 247 | ||||
| -rw-r--r-- | man/ruby.1 | 119 |
4 files changed, 104 insertions, 544 deletions
diff --git a/man/index.txt b/man/index.txt deleted file mode 100644 index 400eb02267..0000000000 --- a/man/index.txt +++ /dev/null @@ -1,25 +0,0 @@ -Gemfile(5) gemfile.5 -bundle(1) bundle.1 -bundle-add(1) bundle-add.1 -bundle-binstubs(1) bundle-binstubs.1 -bundle-check(1) bundle-check.1 -bundle-clean(1) bundle-clean.1 -bundle-config(1) bundle-config.1 -bundle-doctor(1) bundle-doctor.1 -bundle-exec(1) bundle-exec.1 -bundle-gem(1) bundle-gem.1 -bundle-info(1) bundle-info.1 -bundle-init(1) bundle-init.1 -bundle-inject(1) bundle-inject.1 -bundle-install(1) bundle-install.1 -bundle-list(1) bundle-list.1 -bundle-lock(1) bundle-lock.1 -bundle-open(1) bundle-open.1 -bundle-outdated(1) bundle-outdated.1 -bundle-package(1) bundle-package.1 -bundle-platform(1) bundle-platform.1 -bundle-pristine(1) bundle-pristine.1 -bundle-remove(1) bundle-remove.1 -bundle-show(1) bundle-show.1 -bundle-update(1) bundle-update.1 -bundle-viz(1) bundle-viz.1 diff --git a/man/irb.1 b/man/irb.1 deleted file mode 100644 index 93ef9b8f66..0000000000 --- a/man/irb.1 +++ /dev/null @@ -1,257 +0,0 @@ -.\"Ruby is copyrighted by Yukihiro Matsumoto <matz@netlab.jp>. -.Dd August 11, 2019 -.Dt IRB \&1 "Ruby Programmer's Reference Guide" -.Os UNIX -.Sh NAME -.Nm irb -.Nd Interactive Ruby Shell -.Sh SYNOPSIS -.Nm -.Op Fl -version -.Op Fl dfUw -.Op Fl I Ar directory -.Op Fl r Ar library -.Op Fl E Ar external Ns Op : Ns Ar internal -.Op Fl W Ns Op Ar level -.Op Fl - Ns Oo no Oc Ns inspect -.Op Fl - Ns Oo no Oc Ns multiline -.Op Fl - Ns Oo no Oc Ns singleline -.Op Fl - Ns Oo no Oc Ns echo -.Op Fl - Ns Oo no Oc Ns colorize -.Op Fl - Ns Oo no Oc Ns autocomplete -.Op Fl - Ns Oo no Oc Ns verbose -.Op Fl -prompt Ar mode -.Op Fl -prompt-mode Ar mode -.Op Fl -inf-ruby-mode -.Op Fl -simple-prompt -.Op Fl -noprompt -.Op Fl -tracer -.Op Fl -back-trace-limit Ar n -.Op Fl - -.Op program_file -.Op argument ... -.Pp -.Sh DESCRIPTION -.Nm -is the REPL(read-eval-print loop) environment for Ruby programs. -.Pp -.Sh OPTIONS -.Bl -tag -width "1234567890123" -compact -.Pp -.It Fl -version -Prints the version of -.Nm . -.Pp -.It Fl E Ar external Ns Op : Ns Ar internal -.It Fl -encoding Ar external Ns Op : Ns Ar internal -Same as `ruby -E' . -Specifies the default value(s) for external encodings and internal encoding. Values should be separated with colon (:). -.Pp -You can omit the one for internal encodings, then the value -.Pf ( Li "Encoding.default_internal" ) will be nil. -.Pp -.It Fl I Ar path -Same as `ruby -I' . -Specifies -.Li $LOAD_PATH -directory -.Pp -.It Fl U -Same as `ruby -U' . -Sets the default value for internal encodings -.Pf ( Li "Encoding.default_internal" ) to UTF-8. -.Pp -.It Fl d -Same as `ruby -d' . -Sets -.Li $DEBUG -to true. -.Pp -.It Fl f -Suppresses read of -.Pa ~/.irbrc . -.Pp -.It Fl w -Same as `ruby -w' . -.Pp -.Pp -.It Fl W -Same as `ruby -W' . -.Pp -.It Fl h -.It Fl -help -Prints a summary of the options. -.Pp -.It Fl r Ar library -Same as `ruby -r'. -Causes irb to load the library using require. -.Pp -.It Fl -inspect -Uses `inspect' for output (default except for bc mode) -.Pp -.It Fl -noinspect -Doesn't use inspect for output -.Pp -.It Fl -multiline -Uses multiline editor module. -.Pp -.It Fl -nomultiline -Doesn't use multiline editor module. -.Pp -.It Fl -singleline -Uses singleline editor module. -.Pp -.It Fl -nosingleline -Doesn't use singleline editor module. -.Pp -.Pp -.It Fl -extra-doc-dir -Add an extra doc dir for the doc dialog. -.Pp -.Pp -.It Fl -echo -Show result (default). -.Pp -.It Fl -noecho -Don't show result. -.Pp -.Pp -.It Fl -echo-on-assignment -Show result on assignment. -.Pp -.It Fl -noecho-on-assignment -Don't show result on assignment. -.Pp -.It Fl -truncate-echo-on-assignment -Show truncated result on assignment (default). -.Pp -.Pp -.It Fl -colorize -Use colorization. -.Pp -.It Fl -nocolorize -Don't use colorization. -.Pp -.Pp -.It Fl -autocomplete -Use autocompletion. -.Pp -.It Fl -noautocomplete -Don't use autocompletion. -.Pp -.Pp -.It Fl -regexp-completor -Use regexp based completion. -.Pp -.It Fl -type-completor -Use type based completion. -.Pp -.Pp -.It Fl -verbose -Show details. -.Pp -.It Fl -noverbose -Don't show details. -.Pp -.It Fl -prompt Ar mode -.It Fl -prompt-mode Ar mode -Switch prompt mode. Pre-defined prompt modes are -`default', `simple', `xmp' and `inf-ruby'. -.Pp -.It Fl -inf-ruby-mode -Uses prompt appropriate for inf-ruby-mode on emacs. -Suppresses --multiline and --singleline. -.Pp -.It Fl -simple-prompt -Makes prompts simple. -.Pp -.It Fl -noprompt -No prompt mode. -.Pp -.It Fl -tracer -Displays trace for each execution of commands. -.Pp -.It Fl -back-trace-limit Ar n -Displays backtrace top -.Ar n -and tail -.Ar n Ns . -The default value is 16. -.El -.Pp -.Sh ENVIRONMENT -.Bl -tag -compact -width "XDG_CONFIG_HOME" -.It Ev IRB_LANG -The locale used for -.Nm . -.Pp -.It Ev IRBRC -The path to the personal initialization file. -.Pp -.It Ev XDG_CONFIG_HOME -.Nm -respects XDG_CONFIG_HOME. If this is set, load -.Pa $XDG_CONFIG_HOME/irb/irbrc -as a personal initialization file. -.Pp -.El -.Pp -Also -.Nm -depends on same variables as -.Xr ruby 1 . -.Pp -.Sh FILES -.Bl -tag -compact -.It Pa ~/.irbrc -Personal irb initialization. If -.Ev IRBRC -is set, read -.Pa $IRBRC -instead. If -.Ev IRBRC -is not set and -.Ev XDG_CONFIG_HOME -is set, -.Pa $XDG_CONFIG_HOME/irb/irbrc -is loaded. -.Pp -.El -.Pp -.Sh EXAMPLES -.Dl % irb -.Dl irb(main):001:0> Ic 1 + 1 -.Dl 2 -.Dl irb(main):002:0> Ic def t(x) -.Dl irb(main):003:1> Ic x + 1 -.Dl irb(main):004:1> Ic end -.Dl => :t -.Dl irb(main):005:0> Ic t(3) -.Dl => 4 -.Dl irb(main):006:0> Ic if t(3) == 4 -.Dl irb(main):007:1> Ic p :ok -.Dl irb(main):008:1> Ic end -.Dl :ok -.Dl => :ok -.Dl irb(main):009:0> Ic quit -.Dl % -.Pp -.Sh SEE ALSO -.Xr ruby 1 . -.Pp -.Sh REPORTING BUGS -.Bl -bullet -.It -Security vulnerabilities should be reported via an email to -.Mt security@ruby-lang.org . -Reported problems will be published after being fixed. -.Pp -.It -Other bugs and feature requests can be reported via the -Ruby Issue Tracking System -.Pq Lk https://bugs.ruby-lang.org/ . -Do not report security vulnerabilities -via this system because it publishes the vulnerabilities immediately. -.El -.Sh AUTHORS -Written by Keiju ISHITSUKA. diff --git a/man/ri.1 b/man/ri.1 deleted file mode 100644 index 85a6dfcd53..0000000000 --- a/man/ri.1 +++ /dev/null @@ -1,247 +0,0 @@ -.\"Ruby is copyrighted by Yukihiro Matsumoto <matz@netlab.jp>. -.Dd April 20, 2017 -.Dt RI \&1 "Ruby Programmer's Reference Guide" -.Os UNIX -.Sh NAME -.Nm ri -.Nd Ruby API reference front end -.Sh SYNOPSIS -.Nm -.Op Fl ahilTv -.Op Fl d Ar DIRNAME -.Op Fl f Ar FORMAT -.Op Fl w Ar WIDTH -.Op Fl - Ns Oo Cm no- Oc Ns Cm pager -.Op Fl -server Ns Oo = Ns Ar PORT Oc -.Op Fl - Ns Oo Cm no- Oc Ns Cm list-doc-dirs -.Op Fl -no-standard-docs -.Op Fl - Ns Oo Cm no- Oc Ns Bro Cm system Ns | Ns Cm site Ns | Ns Cm gems Ns | Ns Cm home Brc -.Op Fl - Ns Oo Cm no- Oc Ns Cm profile -.Op Fl -dump Ns = Ns Ar CACHE -.Op Ar name ... -.Sh DESCRIPTION -.Nm -is a command-line front end for the Ruby API reference. -You can search and read the API reference for classes and methods with -.Nm . -.Pp -.Nm -is a part of Ruby. -.Pp -.Ar name -can be: -.Bl -diag -offset indent -.It Class | Module | Module::Class -.Pp -.It Class::method | Class#method | Class.method | method -.Pp -.It gem_name: | gem_name:README | gem_name:History -.El -.Pp -All class names may be abbreviated to their minimum unambiguous form. -If a name is ambiguous, all valid options will be listed. -.Pp -A -.Ql \&. -matches either class or instance methods, while #method -matches only instance and ::method matches only class methods. -.Pp -README and other files may be displayed by prefixing them with the gem name -they're contained in. If the gem name is followed by a -.Ql \&: -all files in the gem will be shown. -The file name extension may be omitted where it is unambiguous. -.Pp -For example: -.Bd -literal -offset indent -ri Fil -ri File -ri File.new -ri zip -ri rdoc:README -.Ed -.Pp -Note that shell quoting or escaping may be required for method names -containing punctuation: -.Bd -literal -offset indent -ri 'Array.[]' -ri compact\e! -.Ed -.Pp -To see the default directories -.Nm -will search, run: -.Bd -literal -offset indent -ri --list-doc-dirs -.Ed -.Pp -Specifying the -.Fl -system , Fl -site , Fl -home , Fl -gems , -or -.Fl -doc-dir -options will limit -.Nm -to searching only the specified directories. -.Pp -.Nm -options may be set in the -.Ev RI -environment variable. -.Pp -The -.Nm -pager can be set with the -.Ev RI_PAGER -environment variable or the -.Ev PAGER -environment variable. -.Pp -.Sh OPTIONS -.Bl -tag -width "1234567890123" -compact -.Pp -.It Fl i -.It Fl - Ns Oo Cm no- Oc Ns Cm interactive -In interactive mode you can repeatedly -look up methods with autocomplete. -.Pp -.It Fl a -.It Fl - Ns Oo Cm no- Oc Ns Cm all -Show all documentation for a class or module. -.Pp -.It Fl l -.It Fl - Ns Oo Cm no- Oc Ns Cm list -List classes -.Nm -knows about. -.Pp -.It Fl - Ns Oo Cm no- Oc Ns Cm pager -Send output to a pager, -rather than directly to stdout. -.Pp -.It Fl T -Synonym for -.Fl -no-pager . -.Pp -.It Fl w Ar WIDTH -.It Fl -width Ns = Ns Ar WIDTH -Set the width of the output. -.Pp -.It Fl -server Ns Oo = Ns Ar PORT Oc -Run RDoc server on the given port. -The default port is\~8214. -.Pp -.It Fl f Ar FORMAT -.It Fl -format Ns = Ns Ar FORMAT -Use the selected formatter. -The default formatter is -.Li bs -for paged output and -.Li ansi -otherwise. -Valid formatters are: -.Li ansi , Li bs , Li markdown , Li rdoc . -.Pp -.It Fl h -.It Fl -help -Show help and exit. -.Pp -.It Fl v -.It Fl -version -Output version information and exit. -.El -.Pp -Data source options: -.Bl -tag -width "1234567890123" -compact -.Pp -.It Fl - Ns Oo Cm no- Oc Ns Cm list-doc-dirs -List the directories from which -.Nm -will source documentation on stdout and exit. -.Pp -.It Fl d Ar DIRNAME -.It Fl -doc-dir Ns = Ns Ar DIRNAME -List of directories from which to source -documentation in addition to the standard -directories. May be repeated. -.Pp -.It Fl -no-standard-docs -Do not include documentation from the Ruby standard library, -.Pa site_lib , -installed gems, or -.Pa ~/.rdoc . -Use with -.Fl -doc-dir . -.Pp -.It Fl - Ns Oo Cm no- Oc Ns Cm system -Include documentation from Ruby's standard library. Defaults to true. -.Pp -.It Fl - Ns Oo Cm no- Oc Ns Cm site -Include documentation from libraries installed in -.Pa site_lib . -Defaults to true. -.Pp -.It Fl - Ns Oo Cm no- Oc Ns Cm gems -Include documentation from RubyGems. Defaults to true. -.Pp -.It Fl - Ns Oo Cm no- Oc Ns Cm home -Include documentation stored in -.Pa ~/.rdoc . -Defaults to true. -.El -.Pp -Debug options: -.Bl -tag -width "1234567890123" -compact -.Pp -.It Fl - Ns Oo Cm no- Oc Ns Cm profile -Run with the Ruby profiler. -.Pp -.It Fl -dump Ns = Ns Ar CACHE -Dump data from an ri cache or data file. -.El -.Pp -.Sh ENVIRONMENT -.Bl -tag -width "USERPROFILE" -compact -.Pp -.It Ev RI -Options to prepend to those specified on the command-line. -.Pp -.It Ev RI_PAGER -.It Ev PAGER -Pager program to use for displaying. -.Pp -.It Ev HOME -.It Ev USERPROFILE -.It Ev HOMEPATH -Path to the user's home directory. -.El -.Pp -.Sh FILES -.Bl -tag -width "USERPROFILE" -compact -.Pp -.It Pa ~/.rdoc -Path for ri data in the user's home directory. -.Pp -.El -.Pp -.Sh SEE ALSO -.Xr ruby 1 , -.Xr rdoc 1 , -.Xr gem 1 -.Pp -.Sh REPORTING BUGS -.Bl -bullet -.It -Security vulnerabilities should be reported via an email to -.Mt security@ruby-lang.org . -Reported problems will be published after being fixed. -.Pp -.It -Other bugs and feature requests can be reported via the -Ruby Issue Tracking System -.Pq Lk https://bugs.ruby-lang.org/ . -Do not report security vulnerabilities -via this system because it publishes the vulnerabilities immediately. -.El -.Sh AUTHORS -Written by -.An Dave Thomas Aq dave@pragmaticprogrammer.com . diff --git a/man/ruby.1 b/man/ruby.1 index a0cda14641..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 @@ -430,7 +432,7 @@ Dump some information. Prints the specified target. .Ar target can be one of: -.Bl -hang -offset indent +.Bl -hang -offset indent -width "version" .It Sy version Print version description (same as .Fl -version). @@ -448,18 +450,20 @@ Check syntax (same as .El .Pp Or one of the following, which are intended for debugging the interpreter: -.Bl -hang -offset indent -tag -width "parsetree_with_comment" +.Bl -hang -offset indent -width "parsetree" .It Sy yydebug Enable compiler debug mode (same as .Fl -yydebug). .It Sy parsetree Print a textual representation of the Ruby AST for the program. -.It Sy parsetree_with_comment -Print a textual representation of the Ruby AST for the program, but with each node annotated with the associated Ruby source code. .It Sy insns Print a list of disassembled bytecode instructions. -.It Sy insns_without_opt -Print the list of disassembled bytecode instructions before various optimizations have been applied. +.It Sy -optimize +Disable various optimizations to print a list disassembled bytecode instructions. +.It Sy +error-tolerant +Enable error-tolerant parsing, when yydebug or parsetree. +.It Sy +comment +Annotate a textual representation of the Ruby AST for the program with the associated Ruby source code. .El .Pp .It Fl -verbose @@ -515,6 +519,43 @@ enabled for only mswin32, mingw32, and OS/2 platforms. If this variable is not defined, Ruby refers to .Ev COMSPEC . .Pp +.It Ev RUBY_FREE_AT_EXIT +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 . +.Pp +.It Ev RUBY_MAX_CPU +The maximum number of native threads used by M:N Threads scheduler +Introduced in Ruby 3.3, default: 8. +.Pp +.It Ev RUBY_MN_THREADS +If set to +.Li 1 , +M:N Thread scheduler is enabled on the main Ractor. +Introduced in Ruby 3.3, default: unset. +.Pp +.It Ev RUBY_PAGER +The pager command that will be used for +.Fl -help +option. +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 @@ -537,7 +578,7 @@ malloc family of C standard library calls ( .Xr calloc 3 , and .Xr realloc 3 ) . -In this documentatation, the "heap" refers to the Ruby object heap +In this documentation, the "heap" refers to the Ruby object heap of fixed-sized slots, while "malloc" refers to auxiliary allocations commonly referred to as the "process heap". Thus there are at least two possible ways to trigger GC: @@ -559,14 +600,15 @@ Reaching the old malloc limit. .El .Pp There are currently 4 possible areas where the GC may be tuned by -the following 11 environment variables: -.Bl -hang -compact -width "RUBY_GC_OLDMALLOC_LIMIT_GROWTH_FACTOR" -.It Ev RUBY_GC_HEAP_INIT_SLOTS -Initial allocation slots. Applies to all slot sizes. Introduced in Ruby 2.1, default: 10000. +the following environment variables: +.Bl -hang -compact -width "RUBY_GC_HEAP_n_INIT_SLOTS" .Pp -.It Ev RUBY_GC_HEAP_%d_INIT_SLOTS +.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 @@ -589,6 +631,12 @@ where R is this factor and N is the number of old objects after the last full GC. Introduced in Ruby 2.1.1, default: 2.0 .Pp +.It Ev RUBY_GC_HEAP_REMEMBERED_WB_UNPROTECTED_OBJECTS_LIMIT_RATIO +Used to calculate the +.Li remembered_wb_unprotected_objects_limit +using a ratio of +.Li old_objects . +Introduced in Ruby 3.3, default: 0.1, minimum: 0.0 .It Ev RUBY_GC_MALLOC_LIMIT The initial limit of young generation allocation from the malloc-family. GC will start when this limit is reached. @@ -605,6 +653,31 @@ GC frequency but increasing malloc growth until RUBY_GC_MALLOC_LIMIT_MAX is reached. Introduced in Ruby 2.1, default: 1.4, minimum: 1.0 (no growth) .Pp +.It Ev RUBY_GC_HEAP_FREE_SLOTS_MIN_RATIO +Allocate additional pages when the number of free slots is +lower than the value +.Li (total_slots * (this ratio)) . +Introduced in Ruby 2.4, default: 0.2, minimum: 0.0, maximum: 1.0 +.Pp +.It Ev RUBY_GC_HEAP_FREE_SLOTS_MAX_RATIO +Allow to free pages when the number of free slots is greater than the value +.Li (total_slots * (this ratio)) . +Introduced in Ruby 2.4, default: 0.4, minimum: +.Li RUBY_GC_HEAP_FREE_SLOTS_MIN_RATIO, +maximum: 1.0 +.Pp +.It Ev RUBY_GC_HEAP_FREE_SLOTS_GOAL_RATIO +Allocate slots to satisfy this formula: +.Li free_slots = total_slots * goal_ratio +In other words, prepare +.Li (total_slots * goal_ratio) +free slots. +if this value is 0.0, then use RUBY_GC_HEAP_GROWTH_FACTOR directly. +Introduced in Ruby 2.4, default: 0.65, minimum: +.Li RUBY_GC_HEAP_FREE_SLOTS_MIN_RATIO, +maximum: +.Li RUBY_GC_HEAP_FREE_SLOTS_MAX_RATIO +.Pp .It Ev RUBY_GC_OLDMALLOC_LIMIT The initial limit of old generation allocation from malloc, a full GC will start when this limit is reached. @@ -622,6 +695,11 @@ GC frequency but increasing malloc growth until RUBY_GC_OLDMALLOC_LIMIT_MAX is reached. Introduced in Ruby 2.1, default: 1.2, minimum: 1.0 (no growth) .Pp +.It Ev RUBY_SHARED_FIBER_POOL_FREE_STACKS +Frees stacks of pooled fibers, if set to 1. +Do not free the stacks if set to 0. +Introduced in Ruby 2.7, default: 1 (no growth) +.Pp .El .Sh STACK SIZE ENVIRONMENT Stack size environment variables are implementation-dependent and @@ -637,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. @@ -707,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/ |