Mercurial > irccd

changeset 1020:3dec26654d06

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
man: misc fixes
author David Demelier <markand@malikania.fr>
date Tue, 23 Feb 2021 09:19:27 +0100
parents 90eb31112a53
children fab139c44f72
files plugins/ask/ask.7 plugins/auth/auth.7 plugins/hangman/hangman.7 plugins/history/history.7 plugins/joke/joke.7 plugins/links/links.7 plugins/logger/logger.7 plugins/plugin/plugin.7 plugins/roulette/roulette.7 plugins/tictactoe/tictactoe.7
diffstat 10 files changed, 38 insertions(+), 30 deletions(-) [+]
line wrap: on
line diff
--- a/plugins/ask/ask.7	Sun Feb 21 20:42:17 2021 +0100
+++ b/plugins/ask/ask.7	Tue Feb 23 09:19:27 2021 +0100
@@ -59,7 +59,7 @@
 located in the ask configuration directory.
 .Pp
 Just add one line per answer like this (e.g.
-.Pa ~/.config/irccd/plugin/ask/answers.conf ) .
+.Pa @CMAKE_INSTALL_FULL_SYSCONFDIR@/irccd/plugin/ask/answers.conf ) .
 .Bd -literal -offset Ds
 Stop dreaming,
 Definitely sure!
@@ -67,11 +67,15 @@
 .Ed
 .\" CONFIGURATION
 .Sh CONFIGURATION
-The following options are available under the
-.Va [plugin.ask]
-section:
-.Bl -tag -width 14n
+The plugin
+.Nm
+supports the following configuration properties:
+.Bl -tag -width "file (string)"
 .It Va file No (string)
 the path to the database file (Optional, default: answers.conf in configuration
 directory).
 .El
+.\" SEE ALSO
+.Sh SEE ALSO
+.Xr irccd 1 ,
+.Xr irccd-templates 7
--- a/plugins/auth/auth.7	Sun Feb 21 20:42:17 2021 +0100
+++ b/plugins/auth/auth.7	Tue Feb 23 09:19:27 2021 +0100
@@ -53,7 +53,7 @@
 .Sh CONFIGURATION
 The plugin
 .Nm
-support the following configuration properties:
+supports the following configuration properties:
 .Bl -tag -width "server.password (string)"
 .It Va server.type No (string)
 Must be
@@ -84,3 +84,7 @@
   }
 }
 .Ed
+.\" SEE ALSO
+.Sh SEE ALSO
+.Xr irccd 1 ,
+.Xr irccd-templates 7
--- a/plugins/hangman/hangman.7	Sun Feb 21 20:42:17 2021 +0100
+++ b/plugins/hangman/hangman.7	Tue Feb 23 09:19:27 2021 +0100
@@ -76,16 +76,16 @@
 .Sh CONFIGURATION
 The plugin
 .Nm
-support the following configuration properties:
+supports the following configuration properties:
 .Bl -tag -width "collaborative (bool)"
 .It Va file No (string)
 The path to the database file.
 .Pp
-The file must contains one word per line, it must be saved as UTF-8 and words
-must only contains UTF-8 characters, any other entry will be ignored.
+The file must contain one word per line, it must be saved as UTF-8 and words
+must consist of UTF-8 characters, any other entry will be ignored.
 .Pp
 Example:
-.Bd -literal -offset Ds
+.Bd -literal
 sky
 irccd
 FreeBSD
@@ -100,7 +100,7 @@
 .Sh TEMPLATES
 The plugin
 .Nm
-support the following template properties:
+supports the following template properties:
 .Bl -tag -width wrong-letter
 .It Va asked
 When a letter has been already asked but present in the word. Keywords:
@@ -136,12 +136,12 @@
 .Bd -literal
 plugin "hangman" {
   config {
-    file "/var/srv/db/words.txt";
+    "file" "/var/srv/db/words.txt";
   }
 
   templates {
-    win          "nice job, the word was #{word}!";
-    wrong-letter "please try again, there is no #{letter}";
+    "win"          "nice job, the word was #{word}!";
+    "wrong-letter" "please try again, there is no #{letter}";
   }
 }
 .Ed
--- a/plugins/history/history.7	Sun Feb 21 20:42:17 2021 +0100
+++ b/plugins/history/history.7	Tue Feb 23 09:19:27 2021 +0100
@@ -42,7 +42,7 @@
 .Sh USAGE
 The plugin
 .Nm history
-only reacts to the special command. It understands
+reacts to the special command. It understands
 .Ar seen
 and
 .Ar said
@@ -70,7 +70,7 @@
 .Sh CONFIGURATION
 The plugin
 .Nm
-support the following configuration properties:
+supports 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
@@ -80,7 +80,7 @@
 .Sh TEMPLATES
 The plugin
 .Nm
-support the following template properties:
+supports the following template properties:
 .Bl -tag -width unknown
 .It Va error
 Template when an internal error occured. Keywords:
--- a/plugins/joke/joke.7	Sun Feb 21 20:42:17 2021 +0100
+++ b/plugins/joke/joke.7	Tue Feb 23 09:19:27 2021 +0100
@@ -75,7 +75,7 @@
 .Sh CONFIGURATION
 The plugin
 .Nm
-support the following configuration properties:
+supports the following configuration properties:
 .Bl -tag -width "file (string)"
 .It Va file No (string)
 path to the JSON jokes files (Optional: defaults to data directory/jokes.json).
@@ -93,7 +93,7 @@
 .Nm
 The plugin
 .Nm
-support the following template properties:
+supports the following template properties:
 .Bl -tag -width error
 .It Va error
 Template when an internal error occured. Keywords:
--- a/plugins/links/links.7	Sun Feb 21 20:42:17 2021 +0100
+++ b/plugins/links/links.7	Tue Feb 23 09:19:27 2021 +0100
@@ -51,7 +51,7 @@
 .Sh TEMPLATES
 The plugin
 .Nm
-support the following template properties:
+supports the following template properties:
 .Bl -tag -width info
 .It Va info
 Message to be written when title has been retrieved successfully. Keywords:
--- a/plugins/logger/logger.7	Sun Feb 21 20:42:17 2021 +0100
+++ b/plugins/logger/logger.7	Tue Feb 23 09:19:27 2021 +0100
@@ -63,7 +63,7 @@
 .Sh CONFIGURATION
 The plugin
 .Nm
-support the following configuration properties:
+supports the following configuration properties:
 .Bl -tag -width "file (string)"
 .It Va file No (string)
 The path to the file where to store logs. Keywords:
@@ -73,7 +73,7 @@
 .Sh TEMPLATES
 The plugin
 .Nm
-support the following template properties:
+supports the following template properties:
 .Bl -tag -width message
 .It Va join
 Format when someone joins a channel.
--- a/plugins/plugin/plugin.7	Sun Feb 21 20:42:17 2021 +0100
+++ b/plugins/plugin/plugin.7	Tue Feb 23 09:19:27 2021 +0100
@@ -62,7 +62,7 @@
 .Sh CONFIGURATION
 The plugin
 .Nm
-support the following configuration properties:
+supports 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
@@ -75,7 +75,7 @@
 .Sh TEMPLATES
 The plugin
 .Nm
-support the following templates properties:
+supports the following templates properties:
 .Bl -tag -width not-found
 .It Va usage
 Message to show on invalid usage.
--- a/plugins/roulette/roulette.7	Sun Feb 21 20:42:17 2021 +0100
+++ b/plugins/roulette/roulette.7	Tue Feb 23 09:19:27 2021 +0100
@@ -57,7 +57,7 @@
 .Sh TEMPLATES
 The plugin
 .Nm
-support the following templates properties:
+supports the following templates properties:
 .Bl -tag -width lucky
 .It Va lucky
 The text to show on luck. Keywords:
@@ -67,7 +67,7 @@
 The text to show on shot.
 .El
 .Pp
-All templates support the following standard keywords:
+All templates supports the following standard keywords:
 .Em channel , command , nickname , origin , plugin , server .
 .\" EXAMPLES
 .Sh EXAMPLES
@@ -75,8 +75,8 @@
 .Bd -literal
 plugin "roulette" {
   templates {
-    lucky "#{nickname} you're gonna get shot";
-    shot  "BIM";
+    "lucky" "#{nickname} you're gonna get shot";
+    "shot"  "BIM";
   }
 }
 .Ed
--- a/plugins/tictactoe/tictactoe.7	Sun Feb 21 20:42:17 2021 +0100
+++ b/plugins/tictactoe/tictactoe.7	Tue Feb 23 09:19:27 2021 +0100
@@ -95,7 +95,7 @@
 .Sh TEMPLATES
 The plugin
 .Nm
-support the following templates properties:
+supports the following templates properties:
 .Bl -tag -width running
 .It Va draw
 When the game ended with no winner.
@@ -115,7 +115,7 @@
 Game ended with a winner.
 .El
 .Pp
-All templates support the following standard keywords:
+All templates supports the following standard keywords:
 .Em channel , command , nickname , plugin , server .
 .\" SEE ALSO
 .Sh SEE ALSO