From 2f160359d38a4d475b0f96eb7da61f823d9ef7bd Mon Sep 17 00:00:00 2001 From: Ben Soares Date: Mon, 3 Aug 2020 11:20:05 +0100 Subject: [PATCH] JAL-3477 added help documentation for executable jar command line arguments -jvmmempc and -jvmmemmax --- help/help/html/features/clarguments.html | 19 +++++++++++++++++++ help/help/html/memory.html | 11 ++++++++++- 2 files changed, 29 insertions(+), 1 deletion(-) diff --git a/help/help/html/features/clarguments.html b/help/help/html/features/clarguments.html index 5c9e314..89560e9 100644 --- a/help/help/html/features/clarguments.html +++ b/help/help/html/features/clarguments.html @@ -234,6 +234,25 @@ + +
-jvmmempc=PERCENT
+
Standalone executable jar only. + Limit maximum heap size (memory) to PERCENT% of total physical memory detected. + This defaults to 90 if total physical memory can be detected. + See Memory usage settings for Jalview for more details. +
+ + + +
-jvmmemmax=MAXMEMORY
+
Standalone executable jar only. + Limit maximum heap size (memory) to MAXMEMORY. MAXMEMORY can be specified in bytes, kilobytes(k), megabytes(m), + gigabytes(g) or if you're lucky enough, terabytes(t). + This defaults to 32g if total physcial memory can be detected, or to 8g if total physical memory cannot be detected. + See Memory usage settings for Jalview for more details. +
+ + diff --git a/help/help/html/memory.html b/help/help/html/memory.html index 81190a9..80bffa3 100755 --- a/help/help/html/memory.html +++ b/help/help/html/memory.html @@ -90,7 +90,16 @@
  • Maximum memory limit
    Since 2.11.1.0, Jalview's configuration includes a 'maximum memory limit': 
    jalview.jvmmemmax = 32G
    - Adjusting this default (via a JVL file, above) will allow larger amounts of memory to be allocated to Jalview in connjunction with the jalview.jvmmempc setting. + Adjusting this default (via a JVL file, above) will allow larger amounts (or can limit the amount) of memory to be allocated to Jalview in conjunction with the jalview.jvmmempc setting. +

    +
    • +
  • Command line arguments when using the executable jar (jalview-all.jar)
    + If you are using the Jalview standalone executable jar, (usually named jalview-all-....jar with a Jalview and Java version designation), + then you can set the jvmmempc and jvmmemmax values using application command line arguments -jvmmempc=N + and -jvmmemmax=M respectively, e.g. + 
    java -jar jalview-all-2.11.1.0-j1.8.jar -jvmmempc=50 -jvmmemmax=20g
    + (this example will launch Jalview with a maximum heap size of the smaller of 20GB or 50% of physical memory detected). +

  • Directly opening Jalview with a JVM
    Launching Jalview directly with a JVM is -- 1.7.10.2