Repository: hbase Updated Branches: refs/heads/master 70696ebf5 -> c1c5c8879
HBASE-11753 Document HBASE_SHELL_OPTS environment variable (Misty Stanley-Jones) Project: http://git-wip-us.apache.org/repos/asf/hbase/repo Commit: http://git-wip-us.apache.org/repos/asf/hbase/commit/c1c5c887 Tree: http://git-wip-us.apache.org/repos/asf/hbase/tree/c1c5c887 Diff: http://git-wip-us.apache.org/repos/asf/hbase/diff/c1c5c887 Branch: refs/heads/master Commit: c1c5c887926079efe660c4105ebc033710cb3e95 Parents: 70696eb Author: Jonathan M Hsieh <[email protected]> Authored: Mon Aug 18 12:10:46 2014 -0700 Committer: Jonathan M Hsieh <[email protected]> Committed: Mon Aug 18 12:10:46 2014 -0700 ---------------------------------------------------------------------- src/main/docbkx/shell.xml | 14 ++++++++++++++ 1 file changed, 14 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/hbase/blob/c1c5c887/src/main/docbkx/shell.xml ---------------------------------------------------------------------- diff --git a/src/main/docbkx/shell.xml b/src/main/docbkx/shell.xml index deca139..d1067a1 100644 --- a/src/main/docbkx/shell.xml +++ b/src/main/docbkx/shell.xml @@ -54,6 +54,20 @@ <programlisting>$ ./bin/hbase org.jruby.Main PATH_TO_SCRIPT</programlisting> </section> + <section> + <title>Passing VM Options to the Shell</title> + <para>You can pass VM options to the HBase Shell using the <code>HBASE_SHELL_OPTS</code> + environment variable. You can set this in your environment, for instance by editing + <filename>~/.bashrc</filename>, 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 <literal>\</literal> character, for + readability.</para> + <screen language="bourne"> +$ <userinput>HBASE_SHELL_OPTS="-verbose:gc -XX:+PrintGCApplicationStoppedTime -XX:+PrintGCDateStamps \ + -XX:+PrintGCDetails -Xloggc:$HBASE_HOME/logs/gc-hbase.log" ./bin/hbase shell</userinput> + </screen> + </section> <section xml:id="shell_tricks"> <title>Shell Tricks</title>
