dita-command-help.dita 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  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 file for applicable license. -->
  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 passing the
  7. <parmname>--help</parmname> option on the command line.</shortdesc>
  8. <prolog>
  9. <metadata>
  10. <keywords>
  11. <indexterm>macOS<indexterm>help</indexterm></indexterm>
  12. <indexterm>Linux<indexterm>help</indexterm></indexterm>
  13. <indexterm>Windows<indexterm>help</indexterm></indexterm>
  14. <indexterm>command line<indexterm>help</indexterm></indexterm>
  15. <indexterm><cmdname>dita</cmdname> command<indexterm>help</indexterm></indexterm>
  16. </keywords>
  17. </metadata>
  18. </prolog>
  19. <taskbody>
  20. <steps>
  21. <step>
  22. <cmd conref="../resources/conref-task.dita#ID/open-terminal"/>
  23. </step>
  24. <step>
  25. <cmd>Issue the following command:</cmd>
  26. <choicetable frame="topbot" relcolwidth="1* 3*">
  27. <chrow platform="linux mac">
  28. <choption>Linux or macOS&#xA0;</choption>
  29. <chdesc>
  30. <cmdname>bin/dita</cmdname>
  31. <parmname>--help</parmname>
  32. </chdesc>
  33. </chrow>
  34. <chrow platform="windows">
  35. <choption>Windows</choption>
  36. <chdesc>
  37. <cmdname>bin\dita</cmdname>
  38. <parmname>--help</parmname>
  39. </chdesc>
  40. </chrow>
  41. </choicetable>
  42. <info>
  43. <note conref="../resources/conref-task.dita#ID/dita-in-path"/>
  44. </info>
  45. </step>
  46. </steps>
  47. <result>
  48. <p>A brief description of the supported parameters appears in the command-line window.</p>
  49. </result>
  50. </taskbody>
  51. </task>