Commands¶
RedPen provides not only a simple command line tool but also a server.
Command line tool¶
RedPen provides a simple command to check input document named ‘redpen’.
Usage: redpen¶
We use redpen command as follows.
$redpen [options] input-files
In the above usage, input files is spaces splitted, and redpen has the following supported options.
Options¶
redpen has the following options.
-
-c<CONFIG_FILE>,--configuration<CONFIG_FILE>¶ Configuration file for RedPen
-
-f<INPUT_FORMAT>,--input_format<INPUT_FORMAT>¶ Input file format. [Default: plain]
The argument of this option represents the input format. Currently RedPen supports the following formatts.
Value Description plain Plain text format wiki Wiki (Textile) format markdown Markdown format
Note
RedPen does not support all the elements of wiki format such as tables. The remaining elements would be supported in near future.
-
-r<RESULT_FORMAT>,--result_format<RESULT_FORMAT>¶ Result format. [Default: plain]
The argument of this option represents the output format. Currently RedPen supports the following output formatts.
Value Description plain plain text format xml xml format json json format
-
-h,--help¶ Show help messages.
-
--version¶ Show the vesrion.
Sample server¶
RedPen also provides a sample server.