diff options
Diffstat (limited to 'doc/plugins/filecheck.mdwn')
| -rw-r--r-- | doc/plugins/filecheck.mdwn | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/plugins/filecheck.mdwn b/doc/plugins/filecheck.mdwn new file mode 100644 index 000000000..b038bc433 --- /dev/null +++ b/doc/plugins/filecheck.mdwn @@ -0,0 +1,17 @@ +[[!template id=plugin name=filecheck core=0 author="[[Joey]]"]] +[[!tag type/special-purpose]] + +This plugin enhances the regular [[ikiwiki/PageSpec]] syntax with +some additional tests, for things like file size, mime type, and virus +status. These tests are mostly useful for the [[attachment]] plugin, and +are documented [[here|ikiwiki/pagespec/attachment]]. + +This plugin will use the [[!cpan File::MimeInfo::Magic]] perl module, if +available, for mimetype checking. It falls back to using the `file` command +if necessary for hard to detect files. + +The `virusfree` [[PageSpec|ikiwiki/pagespec/attachment]] requires that +ikiwiki be configured with a virus scanner program via the `virus_checker` +option in the setup file. If using `clamav`, with `clamd`, set it to +"clamdscan -". Or to use clamav without the `clamd` daemon, you +could set it to "clamscan -". |