diff plugins/plugin/plugin.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/plugin/plugin.7	Sun Feb 21 20:20:19 2021 +0100
+++ b/plugins/plugin/plugin.7	Sun Feb 21 20:42:17 2021 +0100
@@ -29,12 +29,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]
-plugin = ""
+.Bd -literal -offset indent
+plugin "plugin"
 .Ed
 .\" USAGE
 .Sh USAGE
@@ -60,24 +60,23 @@
 Both commands work in a channel or as private message with irccd.
 .\" CONFIGURATION
 .Sh CONFIGURATION
-The following options are available under the
-.Va [plugin.plugin]
-section:
-.Bl -tag -width 22n -offset Ds
+The plugin
+.Nm
+support the following configuration properties:
+.Bl -tag -width "max-list-columns (int)"
 .It Va max-list-lines No (int)
 max number of lines allowed for the
 .Ar list
 sub command (Optional, default: 3).
 .It Va max-list-columns No (int)
 max number of columns allowed per lines (Optional, default: 80).
+.El
 .\" TEMPLATES
 .Sh TEMPLATES
-The
+The plugin
 .Nm
-plugin supports the following templates in
-.Va [templates.plugin]
-section:
-.Bl -tag -width 14n -offset Ds
+support the following templates properties:
+.Bl -tag -width not-found
 .It Va usage
 Message to show on invalid usage.
 .It Va info