.TH "md_src_plugins_filecheck_README" 3elektra "Sun May 29 2016" "Version 0.8.14" "Elektra" \" -*- nroff -*-
.ad l
.nh
.SH NAME
md_src_plugins_filecheck_README \- README 

.IP "\(bu" 2
infos = Information about the filecheck plugin is in keys below
.IP "\(bu" 2
infos/author = Thomas Waser thomas.waser@libelektra.org
.IP "\(bu" 2
infos/licence = BSD
.IP "\(bu" 2
infos/needs =
.IP "\(bu" 2
infos/provides =
.IP "\(bu" 2
infos/placements = pregetstorage precommit
.IP "\(bu" 2
infos/description =
.PP
.PP
The filecheck plugin validates files\&. It tests: encoding, lineendings, BOM, printable characters and null bytes\&.
.PP
.SS "Configuration"
.PP
\fCcheck/lineending\fP \fCvalid/lineending\fP When the \fCcheckLE\fP key is present, the plugin checks the file for consistent line endings\&. If you want to validate for a specific line ending you can supply it with the \fCvalidLE\fP key\&. Valid values are: \fCCR\fP, \fCLF\fP, \fCCRLF\fP, \fCLFCR\fP\&.
.PP
\fCcheck/encoding\fP \fCvalid/encoding\fP When the \fCcheckEncoding\fP key is present, the plugin validates the file encoding supplied by the key \fCencoding\fP, or, if not present, defaults to \fCUTF-8\fP
.PP
\fCreject/null\fP When the \fCrejectNull\fP key is present, the plugin rejects the file if a NULL-Byte is found\&.
.PP
\fC/reject/bom\fP When the \fCrejectBom\fP key is present, the plugin rejects the file if any BOM markers are found\&.
.PP
\fC/reject/unprintable\fP When the \fCrejectUnprintable\fP key is preset, the plugin rejects the file if an unprintable character is present (except \fC\\r\fP and \fC\\n\fP)\&.