This program parses a file checking for syntax rules and optionally asking
Aspell for checking word spelling. It makes fix suggestions and outputs a
corrected file accordingly adding review comments if requested.
It tries to find the file type according to the extension or the first lines
and loads rules accordingly.
It displays lines when they are parse.
When an error is found, a menu is displayed. Just press Enter if you don't want
to change anything. If a choice suits you, enter the corresponding number. If
you want to fix it but no choice is correct, enter a space, then you will be
asked for a string to replace the highlighted text. The script will replace the
highlighted text with your choice and parse it again for new errors.
Here are all the available commands:
"Enter,
Ignore.
"Ctrl+L,
Rewrite the last line, suggestions and hints.
"Space,
Edit the highlighted text.
"E,
Edit the whole line.
"H,
Add the displayed hint as review comment. Use this if you want the translator
to see the corresponding warning or error but you have no correction.
"N,
Skip the rest of this line.
"X,
Quit without saving modifications, the script ask you for confirmation, you
have to enter `yes' to exit otherwise parsing starts again at the current
mistake.
"a,
Add the highlighted word to you personal dictionary, capitalized as it is.
"l,
Lowercase the highlighted word to add it to your personal dictionary.
"i,
Ignore the highlighted word, same as Enter.
"I,
Ignore the highlighted word and add it to your session dictionary.
OPTIONS
Verbosity level:
"-q,
quiet mode.
"-v"
verbose, start at level $Debug + 1, add more for more verbosity (see below).
"--verbose
set verbosity level to n (see below).
Files:
"-i,
input filename, can be '-' to read data from standard input.
"-o,
output filename, can be '-' to write data to standard ouput. If no output
filename is provided, input file is backed up with `bak_ext' extension and
input filename is used.
Spell check:
"-s,
check spelling with Aspell.
"-d
use language dictionary for Aspell.
"-n,
don't check spelling.
Mode:
"-r,
review mode, add comments on lines beginning with $Comment after parsed
line.
"-t,
translator mode, don't add comments, just fix errors.
others:
"--rules
use ruleset rules set.
"--type
use filetype whatever the file type is.
"--dump"
Dump the rules to check and exit, use this for debugging purposes.
