ikiwiki (3.20130711) unstable; urgency=low
[ikiwiki.git] / doc / plugins / filecheck.mdwn
1 [[!template id=plugin name=filecheck core=0 author="[[Joey]]"]]
2 [[!tag type/special-purpose]]
3
4 This plugin enhances the regular [[ikiwiki/PageSpec]] syntax with
5 some additional tests, for things like file size, mime type, and virus
6 status. These tests are mostly useful for the [[attachment]] plugin, and
7 are documented [[here|ikiwiki/pagespec/attachment]].
8
9 This plugin will use the [[!cpan File::MimeInfo::Magic]] perl module, if
10 available, for mimetype checking. It falls back to using the `file` command
11 if necessary for hard to detect files.
12
13 The `virusfree` [[PageSpec|ikiwiki/pagespec/attachment]] requires that
14 ikiwiki be configured with a virus scanner program via the `virus_checker`
15 option in the setup file. If using `clamav`, with `clamd`, set it to
16 "clamdscan -". Or to use clamav without the `clamd` daemon, you
17 could set it to "clamscan -".