Mercurial > irccd

comparison man/irccd-api-server.3 @ 1004:3ea3361f0fc7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
irccd: now track modes
author David Demelier <markand@malikania.fr>
date Tue, 16 Feb 2021 18:37:22 +0100
parents 2a6d753f79f6
children cf99df45cb84
comparison
equal deleted inserted replaced
1003:bbb3d3075ec2 1004:3ea3361f0fc7
80 .Fn Irccd.Server 80 .Fn Irccd.Server
81 constructor function creates a new server with settings in the 81 constructor function creates a new server with settings in the
82 .Fa parameters 82 .Fa parameters
83 object which may have the following properties: 83 object which may have the following properties:
84 .Pp 84 .Pp
85 .Bl -tag -compact -width "hostname (string)" 85 .Bl -tag -width "hostname (string)"
86 .It Fa name No (string) 86 .It Fa name No (string)
87 The unique identifier name. 87 The unique identifier name.
88 .It Fa hostname No (string) 88 .It Fa hostname No (string)
89 The host or IP address. 89 The host or IP address.
90 .It Fa port No (int) 90 .It Fa port No (int)
113 The 113 The
114 .Fn Irccd.Server.prototype.info 114 .Fn Irccd.Server.prototype.info
115 method returns the server information. The object have the following 115 method returns the server information. The object have the following
116 properties: 116 properties:
117 .Pp 117 .Pp
118 .Bl -tag -compact -width "hostname (string)" 118 .Bl -tag -width "hostname (string)"
119 .It Va name No (string) 119 .It Va name No (string)
120 The server unique name. 120 The server unique name.
121 .It Va hostname No (string) 121 .It Va hostname No (string)
122 The host name. 122 The host name.
123 .It Va port No (int) 123 .It Va port No (int)
124 The port number. 124 The port number.
125 .It Va ssl No (bool) 125 .It Va ssl No (bool)
126 True if using ssl. 126 True if using ssl.
127 .It Va channels No (array) 127 .It Va channels No (array)
128 An array of all channels. Each channel in the returned array contain the 128 An array of all channels as objects. Each channel in the returned array contain
129 following properties: 129 the following properties:
130 .Bl -tag -width xxx 130 .Bl -tag -width "name (string)"
131 .It Va name No (string) 131 .It Va name No (string)
132 The channel name. 132 The channel name.
133 .It Va joined No (bool) 133 .It Va joined No (bool)
134 True if the daemon is actually present on this channel. 134 True if the daemon is actually present on this channel.
135 .It Va users No (array) 135 .It Va users No (array)
136 An array of users that consists of objects with three properties: 136 An array of users that consists of objects with two properties:
137 .Va nickname , mode 137 .Va nickname No (string) and modes Fa (int)
138 and 138 as their nickname and modes as bitwise mask for this channel.
139 .Va symbol
140 as their nickname, the channel mode and the symbol representing this mode.
141 .El 139 .El
142 .Pp 140 .Pp
143 .It Va realname No (string) 141 .It Va realname No (string)
144 The current real name. 142 The current real name.
145 .It Va username No (string) 143 .It Va username No (string)