Explain the --no-color parameter (#525)

Merge pull request #525 from stefan-jung/no-color-parameter
dita-ot · Feb 3, 2024 · df50829 · df50829
2 parents ac0829b + 742fa1d
commit df50829
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/parameters/dita-command-arguments.dita b/parameters/dita-command-arguments.dita
@@ -342,6 +342,15 @@
           </pt>
           <pd>Write logging messages to a file.</pd>
         </plentry>
+        <plentry>
+          <pt>
+            <parmname>--no-color</parmname>
+          </pt>
+          <pd>By default, DITA-OT prints certain log messages to the console in color. In terminal environments that do
+            not support colored output, the ANSI color escape codes will be shown instead. To deactivate colored output,
+            pass the <parmname>--no-color</parmname> option to the <cmdname>dita</cmdname> command, or set the
+              <codeph>TERM=dumb</codeph> or <codeph>NO_COLOR</codeph> environment variables.</pd>
+        </plentry>
         <plentry>
           <pt>
             <parmname>--parameter</parmname>=<varname>value</varname></pt>