dita2troff.dita 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
  3. <!-- This file is part of the DITA Open Toolkit project. See the accompanying LICENSE file for applicable license. -->
  4. <concept id="dita2troff" xml:lang="en-US">
  5. <title>troff</title>
  6. <shortdesc>The <option>troff</option> transformation produces output for use with the troff viewer on Unix-style
  7. platforms, particularly for programs such as the man page viewer.</shortdesc>
  8. <prolog>
  9. <metadata>
  10. <keywords>
  11. <indexterm>tables<indexterm><xmlelement>table</xmlelement></indexterm></indexterm>
  12. <indexterm><xmlelement>simpletable</xmlelement></indexterm>
  13. <indexterm>UNIX</indexterm>
  14. <indexterm>transformations<indexterm>troff</indexterm></indexterm>
  15. <indexterm>troff<index-see-also>transformations</index-see-also></indexterm>
  16. <indexterm>plug-ins<indexterm>dita2troff</indexterm></indexterm>
  17. <indexterm>dita2troff</indexterm>
  18. </keywords>
  19. </metadata>
  20. </prolog>
  21. <conbody>
  22. <p>Each DITA topic generally produces one troff output file. The <option>troff</option> transformation supports most
  23. common DITA structures, but it does not support <xmlelement>table</xmlelement> or
  24. <xmlelement>simpletable</xmlelement> elements. Most testing of troff output was performed using the Cygwin Linux
  25. emulator.</p>
  26. <p>To run the troff transformation, set the <parmname>transtype</parmname> parameter to <option>troff</option>, or
  27. pass the <parmname>--format</parmname>=<option>troff</option> option to the <cmdname>dita</cmdname> command
  28. line.</p>
  29. <codeblock><filepath conref="../resources/conref-task.dita#ID/dita-cmd"/> <parmname>--input</parmname>=<varname>input-file</varname> <parmname>--format</parmname>=<option>troff</option></codeblock>
  30. <p>where:</p>
  31. <ul>
  32. <li conref="../resources/conref-task.dita#ID/novice-variables-1"
  33. conrefend="../resources/conref-task.dita#ID/novice-variables-2"/>
  34. </ul>
  35. </conbody>
  36. </concept>