irccd: man/irccd-api.7 annotate

annotate man/irccd-api.7 @ 845:00a4720c4874

doc: rewrite documentation in manual pages, closes #1674 Get rid of markdown documentation and the custom generator tools, instead use raw manual pages.

author	David Demelier <markand@malikania.fr>
date	Mon, 08 Jul 2019 16:15:57 +0200
parents
children	a23b7b574ed2

rev	line source
845 00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1 .\"
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2 .\" Copyright (c) 2013-2019 David Demelier <markand@malikania.fr>
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	3 .\"
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	4 .\" Permission to use, copy, modify, and/or distribute this software for any
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	5 .\" purpose with or without fee is hereby granted, provided that the above
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	6 .\" copyright notice and this permission notice appear in all copies.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	7 .\"
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	15 .\"
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	16 .Dd @IRCCD_MAN_DATE@
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	17 .Dt IRCCD-API 7
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	18 .Os
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	19 .\" NAME
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	20 .Sh NAME
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	21 .Nm irccd-api
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	22 .Nd irccd Javascript API
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	23 .\" DESCRIPTION
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	24 .Sh DESCRIPTION
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	25 This documentation shows the API reference for the official irccd Javascript
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	26 API.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	27 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	28 Any function that is indicated as
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	29 .Em optional
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	30 in square brackets means it may not exist on your platform. A quick check in
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	31 Javascript will let you test its presence.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	32 .\" EVENTS
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	33 .Sh EVENTS
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	34 The following is a list of events that Javascript plugins support. All functions
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	35 are completely optional and may be omitted. If you want to support a function
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	36 just implement it as global Javascript function.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	37 .\" onCommand
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	38 .Ss onCommand
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	39 Special commands are not real IRC events. They are called from channel messages
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	40 with a specific syntax using a delimiter and the plugin name.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	41 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	42 For instance, with default irccd parameters, saying on a channel
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	43 .Ar "!ask foo"
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	44 will call the special command of the plugin named
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	45 .Nm ask .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	46 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	47 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	48 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	49 function onCommand(server, origin, channel, message)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	50 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	51 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	52 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	53 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	54 .It Fa server No (Server)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	55 The current server.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	56 .It Fa origin No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	57 Who invoked the command.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	58 .It Fa channel No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	59 The channel where the message comes from.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	60 .It Fa message No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	61 The real message, without the ! part.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	62 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	63 .\" onConnect
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	64 .Ss onConnect
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	65 This callback is called when the irccd instance successfully connect to a
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	66 server.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	67 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	68 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	69 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	70 function onConnect(server)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	71 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	72 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	73 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	74 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	75 .It Fa server No (Server)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	76 The current server.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	77 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	78 .\" onDisconnect
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	79 .Ss onDisconnect
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	80 This callback is called when a server has been disconnected by any way.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	81 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	82 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	83 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	84 function onDisonnect(server)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	85 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	86 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	87 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	88 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	89 .It Fa server No (Server)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	90 The current server.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	91 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	92 .\" onInvite
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	93 .Ss onInvite
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	94 This event is called when someone is inviting you to a channel.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	95 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	96 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	97 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	98 function onInvite(server, origin, channel)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	99 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	100 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	101 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	102 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	103 .It Fa server No (Server)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	104 The current server.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	105 .It Fa origin No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	106 Who invited you.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	107 .It Fa channel No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	108 On which channel you are invited to.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	109 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	110 .\" onJoin
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	111 .Ss onJoin
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	112 User join events, this function is called when someone joins a channel.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	113 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	114 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	115 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	116 function onJoin(server, origin, channel)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	117 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	118 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	119 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	120 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	121 .It Fa server No (Server)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	122 The current server.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	123 .It Fa origin No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	124 The person who joined the channel.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	125 .It Fa channel No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	126 The channel the user has joined.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	127 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	128 .\" onKick
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	129 .Ss onKick
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	130 This event is triggered when someone has been kicked from a channel.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	131 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	132 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	133 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	134 function onKick(server, origin, channel, target, reason)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	135 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	136 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	137 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	138 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	139 .It Fa server No (Server)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	140 The current server.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	141 .It Fa origin No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	142 Who kicked the person.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	143 .It Fa channel No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	144 The channel.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	145 .It Fa target No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	146 The kicked person.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	147 .It Fa reason No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	148 An optional reason.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	149 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	150 .\" onLoad
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	151 .Ss onLoad
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	152 This function is called when irccd instance load a plugin. If this function
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	153 throws an error, the script is not loaded.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	154 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	155 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	156 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	157 function onLoad()
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	158 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	159 .\" onMe
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	160 .Ss onMe
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	161 Action emote.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	162 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	163 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	164 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	165 function onMe(server, origin, channel, message)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	166 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	167 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	168 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	169 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	170 .It Fa server No (Server)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	171 The current server.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	172 .It Fa origin No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	173 The person who said something.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	174 .It Fa channel No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	175 The channel.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	176 .It Fa message No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	177 The message sent.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	178 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	179 .\" onMessage
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	180 .Ss onMessage
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	181 This event is triggered when someone said something on a specific channel.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	182 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	183 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	184 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	185 function onMessage(server, origin, channel, message)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	186 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	187 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	188 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	189 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	190 .It Fa server No (Server)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	191 The current server.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	192 .It Fa origin No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	193 The person who said something.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	194 .It Fa channel No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	195 The channel.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	196 .It Fa message No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	197 The message sent.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	198 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	199 .\" onMode
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	200 .Ss onMode
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	201 This event is triggered when the server changed a channel mode or your mode.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	202 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	203 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	204 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	205 function onMode(server, origin, channel, mode, limit, user, mask)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	206 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	207 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	208 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	209 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	210 .It Fa server No (Server)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	211 The current server.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	212 .It Fa origin No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	213 The person who changed the mode.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	214 .It Fa mode No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	215 The new mode.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	216 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	217 .\" onNames
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	218 .Ss onNames
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	219 This event is triggered when a list of names has come.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	220 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	221 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	222 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	223 function onNames(server, channel, list)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	224 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	225 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	226 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	227 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	228 .It Fa server No (Server)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	229 The current server.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	230 .It Fa channel No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	231 Which channel.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	232 .It Fa list No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	233 A sequence with all users.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	234 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	235 .\" onNick
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	236 .Ss onNick
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	237 This event is triggered when someone changed its nickname.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	238 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	239 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	240 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	241 function onNick(server, origin, nickname)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	242 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	243 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	244 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	245 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	246 .It Fa server No (Server)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	247 The current server.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	248 .It Fa origin No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	249 The old nickname.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	250 .It Fa nickname No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	251 The new nickname.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	252 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	253 .\" onNotice
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	254 .Ss onNotice
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	255 This event is triggered when someone sent a notice to you.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	256 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	257 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	258 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	259 function onNotice(server, origin, notice)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	260 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	261 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	262 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	263 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	264 .It Fa server No (Server)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	265 The current server.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	266 .It Fa origin No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	267 The one who sent the notice.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	268 .It Fa message No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	269 The notice message.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	270 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	271 .\" onPart
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	272 .Ss onPart
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	273 This event is triggered when someone has left a specific channel.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	274 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	275 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	276 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	277 function onPart(server, origin, channel, reason)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	278 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	279 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	280 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	281 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	282 .It Fa server No (Server)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	283 The current server.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	284 .It Fa origin No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	285 The person who left the channel.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	286 .It Fa channel No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	287 The channel.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	288 .It Fa reason No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	289 An optional reason.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	290 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	291 .\" onReload
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	292 .Ss onReload
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	293 Request to reload the plugin.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	294 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	295 This function does nothing in the irccd internals, it just calls a function that
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	296 you can use to reload some data.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	297 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	298 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	299 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	300 function onReload()
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	301 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	302 .\" onTopic
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	303 .Ss onTopic
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	304 This event is triggered when someone changed the channel's topic.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	305 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	306 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	307 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	308 function onTopic(server, origin, channel, topic)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	309 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	310 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	311 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	312 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	313 .It Fa server No (Server)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	314 The current server.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	315 .It Fa origin No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	316 The person who changed the topic.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	317 .It Fa channel No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	318 The channel.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	319 .It Fa topic No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	320 The new topic (may be empty).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	321 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	322 .\" onUnload
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	323 .Ss onUnload
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	324 This event is triggered when the plugin is about to be unloaded.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	325 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	326 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	327 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	328 function onUnload()
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	329 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	330 .\" onWhois
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	331 .Ss onWhois
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	332 This event is triggered when irccd gets information about a user.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	333 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	334 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	335 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	336 function onWhois(server, info)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	337 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	338 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	339 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	340 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	341 .It Fa server No (Server)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	342 The current server.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	343 .It Fa info No (Object)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	344 The whois information.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	345 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	346 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	347 The
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	348 .Fa info
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	349 is an object with the following properties:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	350 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	351 .It Fa nickname No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	352 The user nickname.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	353 .It Fa user No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	354 The user name.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	355 .It Fa host No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	356 The hostname.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	357 .It Fa realname No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	358 The real name used.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	359 .It Fa channels No (array)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	360 An optional list of channels joined.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	361 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	362 .\" MODULES
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	363 .Sh MODULES
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	364 The following modules are part of the official Javascript API. They are all
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	365 accessible as global function, variables and objects.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	366 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	367 All modules are categorized into pseudo namespaces that are placed into the
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	368 global
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	369 .Va Irccd
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	370 object. (e.g.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	371 .Va Irccd.Directory , Irccd.File ) .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	372 .\" {{{ Module: Irccd
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	373 .Ss Irccd
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	374 Top level irccd Javascript module.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	375 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	376 Contains general irccd variables and functions.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	377 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	378 .\" {{{ Constants
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	379 The following constants properties are defined:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	380 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	381 .Bl -tag -width 22n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	382 .It Va version No (object)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	383 See below.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	384 .It Va version.major No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	385 The major irccd version.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	386 .It Va version.minor No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	387 The minor irccd version.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	388 .It Va version.patch No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	389 The patch irccd version.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	390 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	391 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	392 .\" }}} !Constants
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	393 .\" {{{ Types
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	394 The following objects are defined:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	395 .Bl -tag -width 22n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	396 .It Va SystemError No (function)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	397 An exception inheriting Error thrown by some filesystem functions.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	398 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	399 .\" }}} !Types
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	400 .\" }}} !Module: Irccd
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	401 .\" {{{ Module: Irccd.Chrono
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	402 .Ss Irccd.Chrono
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	403 This class let you measure the elapsed time.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	404 .\" {{{ Methods
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	405 .\" {{{ Irccd.Chrono [constructor]
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	406 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	407 Irccd.Chrono [constructor]
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	408 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	409 Construct a new Chrono object. The timer is automatically started on
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	410 construction.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	411 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	412 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	413 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	414 Irccd.ElapsedTimer()
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	415 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	416 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	417 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	418 .\" {{{ Irccd.Chrono.prototype.elapsed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	419 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	420 Irccd.Chrono.prototype.elapsed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	421 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	422 Get the number of elapsed milliseconds.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	423 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	424 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	425 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	426 Irccd.Chrono.prototype.elapsed()
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	427 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	428 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	429 Returns
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	430 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	431 The elapsed time in milliseconds.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	432 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	433 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	434 .\" {{{ Irccd.Chrono.prototype.pause
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	435 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	436 Irccd.Chrono.prototype.pause
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	437 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	438 Pause the timer, without resetting the current elapsed time stored.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	439 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	440 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	441 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	442 Irccd.Chrono.prototype.pause()
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	443 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	444 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	445 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	446 .\" {{{ Irccd.Chrono.prototype.resume
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	447 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	448 Irccd.Chrono.prototype.resume
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	449 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	450 Continue accumulating additional time. Has no effect if the timer is already
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	451 running.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	452 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	453 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	454 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	455 Irccd.Chrono.prototype.restart()
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	456 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	457 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	458 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	459 .\" {{{ Irccd.Chrono.prototype.start
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	460 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	461 Irccd.Chrono.prototype.start
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	462 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	463 Starts or restarts accumulating time.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	464 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	465 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	466 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	467 Irccd.Chrono.prototype.start()
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	468 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	469 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	470 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	471 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	472 .\" }}} !Module: Irccd.Chrono
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	473 .\" {{{ Module: Irccd.Directory
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	474 .Ss Irccd.Directory
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	475 This module can be used to iterate, find, remove or create directories.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	476 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	477 Use this module with care.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	478 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	479 .\" {{{ Constants
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	480 The following constants properties are defined:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	481 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	482 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	483 .It Va Dot No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	484 list "." directory.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	485 .It Va DotDot No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	486 list ".." directory.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	487 .It Va TypeUnknown No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	488 unknown type file.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	489 .It Va TypeDir No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	490 entry is a directory.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	491 .It Va TypeFile No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	492 entry is a file.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	493 .It Va TypeLink No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	494 entry is a link.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	495 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	496 .\" }}} !Constants
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	497 .\" {{{ Functions
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	498 .\" {{{ Irccd.Directory.find
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	499 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	500 Irccd.Directory.find
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	501 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	502 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	503 Find an entry by a pattern or a regular expression.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	504 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	505 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	506 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	507 Irccd.Directory.find(path, pattern, recursive)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	508 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	509 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	510 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	511 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	512 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	513 .It Fa path No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	514 The base path.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	515 .It Fa pattern No (mixed)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	516 The regular expression or file name as string.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	517 .It Fa recursive No (bool)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	518 Set to true to search recursively (Optional, default: false).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	519 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	520 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	521 Returns
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	522 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	523 The path to the file or undefined if not found.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	524 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	525 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	526 .\" {{{ Irccd.Directory.mkdir
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	527 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	528 Irccd.Directory.mkdir
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	529 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	530 Create a directory specified by path. It will create needed subdirectories just
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	531 like you have invoked mkdir -p.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	532 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	533 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	534 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	535 Irccd.Directory.mkdir(path, mode = 0700)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	536 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	537 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	538 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	539 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	540 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	541 .It Fa path No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	542 The path to the directory.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	543 .It Fa mode No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	544 The mode, not available on all platforms.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	545 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	546 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	547 Throws
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	548 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	549 Any exception on error.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	550 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	551 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	552 .\" {{{ Irccd.Directory.remove
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	553 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	554 Irccd.Directory.remove
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	555 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	556 Remove the directory optionally recursively.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	557 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	558 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	559 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	560 Irccd.Directory.remove(path, recursive)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	561 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	562 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	563 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	564 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	565 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	566 .It Fa path No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	567 The path to the directory.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	568 .It Fa recursive No (bool)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	569 Recursively or not (Optional, default: false).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	570 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	571 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	572 Throws
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	573 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	574 Any exception on error.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	575 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	576 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	577 .\" }}} !Functions
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	578 .\" {{{ Methods
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	579 .\" {{{ Irccd.Directory [constructor]
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	580 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	581 Irccd.Directory [constructor]
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	582 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	583 Open a directory.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	584 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	585 When constructed successfully, the object has the following properties:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	586 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	587 .Bl -tag -width 20n -offset indent -compact
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	588 .It Va path No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	589 the path to the directory.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	590 .It Va entries No (array)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	591 an array for each entry containing. See below
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	592 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	593 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	594 For each entry found, the array entries contains as many objects with the
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	595 following properties:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	596 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	597 .Bl -tag -width 14n -offset indent-two -compact
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	598 .It Va name No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	599 the base file name.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	600 .It Va type No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	601 the type of file (Irccd.Directory.Type*).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	602 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	603 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	604 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	605 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	606 Irccd.Directory(path, flags)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	607 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	608 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	609 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	610 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	611 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	612 .It Fa path No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	613 The path to the directory.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	614 .It Va flags No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	615 The OR'ed flags:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	616 .Va Irccd.Directory.Dot , Irccd.Directory.DotDot
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	617 (Optional, default: none).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	618 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	619 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	620 Throws
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	621 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	622 Any exception on error.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	623 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	624 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	625 .\" {{{ Irccd.Directory.prototype.find
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	626 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	627 Irccd.Directory.prototype.find
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	628 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	629 Synonym of find static function but the path is taken from the directory object.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	630 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	631 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	632 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	633 Irccd.Directory.prototype.find(pattern, recursive)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	634 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	635 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	636 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	637 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	638 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	639 .It Fa pattern No (mixed)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	640 The regular expression or file name.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	641 .It Fa recursive No (bool)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	642 Set to true to search recursively (Optional, default: false).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	643 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	644 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	645 Throws
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	646 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	647 Any exception on error.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	648 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	649 Returns
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	650 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	651 The path to the file or undefined if not found.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	652 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	653 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	654 .\" {{{ Irccd.Directory.prototype.remove
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	655 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	656 Irccd.Directory.prototype.remove
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	657 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	658 Synonym of remove static function but the path is taken from the directory
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	659 object.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	660 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	661 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	662 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	663 Irccd.Directory.prototype.remove(recursive)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	664 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	665 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	666 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	667 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	668 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	669 .It Fa recursive No (bool)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	670 Recursively or not (Optional, default: false).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	671 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	672 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	673 Throws
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	674 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	675 Any exception on error.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	676 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	677 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	678 .\" }}} !Methods
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	679 .\" }}} !Module: Irccd.Directory
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	680 .\" {{{ Module: Irccd.File
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	681 .Ss Irccd.File
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	682 This module is available for opening and writing files on the disk.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	683 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	684 For convenience, some functions are available as free-functions and some as
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	685 object methods.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	686 .\" {{{ Constants
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	687 The following constants properties are defined:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	688 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	689 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	690 .It Va SeekCur No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	691 Seek from the current file position.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	692 .It Va SeekEnd No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	693 Seek from end of the file.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	694 .It Va SeekSet No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	695 Seek from beginning of the file.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	696 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	697 .\" }}} !Constants
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	698 .\" {{{ Functions
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	699 .\" {{{ Irccd.File.basename
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	700 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	701 Irccd.File.basename
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	702 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	703 Return the file basename as specified in basename C function.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	704 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	705 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	706 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	707 base = Irccd.File.basename(path)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	708 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	709 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	710 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	711 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	712 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	713 .It Fa path No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	714 The path to the file.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	715 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	716 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	717 Returns
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	718 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	719 The base name.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	720 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	721 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	722 .\" {{{ Irccd.File.dirname
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	723 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	724 Irccd.File.dirname
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	725 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	726 Return the file directory name as specified in dirname C function.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	727 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	728 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	729 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	730 path = Irccd.File.dirname(path)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	731 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	732 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	733 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	734 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	735 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	736 .It Fa path No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	737 The path to the file.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	738 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	739 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	740 Returns
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	741 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	742 The directory name.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	743 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	744 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	745 .\" {{{ Irccd.File.exists
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	746 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	747 Irccd.File.exists
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	748 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	749 Check if the file exists.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	750 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	751 Warning: using this function is usually discouraged as it may introduce a
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	752 possible race condition.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	753 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	754 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	755 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	756 ret = Irccd.File.exists(path)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	757 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	758 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	759 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	760 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	761 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	762 .It Fa path No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	763 The path to the file.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	764 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	765 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	766 Throws
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	767 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	768 Irccd.SystemError on failure.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	769 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	770 Returns
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	771 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	772 True if exists.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	773 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	774 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	775 .\" {{{ Irccd.File.remove
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	776 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	777 Irccd.File.remove
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	778 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	779 Remove the file at the specified path.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	780 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	781 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	782 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	783 Irccd.File.remove(path)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	784 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	785 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	786 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	787 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	788 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	789 .It Fa path No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	790 The path to the file.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	791 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	792 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	793 Throws
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	794 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	795 Irccd.SystemError on failure.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	796 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	797 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	798 .\" {{{ Irccd.File.stat
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	799 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	800 Irccd.File.stat [optional]
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	801 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	802 Get file information at the specified path.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	803 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	804 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	805 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	806 info = Irccd.File.stat(path)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	807 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	808 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	809 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	810 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	811 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	812 .It Fa path No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	813 The path to the file.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	814 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	815 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	816 Throws
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	817 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	818 Irccd.SystemError on failure.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	819 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	820 Returns
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	821 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	822 An object with the following properties. Not all properties are available and
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	823 you must check its presence before using it.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	824 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	825 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	826 .It Va atime No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	827 The last access time.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	828 .It Va blksize No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	829 The block size.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	830 .It Va blocks No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	831 The number of blocks.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	832 .It Va ctime No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	833 The creation time.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	834 .It Va dev No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	835 The device.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	836 .It Va gid No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	837 The group numeric id.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	838 .It Va ino No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	839 The inode.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	840 .It Va mode No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	841 The mode.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	842 .It Va mtime No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	843 The modification time.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	844 .It Va nlink No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	845 The number of hard links.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	846 .It Va rdev No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	847 No description available.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	848 .It Va size No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	849 The file size.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	850 .It Va uid No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	851 The user numeric id.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	852 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	853 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	854 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	855 .\" }}} !Functions
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	856 .\" {{{ Methods
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	857 .\" {{{ Irccd.File [constructor]
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	858 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	859 Irccd.File [constructor]
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	860 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	861 Open a file specified by path with the specified mode.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	862 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	863 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	864 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	865 Irccd.File(path, mode)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	866 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	867 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	868 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	869 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	870 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	871 .It Fa path No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	872 The path to the file.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	873 .It Fa mode No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	874 The mode string.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	875 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	876 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	877 The
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	878 .Fa mode
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	879 is the same as if called by fopen, see the documentation of
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	880 .Xr fopen 3
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	881 for more information about modes.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	882 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	883 Throws
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	884 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	885 Irccd.SystemError on failure.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	886 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	887 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	888 .\" {{{ Irccd.File.prototype.basename
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	889 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	890 Irccd.File.prototype.basename
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	891 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	892 Synonym of Irccd.File.basename static function but with the path taken from the
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	893 object itself.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	894 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	895 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	896 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	897 path = Irccd.File.prototype.basename()
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	898 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	899 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	900 Returns
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	901 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	902 The base name.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	903 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	904 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	905 .\" {{{ Irccd.File.prototype.close
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	906 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	907 Irccd.File.prototype.close
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	908 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	909 Force close of the file, automatically called when object is collected.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	910 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	911 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	912 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	913 Irccd.File.prototype.close()
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	914 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	915 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	916 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	917 .\" {{{ Irccd.File.prototype.dirname
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	918 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	919 Irccd.File.prototype.dirname
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	920 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	921 Synonym of Irccd.File.dirname static function but with the path taken from the
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	922 object itself.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	923 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	924 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	925 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	926 path = Irccd.File.prototype.dirname()
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	927 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	928 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	929 Returns
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	930 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	931 The directory name.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	932 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	933 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	934 .\" {{{ Irccd.File.prototype.lines
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	935 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	936 Irccd.File.prototype.lines
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	937 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	938 Read all lines and return an array.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	939 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	940 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	941 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	942 list = Irccd.File.prototype.lines()
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	943 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	944 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	945 Throws
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	946 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	947 Irccd.SystemError on failure.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	948 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	949 Returns
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	950 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	951 An array with all lines.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	952 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	953 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	954 .\" {{{ Irccd.File.prototype.read
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	955 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	956 Irccd.File.prototype.read
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	957 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	958 Read the specified amount of characters or the whole file.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	959 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	960 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	961 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	962 str = Irccd.File.prototype.read(amount)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	963 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	964 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	965 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	966 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	967 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	968 .It Fa amount No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	969 The amount of characters or -1 to read all (Optional, default: -1).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	970 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	971 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	972 Throws
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	973 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	974 Irccd.SystemError on failure.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	975 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	976 Returns
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	977 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	978 The string.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	979 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	980 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	981 .\" {{{ Irccd.File.prototype.readline
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	982 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	983 Irccd.File.prototype.readline
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	984 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	985 Read the next line available.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	986 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	987 Warning: this method is slow and its usage is discouraged on large files.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	988 Consider using Irccd.File.prototype.lines function if you want to read a file
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	989 line per line.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	990 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	991 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	992 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	993 line = Irccd.File.prototype.readline()
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	994 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	995 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	996 Throws
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	997 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	998 Irccd.SystemError on failure.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	999 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1000 Returns
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1001 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1002 The next line or undefined if EOF.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1003 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1004 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1005 .\" {{{ Irccd.File.prototype.remove
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1006 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1007 Irccd.File.prototype.remove
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1008 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1009 Synonym of Irccd.File.remove static function but with the path taken from the
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1010 object itself.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1011 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1012 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1013 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1014 Irccd.File.prototype.remove()
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1015 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1016 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1017 Throws
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1018 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1019 Irccd.SystemError on failure.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1020 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1021 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1022 .\" {{{ Irccd.File.prototype.seek
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1023 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1024 Irccd.File.prototype.seek
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1025 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1026 Sets the position in the file.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1027 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1028 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1029 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1030 Irccd.File.prototype.seek(type, amount)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1031 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1032 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1033 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1034 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1035 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1036 .It Fa type No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1037 The type of setting
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1038 .Fa ( Irccd.File.SeekSet , Irccd.File.SeekCur , Irccd.File.SeekSet ) .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1039 .It Fa amount No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1040 The new offset.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1041 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1042 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1043 Throws
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1044 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1045 Irccd.SystemError on failure.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1046 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1047 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1048 .\" {{{ Irccd.File.prototype.stat
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1049 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1050 Irccd.File.prototype.stat [optional]
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1051 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1052 Synonym of Irccd.File.stat static function but with the path taken from the
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1053 object itself.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1054 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1055 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1056 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1057 info = Irccd.File.prototype.stat()
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1058 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1059 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1060 Throws
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1061 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1062 Irccd.SystemError on failure.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1063 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1064 Returns
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1065 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1066 The information object.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1067 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1068 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1069 .\" {{{ Irccd.File.prototype.tell
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1070 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1071 Irccd.File.prototype.tell
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1072 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1073 Get the actual position in the file.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1074 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1075 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1076 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1077 pos = Irccd.File.prototype.tell()
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1078 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1079 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1080 Throws
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1081 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1082 Irccd.SystemError on failure.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1083 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1084 Returns
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1085 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1086 The position.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1087 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1088 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1089 .\" {{{ Irccd.File.prototype.write
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1090 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1091 Irccd.File.prototype.write
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1092 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1093 Write some characters to the file.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1094 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1095 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1096 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1097 Irccd.File.prototype.write(data)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1098 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1099 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1100 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1101 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1102 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1103 .It Fa data No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1104 The character to write.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1105 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1106 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1107 Throws
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1108 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1109 Irccd.SystemError on failure.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1110 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1111 Returns
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1112 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1113 The number of bytes written.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1114 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1115 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1116 .\" }}} !Methods
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1117 .\" }}} !Module: Irccd.File
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1118 .\" {{{ Module: Irccd.Logger
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1119 .Ss Irccd.Logger
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1120 This module must be used to log something. It will add messages to the logging
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1121 system configured in the irccd.conf file.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1122 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1123 For instance, if user has chosen to log into syslog, this module will log at
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1124 syslog too.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1125 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1126 Any plugin can log messages, the message will be prepended by the plugin name to
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1127 be easily identifiable.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1128 .\" {{{ Functions
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1129 .\" {{{ Irccd.Logger.debug
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1130 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1131 Irccd.Logger.debug
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1132 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1133 Adds a debug message, this is only appended to the journal if irccd was compiled
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1134 in Debug mode.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1135 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1136 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1137 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1138 Irccd.Logger.debug(message)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1139 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1140 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1141 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1142 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1143 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1144 .It Fa message No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1145 The message.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1146 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1147 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1148 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1149 .\" {{{ Irccd.Logger.info
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1150 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1151 Irccd.Logger.info
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1152 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1153 Log something. The message is logged only if irccd is running with verbose
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1154 messages enabled.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1155 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1156 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1157 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1158 Irccd.Logger.info(message)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1159 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1160 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1161 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1162 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1163 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1164 .It Fa message No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1165 The message.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1166 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1167 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1168 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1169 .\" {{{ Irccd.Logger.warning
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1170 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1171 Irccd.Logger.warning
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1172 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1173 Log a warning. The message will always be logged.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1174 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1175 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1176 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1177 Irccd.Logger.warning(message)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1178 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1179 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1180 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1181 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1182 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1183 .It Fa message No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1184 The message.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1185 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1186 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1187 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1188 .\" }}} !Functions
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1189 .\" }}} !Module: Irccd.Logger
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1190 .\" {{{ Module: Irccd.Plugin
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1191 .Ss Irccd.Plugin
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1192 This module let you manage plugins.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1193 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1194 .\" {{{ Constants
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1195 The following constants properties are defined and contain each key-value pairs
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1196 from the user configuration file.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1197 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1198 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1199 .It Va config No (Object)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1200 Contains the
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1201 .Va [plugin.<name>]
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1202 section.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1203 .It Va paths No (Object)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1204 Contains the
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1205 .Va [paths.<name>]
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1206 section.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1207 .It Va templates No (Object)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1208 Contains the
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1209 .Va [format.<name>]
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1210 section.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1211 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1212 .\" }}} !Constants
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1213 .\" {{{ Functions
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1214 .\" {{{ Irccd.Plugin.info
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1215 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1216 Irccd.Plugin.info
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1217 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1218 Get information about a plugin.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1219 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1220 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1221 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1222 info = Irccd.Plugin.info(name)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1223 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1224 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1225 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1226 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1227 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1228 .It Fa name No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1229 The plugin identifier, if not specified the current plugin is selected.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1230 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1231 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1232 Returns
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1233 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1234 The plugin information or undefined if the plugin was not found. The object has
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1235 the following properties:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1236 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1237 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1238 .It Va name No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1239 The plugin identifier.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1240 .It Va author No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1241 The author.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1242 .It Va license No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1243 The license.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1244 .It Va summary No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1245 A short description.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1246 .It Va version No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1247 The version.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1248 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1249 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1250 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1251 .\" {{{ Irccd.Plugin.list
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1252 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1253 Irccd.Plugin.list
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1254 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1255 Get the list of plugins, the array returned contains all plugin names as
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1256 strings.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1257 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1258 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1259 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1260 list = Irccd.Plugin.list()
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1261 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1262 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1263 Returns
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1264 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1265 The list of all plugin names.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1266 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1267 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1268 .\" {{{ Irccd.Plugin.load
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1269 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1270 Irccd.Plugin.load
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1271 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1272 Load a plugin by name. This function will search through the standard
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1273 directories.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1274 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1275 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1276 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1277 Irccd.Plugin.load(name)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1278 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1279 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1280 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1281 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1282 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1283 .It Fa name No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1284 The plugin identifier.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1285 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1286 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1287 Throws
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1288 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1289 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1290 .It Va Error
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1291 On errors.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1292 .It Va ReferenceError
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1293 If the plugin was not found.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1294 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1295 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1296 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1297 .\" {{{ Irccd.Plugin.reload
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1298 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1299 Irccd.Plugin.reload
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1300 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1301 Reload a plugin by name.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1302 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1303 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1304 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1305 Irccd.Plugin.reload(name)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1306 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1307 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1308 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1309 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1310 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1311 .It Fa name No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1312 The plugin identifier.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1313 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1314 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1315 Throws
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1316 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1317 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1318 .It Va Error
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1319 On errors.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1320 .It Va ReferenceError
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1321 If the plugin was not found.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1322 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1323 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1324 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1325 .\" {{{ Irccd.Plugin.unload
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1326 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1327 Irccd.Plugin.unload
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1328 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1329 Unload a plugin by name and remove it.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1330 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1331 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1332 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1333 Irccd.Plugin.unload(name)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1334 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1335 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1336 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1337 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1338 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1339 .It Fa name No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1340 The plugin identifier.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1341 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1342 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1343 Throws
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1344 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1345 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1346 .It Va Error
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1347 On errors.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1348 .It Va ReferenceError
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1349 If the plugin was not found.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1350 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1351 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1352 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1353 .\" }}} !Functions
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1354 .\" }}} !Module: Irccd.Plugin
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1355 .\" {{{ Module: Irccd.Server
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1356 .Ss Irccd.Server
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1357 This module is the object that you received in almost all IRC event
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1358 (e.g. onConnect). You can use its methods to do your required actions on the
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1359 server.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1360 .\" {{{ Functions
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1361 .\" {{{ Irccd.Server.add
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1362 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1363 Irccd.Server.add
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1364 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1365 Add a new server to the irccd instance.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1366 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1367 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1368 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1369 Irccd.Server.add(server)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1370 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1371 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1372 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1373 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1374 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1375 .It Fa server No (Server)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1376 The server object to add.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1377 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1378 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1379 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1380 .\" {{{ Irccd.Server.find
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1381 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1382 Irccd.Server.find
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1383 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1384 Find a server by name.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1385 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1386 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1387 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1388 server = Irccd.Server.find(name)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1389 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1390 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1391 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1392 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1393 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1394 .It Fa name No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1395 The server name.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1396 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1397 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1398 Returns
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1399 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1400 The server object or undefined if not found.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1401 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1402 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1403 .\" {{{ Irccd.Server.list
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1404 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1405 Irccd.Server.list
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1406 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1407 List all servers in a map.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1408 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1409 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1410 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1411 table = Irccd.Server.list()
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1412 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1413 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1414 Returns
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1415 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1416 The table of all servers as key-value pairs where key is the server identifier
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1417 and value the object itself.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1418 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1419 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1420 .\" {{{ Irccd.Server.remove
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1421 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1422 Irccd.Server.remove
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1423 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1424 Remove a server from the irccd instance and disconnect it.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1425 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1426 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1427 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1428 Irccd.Server.remove(name)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1429 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1430 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1431 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1432 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1433 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1434 .It Fa name No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1435 The server name.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1436 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1437 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1438 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1439 .\" }}} !Functions
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1440 .\" {{{ Methods
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1441 .\" {{{ Irccd.Server [constructor]
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1442 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1443 Irccd.Server [constructor]
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1444 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1445 Construct a new server.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1446 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1447 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1448 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1449 Irccd.Server(info)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1450 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1451 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1452 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1453 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1454 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1455 .It Fa info No (object)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1456 Object information.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1457 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1458 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1459 The
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1460 .Fa info
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1461 argument may have the following properties:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1462 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1463 .It Fa name No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1464 The unique identifier name.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1465 .It Fa hostname No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1466 The host or IP address.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1467 .It Fa ipv4 No (bool)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1468 Enable ipv4 (Optional, default: true).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1469 .It Fa ipv6 No (bool)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1470 Enable ipv6, (Optional, default: true).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1471 .It Fa port No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1472 The port number, (Optional, default: 6667).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1473 .It Fa password No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1474 The password, (Optional, default: undefined).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1475 .It Fa channels No (array)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1476 Array of channels (Optional, default: empty).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1477 .It Fa ssl No (bool)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1478 True to use ssl, (Optional, default: false).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1479 .It Fa nickname No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1480 Nickname, (Optional, default: irccd).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1481 .It Fa username No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1482 User name, (Optional, default: irccd).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1483 .It Fa realname No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1484 Real name, (Optional, default: IRC Client Daemon).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1485 .It Fa commandChar No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1486 Plugin prefix character, (Optional, default: "!").
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1487 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1488 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1489 Warning: at least ipv4 and ipv6 must be set (which is the default).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1490 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1491 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1492 .\" {{{ Irccd.Server.prototype.info
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1493 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1494 Irccd.Server.prototype.info
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1495 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1496 Get server information.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1497 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1498 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1499 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1500 info = Irccd.Server.prototype.info()
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1501 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1502 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1503 Returns
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1504 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1505 The server information. The object have the following properties:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1506 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1507 .It Va name No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1508 The server unique name.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1509 .It Va hostname No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1510 The host name.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1511 .It Va port No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1512 The port number.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1513 .It Va ssl No (bool)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1514 True if using ssl.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1515 .It Va channels No (array)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1516 An array of all channels.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1517 .It Va realname No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1518 The current real name.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1519 .It Va username No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1520 The user name.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1521 .It Va nickname No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1522 The current nickname.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1523 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1524 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1525 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1526 .\" {{{ Irccd.Server.prototype.invite
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1527 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1528 Irccd.Server.prototype.invite
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1529 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1530 Invite the specified target on the channel.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1531 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1532 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1533 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1534 Irccd.Server.prototype.invite(target, channel)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1535 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1536 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1537 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1538 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1539 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1540 .It Fa target No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1541 The target to invite.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1542 .It Fa channel No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1543 The channel.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1544 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1545 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1546 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1547 .\" {{{ Irccd.Server.prototype.isSelf
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1548 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1549 Irccd.Server.prototype.isSelf
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1550 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1551 Check if the nickname targets the bot.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1552 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1553 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1554 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1555 res = Server.prototype.isSelf(nickname)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1556 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1557 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1558 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1559 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1560 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1561 .It Fa nickname No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1562 The nickname to check.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1563 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1564 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1565 Returns
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1566 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1567 True if nickname is same as the bot.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1568 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1569 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1570 .\" {{{ Irccd.Server.prototype.join
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1571 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1572 Irccd.Server.prototype.join
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1573 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1574 Join the specified channel, the password is optional.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1575 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1576 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1577 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1578 Irccd.Server.prototype.join(channel, password)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1579 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1580 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1581 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1582 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1583 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1584 .It Fa channel No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1585 The channel to join.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1586 .It Fa password No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1587 An optional password.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1588 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1589 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1590 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1591 .\" {{{ Irccd.Server.prototype.kick
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1592 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1593 Irccd.Server.prototype.kick
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1594 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1595 Kick the specified target from the channel, the reason is optional.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1596 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1597 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1598 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1599 Server.prototype.kick(nickname, channel, reason)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1600 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1601 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1602 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1603 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1604 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1605 .It Fa nickname No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1606 The person to kick.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1607 .It Fa channel No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1608 From which channel.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1609 .It Fa reason No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1610 A reason (Optional, default: undefined).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1611 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1612 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1613 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1614 .\" {{{ Irccd.Server.prototype.me
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1615 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1616 Irccd.Server.prototype.me
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1617 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1618 Send an action emote.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1619 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1620 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1621 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1622 Irccd.Server.prototype.me(target, message)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1623 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1624 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1625 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1626 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1627 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1628 .It Fa target No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1629 A nick or a channel.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1630 .It Fa message No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1631 The message to send.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1632 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1633 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1634 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1635 .\" {{{ Irccd.Server.prototype.message
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1636 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1637 Irccd.Server.prototype.message
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1638 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1639 Send a message to the specified target or channel.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1640 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1641 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1642 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1643 Irccd.Server.prototype.message(target, message)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1644 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1645 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1646 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1647 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1648 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1649 .It Fa target No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1650 The target.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1651 .It Fa message No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1652 The message to send.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1653 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1654 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1655 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1656 .\" {{{ Irccd.Server.prototype.mode
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1657 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1658 Irccd.Server.prototype.mode
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1659 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1660 Change irccd's user mode or a channel mode.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1661 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1662 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1663 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1664 Irccd.Server.prototype.mode(channel, mode, limit, user, mode)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1665 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1666 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1667 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1668 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1669 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1670 .It Fa channel No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1671 A channel or your nicknam.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1672 .It Fa mode No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1673 The new mode.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1674 .It Fa limit No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1675 An optional limit.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1676 .It Fa user No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1677 An optional use.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1678 .It Fa mask No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1679 An optional mas.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1680 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1681 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1682 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1683 .\" {{{ Irccd.Server.prototype.names
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1684 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1685 Irccd.Server.prototype.names
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1686 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1687 Get the list of names. This function will generate the onNames event.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1688 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1689 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1690 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1691 Irccd.Server.prototype.names(channel)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1692 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1693 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1694 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1695 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1696 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1697 .It Fa channel No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1698 The channel name.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1699 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1700 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1701 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1702 .\" {{{ Irccd.Server.prototype.nick
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1703 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1704 Irccd.Server.prototype.nick
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1705 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1706 Change irccd's nickname.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1707 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1708 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1709 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1710 Irccd.Server.prototype.nick(nickname)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1711 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1712 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1713 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1714 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1715 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1716 .It Fa nickname No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1717 The new nickname.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1718 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1719 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1720 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1721 .\" {{{ Irccd.Server.prototype.notice
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1722 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1723 Irccd.Server.prototype.notice
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1724 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1725 Send a private notice to the specified target.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1726 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1727 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1728 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1729 Irccd.Server.prototype.notice(nickname, message)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1730 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1731 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1732 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1733 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1734 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1735 .It Fa nickname No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1736 The target nickname.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1737 .It Fa message No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1738 The notice message.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1739 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1740 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1741 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1742 .\" {{{ Irccd.Server.prototype.part
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1743 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1744 Irccd.Server.prototype.part
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1745 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1746 Leave the specified channel, the reason is optional.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1747 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1748 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1749 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1750 Irccd.Server.prototype.part(channel, reason)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1751 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1752 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1753 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1754 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1755 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1756 .It Fa channel No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1757 The channel to leave.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1758 .It Fa reason No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1759 A reason (Optional, default: undefined).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1760 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1761 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1762 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1763 .\" {{{ Irccd.Server.prototype.toString
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1764 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1765 Irccd.Server.prototype.toString
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1766 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1767 Convert object as a string.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1768 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1769 Because each server has a unique identifier, this method allows adding a server
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1770 a property key.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1771 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1772 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1773 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1774 id = Irccd.Server.prototype.toString()
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1775 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1776 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1777 Returns
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1778 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1779 The server identifier.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1780 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1781 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1782 .\" {{{ Irccd.Server.prototype.topic
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1783 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1784 Irccd.Server.prototype.topic
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1785 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1786 Change the topic of the specified channel.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1787 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1788 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1789 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1790 Irccd.Server.prototype.topic(channel, topic)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1791 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1792 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1793 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1794 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1795 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1796 .It Fa channel No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1797 The channel.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1798 .It Fa topic No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1799 The new topic.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1800 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1801 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1802 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1803 .\" {{{ Irccd.Server.prototype.whois
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1804 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1805 Irccd.Server.prototype.whois
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1806 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1807 Get whois information from a user. The function will generate onWhois event.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1808 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1809 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1810 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1811 Irccd.Server.prototype.whois(target)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1812 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1813 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1814 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1815 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1816 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1817 .It Fa target No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1818 The target.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1819 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1820 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1821 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1822 .\" }}} !Methods
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1823 .\" }}} !Module: Irccd.Server
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1824 .\" {{{ Module: Irccd.System
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1825 .Ss Irccd.System
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1826 System inspection.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1827 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1828 Use this module if you want to inspect the system independently.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1829 .\" {{{ Functions
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1830 .\" {{{ Irccd.System.env
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1831 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1832 Irccd.System.env
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1833 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1834 Get a environment variable.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1835 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1836 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1837 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1838 value = Irccd.System.env(name)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1839 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1840 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1841 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1842 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1843 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1844 .It Fa name No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1845 The environment variable name.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1846 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1847 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1848 Returns
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1849 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1850 The variable or an empty string.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1851 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1852 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1853 .\" {{{ Irccd.System.exec
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1854 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1855 Irccd.System.exec
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1856 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1857 Execute a system command.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1858 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1859 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1860 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1861 Irccd.System.exec(cmd)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1862 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1863 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1864 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1865 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1866 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1867 .It Fa cmd No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1868 The command to execute.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1869 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1870 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1871 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1872 .\" {{{ Irccd.System.home
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1873 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1874 Irccd.System.home
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1875 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1876 Get the home directory. This function should be used with care, plugin should
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1877 not use user's home to store files.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1878 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1879 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1880 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1881 home = Irccd.System.home()
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1882 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1883 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1884 Returns
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1885 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1886 The user home directory.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1887 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1888 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1889 .\" {{{ Irccd.System.name
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1890 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1891 Irccd.System.name
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1892 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1893 Get the operating system name. Returns one of:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1894 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1895 .Bl -bullet -compact
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1896 .It
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1897 Linux
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1898 .It
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1899 Windows
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1900 .It
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1901 FreeBSD
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1902 .It
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1903 DragonFlyBSD
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1904 .It
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1905 OpenBSD
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1906 .It
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1907 NetBSD
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1908 .It
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1909 macOS
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1910 .It
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1911 Android
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1912 .It
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1913 Aix
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1914 .It
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1915 Haiku
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1916 .It
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1917 iOS
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1918 .It
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1919 Solaris
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1920 .It
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1921 Unknown
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1922 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1923 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1924 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1925 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1926 name = Irccd.System.name()
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1927 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1928 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1929 Returns
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1930 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1931 The operating system name.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1932 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1933 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1934 .\" {{{ Irccd.System.popen [optional]
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1935 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1936 Irccd.System.popen [optional]
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1937 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1938 Wrapper for
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1939 .Xr popen 3
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1940 if the function is available.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1941 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1942 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1943 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1944 handle = Irccd.System.popen(cmd, mode)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1945 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1946 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1947 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1948 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1949 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1950 .It Fa cmd No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1951 The command to execute.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1952 .It Fa mode No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1953 The mode (e.g. r).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1954 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1955 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1956 Throws
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1957 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1958 Irccd.SystemError on failure.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1959 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1960 Returns
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1961 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1962 An Irccd.File object.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1963 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1964 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1965 .\" {{{ Irccd.System.sleep
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1966 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1967 Irccd.System.sleep
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1968 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1969 Sleep for seconds. Suspend the execution thread.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1970 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1971 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1972 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1973 Irccd.System.sleep(sec)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1974 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1975 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1976 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1977 .\" {{{ Irccd.System.ticks
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1978 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1979 Irccd.System.ticks
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1980 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1981 Get the time spent from start. Get how many milliseconds spent since the irccd
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1982 startup.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1983 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1984 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1985 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1986 msec = Irccd.System.ticks()
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1987 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1988 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1989 Returns
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1990 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1991 The number of milliseconds.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1992 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1993 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1994 .\" {{{ Irccd.System.uptime
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1995 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1996 Irccd.System.uptime
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1997 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1998 Get the system uptime. This function returns the number of seconds elapsed since
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1999 the system boot up.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2000 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2001 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2002 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2003 secs = Irccd.System.uptime()
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2004 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2005 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2006 Returns
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2007 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2008 The number of seconds.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2009 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2010 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2011 .\" {{{ Irccd.System.usleep
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2012 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2013 Irccd.System.usleep
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2014 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2015 Sleep for milliseconds. Suspend the execution thread.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2016 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2017 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2018 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2019 Irccd.System.usleep(msec)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2020 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2021 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2022 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2023 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2024 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2025 .It Fa msec No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2026 The number of milliseconds.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2027 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2028 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2029 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2030 .\" {{{ Irccd.System.version
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2031 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2032 Irccd.System.version
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2033 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2034 Get the operating system version. Result of this function is system dependant.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2035 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2036 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2037 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2038 version = Irccd.System.version()
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2039 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2040 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2041 Returns
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2042 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2043 The version as a string.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2044 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2045 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2046 .\" }}} !Functions
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2047 .\" }}} !Module: Irccd.System
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2048 .\" {{{ Module: Irccd.Timer
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2049 .Ss Irccd.Timer
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2050 Create repetitive or one-shot timers.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2051 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2052 .\" {{{ Constants
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2053 The following constants properties are defined:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2054 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2055 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2056 .It Va Single No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2057 The timer is single-shot.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2058 .It Va Repeat No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2059 The timer is looping.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2060 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2061 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2062 .\" {{{ Methods
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2063 .\" {{{ Irccd.Timer [constructor]
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2064 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2065 Irccd.Timer [constructor]
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2066 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2067 Create a new timer object but do not start it immediately.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2068 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2069 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2070 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2071 Irccd.Timer(type, delay, callback)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2072 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2073 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2074 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2075 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2076 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2077 .It Fa type No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2078 Type of timer (
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2079 .Fa Irccd.Timer.Repeat
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2080 or
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2081 .Fa Irccd.Timer.Single ) .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2082 .It Fa delay No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2083 The interval in milliseconds.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2084 .It Fa callback No (function)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2085 The function to call.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2086 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2087 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2088 Example:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2089 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2090 var t = new Irccd.Timer(Irccd.Timer.Repeat, 1000, function () {
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2091 // Do your action, this will be called every 1 second.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2092 });
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2093 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2094 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2095 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2096 .\" {{{ Irccd.Timer.prototype.start
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2097 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2098 Irccd.Timer.prototype.start
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2099 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2100 Start the timer.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2101 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2102 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2103 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2104 Irccd.Timer.prototype.start()
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2105 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2106 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2107 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2108 .\" {{{ Irccd.Timer.prototype.stop
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2109 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2110 Irccd.Timer.prototype.stop
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2111 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2112 Stop the timer.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2113 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2114 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2115 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2116 Irccd.Timer.prototype.stop()
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2117 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2118 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2119 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2120 .\" }}} !Methods
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2121 .\" }}} !Module: Irccd.Timer
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2122 .\" {{{ Module: Irccd.Unicode
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2123 .Ss Irccd.Unicode
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2124 Check for character categories.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2125 .\" {{{ Functions
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2126 .\" {{{ Irccd.Unicode.isDigit
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2127 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2128 Irccd.Unicode.isDigit
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2129 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2130 Check if the unicode character is a digit.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2131 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2132 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2133 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2134 ret = Irccd.Unicode.isDigit(code)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2135 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2136 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2137 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2138 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2139 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2140 .It Fa code No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2141 The code point.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2142 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2143 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2144 Returns
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2145 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2146 True if digit.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2147 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2148 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2149 .\" {{{ Irccd.Unicode.isLetter
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2150 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2151 Irccd.Unicode.isLetter
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2152 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2153 Check if the unicode character is a letter.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2154 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2155 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2156 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2157 ret = Irccd.Unicode.isLetter(code)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2158 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2159 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2160 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2161 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2162 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2163 .It Fa code No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2164 The code point.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2165 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2166 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2167 Returns
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2168 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2169 True if letter.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2170 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2171 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2172 .\" {{{ Irccd.Unicode.isLower
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2173 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2174 Irccd.Unicode.isLower
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2175 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2176 Check if the unicode character is lower case.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2177 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2178 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2179 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2180 ret = Irccd.Unicode.isLower(code)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2181 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2182 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2183 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2184 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2185 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2186 .It Fa code No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2187 The code point.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2188 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2189 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2190 Returns
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2191 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2192 True if lower case.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2193 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2194 .\" }}} !Functions
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2195 .\" {{{ Irccd.Unicode.isSpace
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2196 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2197 Irccd.Unicode.isSpace
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2198 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2199 Check if the unicode character is a space.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2200 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2201 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2202 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2203 ret = Irccd.Unicode.isSpace(code)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2204 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2205 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2206 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2207 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2208 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2209 .It Fa code No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2210 The code point.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2211 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2212 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2213 Returns
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2214 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2215 True if space.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2216 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2217 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2218 .\" {{{ Irccd.Unicode.isTitle
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2219 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2220 Irccd.Unicode.isTitle
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2221 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2222 Check if the unicode character is title case.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2223 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2224 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2225 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2226 ret = Irccd.Unicode.isTitle(code)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2227 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2228 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2229 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2230 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2231 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2232 .It Fa code No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2233 The code point.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2234 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2235 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2236 Returns
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2237 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2238 True if title case.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2239 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2240 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2241 .\" {{{ Irccd.Unicode.isUppwer
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2242 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2243 Irccd.Unicode.isUpper
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2244 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2245 Check if the unicode character is upper case.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2246 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2247 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2248 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2249 ret = Irccd.Unicode.isUpper(code)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2250 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2251 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2252 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2253 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2254 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2255 .It Fa code No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2256 The code point.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2257 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2258 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2259 Returns
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2260 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2261 True if upper case.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2262 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2263 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2264 .\" }}} !Functions
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2265 .\" }}} !Module: Irccd.Unicode
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2266 .\" {{{ Module: Irccd.Util
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2267 .Ss Irccd.Util
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2268 Various utilities.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2269 .\" {{{ Functions
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2270 .\" {{{ Irccd.Util.cut
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2271 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2272 Irccd.Util.cut
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2273 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2274 Cut a piece of data into several lines.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2275 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2276 The argument
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2277 .Fa data
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2278 is a string or a list of strings. In any case, all strings are first splitted by
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2279 spaces and trimmed. This ensure that useless whitespaces are discarded.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2280 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2281 The argument
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2282 .Fa maxc
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2283 controls the maximum of characters allowed per line, it can be a positive
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2284 integer. If undefined is given, a default of 72 is used.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2285 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2286 The argument
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2287 .Fa maxl
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2288 controls the maximum of lines allowed. It can be a positive integer or undefined
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2289 for an infinite list.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2290 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2291 If
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2292 .Fa maxl
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2293 is used as a limit and the data can not fit within the bounds,
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2294 undefined is returned.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2295 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2296 An empty list may be returned if empty strings were found.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2297 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2298 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2299 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2300 lines = Irccd.Util.cut(data, maxc, maxl)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2301 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2302 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2303 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2304 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2305 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2306 .It Fa data No (mixed)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2307 A string or an array of strings.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2308 .It Fa maxc No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2309 Max number of colums (Optional, default: 72).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2310 .It Fa maxl No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2311 Max number of lines (Optional, default: undefined).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2312 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2313 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2314 Throws
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2315 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2316 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2317 .It Va RangeError
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2318 If maxl or maxc are negative numbers.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2319 .It Va RangeError
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2320 If one word length was bigger than maxc.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2321 .It Va TypeError
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2322 If data is not a string or a list of strings.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2323 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2324 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2325 Returns
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2326 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2327 A list of strings ready to be sent or undefined if the data is too big.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2328 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2329 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2330 .\" {{{ Irccd.Util.format
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2331 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2332 Irccd.Util.format
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2333 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2334 Format a string according to the template system.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2335 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2336 See the documentation about the template format in
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2337 .Xr irccd-templates 7 .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2338 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2339 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2340 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2341 str = Irccd.Util.format(input, params)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2342 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2343 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2344 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2345 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2346 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2347 .It Fa input No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2348 The text to update.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2349 .It Fa params No (Object)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2350 The parameters. For each keyword you want to replace in the
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2351 .Ar input ,
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2352 add a new entry into the object. Note: the special
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2353 .Va date
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2354 object key is reserved and must be set to a timestamp if desired.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2355 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2356 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2357 Returns
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2358 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2359 The converted text.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2360 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2361 Remarks
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2362 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2363 Be very careful when you use this function with untrusted input. Do never pass
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2364 untrusted content (e.g. user message) as input parameter.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2365 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2366 For example, the following code is unsafe:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2367 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2368 function onMessage(server, channel, origin, message)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2369 {
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2370 // DON'T DO THIS.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2371 server.message(channel, Irccd.Util.format("@{red}" + message + "@{}");
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2372 }
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2373 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2374 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2375 If a user sends a message like ${HOME}, it will prints the user home directory,
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2376 which is a high security issue if you have environment variables with passwords.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2377 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2378 Instead, always use a literal string using a replacement with the user input:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2379 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2380 function onMessage(server, channel, origin, message)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2381 {
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2382 // CORRECT.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2383 server.message(channel, Irccd.Util.format("@{red}#{message}@{}", {
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2384 message: message
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2385 });
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2386 }
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2387 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2388 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2389 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2390 .\" {{{ Irccd.Util.splithost
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2391 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2392 Irccd.Util.splithost
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2393 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2394 Extract the host from a user, for instance with foo!~foo@localhost,
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2395 .Em localhost
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2396 will be returned.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2397 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2398 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2399 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2400 hostname = Irccd.Util.splithost(user)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2401 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2402 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2403 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2404 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2405 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2406 .It Fa user No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2407 The user to split.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2408 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2409 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2410 Returns
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2411 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2412 The host
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2413 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2414 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2415 .\" {{{ Irccd.Util.splituser
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2416 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2417 Irccd.Util.splituser
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2418 .Bd -ragged -offset indent
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2419 Extract the name from a user, for instance with foo!~bar@localhost,
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2420 .Em foo
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2421 will be returned.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2422 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2423 Synopsis
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2424 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2425 nick = Irccd.Util.splituser(user)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2426 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2427 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2428 Arguments
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2429 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2430 .Bl -tag -width 20n -compact -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2431 .It Fa user No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2432 The user to split.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2433 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2434 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2435 Returns
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2436 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2437 The nickname.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2438 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2439 .\" }}}
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2440 .\" }}} !Functions
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2441 .\" }}} !Module: Irccd.Util
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2442 .\" SEE ALSO
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2443 .Sh SEE ALSO
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	2444 .Xr irccd 1

Mercurial > irccd

annotate man/irccd-api.7 @ 845:00a4720c4874