Domů Procházet Nápověda
Přihlásit se
bn
/
se
2
0
Rozštěpit 0
Soubory Úkoly 0 Pull Requesty 0 Wiki
Strom: aa0af5da67
Větve Značky
se
/
SE
/
schema
/
WPS_Functions
/
dita-ot
/
dita-ot-3.0.4
/
doc
/
parameters
/
dita-command-arguments.html

dita-command-arguments.html 16 KB
Historie Surový

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233 
  1. <!DOCTYPE html
    2. 

  2.   SYSTEM "about:legacy-compat">
    3. 

  3. <html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2018"><meta name="DC.rights.owner" content="(C) Copyright 2018"><meta name="DC.Type" content="reference"><meta name="description" content="The dita command takes mandatory arguments to process DITA content, manage plug-ins, or print information about the command. Options can be used to modify the command behavior or specify additional configuration parameters."><meta name="DC.subject" content="dita command, syntax"><meta name="keywords" content="dita command, syntax"><meta name="DC.Relation" scheme="URI" content="../parameters/index.html"><meta name="DC.Relation" scheme="URI" content="../topics/build-using-dita-command.html"><meta name="DC.Relation" scheme="URI" content="../parameters/parameters_intro.html"><meta name="DC.Relation" scheme="URI" content="../parameters/internal-ant-properties.html"><meta name="DC.Relation" scheme="URI" content="../topics/using-dita-properties-file.html"><meta name="DC.Format" content="HTML5"><meta name="DC.Identifier" content="dita-command-properties"><meta name="DC.Language" content="en"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Arguments and options for the dita command</title></head><body id="dita-command-properties"><header role="banner"><div class="header">
    4. 

  4.   <p>DITA Open Toolkit</p>
    5. 

  5.   <hr>
    6. 

  6. </div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.0</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../topics/installing-client.html">Installing DITA-OT</a></li><li><a href="../topics/alternative-input-formats.html">Authoring formats</a></li><li><a href="../topics/building-output.html">Building output</a></li><li><a href="../parameters/index.html">Setting parameters</a><ul><li class="active"><a href="../parameters/dita-command-arguments.html">DITA command arguments</a></li><li><a href="../parameters/parameters_intro.html">DITA-OT parameters</a></li><li><a href="../parameters/configuration-properties.html">Configuration properties</a></li></ul></li><li><a href="../topics/extending-the-ot.html">Customizing DITA-OT</a></li><li><a href="../topics/troubleshooting-overview.html">Troubleshooting</a></li><li><a href="../reference/index.html">Reference</a></li><li><a href="../topics/dita-and-dita-ot-resources.html">Resources</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1">
    7. 

  7.   <h1 class="title topictitle1" id="ariaid-title1">Arguments and options for the <span class="keyword cmdname">dita</span> command</h1>
    8. 

  8.   
    9. 

  9.   
    10. 

  10.   
    11. 

  11.   <div class="body refbody"><p class="shortdesc">The <span class="keyword cmdname">dita</span> command takes mandatory arguments to process DITA content, manage plug-ins, or
    12. 

  12.     print information about the command. Options can be used to modify the command behavior or specify additional
    13. 

  13.     configuration parameters.</p>
    14. 

  14.     <section class="section"><h2 class="title sectiontitle">Usage</h2>
    15. 

  15.       
    16. 

  16.       <div style="display: block; border: 1 black solid; padding: 2pt; color: maroon; margin-bottom: 6pt;">
    17. 

  17.         <div><a name=""></a>
    18. 

  18.           <blockquote> 
    19. 

  19.             <kbd><b>dita</b></kbd>
    20. 

  20.             <kbd><b>--input=</b></kbd>
    21. 

  21.             <var>file</var>
    22. 

  22.             <kbd><b>--format=</b></kbd>
    23. 

  23.             <var>name</var>
    24. 

  24.              [ 
    25. 

  25.               <var>options</var>
    26. 

  26.              ] 
    27. 

  27.            </blockquote>
    28. 

  28.         </div>
    29. 

  29.         <div><a name=""></a>
    30. 

  30.           <blockquote> 
    31. 

  31.             <kbd><b>dita</b></kbd>
    32. 

  32.             <kbd><b>--install</b></kbd>
    33. 

  33.              [ { 
    34. 

  34.               <var>filename</var>
    35. 

  35.               <var> | URL</var>
    36. 

  36.              } ] 
    37. 

  37.            </blockquote>
    38. 

  38.         </div>
    39. 

  39.         <div><a name=""></a>
    40. 

  40.           <blockquote> 
    41. 

  41.             <kbd><b>dita</b></kbd>
    42. 

  42.             <kbd><b>--uninstall</b></kbd>
    43. 

  43.             <var>id</var>
    44. 

  44.            </blockquote>
    45. 

  45.         </div>
    46. 

  46.         <div><a name=""></a>
    47. 

  47.           <blockquote> 
    48. 

  48.             <kbd><b>dita</b></kbd>
    49. 

  49.             <kbd><b>--help</b></kbd>
    50. 

  50.            </blockquote>
    51. 

  51.         </div>
    52. 

  52.         <div><a name=""></a>
    53. 

  53.           <blockquote> 
    54. 

  54.             <kbd><b>dita</b></kbd>
    55. 

  55.             <kbd><b>--version</b></kbd>
    56. 

  56.            </blockquote>
    57. 

  57.         </div>
    58. 

  58.       </div>
    59. 

  59.       <div class="note note note_note"><span class="note__title">Note:</span> Most <span class="keyword cmdname">dita</span> command options support several syntax alternatives. All options can be
    60. 

  60.         specified with a GNU-style option keyword preceded by two hyphens. In many cases, Unix-style single-letter
    61. 

  61.         options (preceded by a single hyphen) are also available for backwards compatibility.</div>
    62. 

  62.     </section>
    63. 

  63.     <section class="section"><h2 class="title sectiontitle">Arguments</h2>
    64. 

  64.       
    65. 

  65.       <dl class="dl parml">
    66. 

  66.         
    67. 

  67.           <dt class="dt pt dlterm">
    68. 

  68.             <span class="keyword parmname">--input</span>=<var class="keyword varname">file</var></dt>
    69. 

  69.           <dt class="dt pt dlterm">
    70. 

  70.             <span class="keyword parmname">-i</span>
    71. 

  71.             <var class="keyword varname">file</var>
    72. 

  72.           </dt>
    73. 

  73.           <dd class="dd pd" id="dita-command-properties__args.input.desc">Specifies the master file for your documentation project. This argument corresponds
    74. 

  74.             to the common parameter <span class="keyword parmname">args.input</span>. Typically this is a DITA map, however it also can
    75. 

  75.             be a DITA topic if you want to transform a single DITA file. The path can be absolute, relative to
    76. 

  76.               <span class="keyword parmname">args.input.dir</span>, or relative to the current directory if
    77. 

  77.               <span class="keyword parmname">args.input.dir</span> is not defined.</dd>
    78. 

  78.         
    79. 

  79.         
    80. 

  80.           <dt class="dt pt dlterm">
    81. 

  81.             <span class="keyword parmname">--format</span>=<var class="keyword varname">name</var></dt>
    82. 

  82.           <dt class="dt pt dlterm">
    83. 

  83.             <span class="keyword parmname">-f</span>
    84. 

  84.             <var class="keyword varname">name</var>
    85. 

  85.           </dt>
    86. 

  86.           <dd class="dd pd">Specifies the output format (transformation type).</dd>
    87. 

  87.           <dd class="dd pd ddexpand">This argument corresponds to the common parameter <span class="keyword parmname">transtype</span>.</dd>
    88. 

  88.           <dd class="dd pd ddexpand">
    89. 

  89.             <div class="p">You can create plug-ins to add new output formats; by default, the following values are
    90. 

  90.                 available:
    91. 

  91.                 <ul class="ul">
    92. 

  92.                   <li class="li"><span class="keyword option">dita</span></li>
    93. 

  93.                   <li class="li"><span class="keyword option">eclipsehelp</span></li>
    94. 

  94.                   <li class="li"><span class="keyword option">html5</span></li>
    95. 

  95.                   <li class="li"><span class="keyword option">htmlhelp</span></li>
    96. 

  96.                   <li class="li"><span class="keyword option">markdown</span>, <span class="keyword option">markdown_gitbook</span>, and
    97. 

  97.                     <span class="keyword option">markdown_github</span></li>
    98. 

  98.                   <li class="li"><span class="keyword option">pdf</span></li>
    99. 

  99.                   <li class="li"><span class="keyword option">tocjs</span></li>
    100. 

  100.                   <li class="li"><span class="keyword option">troff</span></li>
    101. 

  101.                   <li class="li"><span class="keyword option">xhtml</span></li>
    102. 

  102.                 </ul>
    103. 

  103.               </div>
    104. 

  104.           </dd>
    105. 

  105.         
    106. 

  106.         
    107. 

  107.           <dt class="dt pt dlterm">
    108. 

  108.             <span class="keyword parmname">--install</span>&nbsp;<var class="keyword varname">filename</var></dt>
    109. 

  109.           <dt class="dt pt dlterm">
    110. 

  110.             <span class="keyword parmname">--install</span>&nbsp;<var class="keyword varname">URL</var></dt>
    111. 

  111.           <dd class="dd pd">Install a single plug-in from a local ZIP file or from a URL.</dd>
    112. 

  112.         
    113. 

  113.         
    114. 

  114.           <dt class="dt pt dlterm">
    115. 

  115.             <span class="keyword parmname">--install</span>
    116. 

  116.           </dt>
    117. 

  117.           <dd class="dd pd"><span class="ph">If no <var class="keyword varname">filename</var> or <var class="keyword varname">URL</var> argument is
    118. 

  118.                   provided, the installation process reloads the current set of plug-ins from the
    119. 

  119.                     <span class="ph filepath">plugins</span> directory. This approach can be used to add or remove multiple plug-ins
    120. 

  120.                   at once, or any individual plug-ins you have already copied to (or removed from) the
    121. 

  121.                     <span class="ph filepath">plugins</span> directory.</span></dd>
    122. 

  122.         
    123. 

  123.         
    124. 

  124.           <dt class="dt pt dlterm">
    125. 

  125.             <span class="keyword parmname">--uninstall</span>&nbsp;<var class="keyword varname">id</var>
    126. 

  126.           </dt>
    127. 

  127.           <dd class="dd pd">
    128. 

  128.             <p class="p">Uninstall a plug-in with the specified ID.</p>
    129. 

  129.             <div class="note attention note_attention"><span class="note__title">Attention:</span> The <span class="keyword parmname">--uninstall</span> option also
    130. 

  130.                   removes the corresponding subdirectory from the <span class="ph filepath">plugins</span> folder.</div>
    131. 

  131.           </dd>
    132. 

  132.         
    133. 

  133.         
    134. 

  134.           <dt class="dt pt dlterm">
    135. 

  135.             <span class="keyword parmname">--help</span></dt>
    136. 

  136.           <dt class="dt pt dlterm">
    137. 

  137.             <span class="keyword parmname">-h</span>
    138. 

  138.           </dt>
    139. 

  139.           <dd class="dd pd">Print command usage help.</dd>
    140. 

  140.         
    141. 

  141.         
    142. 

  142.           <dt class="dt pt dlterm">
    143. 

  143.             <span class="keyword parmname">--version</span>
    144. 

  144.           </dt>
    145. 

  145.           <dd class="dd pd">Print version information and exit.</dd>
    146. 

  146.         
    147. 

  147.       </dl>
    148. 

  148.     </section>
    149. 

  149.     <section class="section"><h2 class="title sectiontitle">Options</h2>
    150. 

  150.       
    151. 

  151.       <dl class="dl parml" id="dita-command-properties__dita_build_options">
    152. 

  152.         
    153. 

  153.           <dt class="dt pt dlterm">
    154. 

  154.             <span class="keyword parmname">--output</span>=<var class="keyword varname">dir</var></dt>
    155. 

  155.           <dt class="dt pt dlterm">
    156. 

  156.             <span class="keyword parmname">-o</span>
    157. 

  157.             <var class="keyword varname">dir</var>
    158. 

  158.           </dt>
    159. 

  159.           <dd class="dd pd" id="dita-command-properties__output.dir.desc">Specifies the path of the output directory; the path can be absolute or relative to
    160. 

  160.             the current directory. This argument corresponds to the common parameter <span class="keyword parmname">output.dir</span>. By
    161. 

  161.             default, the output is written to the <span class="ph filepath">out</span> subdirectory of the current directory.</dd>
    162. 

  162.         
    163. 

  163.         
    164. 

  164.           <dt class="dt pt dlterm">
    165. 

  165.             <span class="keyword parmname">--filter</span>=<var class="keyword varname">file</var>
    166. 

  166.           </dt>
    167. 

  167.           <dd class="dd pd">Specifies filter file(s) used to include, exclude, or flag content. </dd>
    168. 

  168.           <dd class="dd pd ddexpand">This argument corresponds to the common parameter <span class="keyword parmname">args.filter</span>. Relative paths are
    169. 

  169.             resolved against the current directory and internally converted to absolute paths.</dd>
    170. 

  170.         
    171. 

  171.         
    172. 

  172.           <dt class="dt pt dlterm">
    173. 

  173.             <span class="keyword parmname">--temp</span>=<var class="keyword varname">dir</var></dt>
    174. 

  174.           <dt class="dt pt dlterm">
    175. 

  175.             <span class="keyword parmname">-t</span>
    176. 

  176.             <var class="keyword varname">dir</var>
    177. 

  177.           </dt>
    178. 

  178.           <dd class="dd pd">Specifies the location of the temporary directory.</dd>
    179. 

  179.           <dd class="dd pd ddexpand">This argument corresponds to the common parameter <span class="keyword parmname">dita.temp.dir</span>.</dd>
    180. 

  180.         
    181. 

  181.         
    182. 

  182.           <dt class="dt pt dlterm">
    183. 

  183.             <span class="keyword parmname">--verbose</span></dt>
    184. 

  184.           <dt class="dt pt dlterm">
    185. 

  185.             <span class="keyword parmname">-v</span>
    186. 

  186.           </dt>
    187. 

  187.           <dd class="dd pd">Verbose logging.</dd>
    188. 

  188.         
    189. 

  189.         
    190. 

  190.           <dt class="dt pt dlterm">
    191. 

  191.             <span class="keyword parmname">--debug</span></dt>
    192. 

  192.           <dt class="dt pt dlterm">
    193. 

  193.             <span class="keyword parmname">-d</span>
    194. 

  194.           </dt>
    195. 

  195.           <dd class="dd pd">Debug logging.</dd>
    196. 

  196.         
    197. 

  197.         
    198. 

  198.           <dt class="dt pt dlterm">
    199. 

  199.             <span class="keyword parmname">--logfile</span>=<var class="keyword varname">file</var></dt>
    200. 

  200.           <dt class="dt pt dlterm">
    201. 

  201.             <span class="keyword parmname">-l</span>
    202. 

  202.             <var class="keyword varname">file</var>
    203. 

  203.           </dt>
    204. 

  204.           <dd class="dd pd">Write logging messages to a file.</dd>
    205. 

  205.         
    206. 

  206.         
    207. 

  207.           <dt class="dt pt dlterm">
    208. 

  208.             <span class="keyword parmname">--parameter</span>=<var class="keyword varname">value</var></dt>
    209. 

  209.           <dt class="dt pt dlterm">
    210. 

  210.             <span class="keyword parmname">-D</span><var class="keyword varname">parameter</var>=<var class="keyword varname">value</var>
    211. 

  211.           </dt>
    212. 

  212.           <dd class="dd pd">Specify a value for a DITA-OT or Ant build parameter.
    213. 

  213.             <p class="p">The GNU-style <span class="keyword parmname">--parameter</span>=<var class="keyword varname">value</var> form is only available for
    214. 

  214.               parameters that are configured in the plug-in configuration file; the Java-style <span class="keyword parmname">-D</span>
    215. 

  215.               form can also be used to specify additional non-configured parameters or set system properties.</p>
    216. 

  216.             <p class="p">Parameters not implemented by the specified transformation type or referenced in a
    217. 

  217.                 <span class="ph filepath">.properties</span> file are ignored.</p><div class="note tip note_tip"><span class="note__title">Tip:</span> If you are building in different environments where the location of the input
    218. 

  218.         files is not consistent, set <span class="keyword option">args.input.dir</span> with the <span class="keyword cmdname">dita</span> command and
    219. 

  219.         reference its value with <code class="ph codeph">${args.input.dir}</code> in your <span class="ph filepath">.properties</span>
    220. 

  220.         file.</div></dd>
    221. 

  221.         
    222. 

  222.         
    223. 

  223.           <dt class="dt pt dlterm">
    224. 

  224.             <span class="keyword parmname">--propertyfile</span>=<var class="keyword varname">file</var>
    225. 

  225.           </dt>
    226. 

  226.           <dd class="dd pd">Use build parameters defined in the referenced <span class="ph filepath">.properties</span> file.
    227. 

  227.             <p class="p">Build parameters specified on the command line override those set in the <span class="ph filepath">.properties</span>
    228. 

  228.               file.</p></dd>
    229. 

  229.         
    230. 

  230.       </dl>
    231. 

  231.     </section>
    232. 

  232.   </div>
    233. 

  233. <nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../parameters/index.html" title="You can adjust the behavior of the DITA Open Toolkit via dita command arguments and options, DITA-OT parameters settings, and configuration properties.">Setting DITA Open Toolkit parameters</a></div></div><div class="linklist relinfo reltasks"><strong>Related tasks</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../topics/build-using-dita-command.html" title="You can generate output using the DITA Open Toolkit dita command-line tool. Build parameters can be specified on the command line or with .properties files.">Building output using the dita command</a></li><li class="linklist"><a class="link" href="../topics/using-dita-properties-file.html" title="Usually, DITA builds require setting a number of parameters that do not change frequently. You can reference a set of build parameters defined in a .properties file when building output with the dita command. If needed, you can override any parameter by specifying it explicitly as an argument to the dita command.">Setting build parameters with .properties files</a></li></ul></div><div class="linklist relinfo relref"><strong>Related reference</strong><br><ul class="linklist"><li class="linklist"><a class="link" href="../parameters/parameters_intro.html" title="Certain parameters apply to all DITA-OT transformations. Other parameters are common to the HTML-based transformations. Some parameters apply only to specific transformation types. These parameters can be passed as options to the dita command using the --parameter=value syntax or included in build scripts as Ant properties.">DITA-OT parameters</a></li><li class="linklist"><a class="link" href="../parameters/internal-ant-properties.html" title="Reference list of Ant properties used by DITA-OT internally.">Internal Ant properties</a></li></ul></div></nav></article></main></body></html>
    234.