diff --git a/src/main/docbkx/shell.xml b/src/main/docbkx/shell.xml index deca139ec8e..d1067a1e795 100644 --- a/src/main/docbkx/shell.xml +++ b/src/main/docbkx/shell.xml @@ -54,6 +54,20 @@ $ ./bin/hbase org.jruby.Main PATH_TO_SCRIPT +
+ Passing VM Options to the Shell + You can pass VM options to the HBase Shell using the HBASE_SHELL_OPTS + environment variable. You can set this in your environment, for instance by editing + ~/.bashrc, or set it as part of the command to launch HBase + Shell. The following example sets several garbage-collection-related variables, just for + the lifetime of the VM running the HBase Shell. The command should be run all on a + single line, but is broken by the \ character, for + readability. + +$ HBASE_SHELL_OPTS="-verbose:gc -XX:+PrintGCApplicationStoppedTime -XX:+PrintGCDateStamps \ + -XX:+PrintGCDetails -Xloggc:$HBASE_HOME/logs/gc-hbase.log" ./bin/hbase shell + +
Shell Tricks