OS Manuals

/usr/share/logstash/bin/ruby

Logstash - transport and process your logs, events, or other data

From logstash-9.0 9.0.8-r25 (enterprise-packages), captured 2026-11-08 by running ruby --help (exit 0). permalink

Using system java: /usr/sbin/java
Usage: jruby [switches] [--] [programfile] [arguments]
   -0[octal]                                           specify record separator (\0, if no argument)
   -a                                                  autosplit mode with -n or -p (splits $_ into $F)
   -c                                                  check syntax only
   -Cdirectory                                         cd to directory, before executing your script
   -d                                                  set debugging flags (set $DEBUG to true)
   -e 'command'                                        one line of script. Several -e's allowed. Omit [programfile]
   -Eex[:in]                                           specify the default external and internal character encodings
   -Fpattern                                           split() pattern for autosplit (-a)
   -G                                                  load a Bundler Gemspec before executing any user code
   -i[extension]                                       edit ARGV files in place (make backup if extension supplied)
   -Idirectory                                         specify $LOAD_PATH directory (may be used more than once)
   -J[java option]                                     pass an option on to the JVM (e.g. -J-Xmx512m); use --properties to list
                                                       properties; run 'java -help' for a list of other Java options
   -l                                                  enable line ending processing
   -n                                                  assume 'while gets(); ... end' loop around your script
   -p                                                  assume loop like -n but print line also like sed
   -rlibrary                                           require the library, before executing your script
   -s                                                  enable some switch parsing for switches after script name
   -S                                                  look for the script in bin or using PATH environment variable
   -U                                                  use UTF-8 as default internal encoding
   -v                                                  print version number, then turn on verbose mode
   -w                                                  turn warnings on for your script
   -W[level]                                           set warning level; 0=silence, 1=medium, 2=verbose (default)
   -x[directory]                                       strip off text before #!ruby line and perhaps cd to directory
   -X[option]                                          enable extended option (omit option to list)
   -y                                                  enable parsing debug output
   --backtrace-limit[lines]                            limits the maximum length of a backtrace
   --copyright                                         print the copyright
   --debug                                             sets the execution mode most suitable for debugger functionality
   --jdb                                               runs JRuby process under JDB
   --properties                                        List all JRuby configuration properties
   --sample                                            run with profiling using the JVM's sampling profiler
   --profile                                           run with instrumented (timed) profiling, flat format
   --profile.api                                       activate Ruby profiler API
   --profile.flat                                      synonym for --profile
   --profile.graph                                     run with instrumented (timed) profiling, graph format
   --profile.html                                      run with instrumented (timed) profiling, graph format in HTML
   --profile.json                                      run with instrumented (timed) profiling, graph format in JSON
   --profile.out                                       [file]
   --profile.service                                   <ProfilingService implementation classname> output profile data to
                                                       [file]
   --client                                            use the non-optimizing "client" JVM (improves startup; default)
   --server                                            use the optimizing "server" JVM (improves perf)
   --headless                                          do not launch a GUI window, no matter what
   --dev                                               prioritize startup time over long term performance
   --manage                                            enable remote JMX management and monitoring of JVM and JRuby
   --bytecode                                          show the JVM bytecode produced by compiling specified code
   --version                                           print the version
   --disable-gems                                      do not load RubyGems on startup (only for debugging)
   --enable=feature[,...], --disable=feature[,...]     enable or disable features
Features:
   gems                      rubygems (default: enabled)
   did_you_mean              did_you_mean (default: enabled)
   rubyopt                   RUBYOPT environment variable (default: enabled)
   frozen-string-literal     freeze all string literals (default: disabled)
Options (48)
OptionDescriptionSource
-0 octalspecify record separator (\0, if no argument)help
-aautosplit mode with -n or -p (splits $_ into $F)help
-ccheck syntax onlyhelp
-Cdirectorycd to directory, before executing your scripthelp
-dset debugging flags (set $DEBUG to true)help
-e 'command'one line of script.help
-Eex :inspecify the default external and internal character encodingshelp
-Fpatternsplit() pattern for autosplit (-a)help
-Gload a Bundler Gemspec before executing any user codehelp
-i extensionedit ARGV files in place (make backup if extension supplied)help
-Idirectoryspecify $LOAD_PATH directory (may be used more than once)help
-J javapass an option on to the JVM (e.g. -J-Xmx512m);help
-lenable line ending processinghelp
-nassume 'while gets();help
-passume loop like -n but print line also like sedhelp
-rlibraryrequire the library, before executing your scripthelp
-senable some switch parsing for switches after script namehelp
-Slook for the script in bin or using PATH environment variablehelp
-Uuse UTF-8 as default internal encodinghelp
-vprint version number, then turn on verbose modehelp
-wturn warnings on for your scripthelp
-W levelset warning level;help
-x directorystrip off text before #!ruby line and perhaps cd to directoryhelp
-X optionenable extended option (omit option to list)help
-yenable parsing debug outputhelp
--backtrace-limit lineslimits the maximum length of a backtracehelp
--copyrightprint the copyrighthelp
--debugsets the execution mode most suitable for debugger functionalityhelp
--jdbruns JRuby process under JDBhelp
--propertiesList all JRuby configuration propertieshelp
--samplerun with profiling using the JVM's sampling profilerhelp
--profilerun with instrumented (timed) profiling, flat formathelp
--profile.apiactivate Ruby profiler APIhelp
--profile.flatsynonym for --profilehelp
--profile.graphrun with instrumented (timed) profiling, graph formathelp
--profile.htmlrun with instrumented (timed) profiling, graph format in HTMLhelp
--profile.jsonrun with instrumented (timed) profiling, graph format in JSONhelp
--profile.out[file]help
--profile.service<ProfilingService implementation classname> output profile data to [file]help
--clientuse the non-optimizing "client" JVM (improves startup;help
--serveruse the optimizing "server" JVM (improves perf)help
--headlessdo not launch a GUI window, no matter whathelp
--devprioritize startup time over long term performancehelp
--manageenable remote JMX management and monitoring of JVM and JRubyhelp
--bytecodeshow the JVM bytecode produced by compiling specified codehelp
--versionprint the versionhelp
--disable-gemsdo not load RubyGems on startup (only for debugging)help
--enable, --disable featureenable or disable featureshelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.