1ACHECK.5(8)           User Contributed Perl Documentation          ACHECK.5(8)
2
3
4

NAME

6       .acheck - Acheck configuration file
7

DESCRIPTION

9       This is the configuration file for acheck. If it exists, it must be at
10       the top of your home directory ($HOME). This file is optional unless
11       you don't want to use default values.
12
13       Lines beginning with a number sign (`#') and empty lines will be
14       ignored.  Spaces at the beginning and the end of a line will also be
15       ignored as well as tabulators.  If you need spaces at the end or the
16       beginning of a value you can use apostrophes (`"').  An option line
17       starts with it's name followed by a value. An equal sign is optional.
18       A comment starts with the number sign, there can be any number of
19       spaces and/or tab stops in front of the #.  Some possible examples:
20
21        # this line is ignored
22        option   value
23        option = value                               # this is a comment
24        option        "value ending with space   "
25
26       You have to escape number signs with a backslash (`\') to use it in a
27       value.
28
29       Default values are provided into square brackets, they should be
30       suitable for most installations.
31

SPELLING

33       Define if you want to use ispell for checking spelling and how to use
34       it.
35
36       check_spelling
37           use Aspell for spelling if set to `yes' [yes]
38
39       dictionary
40           Language dictionary to use with Aspell, use default if empty
41           [empty]
42
43       word_letters
44           regular expression to define characters allowed to write a word,
45           pattern matches according locale [\w]
46
47       $review_mode
48           set to `yes' if you want review comments to be added in the output
49           file after parsed line, otherwise just fix error [no]
50

COLORS

52       Set text colors for clear presentation.
53
54       The recognized colors (all of which should be fairly intuitive) are:
55       clear, reset, dark, bold, underline, underscore, blink, reverse,
56       concealed, black, red, green, yellow, blue, magenta, cyan, white,
57       on_black, on_red, on_green, on_yellow, on_blue, on_magenta, on_cyan,
58       and on_white.  Case is not significant.  Underline and underscore are
59       equivalent, as are clear and reset, so use whichever is the most
60       intuitive to you.  The color alone sets the foreground color, and
61       on_color sets the background color.
62
63       Note that not all colors are supported by all terminal types, and some
64       terminals may not support any of these sequences.  Dark, blink, and
65       concealed in particular are frequently not implemented.
66
67       error_color
68           color used to highlight errors, this should highlight space
69           characters [bold on_red]
70
71       fix_color
72           color used to highlight suggestions, this should highlight space
73           characters [bold on_green]
74
75       error_head_color
76           color used to display the error line header [bold red]
77
78       error_color
79           color used to display the suggestion line header [bold green]
80
81       comment_color
82           color used for comments and hints [cyan]
83

OTHERS

85       bak_ext
86           extension for backup files [bak]
87
88       comment
89           comment string for review [>> ]
90
91       debug
92           verbosity level [0]
93
94       Verbosity Levels:
95
96       0 quiet, normal
97           only warnings and errors
98
99       1 debug
100           names of subroutines
101
102       2 debug verbose
103           names and arguments of subroutines
104
105       3 .. 5 debug very verbose
106           output parsing and checking details
107

SEE ALSO

109       acheck(1), acheck-rules(5)
110

AUTHOR

112       Nicolas Bertolissio <bertol@debian.org>
113
114
115
116perl v5.10.0                      2003-10-05                       ACHECK.5(8)