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: 0b6fc7fd2b
Větve Značky
se
/
SE
/
stuff
/
dita-ot-2.3.3
/
doc
/
parameters
/
dita-command-arguments.html

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

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157 
  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 2016"><meta name="DC.rights.owner" content="(C) Copyright 2016"><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="../user-guide/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="../user-guide/build-using-dita-properties-file.html"><meta name="DC.Format" content="XHTML"><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 2.3</a></li><li><a href="../release-notes/index.html">Release Notes</a></li><li><a href="../getting-started/index.html">Getting Started</a></li><li><a href="../user-guide/index.html">User Guide</a></li><li><a href="../parameters/index.html">Parameter Reference</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="../dev_ref/index.html">Developer Reference</a></li><li><a href="../user-guide/dita-and-dita-ot-resources.html">DITA 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>-i</b></kbd>
    21. 

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

  22.             <kbd><b>-f</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.     </section>
    60. 

  60.     <section class="section"><h2 class="title sectiontitle">Arguments</h2>
    61. 

  61.       
    62. 

  62.       <dl class="dl parml">
    63. 

  63.         
    64. 

  64.           <dt class="dt pt dlterm"><span class="keyword parmname">-i</span>, <span class="keyword parmname">-input</span>
    65. 

  65.             <var class="keyword varname">file</var></dt>
    66. 

  66.           <dd class="dd pd" id="dita-command-properties__args.input.desc">Specifies the master file for your documentation project. Typically this is a DITA
    67. 

  67.             map, however it also can be a DITA topic if you want to transform a single DITA file. The path can be
    68. 

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

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

  70.         
    71. 

  71.         
    72. 

  72.           <dt class="dt pt dlterm"><span class="keyword parmname">-f</span>, <span class="keyword parmname">-format</span>
    73. 

  73.             <var class="keyword varname">name</var></dt>
    74. 

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

  75.         
    76. 

  76.         
    77. 

  77.           <dt class="dt pt dlterm"><span class="keyword parmname">-install</span>
    78. 

  78.             <var class="keyword varname">filename</var></dt>
    79. 

  79.           <dt class="dt pt dlterm"><span class="keyword parmname">-install</span>
    80. 

  80.             <var class="keyword varname">URL</var></dt>
    81. 

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

  82.         
    83. 

  83.         
    84. 

  84.           <dt class="dt pt dlterm"><span class="keyword parmname">-install</span></dt>
    85. 

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

  86.                   provided, the installation process reloads plug-ins from the <span class="ph filepath">plugins</span> directory.
    87. 

  87.                   This approach can be used to install multiple plug-ins at once, or install any individual plug-ins
    88. 

  88.                   you have already copied to the <span class="ph filepath">plugins</span> directory.</span></dd>
    89. 

  89.         
    90. 

  90.         
    91. 

  91.           <dt class="dt pt dlterm"><span class="keyword parmname">-uninstall</span>
    92. 

  92.             <var class="keyword varname">id</var></dt>
    93. 

  93.           <dd class="dd pd">Uninstall a plug-in with the specified ID.</dd>
    94. 

  94.         
    95. 

  95.         
    96. 

  96.           <dt class="dt pt dlterm"><span class="keyword parmname">-h</span>, <span class="keyword parmname">-help</span></dt>
    97. 

  97.           <dd class="dd pd">Print command usage help.</dd>
    98. 

  98.         
    99. 

  99.         
    100. 

  100.           <dt class="dt pt dlterm"><span class="keyword parmname">-version</span></dt>
    101. 

  101.           <dd class="dd pd">Print version information and exit.</dd>
    102. 

  102.         
    103. 

  103.       </dl>
    104. 

  104.     </section>
    105. 

  105.     <section class="section"><h2 class="title sectiontitle">Options</h2>
    106. 

  106.       
    107. 

  107.       <dl class="dl parml" id="dita-command-properties__dita_build_options">
    108. 

  108.         
    109. 

  109.           <dt class="dt pt dlterm"><span class="keyword parmname">-o</span>, <span class="keyword parmname">-output</span>
    110. 

  110.             <var class="keyword varname">dir</var></dt>
    111. 

  111.           <dd class="dd pd" id="dita-command-properties__output.dir.desc">Specifies the path of the output directory; the path can be
    112. 

  112.             absolute or relative to the current directory. By default, the output is written to the
    113. 

  113.               <span class="ph filepath">out</span> subdirectory of the current directory.</dd>
    114. 

  114.         
    115. 

  115.         
    116. 

  116.           <dt class="dt pt dlterm"><span class="keyword parmname">-filter</span>
    117. 

  117.             <var class="keyword varname">file</var></dt>
    118. 

  118.           <dd class="dd pd">Specifies a filter file to be used to include, exclude, or flag content.</dd>
    119. 

  119.         
    120. 

  120.         
    121. 

  121.           <dt class="dt pt dlterm"><span class="keyword parmname">-t</span>, <span class="keyword parmname">-temp</span>
    122. 

  122.             <var class="keyword varname">dir</var></dt>
    123. 

  123.           <dd class="dd pd">Specifies the location of the temporary directory.</dd>
    124. 

  124.         
    125. 

  125.         
    126. 

  126.           <dt class="dt pt dlterm"><span class="keyword parmname">-v</span>, <span class="keyword parmname">-verbose</span></dt>
    127. 

  127.           <dd class="dd pd">Verbose logging.</dd>
    128. 

  128.         
    129. 

  129.         
    130. 

  130.           <dt class="dt pt dlterm"><span class="keyword parmname">-d</span>, <span class="keyword parmname">-debug</span></dt>
    131. 

  131.           <dd class="dd pd">Debug logging.</dd>
    132. 

  132.         
    133. 

  133.         
    134. 

  134.           <dt class="dt pt dlterm"><span class="keyword parmname">-l</span>, <span class="keyword parmname">-logfile</span>
    135. 

  135.             <var class="keyword varname">file</var></dt>
    136. 

  136.           <dd class="dd pd">Write logging messages to a file.</dd>
    137. 

  137.         
    138. 

  138.         
    139. 

  139.           <dt class="dt pt dlterm"><span class="keyword parmname">-D</span><var class="keyword varname">parameter</var>=<var class="keyword varname">value</var></dt>
    140. 

  140.           <dd class="dd pd">Specify a value for a DITA-OT or Ant build parameter. <p class="p">Parameters not implemented by
    141. 

  141.               the specified transformation type or referenced in a <span class="ph filepath">.properties</span>
    142. 

  142.               file are ignored.</p><div class="note tip note_tip"><span class="note__title tiptitle">Tip:</span> If you are building in different environments where the location of the input
    143. 

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

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

  145.         file.</div></dd>
    146. 

  146.         
    147. 

  147.         
    148. 

  148.           <dt class="dt pt dlterm"><span class="keyword parmname">-propertyfile</span>
    149. 

  149.             <var class="keyword varname">file</var></dt>
    150. 

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

  151.               <p class="p">Build parameters specified on the command line override those set in the
    152. 

  152.                 <span class="ph filepath">.properties</span> file.</p></dd>
    153. 

  153.         
    154. 

  154.       </dl>
    155. 

  155.     </section>
    156. 

  156.   </div>
    157. 

  157. <nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../parameters/index.html" title="The Parameter Reference is designed to help users to locate information easily and quickly. It includes documentation for dita command arguments and options, DITA-OT parameters, and configuration properties.">DITA Open Toolkit Parameter Reference</a></div></div><div class="linklist linklist relinfo reltasks"><strong>Related tasks</strong><br><div><a class="link" href="../user-guide/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></div><div><a class="link" href="../user-guide/build-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></div></div><div class="linklist linklist relinfo relref"><strong>Related reference</strong><br><div><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 -Dparameter-name=value syntax or included in build scripts as Ant properties.">DITA-OT parameters</a></div><div><a class="link" href="../parameters/internal-ant-properties.html" title="Reference list of Ant properties used by DITA-OT internally.">Internal Ant properties</a></div></div></nav></article></main></body></html>
    158.