| 1234567891011121314151617181920212223242526272829303132333435363738 |
- <!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 2016"><meta name="DC.rights.owner" content="(C) Copyright 2016"><meta name="DC.Type" content="task"><meta name="description" content="You can access a list of supported parameters for the dita command by issuing the -help parameter."><meta name="DC.Relation" scheme="URI" content="../user-guide/troubleshooting-overview.html"><meta name="DC.Format" content="XHTML"><meta name="DC.Identifier" content="accessing-help-from-the-cl-tool"><link rel="stylesheet" type="text/css" href="../css/commonltr.css"><link rel="stylesheet" type="text/css" href="../css/dita-ot-doc.css"><title>Accessing help for the dita command</title></head><body id="accessing-help-from-the-cl-tool"><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 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><ul><li><a href="../user-guide/transforming-dita-content.html">Publishing DITA content</a></li><li><a href="../user-guide/AvailableTransforms.html">Output formats</a></li><li><a href="../user-guide/DITA_spec-support.html">DITA specification support</a></li><li><a href="../user-guide/DITA-globalization.html">Globalizing DITA content</a></li><li><a href="../user-guide/troubleshooting-overview.html">Troubleshooting</a><ul><li><a href="../user-guide/prerequisite-software.html">Prerequisite software</a></li><li><a href="../user-guide/DITA-messages.html">DITA-OT error messages</a></li><li><a href="../user-guide/other-errors.html">Other error messages</a></li><li><a href="../user-guide/log-files.html">Log files</a></li><li class="active"><a href="../user-guide/dita-command-help.html">Accessing help for the dita command</a></li><li><a href="../user-guide/determining-version-of-ditaot.html">Checking the DITA-OT version</a></li><li><a href="../user-guide/enabling-debug-mode.html">Enabling debug mode</a></li><li><a href="../user-guide/increasing-the-jvm.html">Increasing Java memory allocation</a></li><li><a href="../user-guide/reducing-processing-time.html">Reducing processing time</a></li></ul></li></ul></li><li><a href="../parameters/index.html">Parameter Reference</a></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">
- <h1 class="title topictitle1" id="ariaid-title1">Accessing help for the dita command</h1>
-
- <div class="body taskbody"><p class="shortdesc">You can access a list of supported parameters for the <span class="keyword cmdname">dita</span> command by issuing the
- <span class="keyword parmname">-help</span> parameter.</p>
- <div class="tasklabel"><h2 class="sectiontitle tasklabel">Procedure</h2></div><ol class="ol steps"><li class="li step stepexpand">
- <span class="ph cmd">Open a command prompt or terminal session, and then change to the directory where the
- DITA Open Toolkit is installed.</span>
- </li><li class="li step stepexpand">
- <span class="ph cmd">Issue the following command:</span>
- <table class="simpletable choicetable choicetableborder frame-topbot"><col style="width:25%"><col style="width:75%"><thead><tr class="sthead chhead"><th class="stentry choptionhd" id="d49556e36-option">Option</th><th class="stentry chdeschd" id="d49556e36-desc">Description</th></tr></thead><tbody><tr class="strow chrow">
- <th scope="row" class="stentry choption" headers="d49556e36-option">Linux or Mac OS X </th>
- <td class="stentry chdesc" headers="d49556e36-desc">
- <span class="keyword cmdname">bin/dita</span>
- <span class="keyword option">-help</span>
- </td>
- </tr><tr class="strow chrow">
- <th scope="row" class="stentry choption" headers="d49556e36-option">Windows</th>
- <td class="stentry chdesc" headers="d49556e36-desc">
- <span class="keyword cmdname">bin\dita</span>
- <span class="keyword option">-help</span>
- </td>
- </tr></tbody></table>
- <div class="itemgroup info">
- <div class="note tip note_tip"><span class="note__title tiptitle">Tip:</span> Add the absolute path for <span class="ph filepath"><var class="keyword varname">dita-ot-dir</var></span><span class="ph filepath">/bin</span> to the <var class="keyword varname">PATH</var> environment variable to run the
- <span class="keyword cmdname">dita</span> command from any location on the file system without typing the path.</div>
- </div>
- </li></ol>
- <section class="section result"><div class="tasklabel"><h2 class="sectiontitle tasklabel">Results</h2></div>
- <p class="p">A brief description of the supported parameters appears in the command-line window.</p>
- </section>
- </div>
- <nav role="navigation" class="related-links"><div class="familylinks"><div class="parentlink"><strong>Parent topic:</strong> <a class="link" href="../user-guide/troubleshooting-overview.html" title="This section contains information about problems that you might encounter and how to resolve them.">Error messages and troubleshooting</a></div></div></nav></article></main></body></html>
|
