Mercurial > irccd
diff plugins/history/history.7 @ 1019:90eb31112a53
man: update plugin documentation
author | David Demelier <markand@malikania.fr> |
---|---|
date | Sun, 21 Feb 2021 20:42:17 +0100 |
parents | cf99df45cb84 |
children | 3dec26654d06 |
line wrap: on
line diff
--- a/plugins/history/history.7 Sun Feb 21 20:20:19 2021 +0100 +++ b/plugins/history/history.7 Sun Feb 21 20:42:17 2021 +0100 @@ -31,12 +31,12 @@ .Sh INSTALLATION The plugin .Nm -is distributed with irccd. To enable it add the following to your plugins -section: +is distributed with irccd. To enable it add it into your +.Xr irccd.conf 5 +configuration file. .Pp -.Bd -literal -[plugins] -history = "" +.Bd -literal -offset indent +plugin "history" .Ed .\" USAGE .Sh USAGE @@ -68,22 +68,20 @@ .Ed .\" CONFIGURATION .Sh CONFIGURATION -The following options are available under the -.Va [plugin.history] -section: -.Bl -tag -width 14n -offset Ds +The plugin +.Nm +support the following configuration properties: +.Bl -tag -width "file (string)" .It Va file No (string) path to the JSON file for saving information (Optional. default to cache directory). .El .\" TEMPLATES .Sh TEMPLATES -The +The plugin .Nm -plugin supports the following templates in -.Va [templates.history] -section: -.Bl -tag -width 14n -offset Ds +support the following template properties: +.Bl -tag -width unknown .It Va error Template when an internal error occured. Keywords: .It Va seen @@ -105,8 +103,11 @@ .Sh EXAMPLES Example of configuration file: .Bd -literal -[templates.history] -seen = "#{target} has been seen on #{channel} the last time on: %d/%m/%Y %H:%M" +plugin "history" { + templates { + "seen" "#{target} has been seen on #{channel} the last time on: %d/%m/%Y %H:%M"; + } +} .Ed .\" SEE ALSO .Sh SEE ALSO