changeset 856:6c4fb8f42aca

doc: improve wording and style
author David Demelier <markand@malikania.fr>
date Wed, 24 Jul 2019 21:50:00 +0000
parents 199b146e8163
children 8b4becff9fbb
files man/irccd.conf.5 man/irccdctl.1 man/irccdctl.conf.5
diffstat 3 files changed, 136 insertions(+), 113 deletions(-) [+]
line wrap: on
line diff
--- a/man/irccd.conf.5	Wed Jul 24 20:59:00 2019 +0000
+++ b/man/irccd.conf.5	Wed Jul 24 21:50:00 2019 +0000
@@ -45,7 +45,7 @@
 let you splitting your configuration file.
 .Pp
 Note: this @include statement must be at the beginning of the file and must be
-      surrounded by quotes if the file name has spaces.
+surrounded by quotes if the file name has spaces.
 .Pp
 You can use both relative or absolute paths. If relative paths are used, they
 are relative to the current file being parsed.
@@ -99,23 +99,28 @@
 This section can let you configure how irccd should log the messages.
 .Pp
 Available options:
-.Bl -tag -offset Ds -width indent-xxxxxxxxxxxxxxxxxxx
+.Bl -tag -width 20n
 .It Va verbose No (bool)
-be verbose (Optional, default: false).
+Be verbose (Optional, default: false).
 .It Va type No (string)
-which kind of logging, console, file or syslog (Optional, default: console).
+Which kind of logging, valid values are
+.Dq console ,
+.Dq file
+or
+.Dq syslog
+(Optional, default: console).
 .Pp
-The additional options for
+Note: syslog is not available on all platforms.
+.El
+.Pp
+The following options are available for the
 .Ar file
 type:
-.Bl -tag -width indent-xxxxxxxxxxxxx
+.Bl -tag -width 20n
 .It Va path-logs No (string)
-path to the normal messages.
+Path to the normal messages.
 .It Va path-errors No (string)
-path to the error messages.
-.El
-.Pp
-Note: syslog is not available on all platforms.
+Path to the error messages.
 .El
 .\" [templates]
 .Ss templates
@@ -130,53 +135,54 @@
 Note: colors and attributes are not supported on Windows.
 .Pp
 Available options:
-.Bl -tag -offset Ds -width indent-xxxxxxxxxxxxxxxxxxx
+.Bl -tag -width 18n
 .It Va debug No (string)
-template to use to format debug messages (Optional, default: none).
+Template to use to format debug messages (Optional, default: none).
 .It Va info No (string)
-template to use to format information messages (Optional, default: none).
+Template to use to format information messages (Optional, default: none).
 .It Va warning No (string)
-template to use to format warnings (Optional, default: none).
+Template to use to format warnings (Optional, default: none).
 .El
 .\" [server]
 .Ss server
-This section is used to connect to one or more server.
+This section is used to connect to one or more server. Create a new server
+section for each IRC server you want to connect to.
 .Pp
 Available options:
-.Bl -tag -offset Ds -width indent-xxxxxxxxxxxxxxxxxxx
+.Bl -tag -width 26n
 .It Va name No (identifier)
-the unique id.
+The unique id.
 .It Va hostname No (string)
-the server address or IP.
+The server address or IP.
 .It Va port No (int)
-the server port (Optional, default: 6667).
+The server port (Optional, default: 6667).
 .It Va password No (string)
-an optional server password (Optional, default: none).
+An optional server password (Optional, default: none).
 .It Va join-invite No (bool)
-automatically join channels upon invitation (Optional, default: false).
+Automatically join channels upon invitation (Optional, default: false).
 .It Va channels No (list)
-list of channels to auto join (Optional, default: empty).
+List of channels to auto join (Optional, default: empty).
 .Pp
-Note: if a channel requires a password, add it after a colon
-      (e.g. #channel:password).
+Note: if a channel requires a password, add it after a colon (e.g.
+.Dq #channel:password ) .
 .It Va command-char No (string)
-the prefix for invoking special commands (Optional, default: !).
+The prefix for invoking special commands (Optional, default: !).
 .It Va ssl No (bool)
-enable or disable SSL (Optional, default: false).
+Enable or disable SSL (Optional, default: false).
 .It Va auto-reconnect No (bool)
-enable reconnection after failure (Optional, default: true).
+Enable reconnection after failure (Optional, default: true).
 .It Va auto-reconnect-delay No (int)
-number of seconds to wait before retrying (Optional, default: 30).
+Number of seconds to wait before retrying (Optional, default: 30).
 .It Va ping-timeout No (int)
-number of seconds before ping timeout (Optional, default: 300).
+Number of seconds before ping timeout (Optional, default: 300).
 .It Va nickname No (string)
-the nickname (Optional, default: irccd).
+The nickname (Optional, default: irccd).
 .It Va realname No (string)
-the realname (Optional, default: IRC Client Daemon).
+The realname (Optional, default: IRC Client Daemon).
 .It Va username No (string)
-the username name (Optional, default: irccd).
+The username name (Optional, default: irccd).
 .It Va ctcp-version No (string)
-what version to respond to CTCP VERSION (Optional, default: IRC Client Daemon).
+What version to respond to CTCP VERSION (Optional, default: IRC Client Daemon).
 .El
 .\" [paths]
 .Ss paths
@@ -186,17 +192,18 @@
 common convention used in all plugins:
 .Pp
 Available options:
-.Bl -tag -offset Ds -width indent-xxxxxxxxxxxxxxxxxxx
+.Bl -tag -width 16n
 .It Va cache No (string)
-path for data files written by the plugin.
+Path for data files written by the plugin.
 .It Va data No (string)
-path for data files provided by the user.
+Path for data files provided by the user.
 .It Va config No (string)
-path for additional configuration from the user.
+Path for additional configuration from the user.
 .El
 .Pp
-For each of these paths, plugin/name is appended with the appropriate plugin
-name when used.
+For each of these paths,
+.Dq plugin/name
+is appended with the appropriate plugin name when used.
 .Pp
 The section is redefinable per plugin basis using the
 .Va [paths.<plugin>]
@@ -214,11 +221,11 @@
 This section defines transports that are used to communicate through clients
 connected to irccd and to perform requests to irccd.
 .Pp
-With transports, you can may ask irccd to send a message, a notice or even
-kicking someone from a channel. Irccd will also notify all clients connected to
-this transport on IRC events.
+With transports, you may ask irccd to send a message, a notice or even to kick
+someone from a channel. Irccd will also notify all clients connected to this
+transport on IRC events.
 .Pp
-There are two type of listeners availables:
+There are two types of transport availables:
 .Bl -bullet
 .It
 Internet sockets, IPv4 and IPv6,
@@ -230,69 +237,78 @@
 encrypted connections.
 .Pp
 Available options:
-.Bl -tag -offset Ds -width indent-xxxxxxxxxxxxxxxxxxx
+.Bl -tag -width 18n
 .It Va type No (string)
-type of listener "ip" or "unix".
+Type of transport
+.Dq ip
+or
+.Dq unix .
 .It Va password No (string)
-an authentication password (Optional, default: none).
+An authentication password (Optional, default: none).
 .It Va ssl No (bool)
-enable SSL (Optional, default: false),
+Enable SSL (Optional, default: false),
 .It Va key No (string)
-path to private key file (Required if ssl is true)
+Path to private key file (Required if ssl is true)
 .It Va certificate No (string)
-path to certificate (Required if ssl is true)
-.Pp
-The additional options for ip type:
-.Bl -tag -width indent-xxxxxxxxx
-.It Va port No (int)
-port number.
-.It Va address No (string)
-address to bind or * for any (Optional, default: *).
-.It Va ipv4 No (bool)
-bind on IPv4 (Optional, default true).
-.It Va ipv6 No (bool)
-bind on IPv6 (Optional, default true).
+Path to certificate (Required if ssl is true)
 .El
 .Pp
-The additional options for unix type:
-.Bl -tag -width indent-xxxxxxxxx
-.It Va path No (string)
-the file path to the socket.
-.El
+The following options are available for the
+.Ar ip
+type:
+.Bl -tag -width 18n
+.It Va port No (int)
+Port number.
+.It Va address No (string)
+Address to bind or
+.Dq *
+for any (Optional, default:
+.Dq * ) .
+.It Va ipv4 No (bool)
+Bind on IPv4 (Optional, default true).
+.It Va ipv6 No (bool)
+Bind on IPv6 (Optional, default true).
 .El
 .Pp
-Warning: consider using internet sockets with care, especially if you are
-         running your bot on a server with multiple users. If your bot has
-         operator rights and you bind on any address, almost every users
-         can do a kick or a ban.
+The following options are available for the
+.Ar unix
+type:
+.Bl -tag -width 18n
+.It Va path No (string)
+The file path to the socket.
+.El
 .\" [rule]
 .Ss rule
-The rule section is one of the most powerful within irccd configuration. It let
+The rule section is one of the most powerful within irccd configuration. It lets
 you enable or disable plugins and IRC events for specific criterias. For
 instance, you may want to disable a plugin only for a specific channel on a
 specific server. And because rules are evaluated in the order they are defined,
 you can override rules.
 .Pp
 Available options:
-.Bl -tag -offset Ds -width indent-xxxxxxxxxxxxxxxxxxx
+.Bl -tag -width 15n
 .It Va servers No (list)
-a list of servers that will match the rule (Optional, default: empty).
+A list of servers that will match the rule (Optional, default: empty).
 .It Va channels No (list)
-a list of channel (Optional, default: empty).
+A list of channel (Optional, default: empty).
 .It Va origins No (list)
-a list of nicknames to check (Optional, default: empty).
+A list of nicknames to check (Optional, default: empty).
 .It Va plugins No (list)
-which plugins (Optional, default: empty),
+Which plugins (Optional, default: empty),
 .It Va events No (list)
-which events like onCommand, onMessage (Optional, default: empty).
+Which events like onCommand, onMessage (Optional, default: empty).
 .It Va action No (string)
-set to accept or drop.
+Set to
+.Dq accept
+or
+.Dq drop .
 .El
 .Pp
 Warning: don't make sensitive rules on origins option, irccd does not have any
-         kind of nickname authentication. Thus, it may be very easy for someone
-         to use a temporary nickname.
-.Sh EXAMPLE
+kind of nickname authentication. Thus, it may be very easy for someone
+to use a temporary nickname.
+.\" EXAMPLES
+.Sh EXAMPLES
 Full example of configuration file
 .Bd -literal
 # Add a transport that bind only to IPv6.
@@ -341,5 +357,10 @@
 plugins = "reboot"
 action = accept
 .Ed
+.\" SEE ALSO
 .Sh SEE ALSO
 .Xr irccd 1
+.\" AUTHORS
+.Sh AUTHORS
+.Nm
+was written by David Demelier <markand@malikania.fr>
--- a/man/irccdctl.1	Wed Jul 24 20:59:00 2019 +0000
+++ b/man/irccdctl.1	Wed Jul 24 21:50:00 2019 +0000
@@ -273,17 +273,17 @@
 Available options:
 .Bl -tag -width 12n
 .It Fl c Ar channel
-match a channel.
+Match a channel.
 .It Fl e Ar event
-match an event.
+Match an event.
 .It Fl i Ar index
-rule position.
+Rule position.
 .It Fl o Ar origin
-match an origin.
+Match an origin.
 .It Fl p Ar plugin
-match a plugin.
+Match a plugin.
 .It Fl s Ar server
-match a server.
+Match a server.
 .El
 .Pp
 Note: all options (except
@@ -296,17 +296,17 @@
 Available options:
 .Bl -tag -width 14n
 .It Fl a Ar accept|drop
-set action.
+Set action.
 .It Fl c|C Ar channel
-match or unmatch a channel respectively.
+Match or unmatch a channel respectively.
 .It Fl e|E Ar event
-match or unmatch an event respectively.
+Match or unmatch an event respectively.
 .It Fl o|O Ar origin
-match or unmatch an origin respectively.
+Match or unmatch an origin respectively.
 .It Fl p|P Ar plugin
-match or unmatch a plugin respectively.
+Match or unmatch a plugin respectively.
 .It Fl s|S Ar server
-match or unmatch a server respectively.
+Match or unmatch a server respectively.
 .El
 .Pp
 Note: all options (except
@@ -344,15 +344,15 @@
 Available options:
 .Bl -tag -width 12n
 .It Fl c Ar character
-specify the command character prefix.
+Specify the command character prefix.
 .It Fl n Ar nickname
-specify a nickname.
+Specify a nickname.
 .It Fl r Ar realname
-specify a real name.
+Specify a real name.
 .It Fl u Ar username
-specify a user name.
+Specify a user name.
 .It Fl p Ar port
-use the specific port, otherwise 6667 is used.
+Use the specific port, otherwise 6667 is used.
 .El
 .\" server-disconnect
 .It Cm server-disconnect
--- a/man/irccdctl.conf.5	Wed Jul 24 20:59:00 2019 +0000
+++ b/man/irccdctl.conf.5	Wed Jul 24 21:50:00 2019 +0000
@@ -36,9 +36,9 @@
 This section defines the global irccdctl parameters.
 .Pp
 Available options:
-.Bl -tag -offset Ds -width 18n
+.Bl -tag -width 18n
 .It Va verbose No (bool)
-enable verbose message (Optional, default: false).
+Enable verbose message (Optional, default: false).
 .El
 .\" [connect]
 .Ss connect
@@ -47,37 +47,37 @@
 internet sockets.
 .Pp
 Available options:
-.Bl -tag -offset Ds -width 18n
+.Bl -tag -width 18n
 .It Va type No (string)
-connection type, must be set to
-.Ar ip
+Connection type, must be set to
+.Dq ip
 or
-.Ar unix .
+.Dq unix .
 .It Va password No (string)
-an authentication password (Optional, default: none).
+An authentication password (Optional, default: none).
+.El
 .Pp
-The additional options for
+The following options are available for the
 .Ar ip
 type:
 .Bl -tag -width 18n
 .It Va hostname No (string)
-host to connect.
+Host to connect.
 .It Va port No (int)
-port number.
+Port number.
 .It Va ipv4 No (bool)
-try to connect with ipv4 (Optional: default true).
+Try to connect with ipv4 (Optional: default true).
 .It Va ipv6 No (bool)
-try to connect with ipv6 (Optional: default true).
+Try to connect with ipv6 (Optional: default true).
 .El
 .Pp
-The additional options for
+The following options are available for the
 .Ar unix
 type:
 .Bl -tag -width 18n
 .It Va path No (string)
 The file path to the socket.
 .El
-.El
 .\" [alias]
 .Ss alias
 The alias section can be used to define custom user commands.
@@ -96,7 +96,9 @@
 warning = ( "server-me", "localhost", "#staff", "is a bot")
 .Ed
 .Pp
-This example defines an alias `present` that will:
+This alias
+.Cm present
+will do:
 .Bl -enum
 .It
 Send a message on the channel #staff in the server localhost