increasing-the-jvm.dita 2.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  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 file for applicable license. -->
  4. <task id="t-increasing-the-JVM">
  5. <title>Increasing Java memory allocation</title>
  6. <titlealts>
  7. <navtitle>Increasing Java memory</navtitle>
  8. </titlealts>
  9. <shortdesc>If you are working with large documents with extensive metadata or key references, you will need to
  10. increase the memory allocation for the Java process. You can do this from the command-line prompt for a specific
  11. session, or you can increase the value of the <codeph>ANT_OPTS</codeph> environment variable.</shortdesc>
  12. <prolog>
  13. <metadata>
  14. <keywords>
  15. <indexterm>macOS
  16. <indexterm>increase Java memory</indexterm></indexterm>
  17. <indexterm>Linux
  18. <indexterm>increase Java memory</indexterm></indexterm>
  19. <indexterm>Windows
  20. <indexterm>increase Java memory</indexterm></indexterm>
  21. <indexterm>command line
  22. <indexterm>increase Java memory</indexterm></indexterm>
  23. <indexterm>operating system
  24. <index-see>Linux</index-see>
  25. <index-see>macOS</index-see>
  26. <index-see>Windows</index-see></indexterm>
  27. <indexterm>Java
  28. <indexterm>memory</indexterm></indexterm>
  29. <indexterm><codeph>ANT_OPTS</codeph></indexterm>
  30. <indexterm>Java
  31. <indexterm><codeph>ANT_OPTS</codeph></indexterm></indexterm>
  32. <indexterm>metadata
  33. <indexterm>processing time, effect on</indexterm></indexterm>
  34. <indexterm>memory</indexterm>
  35. </keywords>
  36. </metadata>
  37. </prolog>
  38. <taskbody>
  39. <steps-unordered>
  40. <step>
  41. <cmd>To change the value for a specific session, from the command prompt, issue the following command:</cmd>
  42. <choicetable>
  43. <chhead>
  44. <choptionhd>Platform</choptionhd>
  45. <chdeschd>Command</chdeschd>
  46. </chhead>
  47. <chrow platform="unix">
  48. <choption>Linux or macOS&#xA0;</choption>
  49. <chdesc><codeph>export ANT_OPTS=$ANT_OPTS -Xmx<varname>1024</varname>M</codeph></chdesc>
  50. </chrow>
  51. <chrow platform="windows">
  52. <choption>Windows</choption>
  53. <chdesc><codeph>set ANT_OPTS=%ANT_OPTS% -Xmx<varname>1024</varname>M</codeph></chdesc>
  54. </chrow>
  55. </choicetable>
  56. <info>
  57. <p>This increases the JVM memory allocation to 1024 megabytes. The amount of memory which can be allocated is
  58. limited by available system memory and the operating system.</p></info>
  59. </step>
  60. <step>
  61. <cmd>To persistently change the value, change the value allocated to the <codeph>ANT_OPTS</codeph> environment
  62. variable on your system.</cmd>
  63. </step>
  64. </steps-unordered>
  65. </taskbody>
  66. </task>