irccd: man/irccd-api-server.3 annotate

annotate man/irccd-api-server.3 @ 1150:4c9d2d5d126f

irccd: add CTCP support in Irccd.Server, closes #2532

author	David Demelier <markand@malikania.fr>
date	Sun, 06 Feb 2022 15:03:59 +0100
parents	c165e975f144
children	1845a0509a93

rev	line source
932 0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	1 .\"
1136 f06e9761cc90 misc: update copyright years David Demelier <markand@malikania.fr> parents: 1030 diff changeset	2 .\" Copyright (c) 2013-2022 David Demelier <markand@malikania.fr>
932 0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	3 .\"
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	4 .\" Permission to use, copy, modify, and/or distribute this software for any
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	5 .\" purpose with or without fee is hereby granted, provided that the above
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	6 .\" copyright notice and this permission notice appear in all copies.
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	7 .\"
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	15 .\"
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	16 .Dd @IRCCD_MAN_DATE@
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	17 .Dt IRCCD-API-SERVER 3
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	18 .Os
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	19 .\" NAME
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	20 .Sh NAME
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	21 .Nm Irccd.Unicode
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	22 .Nd server management
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	23 .\" SYNOPSIS
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	24 .Sh SYNOPSIS
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	25 .Fn Irccd.Server.add "server"
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	26 .Fn Irccd.Server.find "name"
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	27 .Fn Irccd.Server.list
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	28 .Fn Irccd.Server.remove "name"
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	29 .Fn Irccd.Server "parameters"
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	30 .Fn Irccd.Server.prototype.info
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	31 .Fn Irccd.Server.prototype.invite "target, channel"
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	32 .Fn Irccd.Server.prototype.isSelf "nickname"
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	33 .Fn Irccd.Server.prototype.join "channel, password = undefined"
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	34 .Fn Irccd.Server.prototype.kick "target, channel, reason = undefined"
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	35 .Fn Irccd.Server.prototype.me "target, message"
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	36 .Fn Irccd.Server.prototype.message "target, message"
1030 509bcfb14670 misc: change signature to change mode David Demelier <markand@malikania.fr> parents: 1018 diff changeset	37 .Fn Irccd.Server.prototype.mode "target, mode, args"
932 0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	38 .Fn Irccd.Server.prototype.names "channel"
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	39 .Fn Irccd.Server.prototype.nick "nickname"
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	40 .Fn Irccd.Server.prototype.notice "target, message"
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	41 .Fn Irccd.Server.prototype.part "channel, reason = undefined"
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	42 .Fn Irccd.Server.prototype.toString
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	43 .Fn Irccd.Server.prototype.topic "target, topic"
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	44 .Fn Irccd.Server.prototype.whois "target"
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	45 .\" DESCRIPTION
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	46 .Sh DESCRIPTION
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	47 This module is the object that you received in almost all IRC event (e.g.
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	48 onConnect). You can use its methods to do your required actions on the server.
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	49 .\" METHODS
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	50 .Sh METHODS
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	51 .\" Irccd.Server.add
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	52 The
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	53 .Fn Irccd.Server.add
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	54 method adds the new
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	55 .Fa server
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	56 into the irccd instance.
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	57 .Pp
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	58 .\" Irccd.Server.find
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	59 The
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	60 .Fn Irccd.Server.find
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	61 method finds a server by its
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	62 .Fa name
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	63 and returns it.
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	64 .Pp
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	65 .\" Irccd.Server.list
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	66 The
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	67 .Fn Irccd.Server.list
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	68 method returns a map of all running servers. The table of all servers as
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	69 key-value pairs where key is the server identifier and value the object itself.
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	70 .Pp
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	71 .\" Irccd.Server.remove
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	72 The
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	73 .Fn Irccd.Server.remove
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	74 method removes the server specified by
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	75 .Fa name
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	76 from the irccd instance and disconnects it.
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	77 .Pp
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	78 .\" Irccd.Server
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	79 The
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	80 .Fn Irccd.Server
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	81 constructor function creates a new server with settings in the
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	82 .Fa parameters
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	83 object which may have the following properties:
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	84 .Pp
1004 3ea3361f0fc7 irccd: now track modes David Demelier <markand@malikania.fr> parents: 996 diff changeset	85 .Bl -tag -width "hostname (string)"
932 0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	86 .It Fa name No (string)
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	87 The unique identifier name.
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	88 .It Fa hostname No (string)
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	89 The host or IP address.
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	90 .It Fa port No (int)
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	91 The port number, (Optional, default: 6667).
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	92 .It Fa password No (string)
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	93 The password, (Optional, default: undefined).
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	94 .It Fa channels No (array)
996 2a6d753f79f6 man: add back David Demelier <markand@malikania.fr> parents: 932 diff changeset	95 Array of channels as object of two properties:
2a6d753f79f6 man: add back David Demelier <markand@malikania.fr> parents: 932 diff changeset	96 .Fa name
2a6d753f79f6 man: add back David Demelier <markand@malikania.fr> parents: 932 diff changeset	97 and
2a6d753f79f6 man: add back David Demelier <markand@malikania.fr> parents: 932 diff changeset	98 .Fa password (optional)
2a6d753f79f6 man: add back David Demelier <markand@malikania.fr> parents: 932 diff changeset	99 as channel name and password respectively. (Optional, default: empty).
932 0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	100 .It Fa ssl No (bool)
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	101 True to use ssl (Optional, default: false).
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	102 .It Fa nickname No (string)
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	103 Nickname, (Optional, default: irccd).
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	104 .It Fa username No (string)
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	105 User name, (Optional, default: irccd).
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	106 .It Fa realname No (string)
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	107 Real name, (Optional, default: IRC Client Daemon).
996 2a6d753f79f6 man: add back David Demelier <markand@malikania.fr> parents: 932 diff changeset	108 .It Fa prefix No (string)
932 0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	109 Plugin prefix character, (Optional, default: "!").
1150 4c9d2d5d126f irccd: add CTCP support in Irccd.Server, closes #2532 David Demelier <markand@malikania.fr> parents: 1137 diff changeset	110 .It Fa ctcp No (object)
4c9d2d5d126f irccd: add CTCP support in Irccd.Server, closes #2532 David Demelier <markand@malikania.fr> parents: 1137 diff changeset	111 An object with CTCP variables to send, see
4c9d2d5d126f irccd: add CTCP support in Irccd.Server, closes #2532 David Demelier <markand@malikania.fr> parents: 1137 diff changeset	112 .Fn Irccd.Server.prototype.info
4c9d2d5d126f irccd: add CTCP support in Irccd.Server, closes #2532 David Demelier <markand@malikania.fr> parents: 1137 diff changeset	113 method for possible values.
932 0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	114 .El
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	115 .Pp
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	116 .\" Irccd.Server.prototype.info
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	117 The
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	118 .Fn Irccd.Server.prototype.info
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	119 method returns the server information. The object have the following
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	120 properties:
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	121 .Pp
1004 3ea3361f0fc7 irccd: now track modes David Demelier <markand@malikania.fr> parents: 996 diff changeset	122 .Bl -tag -width "hostname (string)"
932 0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	123 .It Va name No (string)
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	124 The server unique name.
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	125 .It Va hostname No (string)
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	126 The host name.
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	127 .It Va port No (int)
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	128 The port number.
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	129 .It Va ssl No (bool)
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	130 True if using ssl.
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	131 .It Va channels No (array)
1004 3ea3361f0fc7 irccd: now track modes David Demelier <markand@malikania.fr> parents: 996 diff changeset	132 An array of all channels as objects. Each channel in the returned array contain
3ea3361f0fc7 irccd: now track modes David Demelier <markand@malikania.fr> parents: 996 diff changeset	133 the following properties:
3ea3361f0fc7 irccd: now track modes David Demelier <markand@malikania.fr> parents: 996 diff changeset	134 .Bl -tag -width "name (string)"
996 2a6d753f79f6 man: add back David Demelier <markand@malikania.fr> parents: 932 diff changeset	135 .It Va name No (string)
2a6d753f79f6 man: add back David Demelier <markand@malikania.fr> parents: 932 diff changeset	136 The channel name.
2a6d753f79f6 man: add back David Demelier <markand@malikania.fr> parents: 932 diff changeset	137 .It Va joined No (bool)
2a6d753f79f6 man: add back David Demelier <markand@malikania.fr> parents: 932 diff changeset	138 True if the daemon is actually present on this channel.
2a6d753f79f6 man: add back David Demelier <markand@malikania.fr> parents: 932 diff changeset	139 .It Va users No (array)
1004 3ea3361f0fc7 irccd: now track modes David Demelier <markand@malikania.fr> parents: 996 diff changeset	140 An array of users that consists of objects with two properties:
3ea3361f0fc7 irccd: now track modes David Demelier <markand@malikania.fr> parents: 996 diff changeset	141 .Va nickname No (string) and modes Fa (int)
3ea3361f0fc7 irccd: now track modes David Demelier <markand@malikania.fr> parents: 996 diff changeset	142 as their nickname and modes as bitwise mask for this channel.
996 2a6d753f79f6 man: add back David Demelier <markand@malikania.fr> parents: 932 diff changeset	143 .El
2a6d753f79f6 man: add back David Demelier <markand@malikania.fr> parents: 932 diff changeset	144 .Pp
932 0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	145 .It Va realname No (string)
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	146 The current real name.
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	147 .It Va username No (string)
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	148 The user name.
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	149 .It Va nickname No (string)
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	150 The current nickname.
1150 4c9d2d5d126f irccd: add CTCP support in Irccd.Server, closes #2532 David Demelier <markand@malikania.fr> parents: 1137 diff changeset	151 .It Va ctcp No (object)
4c9d2d5d126f irccd: add CTCP support in Irccd.Server, closes #2532 David Demelier <markand@malikania.fr> parents: 1137 diff changeset	152 An object with CTCP properties, currently:
4c9d2d5d126f irccd: add CTCP support in Irccd.Server, closes #2532 David Demelier <markand@malikania.fr> parents: 1137 diff changeset	153 .Bl -tag -width "Va version"
4c9d2d5d126f irccd: add CTCP support in Irccd.Server, closes #2532 David Demelier <markand@malikania.fr> parents: 1137 diff changeset	154 .It Va version
4c9d2d5d126f irccd: add CTCP support in Irccd.Server, closes #2532 David Demelier <markand@malikania.fr> parents: 1137 diff changeset	155 User version.
4c9d2d5d126f irccd: add CTCP support in Irccd.Server, closes #2532 David Demelier <markand@malikania.fr> parents: 1137 diff changeset	156 .It Va source
4c9d2d5d126f irccd: add CTCP support in Irccd.Server, closes #2532 David Demelier <markand@malikania.fr> parents: 1137 diff changeset	157 SCM source.
4c9d2d5d126f irccd: add CTCP support in Irccd.Server, closes #2532 David Demelier <markand@malikania.fr> parents: 1137 diff changeset	158 .El
932 0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	159 .El
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	160 .Pp
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	161 .\" Irccd.Server.prototype.invite
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	162 The
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	163 .Fn Irccd.Server.prototype.invite
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	164 method invites the specified
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	165 .Fa target
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	166 on the given
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	167 .Fa channel .
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	168 .Pp
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	169 .\" Irccd.Server.prototype.isSelf
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	170 The
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	171 .Fn Irccd.Server.prototype.isSelf
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	172 method returns true if
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	173 .Fa nickname
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	174 targets the bot.
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	175 .Pp
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	176 .\" Irccd.Server.prototype.join
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	177 The
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	178 .Fn Irccd.Server.prototype.join
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	179 method joins the specified
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	180 .Fa channel
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	181 with an optional
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	182 .Fa password .
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	183 .Pp
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	184 .\" Irccd.Server.prototype.kick
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	185 The
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	186 .Fn Irccd.Server.prototype.kick
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	187 method kicks the specified
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	188 .Fa target
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	189 from the
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	190 .Fa channel ,
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	191 the
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	192 .Fa reason
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	193 is optional.
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	194 .Pp
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	195 .\" Irccd.Server.prototype.me
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	196 The
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	197 .Fn Irccd.Server.prototype.me
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	198 method sends an action emote
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	199 .Fa message
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	200 to the given
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	201 .Fa target .
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	202 .Pp
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	203 .\" Irccd.Server.prototype.message
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	204 The
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	205 .Fn Irccd.Server.prototype.message
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	206 method sends the
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	207 .Fa message
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	208 to the specified
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	209 .Fa target .
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	210 .Pp
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	211 .\" Irccd.Server.prototype.mode
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	212 The
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	213 .Fn Irccd.Server.prototype.mode
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	214 method changes irccd's user mode or a channel mode. If the
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	215 .Fa target
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	216 is the bot's nickname, it changes its
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	217 .Fa mode .
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	218 otherwise it changes the channel one.
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	219 The optional argument
1030 509bcfb14670 misc: change signature to change mode David Demelier <markand@malikania.fr> parents: 1018 diff changeset	220 .Fa args
509bcfb14670 misc: change signature to change mode David Demelier <markand@malikania.fr> parents: 1018 diff changeset	221 contains additional mode arguments.
932 0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	222 .Pp
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	223 .\" Irccd.Server.prototype.names
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	224 The
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	225 .Fn Irccd.Server.prototype.names
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	226 method requests a list of names for the given
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	227 .Fa channel .
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	228 This function will generate the onNames event.
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	229 .Pp
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	230 .\" Irccd.Server.prototype.nick
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	231 The
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	232 .Fn Irccd.Server.prototype.nick
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	233 method changes the bot's
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	234 .Fa nickname .
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	235 .Pp
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	236 .\" Irccd.Server.prototype.notice
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	237 The
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	238 .Fn Irccd.Server.prototype.notice
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	239 method sends a private notice
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	240 .Fa message
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	241 to the specified
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	242 .Fa target .
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	243 .Pp
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	244 .\" Irccd.Server.prototype.part
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	245 The
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	246 .Fn Irccd.Server.prototype.part
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	247 method leaves the specified
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	248 .Fa channel ,
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	249 using an optional
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	250 .Fa reason
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	251 if not null.
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	252 .Pp
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	253 .\" Irccd.Server.prototype.toString
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	254 The
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	255 .Fn Irccd.Server.prototype.toString
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	256 method converts the server to string by returning its unique identifier.
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	257 Because each server has a unique identifier, this method allows adding a server
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	258 as property key in maps.
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	259 .Pp
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	260 .\" Irccd.Server.prototype.topic
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	261 The
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	262 .Fn Irccd.Server.prototype.topic
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	263 method sets the topic to
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	264 .Fa topic
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	265 in the given
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	266 .Fa channel .
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	267 .Pp
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	268 .\" Irccd.Server.prototype.whois
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	269 The
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	270 .Fn Irccd.Server.prototype.whois
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	271 method requests whois information for the
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	272 .Fa target .
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	273 This function will generate onWhois event.
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	274 .Pp
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	275 .\" EXCEPTIONS
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	276 .Sh EXCEPTIONS
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	277 .Bl -tag -width 22n
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	278 .It Bq Er Irccd.ServerError
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	279 Thrown on server errors. Usually on invalid arguments.
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	280 .It Bq Er Error
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	281 On other errors.
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	282 .El
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	283 .\" SEE ALSO
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	284 .Sh SEE ALSO
0e11221c9bcc man: split irccd-api into individual ones David Demelier <markand@malikania.fr> parents: diff changeset	285 .Xr irccd-api 3
1137 c165e975f144 man: improvements David Demelier <markand@malikania.fr> parents: 1136 diff changeset	286 .\" AUTHORS
c165e975f144 man: improvements David Demelier <markand@malikania.fr> parents: 1136 diff changeset	287 .Sh AUTHORS
c165e975f144 man: improvements David Demelier <markand@malikania.fr> parents: 1136 diff changeset	288 The
c165e975f144 man: improvements David Demelier <markand@malikania.fr> parents: 1136 diff changeset	289 .Nm irccd
c165e975f144 man: improvements David Demelier <markand@malikania.fr> parents: 1136 diff changeset	290 daemon was written by
c165e975f144 man: improvements David Demelier <markand@malikania.fr> parents: 1136 diff changeset	291 .An David Demelier Aq Mt markand@malikania.fr .

Mercurial > irccd

annotate man/irccd-api-server.3 @ 1150:4c9d2d5d126f