dita-command-help.dita 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  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.md file for applicable licenses.-->
  4. <task id="accessing-help-from-the-cl-tool">
  5. <title>Accessing help for the dita command</title>
  6. <shortdesc>You can access a list of supported parameters for the <cmdname>dita</cmdname> command by issuing the
  7. <parmname>-help</parmname> parameter.</shortdesc>
  8. <taskbody>
  9. <steps>
  10. <step>
  11. <cmd conref="../resources/conref-task.dita#ID/open-terminal"/>
  12. </step>
  13. <step>
  14. <cmd>Issue the following command:</cmd>
  15. <choicetable frame="topbot" relcolwidth="1.0* 3.0*">
  16. <chrow platform="linux osx">
  17. <choption>Linux or Mac OS&#xA0;X&#xA0;</choption>
  18. <chdesc>
  19. <cmdname>bin/dita</cmdname>
  20. <option>-help</option>
  21. </chdesc>
  22. </chrow>
  23. <chrow platform="windows">
  24. <choption>Windows</choption>
  25. <chdesc>
  26. <cmdname>bin\dita</cmdname>
  27. <option>-help</option>
  28. </chdesc>
  29. </chrow>
  30. </choicetable>
  31. <info>
  32. <note conref="../resources/conref-task.dita#ID/dita-in-path"/>
  33. </info>
  34. </step>
  35. </steps>
  36. <result>
  37. <p>A brief description of the supported parameters appears in the command-line window.</p>
  38. </result>
  39. </taskbody>
  40. </task>