Before this change, USAGE.md talked about “main.exe”. In Descent 3
v1.4.0, there was indeed an executable named MAIN.EXE. However, that
executable was renamed to Descent3.exe in v1.5.0.
Before this change, the documentation for -logfile did not format its
code spans correctly. Specifically, it used back ticks to create code
spans. Unfortunately, you can’t create code spans using back ticks if
the code spans are embedded in an HTML block. This change fixes the
formatting by replacing the back ticks with <code> and </code>.
This commit takes all of the command-line options documentation from the
wiki [1] and merges it with the command-line options documentation
that’s in USAGE.md. This change will eventually allow us to remove the
command-line options documentation from the wiki so that we only have
one list of command-line options instead of two.
Before this change, USAGE.md used a Markdown table and the wiki used an
HTML table. I ended up replacing the Markdown table in USAGE.md with an
HTML table because it was easier to copy and paste the HTML table from
the wiki than to convert the HTML table from the wiki into a Markdown
table.
The main motivation behind this change is to make it easier to create a
future commit. That future commit will add documentation for the
-additionaldir command-line option. Making sure that there’s only one
list of command-line options instead of two will make it so that
-additionaldir doesn’t need to be documented in two different places.
This is related #618, but it doesn’t fully fix that issue.
[1]: <https://github.com/DescentDevelopers/Descent3/wiki/Running-Descent-3#command-line-options>
Before this change, the documentation for the command-line options that
take arguments was inconsistent. There was a <placeholder> in the
“option” cell for almost all of the command-line options that take
arguments. -display was the only command-line option that takes
arguments that didn’t have a <placeholder>. This change makes the
documentation more consistent by ensuring that all command-line options
that take arguments have <placeholders>.
The new command line option -display lets the user select the display on
which Descent 3 should be displayed.
This is useful in multi-monitor setups where the game now can be run on any of
the given monitors.
