ACHECK.5(5)

✨ NAME ✨

.acheck — the acheck configuration file, bestie. (section 5 of the manual, for the record 💅)

---

🌸 DESCRIPTION 🌸

Okay so this is the config file for acheck. If it exists, it has to live at the top of your home directory, aka $HOME. That's the rule. This file is optional — unless you don't wanna use the default values, in which case, bestie, you need it.

Here's the vibe of how the file reads:

• Lines that start with a number sign (#) get ignored. So do empty lines.
• Spaces at the beginning and at the end of a line are ignored too, same with tabulators.
• If you do need spaces at the end or the beginning of a value, you can use apostrophes ("). 🫶
• An option line starts with its name, followed by a value.
• An equal sign is optional.
• A comment starts with the number sign — and there can be any number of spaces and/or tab stops in front of the #.

Some possible examples, fr fr:

# this line is ignored
option   value
option = value                               # this is a comment
option        "value ending with space   "

You have to escape number signs with a backslash (\) to use it in a value. No cap.

Default values are provided in square brackets — they should be suitable for most installations. ✨

---

🎀 SPELLING 🎀

Define if you want to use ispell for checking spelling, and how to use it.

• check_spelling — use Aspell for spelling if set to yes [yes]
• dictionary — language dictionary to use with Aspell, use default if empty [empty]
• word_letters — regular expression to define characters allowed to write a word, pattern matches according locale [\w]
• $review_mode — set to yes if you want review comments to be added in the output file after parsed line, otherwise just fix error [no]

---

🌈 COLORS 🌈

Set text colors for clear presentation. It's giving aesthetic. 💅

The recognized colors (all of which should be fairly intuitive) are: clear, reset, dark, bold, underline, underscore, blink, reverse, concealed, black, red, green, yellow, blue, magenta, cyan, white, on_black, on_red, on_green, on_yellow, on_blue, on_magenta, on_cyan, and on_white.

Case is not significant. underline and underscore are equivalent, and so are clear and reset — so use whichever is the most intuitive to you. The color alone sets the foreground color, and on_color sets the background color. Simple as that.

Heads up bestie: not all colors are supported by all terminal types, and some terminals may not support any of these sequences. dark, blink, and concealed in particular are frequently not implemented. 😭

• error_color — color used to highlight errors, this should highlight space characters [bold on_red]
• fix_color — color used to highlight suggestions, this should highlight space characters [bold on_green]
• error_head_color — color used to display the error line header [bold red]
• error_color — color used to display the suggestion line header [bold green]
• comment_color — color used for comments and hints [cyan]

Not me pointing out that error_color shows up twice in that list 🙈 — that's literally what the page says, so that's what you get.

---

🦋 OTHERS 🦋

• bak_ext — extension for backup files [bak]
• comment — comment string for review [>> ]
• debug — verbosity level [0]

⭐ Verbosity Levels ⭐

1. 0 quiet, normal — only warnings and errors
2. 1 debug — names of subroutines
3. 2 debug verbose — names and arguments of subroutines
4. 3 .. 5 debug very verbose — output parsing and checking details

---

👑 SEE ALSO 👑

acheck(1), acheck-rules(5)

---

💜 AUTHOR 💜

Nicolas Bertolissio <bertol@debian.org>

---

perl v5.24.1 · 2017-01-03 — that's the version and date, babe, and with that we're done. slay, go configure your acheck 💖✨🎀🦋🌸💅🫶