increasing-the-jvm.dita 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN" "task.dtd">
  3. <!--This file is part of the DITA Open Toolkit project. See the accompanying LICENSE.md file for applicable licenses.-->
  4. <task id="t-increasing-the-JVM">
  5. <title>Increasing Java memory allocation</title>
  6. <shortdesc>If you are working with large documents with extensive metadata or key references, you will need to
  7. increase the memory allocation for the Java process. You can do this from the command-line prompt for a specific
  8. session, or you can increase the value of the <codeph>ANT_OPTS</codeph> environment variable.</shortdesc>
  9. <taskbody>
  10. <steps-unordered>
  11. <step>
  12. <cmd>To change the value for an specific session, from the command prompt, issue the following command:</cmd>
  13. <choicetable>
  14. <chhead>
  15. <choptionhd>Platform</choptionhd>
  16. <chdeschd>Command</chdeschd>
  17. </chhead>
  18. <chrow platform="unix">
  19. <choption>Linux or Mac OS&#xA0;X&#xA0;</choption>
  20. <chdesc><codeph>export ANT_OPTS=$ANT_OPTS -Xmx<varname>1024</varname>M</codeph></chdesc>
  21. </chrow>
  22. <chrow platform="windows">
  23. <choption>Windows</choption>
  24. <chdesc><codeph>set ANT_OPTS=%ANT_OPTS% -Xmx<varname>1024</varname>M</codeph></chdesc>
  25. </chrow>
  26. </choicetable>
  27. <info>
  28. <p>This increases the JVM memory allocation to 1024 megabytes. The amount of memory which can be allocated is
  29. limited by available system memory and the operating system.</p></info>
  30. </step>
  31. <step>
  32. <cmd>To persistently change the value, change the value allocated to the <codeph>ANT_OPTS</codeph> environment
  33. variable on your system.</cmd>
  34. </step>
  35. </steps-unordered>
  36. </taskbody>
  37. </task>