diff man/irccd-api.3 @ 1009:637a98de3910

misc: add more examples
author David Demelier <markand@malikania.fr>
date Wed, 17 Feb 2021 19:45:00 +0100
parents 3ea3361f0fc7
children cf99df45cb84
line wrap: on
line diff
--- a/man/irccd-api.3	Wed Feb 17 19:33:00 2021 +0100
+++ b/man/irccd-api.3	Wed Feb 17 19:45:00 2021 +0100
@@ -65,6 +65,25 @@
 .Em optional
 in square brackets means it may not exist on your platform. A quick check in
 Javascript will let you test its presence.
+.Pp
+An example of plugin can be found at
+.Pa @CMAKE_INSTALL_FULL_DATADIR@/irccd/sample-plugin.js
+.\" INFO
+.Sh INFO
+The global
+.Vt info
+object in the plugin can contain the following strings which identifies the
+plugin information:
+.Bl -tag
+.It Vt license
+Plugin license.
+.It Vt version
+Arbitraty version.
+.It Vt author
+Author.
+.It Vt summary
+A short description about the plugin.
+.El
 .\" EVENTS
 .Sh EVENTS
 The following is a list of events that Javascript plugins support. All functions