Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Explain the --no-color parameter #525

Merged
merged 4 commits into from
Feb 3, 2024
Merged

Explain the --no-color parameter #525

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a93ada9
Explain the -no-color parameter.
stefan-jung Jan 26, 2024
bf6f7c2
Move no-color option to alpha sort; format to fix CI
infotexture Feb 3, 2024
bf18857
Use GNU-style double hyphen syntax for consistency
infotexture Feb 3, 2024
742fa1d
Clarify options for disabling colored log output
infotexture Feb 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions parameters/dita-command-arguments.dita
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -431,6 +431,12 @@
<pd>Verbose logging prints additional information to the console, including directory settings, effective
values for Ant properties, input/output files, and informational messages to assist in troubleshooting.</pd>
</plentry>
<plentry>
<pt>
<parmname>-no-color</parmname>
</pt>
<pd>By default, the DITA-OT outputs certain logging messages wrapped in special characters to get a colored output. If you prefer a clean output, you can set this parameter to deactivate the colored logging output.<codeblock>�[31m[move-meta] Failed to read file:/tmp/abc.dita: Failed to parse /tmp/abc.dita:Failed to read document: XML document structures must start and end within the same entity.�[0m</codeblock></pd>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you prefer a clean output

This makes it sound like the default is somehow "dirty", but what's happening here is that your terminal doesn't support colored output. Will rephrase this accordingly.

While we're at it, lets sort this alphabetically along with the rest of the listing.

</plentry>
</parml>
</section>
</refbody>
Expand Down
Loading