| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402 |
- <!DOCTYPE html
- SYSTEM "about:legacy-compat">
- <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 2020"><meta name="DC.rights.owner" content="(C) Copyright 2020"><meta name="DC.type" content="reference"><meta name="description" content="The dita command takes mandatory arguments to process DITA content. Subcommands can be used to manage plug-ins, or print information about the current configuration. A series of options are available to modify the command behavior or specify additional configuration parameters."><meta name="DC.subject" content="filters, command, dita, command, arguments list, arguments, installing, uninstalling, artlbl, args.artlbl"><meta name="keywords" content="filters, command, dita, command, arguments list, arguments, installing, uninstalling, artlbl, args.artlbl"><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">
- <p>DITA Open Toolkit</p>
- <hr>
- </div></header><nav role="toc"><ul><li><a href="../index.html">DITA Open Toolkit 3.5</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/building-output.html">Building output</a></li><li><a href="../topics/input-formats.html">Authoring formats</a></li><li><a href="../topics/output-formats.html">Output formats</a></li><li><a href="../parameters/index.html">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/html-customization.html">Customizing HTML</a></li><li><a href="../topics/pdf-customization.html">Customizing PDF</a></li><li><a href="../topics/adding-plugins.html">Adding plug-ins</a></li><li><a href="../topics/custom-plugins.html">Creating plug-ins</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">
- <h1 class="title topictitle1" id="ariaid-title1">Arguments and options for the <span class="keyword cmdname">dita</span> command</h1>
-
-
-
- <div class="body refbody"><p class="shortdesc">The <span class="keyword cmdname">dita</span> command takes mandatory arguments to process DITA content. Subcommands can be
- used to manage plug-ins, or print information about the current configuration. A series of options are available to
- modify the command behavior or specify additional configuration parameters.</p>
- <section class="section"><h2 class="title sectiontitle">Usage</h2>
-
- <p class="p">To convert content from one format to another, specify the file to transform and the desired output format. If
- necessary, you can set additional configuration parameters with options.</p>
- <div style="display: block; border: 1 black solid; padding: 2pt; color: maroon; margin-bottom: 6pt;">
- <div><a name=""></a>
- <blockquote>
- <kbd><b>dita</b></kbd>
- <kbd><b>--input</b></kbd>
- <kbd class="ph oper">=</kbd>
- <var>file</var>
- <kbd><b>--format</b></kbd>
- <kbd class="ph oper">=</kbd>
- <var>name</var>
- [
- <var>options</var>
- ]
- </blockquote>
- </div>
- <div><a name=""></a>
- <blockquote>
- <kbd><b>dita</b></kbd>
- <kbd><b>--project</b></kbd>
- <kbd class="ph oper">=</kbd>
- <var>file</var>
- [
- <var>options</var>
- ]
- </blockquote>
- </div>
- </div>
- <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
- specified with a GNU-style option keyword preceded by two hyphens. In many cases, Unix-style single-letter
- options (preceded by a single hyphen) are also available for brevity and backwards compatibility.</div>
- <p class="p">The <span class="keyword cmdname">dita</span> command also supports a series of subcommands that can be used to manage plug-ins,
- or print information about the current configuration or version.</p>
- <div style="display: block; border: 1 black solid; padding: 2pt; color: maroon; margin-bottom: 6pt;">
- <div><a name=""></a>
- <blockquote>
- <kbd><b>dita</b></kbd>
- <kbd><b>deliverables</b></kbd>
- <var>file</var>
- </blockquote>
- </div>
- <div><a name=""></a>
- <blockquote>
- <kbd><b>dita</b></kbd>
- <kbd><b>install</b></kbd>
- [ {
- <var>ID</var>
- <var> | URL</var>
- <var> | file</var>
- } ]
- </blockquote>
- </div>
- <div><a name=""></a>
- <blockquote>
- <kbd><b>dita</b></kbd>
- <kbd><b>plugins</b></kbd>
- </blockquote>
- </div>
- <div><a name=""></a>
- <blockquote>
- <kbd><b>dita</b></kbd>
- <kbd><b>transtypes</b></kbd>
- </blockquote>
- </div>
- <div><a name=""></a>
- <blockquote>
- <kbd><b>dita</b></kbd>
- <kbd><b>uninstall</b></kbd>
- <var>ID</var>
- </blockquote>
- </div>
- <div><a name=""></a>
- <blockquote>
- <kbd><b>dita</b></kbd>
- <kbd><b>version</b></kbd>
- </blockquote>
- </div>
- </div>
- <div class="note attention note_attention"><span class="note__title">Attention:</span> Prior to DITA-OT 3.5, subcommands were specified with the double-hyphen option syntax,
- which is still supported for backwards compatibility. (For example, <span class="keyword cmdname">dita</span>
- <span class="keyword parmname">--install</span> will still work.)</div>
- </section>
- <section class="section"><h2 class="title sectiontitle">Arguments</h2>
-
-
-
-
-
- <p class="p">Each transformation requires you to specify at least the file to transform and the desired output format.</p>
- <dl class="dl parml">
-
- <dt class="dt pt dlterm">
- <span class="keyword parmname">--input</span>=<var class="keyword varname">file</var></dt>
- <dt class="dt pt dlterm">
- <span class="keyword parmname">-i</span>
- <var class="keyword varname">file</var>
- </dt>
- <dd class="dd pd" id="dita-command-properties__args.input.desc">Specifies the master file for your documentation project. This argument corresponds
- to the common parameter <span class="keyword parmname">args.input</span>. Typically this is a DITA map, however it also can
- be a DITA topic if you want to transform a single DITA file. The path can be absolute, relative to
- <span class="keyword parmname">args.input.dir</span>, or relative to the current directory if
- <span class="keyword parmname">args.input.dir</span> is not defined.</dd>
-
-
- <dt class="dt pt dlterm">
- <span class="keyword parmname">--format</span>=<var class="keyword varname">name</var></dt>
- <dt class="dt pt dlterm">
- <span class="keyword parmname">-f</span>
- <var class="keyword varname">name</var>
- </dt>
- <dd class="dd pd">Specifies the output format (transformation type).</dd>
- <dd class="dd pd ddexpand">This argument corresponds to the common parameter <span class="keyword parmname">transtype</span>.</dd>
- <dd class="dd pd ddexpand">To list the formats that are currently available in your environment, use <span class="keyword cmdname">dita
- transtypes</span>.</dd>
- <dd class="dd pd ddexpand">
- <div class="p">You can create plug-ins to add new output formats; by default, the following values are
- available:
-
- <ul class="ul">
- <li class="li"><span class="keyword option">dita</span></li>
- <li class="li"><span class="keyword option">eclipsehelp</span></li>
- <li class="li"><span class="keyword option">html5</span></li>
- <li class="li"><span class="keyword option">htmlhelp</span></li>
- <li class="li"><span class="keyword option">markdown</span>, <span class="keyword option">markdown_gitbook</span>, and
- <span class="keyword option">markdown_github</span></li>
- <li class="li"><span class="keyword option">pdf</span></li>
- <li class="li"><span class="keyword option">xhtml</span></li>
- </ul>
- <div class="note tip note_tip"><span class="note__title">Tip:</span> See
- <a class="xref" href="../topics/output-formats.html" title="DITA Open Toolkit ships with several core transformations that convert DITA content to different output formats. Additional formats are available from the plug-in registry at dita-ot.org/plugins.">DITA-OT transformations (output formats)</a> for sample command line syntax and more information on each
- transformation. </div>
- </div>
- </dd>
-
- </dl>
- </section>
- <section class="section"><h2 class="title sectiontitle">Subcommands</h2>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dl class="dl parml">
-
- <dt class="dt pt dlterm">
- <span class="keyword parmname">deliverables</span>
- <var class="keyword varname">file</var></dt>
- <dd class="dd pd">Show a list of the available deliverables in the specified project <var class="keyword varname">file</var>.</dd>
-
-
- <dt class="dt pt dlterm">
- <span class="keyword parmname">install</span>
- <var class="keyword varname">{ ID | URL | file }</var></dt>
- <dt class="dt pt dlterm">
- <span class="keyword parmname">--install</span>=<var class="keyword varname">{ ID | URL | file }</var></dt>
- <dd class="dd pd">Install a single plug-in <var class="keyword varname">ID </var>from the registry at
- <a class="xref" href="https://www.dita-ot.org/plugins" target="_blank" rel="external noopener">dita-ot.org/plugins</a> (or a local registry), from a remote <var class="keyword varname">URL</var>, or a
- local ZIP <var class="keyword varname">file</var>.</dd>
-
-
- <dt class="dt pt dlterm">
- <span class="keyword parmname">install</span>
- </dt>
- <dt class="dt pt dlterm">
- <span class="keyword parmname">--install</span>
- </dt>
- <dd class="dd pd"><span class="ph">If no <var class="keyword varname">ID</var>, <var class="keyword varname">URL</var>, or
- <var class="keyword varname">file</var> argument is provided, the installation process reloads the current set of
- plug-ins from the <span class="ph filepath">plugins</span> directory. This approach can be used to add or remove
- multiple plug-ins at once, or any individual plug-ins you have already copied to (or removed from) the
- <span class="ph filepath">plugins</span> directory. Any plug-ins added or removed in the process will be listed
- by their plug-in ID.</span></dd>
-
-
- <dt class="dt pt dlterm">
- <span class="keyword parmname">uninstall</span>
- <var class="keyword varname">ID</var>
- </dt>
- <dt class="dt pt dlterm">
- <span class="keyword parmname">--uninstall</span>=<var class="keyword varname">ID</var>
- </dt>
- <dd class="dd pd">
- <p class="p">Remove the plug-in with the specified <var class="keyword varname">ID</var>.</p>
- </dd>
- <dd class="dd pd ddexpand">For a list of the currently installed plug-in IDs, use <span class="keyword cmdname">dita plugins</span>.</dd>
- <dd class="dd pd ddexpand">
- <div class="note attention note_attention"><span class="note__title">Attention:</span> The <span class="keyword cmdname">uninstall</span> subcommand also
- removes the corresponding plug-in directory from the <span class="ph filepath">plugins</span> folder.
- </div>
- </dd>
-
-
- <dt class="dt pt dlterm">
- <span class="keyword parmname">plugins</span>
- </dt>
- <dt class="dt pt dlterm">
- <span class="keyword parmname">--plugins</span>
- </dt>
- <dd class="dd pd">Show a list of the currently installed plug-ins.</dd>
-
-
- <dt class="dt pt dlterm">
- <span class="keyword parmname">transtypes</span>
- </dt>
- <dt class="dt pt dlterm">
- <span class="keyword parmname">--transtypes</span>
- </dt>
- <dd class="dd pd">Show a list of the available output formats (transformation types).</dd>
- <dd class="dd pd ddexpand">The entries in this list may be passed as values to the <span class="keyword parmname">--format</span> argument.</dd>
-
-
- <dt class="dt pt dlterm">
- <span class="keyword parmname">version</span>
- </dt>
- <dt class="dt pt dlterm">
- <span class="keyword parmname">--version</span>
- </dt>
- <dd class="dd pd">Print version information and exit.</dd>
-
- </dl>
- </section>
- <section class="section"><h2 class="title sectiontitle">Options</h2>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dl class="dl parml" id="dita-command-properties__dita_build_options">
-
- <dt class="dt pt dlterm">
- <span class="keyword parmname">--debug</span></dt>
- <dt class="dt pt dlterm">
- <span class="keyword parmname">-d</span>
- </dt>
- <dd class="dd pd">Debug logging prints considerably more additional information. The debug log includes all information from
- the verbose log, plus details on Java classes, additional Ant properties and overrides, preprocessing
- filters, parameters, and stages, and the complete build sequence. Debug logging requires additional
- resources and can slow down the build process, so it should only be enabled when further details are
- required to diagnose problems.</dd>
-
-
- <dt class="dt pt dlterm">
- <span class="keyword parmname">--output</span>=<var class="keyword varname">dir</var></dt>
- <dt class="dt pt dlterm">
- <span class="keyword parmname">-o</span>
- <var class="keyword varname">dir</var>
- </dt>
- <dd class="dd pd" id="dita-command-properties__output.dir.desc">
- <p class="p">Specifies the path of the output directory; the path can be absolute or relative to the current
- directory.</p>
- <p class="p">This argument corresponds to the common parameter <span class="keyword parmname">output.dir</span>. By default, the output
- is written to the <span class="ph filepath">out</span> subdirectory of the current directory.</p>
- </dd>
-
-
- <dt class="dt pt dlterm">
- <span class="keyword parmname">--filter</span>=<var class="keyword varname">files</var>
- </dt>
- <dd class="dd pd">Specifies filter file(s) used to include, exclude, or flag content. </dd>
- <dd class="dd pd ddexpand">
- <p class="p">This argument corresponds to the common parameter <span class="keyword parmname">args.filter</span>. Relative paths are
- resolved against the current directory and internally converted to absolute paths.</p>
- <div class="note note note_note"><span class="note__title">Note:</span>
- <p class="p">To specify multiple filter files, use the system path separator character to delimit individual file
- paths (semicolon ‘<code class="ph codeph">;</code>’ on Windows, and colon ‘<code class="ph codeph">:</code>’ on macOS and Linux) and
- wrap the value in quotes:</p>
- <p class="p"><code class="ph codeph">--filter="filter1.ditaval;filter2.ditaval;filter3.ditaval"</code></p>
- <p class="p">DITAVAL files are evaluated in the order specified, so conditions specified in the first file take
- precedence over matching conditions specified in later files, just as conditions at the start of a
- DITAVAL document take precedence over matching conditions later in the same document.</p>
- </div>
- </dd>
-
-
- <dt class="dt pt dlterm">
- <span class="keyword parmname">--force</span>
- </dt>
- <dd class="dd pd">Force-install an existing plug-in.</dd>
- <dd class="dd pd ddexpand">Passed as an additional option to the installation subcommand: <span class="keyword cmdname">dita
- install</span> <var class="keyword varname">plug-in-zip</var> <span class="keyword parmname">--force</span></dd>
-
-
- <dt class="dt pt dlterm">
- <span class="keyword parmname">--help</span></dt>
- <dt class="dt pt dlterm">
- <span class="keyword parmname">-h</span>
- </dt>
- <dd class="dd pd">Print a list of available arguments, options, and subcommands.</dd>
-
-
- <dt class="dt pt dlterm">
- <span class="keyword parmname">--logfile</span>=<var class="keyword varname">file</var></dt>
- <dt class="dt pt dlterm">
- <span class="keyword parmname">-l</span>
- <var class="keyword varname">file</var>
- </dt>
- <dd class="dd pd">Write logging messages to a file.</dd>
-
-
- <dt class="dt pt dlterm">
- <span class="keyword parmname">--parameter</span>=<var class="keyword varname">value</var></dt>
- <dt class="dt pt dlterm">
- <span class="keyword parmname">-D</span><var class="keyword varname">parameter</var>=<var class="keyword varname">value</var>
- </dt>
- <dd class="dd pd">Specify a value for a DITA-OT or Ant build parameter.
- <p class="p">The GNU-style <span class="keyword parmname">--parameter</span>=<var class="keyword varname">value</var> form is only available for
- parameters that are configured in the plug-in configuration file; the Java-style <span class="keyword parmname">-D</span>
- form can also be used to specify additional non-configured parameters or set system properties.</p>
- <p class="p">Parameters not implemented by the specified transformation type or referenced in a
- <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
- files is not consistent, set <span class="keyword option">args.input.dir</span> with the <span class="keyword cmdname">dita</span> command and
- reference its value with <code class="ph codeph">${args.input.dir}</code> in your <span class="ph filepath">.properties</span> file.
-
-
- </div></dd>
-
-
- <dt class="dt pt dlterm">
- <span class="keyword parmname">--propertyfile</span>=<var class="keyword varname">file</var>
- </dt>
- <dd class="dd pd">Use build parameters defined in the referenced <span class="ph filepath">.properties</span> file.
- <p class="p">Build parameters specified on the command line override those set in the <span class="ph filepath">.properties</span>
- file.</p></dd>
-
-
- <dt class="dt pt dlterm">
- <span class="keyword parmname">--resource</span>=<var class="keyword varname">file</var>
- </dt>
- <dt class="dt pt dlterm">
- <span class="keyword parmname">-r</span>
- <var class="keyword varname">file</var>
- </dt>
- <dd class="dd pd">Process input with additional resources.
- <div class="p">For example, to process a single topic file with a map that contains key definitions, use a command like
- this:
- <pre class="pre codeblock"><code><span class="keyword cmdname">dita</span> <span class="keyword parmname">--input</span>=<span class="ph filepath">topic.dita</span> <span class="keyword parmname">--resource</span>=<span class="ph filepath">keys.ditamap</span> <span class="keyword parmname">--format</span>=<span class="keyword option">html5</span></code></pre>
- </div></dd>
-
-
- <dt class="dt pt dlterm">
- <span class="keyword parmname">--temp</span>=<var class="keyword varname">dir</var></dt>
- <dt class="dt pt dlterm">
- <span class="keyword parmname">-t</span>
- <var class="keyword varname">dir</var>
- </dt>
- <dd class="dd pd">Specifies the location of the temporary directory.</dd>
- <dd class="dd pd ddexpand">This argument corresponds to the common parameter <span class="keyword parmname">dita.temp.dir</span>.</dd>
-
-
- <dt class="dt pt dlterm">
- <span class="keyword parmname">--verbose</span></dt>
- <dt class="dt pt dlterm">
- <span class="keyword parmname">-v</span>
- </dt>
- <dd class="dd pd">Verbose logging prints additional information to the console, including directory settings, effective
- values for Ant properties, input/output files, and informational messages to assist in troubleshooting.</dd>
-
- </dl>
- </section>
- </div>
- <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 DITA Open Toolkit behavior via dita command arguments and options, DITA-OT parameter settings, and configuration properties.">DITA Open Toolkit parameters</a></div></div><div class="linklist 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 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 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>
|