irccd: man/irccd-ipc.7 annotate

annotate man/irccd-ipc.7 @ 1004:3ea3361f0fc7

irccd: now track modes

author	David Demelier <markand@malikania.fr>
date	Tue, 16 Feb 2021 18:37:22 +0100
parents	5e25439fe98d
children	cf99df45cb84

rev	line source
845 00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	1 .\"
913 5e25439fe98d misc: update years David Demelier <markand@malikania.fr> parents: 845 diff changeset	2 .\" Copyright (c) 2013-2020 David Demelier <markand@malikania.fr>
845 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 network protocol
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 guide will help you controlling irccd via sockets.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	26 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	27 For this to work, you need to define at least one transport in your
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	28 .Pa irccd.conf
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	29 file, for more information see
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	30 .Xr irccd.conf 5 .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	31 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	32 Most of the commands are similar to
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	33 .Nm irccdctl
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	34 and mapped to the same network command. For more detailed information about each
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	35 command, take a look at
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	36 .Xr irccdctl 1
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	37 before.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	38 .\" SYNTAX
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	39 .Sh SYNTAX
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	40 Irccd use JSON as protocol for sending and receiving data. A message must ends
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	41 with
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	42 .Em \er\en\er\en
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	43 to be complete, thus it's possible to write JSON messages in multiple lines.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	44 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	45 For example, this buffer will be parsed as two different messages.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	46 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	47 {
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	48 "param1": "value1"
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	49 }
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	50
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	51 {
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	52 "param1": "value1"
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	53 }
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	54 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	55 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	56 Warning: please note that the \er\en\er\en characters are the escape characters
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	57 of line feed and new line, not the concatenation of \e and r.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	58 .\" RESPONSES
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	59 .Sh RESPONSES
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	60 All commands emit a response with the following properties:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	61 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	62 .Bl -tag -width 24n -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	63 .It Va command No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	64 the result of the issued command.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	65 .It Va error No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	66 the error error code, not defined on success.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	67 .It Va errorCategory No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	68 the error category (example: server, plugin).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	69 .It Va errorMessage No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	70 the arbitrary error message.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	71 .El
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 Example with a successful message:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	74 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	75 {
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	76 "command": "server-message",
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	77 }
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	78 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	79 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	80 Example with an error:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	81 .Bd -literal -offset Ds
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	82 {
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	83 "command": "server-message",
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	84 "error": 1,
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	85 "errorCagegory": "server",
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	86 "errorMessage": "server not found"
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	87 }
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	88 .Ed
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	89 .Sh COMMANDS
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	90 .\" COMMANDS
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	91 The following commands are available.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	92 .Bl -tag -width xxxxxxxx-yyyyyyyyy
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	93 .\" plugin-config
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	94 .It Cm plugin-config
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	95 Set or get values to a plugin.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	96 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	97 Available properties:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	98 .Bl -tag -width 20n
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	99 .It Va command No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	100 must be
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	101 .Em plugin-config .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	102 .It Va plugin No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	103 plugin identifier.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	104 .It Va variable No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	105 the variable (Optional, default: undefined).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	106 .It Va value No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	107 the value (Optional, default: undefined)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	108 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	109 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	110 The following properties are available in a successful response when getting a
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	111 value:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	112 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	113 .Bl -tag -width 20n
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	114 .It Va variables No (list)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	115 All values or unique variable.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	116 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	117 .\" plugin-info
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	118 .It Cm plugin-info
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	119 Retrieve plugin information.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	120 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	121 Available properties:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	122 .Bl -tag -width 20n
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	123 .It Va command No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	124 must be
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	125 .Em plugin-info .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	126 .It Va plugin No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	127 plugin identifier.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	128 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	129 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	130 The following properties are available in a successful response:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	131 .Bl -tag -width 20n
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	132 .It Va author No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	133 author name.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	134 .It Va license No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	135 plugin license.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	136 .It Va summary No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	137 plugin description.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	138 .It Va version No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	139 arbitrary version.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	140 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	141 .\" plugin-list
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	142 .It Cm plugin-list
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	143 Get the list of all loaded plugins.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	144 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	145 Available properties:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	146 .Bl -tag -width 20n
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	147 .It Va command No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	148 must be
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	149 .Em plugin-list .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	150 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	151 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	152 The following properties are available in a successful response:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	153 .Bl -tag -width 20n
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	154 .It Va list No (list)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	155 a list of plugin names.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	156 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	157 .\" plugin-load
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	158 .It Cm plugin-load
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	159 Load a plugin by searching it.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	160 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	161 Available properties:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	162 .Bl -tag -width 20n
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	163 .It Va command No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	164 must be
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	165 .Em plugin-load .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	166 .It Va plugin No (identifier)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	167 the plugin identifier.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	168 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	169 .\" plugin-reload
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	170 .It Cm plugin-reload
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	171 Reload a plugin.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	172 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	173 Available properties:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	174 .Bl -tag -width 20n
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	175 .It Va command No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	176 must be
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	177 .Em plugin-reload .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	178 .It Va plugin No (identifier)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	179 the plugin identifier.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	180 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	181 .\" plugin-unload
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	182 .It Cm plugin-unload
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	183 Unload a plugin.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	184 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	185 Available properties:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	186 .Bl -tag -width 20n
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	187 .It Va command No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	188 must be
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	189 .Em plugin-unload .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	190 .It Va plugin No (identifier)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	191 the plugin identifier.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	192 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	193 .\" rule-add
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	194 .It Cm rule-add
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	195 Add a new rule.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	196 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	197 Available properties:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	198 .Bl -tag -width 20n
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	199 .It Va command No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	200 must be
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	201 .Em rule-add .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	202 .It Va channels No (list)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	203 a list of channels to match (Optional, default: undefined).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	204 .It Va events No (list)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	205 a list of events to match (Optional, default: undefined).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	206 .It Va origins No (list)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	207 a list of origins to match (Optional, default: undefined).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	208 .It Va plugins No (list)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	209 a list of plugins to match (Optional, default: undefined).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	210 .It Va servers No (list)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	211 a list of servers to match (Optional, default: undefined).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	212 .It Va action No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	213 must be accept or drop.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	214 .It Va index No (unsigned)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	215 rule index (Optional, default: undefined).
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 .\" rule-edit
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	218 .It Cm rule-edit
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	219 Edit a rule in place.
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 Available properties:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	222 .Bl -tag -width 20n
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	223 .It Va command No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	224 must be
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	225 .Em rule-edit .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	226 .It Va add-channels No (list)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	227 a list of channels to match (Optional, default: undefined).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	228 .It Va add-events No (list)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	229 a list of events to match (Optional, default: undefined).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	230 .It Va add-origins No (list)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	231 a list of origins to match (Optional, default: undefined).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	232 .It Va add-plugins No (list)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	233 a list of plugins to match (Optional, default: undefined).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	234 .It Va add-servers No (list)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	235 a list of servers to match (Optional, default: undefined).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	236 .It Va remove-channels No (list)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	237 a list of channels to unmatch (Optional, default: undefined).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	238 .It Va remove-events No (list)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	239 a list of events to unmatch (Optional, default: undefined).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	240 .It Va remove-origins No (list)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	241 a list of origins to unmatch (Optional, default: undefined).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	242 .It Va remove-plugins No (list)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	243 a list of plugins to unmatch (Optional, default: undefined).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	244 .It Va remove-servers No (list)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	245 a list of servers to unmatch (Optional, default: undefined).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	246 .It Va action No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	247 can be accept or drop (Optional, default: undefined).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	248 .It Va index No (unsigned)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	249 rule index.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	250 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	251 .\" rule-info
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	252 .It Cm rule-info
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	253 Show information about a rule.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	254 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	255 Available properties:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	256 .Bl -tag -width 20n
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	257 .It Va command No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	258 must be
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	259 .Em rule-info .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	260 .It Va index No (unsigned)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	261 rule index.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	262 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	263 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	264 The following properties are available in a successful response:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	265 .Bl -tag -width 20n
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	266 .It Va servers No (list)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	267 a list of servers matched.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	268 .It Va channels No (list)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	269 a list of channels matched.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	270 .It Va origins No (list)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	271 a list of origins matched.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	272 .It Va plugins No (list)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	273 a list of plugins matched.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	274 .It Va events No (list)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	275 a list of events matched.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	276 .It Va action No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	277 rule action, accept or drop.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	278 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	279 .\" rule-list
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	280 .It Cm rule-list
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	281 Get a list of rules.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	282 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	283 Available properties:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	284 .Bl -tag -width 20n
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	285 .It Va command No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	286 must be
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	287 .Em rule-list .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	288 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	289 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	290 The following properties are available in a successful response:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	291 .Bl -tag -width 20n
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	292 .It Va list (list)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	293 a list of object that contain the same information as
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	294 .Cm rule-info
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	295 command was invoked.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	296 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	297 .\" rule-move
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	298 .It Cm rule-move
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	299 Move a rule.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	300 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	301 Available properties:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	302 .Bl -tag -width 20n
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	303 .It Va command No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	304 must be
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	305 .Em rule-move .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	306 .It Va from No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	307 the source index.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	308 .It Va to No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	309 the destination index.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	310 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	311 .\" rule-remove
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	312 .It Cm rule-remove
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	313 Remove a rule.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	314 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	315 Available properties:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	316 .Bl -tag -width 20n
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	317 .It Va command No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	318 must be
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	319 .Em rule-remove .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	320 .It Va index No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	321 rule index.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	322 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	323 .\" server-connect
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	324 .It Cm server-connect
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	325 Connect to a server.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	326 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	327 Available properties:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	328 .Bl -tag -width 20n
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	329 .It Va command No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	330 must be
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	331 .Em server-connect .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	332 .It Va name No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	333 the server unique id.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	334 .It Va hostname No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	335 the host address.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	336 .It Va port No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	337 the port number (Optional, default: 6667).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	338 .It Va ssl No (bool)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	339 use SSL (Optional, default: false).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	340 .It Va nickname No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	341 the nickname to use (Optional, default: irccd).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	342 .It Va username No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	343 the user name to use (Optional, default: irccd).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	344 .It Va realname No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	345 the real name to use. (Optional, default: IRC Client Daemon).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	346 .It Va ctcpVersion No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	347 the CTCP Version to answer. (Optional, default: the irccd's version),
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	348 .It Va commandChar No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	349 the command character to use to invoke command. (Optional, default: !).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	350 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	351 .\" server-disconnect
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	352 .It Cm server-disconnect
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	353 Disconnect from a server.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	354 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	355 If server is not specified, irccd disconnects all servers.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	356 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	357 Available properties:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	358 .Bl -tag -width 20n
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	359 .It Va command No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	360 must be
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	361 .Ar server-disconnect .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	362 .It Va server No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	363 the server unique id (Optional, default: none).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	364 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	365 .\" server-info
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	366 .It Cm server-info
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	367 Get server information.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	368 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	369 Available properties:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	370 .Bl -tag -width 20n
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	371 .It Va command No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	372 must be
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	373 .Ar server-info .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	374 .It Va server No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	375 the server unique id.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	376 .El
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 The following properties are available in a successful response:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	379 .Bl -tag -width 20n
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	380 .It Va name No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	381 the server unique id.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	382 .It Va hostname No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	383 the server hostname.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	384 .It Va port No (int)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	385 the port.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	386 .It Va ipv4 No (bool)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	387 true if using IPv6.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	388 .It Va ipv6 No (bool)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	389 true if using IPv6.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	390 .It Va ssl No (bool)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	391 true if connection is using SSL.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	392 .It Va channels No (list)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	393 list of channels.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	394 .It Va nickname No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	395 the current nickname in use.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	396 .It Va username No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	397 the username in use.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	398 .It Va realname No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	399 the realname in use.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	400 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	401 .\" server-invite
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	402 .It Cm server-invite
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	403 Invite the specified target on the channel.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	404 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	405 Available properties:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	406 .Bl -tag -width 20n
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	407 .It Va command No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	408 must be
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	409 .Ar server-invite .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	410 .It Va server No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	411 the server unique id.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	412 .It Va target No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	413 the nickname to invite.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	414 .It Va channel No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	415 the channel.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	416 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	417 .\" server-join
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	418 .It Cm server-join
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	419 Join the specified channel.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	420 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	421 Available properties:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	422 .Bl -tag -width 20n
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	423 .It Va command No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	424 must be
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	425 .Ar server-join .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	426 .It Va server No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	427 the server unique id.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	428 .It Va channel No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	429 the channel to join.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	430 .It Va password No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	431 the password (Optional, default: none).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	432 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	433 .\" server-kick
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	434 .It Cm server-kick
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	435 Kick the specified target from the channel.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	436 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	437 Available properties:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	438 .Bl -tag -width 20n
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	439 .It Va command No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	440 must be
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	441 .Ar server-kick .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	442 .It Va server No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	443 the server unique id.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	444 .It Va target No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	445 the target nickname.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	446 .It Va channel No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	447 the channel.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	448 .It Va reason No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	449 the reason (Optional, default: none).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	450 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	451 .\" server-list
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	452 .It Cm server-list
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	453 Get the list of all connected servers.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	454 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	455 Available properties:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	456 .Bl -tag -width 20n
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	457 .It Va command No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	458 must be
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	459 .Ar server-list .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	460 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	461 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	462 The following properties are available in a successful response:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	463 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	464 .Bl -tag -width 20n
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	465 .It Va list No (list)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	466 the list of all server unique ids as integers.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	467 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	468 .\" server-me
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	469 .It Cm server-me
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	470 Send an action emote.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	471 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	472 Available properties:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	473 .Bl -tag -width 20n
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	474 .It Va command No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	475 must be
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	476 .Ar server-me .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	477 .It Va server No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	478 the server unique id.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	479 .It Va target No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	480 the target or channel.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	481 .It Va message No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	482 the message.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	483 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	484 .\" server-message
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	485 .It Cm server-message
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	486 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	487 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	488 Available properties:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	489 .Bl -tag -width 20n
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	490 .It Va command No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	491 must be
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	492 .Ar server-message .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	493 .It Va server No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	494 the server unique id.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	495 .It Va target No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	496 the target or channel.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	497 .It Va message No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	498 the message.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	499 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	500 .\" server-mode
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	501 .It Cm server-mode
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	502 Change channel or bot mode.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	503 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	504 Available properties:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	505 .Bl -tag -width 20n
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	506 .It Va command No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	507 must be
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	508 .Ar server-mode .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	509 .It Va server No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	510 the server unique id.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	511 .It Va channel No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	512 the channel or irccd's nickname
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	513 .It Va mode No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	514 the mode.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	515 .It Va limit No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	516 a optional limit.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	517 .It Va user No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	518 a optional user.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	519 .It Va mask No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	520 a optional mask.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	521 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	522 .\" server-nick
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	523 .It Cm server-nick
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	524 Change irccd's nickname.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	525 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	526 Available properties:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	527 .Bl -tag -width 20n
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	528 .It Va command No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	529 must be
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	530 .Ar server-nick .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	531 .It Va server No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	532 the server unique id.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	533 .It Va nickname No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	534 the new nickname.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	535 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	536 .\" server-notice
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	537 .It Cm server-notice
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	538 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	539 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	540 Available properties:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	541 .Bl -tag -width 20n
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	542 .It Va command No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	543 must be
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	544 .Ar server-notice .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	545 .It Va server No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	546 the server unique id.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	547 .It Va target No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	548 the target.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	549 .It Va message No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	550 the notice message.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	551 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	552 .\" server-part
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	553 .It Cm server-part
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	554 Leave the specified channel.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	555 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	556 Available properties:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	557 .Bl -tag -width 20n
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	558 .It Va command No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	559 must be
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	560 .Ar server-part .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	561 .It Va server No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	562 the unique server id.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	563 .It Va channel No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	564 the channel to leave.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	565 .It Va reason No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	566 the reason (Optional, default: none).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	567 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	568 .\" server-reconnect
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	569 .It Cm server-reconnect
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	570 Force reconnection of one or all servers.
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 If server is not specified, all servers will try to reconnect.
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 Available properties:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	575 .Bl -tag -width 20n
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	576 .It Va command No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	577 must be
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	578 .Ar server-reconnect .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	579 .It Va server No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	580 the server unique id (Optional, default: none).
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	581 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	582 .\" server-topic
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	583 .It Cm server-topic
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	584 Change the topic of the specified channel.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	585 .Pp
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	586 Available properties:
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	587 .Bl -tag -width 20n
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	588 .It Va command No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	589 must be
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	590 .Ar server-topic .
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	591 .It Va server No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	592 the unique server id.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	593 .It Va channel No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	594 the channel.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	595 .It Va topic No (string)
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	596 the new topic.
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	597 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	598 .El
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	599 .\" SEE ALSO
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	600 .Sh SEE ALSO
00a4720c4874 doc: rewrite documentation in manual pages, closes #1674 David Demelier <markand@malikania.fr> parents: diff changeset	601 .Xr irccd 1

Mercurial > irccd

annotate man/irccd-ipc.7 @ 1004:3ea3361f0fc7