You can use the Desktop Checker from your command line. These options are useful if you have content that you want to check but don't yet have an Acrolinx Integration to use in your editor. For example, you could write a script that activates a check from within your favorite XML editor. See the options in the following table.
Option |
Alias |
Type |
Description |
---|---|---|---|
|
|
boolean |
Show help. |
|
|
boolean |
Show version. |
|
|
string |
Select a file to open in the Desktop Checker. |
|
boolean |
Check a document when the Desktop Checker starts. Use it in combination with |
|
|
string |
Set a specific content format for checking. This is useful if you want to check a file with a nonstandard extension. |
|
|
string |
Refer to the section “Language Support“ on the Code Mirror website. |
|
|
|
string |
Set the default Acrolinx URL to use if connecting for the first time. |
On Windows, to start the Desktop Checker and run a check on a file, you might use:
"Acrolinx Desktop Checker.exe" --file "sample.txt" --check
On Mac, you might start the Desktop Checker and open a file with:
open "/Applications/Acrolinx Desktop Checker.app"/ -n -W --args --file sample.txt
On Linux (Ubuntu), you might start the Desktop Checker and open a file with:
acrolinxdesktopchecker -f sample.txt
Note
Keep in mind that on Linux the Desktop Checker is in the opt
folder.
Let's assume you would like set a specific content format for checking, in this case Markdown. You would use the following command:
On Windows, in C:\Program Files (x86)\Acrolinx\Desktop Checker
:
"Acrolinx Desktop Checker.exe" --check -f C:\tmp\02\MARKDOWNapiary.apib --content-format MARKDOWN
On Mac:
open "/Applications/Acrolinx Desktop Checker.app"/ -n -W --args --file apiary.apib --check --content-format MARKDOWN
On Linux (Ubuntu), in /opt/Acrolinx Desktop Checker
:
./acrolinxdesktopchecker --check -f test.apib --content-format MARKDOWN