dita-command-help.dita 2.0 KB

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