path: root/doc/globals.rdoc
diff options
authordrbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2013-02-21 21:31:09 +0000
committerdrbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2013-02-21 21:31:09 +0000
commit6b88b523f4f7e35ca685a838b751c1a70608948f (patch)
tree525f4dfe0b0c6763cacce751ee51e1a348f8f26e /doc/globals.rdoc
parent9c49b69d3eac7b19c60b3aacd00c687781c6c797 (diff)
* doc/globals.rdoc: Document what setting $DEBUG does.
* doc/globals.rdoc: Added pointer to $-d for full documentation. git-svn-id: svn+ssh:// b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'doc/globals.rdoc')
1 files changed, 6 insertions, 2 deletions
diff --git a/doc/globals.rdoc b/doc/globals.rdoc
index f4cfd35..060764f 100644
--- a/doc/globals.rdoc
+++ b/doc/globals.rdoc
@@ -25,7 +25,11 @@ $$:: The process number of the Ruby running this script.
$?:: The status of the last executed child process.
$::: Load path for scripts and binary modules by load or require.
$":: The array contains the module names loaded by require.
-$DEBUG:: The status of the -d switch.
+$DEBUG:: The debug flag, which is set by the -d switch. Enabling debug
+ output prints each exception raised to $stderr (but not its
+ backtrace). Setting this to a true value enables debug output as
+ if -d were given on the command line. Setting this to a false
+ value disables debug output.
$FILENAME:: Current input file from $<. Same as $<.filename.
$LOAD_PATH:: The alias to the $:.
$stderr:: The current standard error output.
@@ -37,7 +41,7 @@ $VERBOSE:: The verbose flag, which is set by the -w or -v switch. Setting
including from Kernel#warn.
$-0:: The alias to $/.
$-a:: True if option -a is set. Read-only variable.
-$-d:: The alias to $DEBUG.
+$-d:: The alias of $DEBUG. See $DEBUG above for further discusison.
$-F:: The alias to $;.
$-i:: In in-place-edit mode, this variable holds the extension, otherwise nil.
$-I:: The alias to $:.