From baebbb25a3e32ec2a1eee8ae99c8ee08a4e6c842 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Helleu?= Date: Wed, 4 May 2016 22:19:37 +0200 Subject: doc: fix styles in relay protocol (issue #722) --- doc/en/weechat_relay_protocol.en.asciidoc | 305 +++++++++++++++-------------- doc/fr/weechat_relay_protocol.fr.asciidoc | 308 +++++++++++++++--------------- doc/ja/weechat_relay_protocol.ja.asciidoc | 294 ++++++++++++++-------------- 3 files changed, 453 insertions(+), 454 deletions(-) (limited to 'doc') diff --git a/doc/en/weechat_relay_protocol.en.asciidoc b/doc/en/weechat_relay_protocol.en.asciidoc index e326f59af..796350fef 100644 --- a/doc/en/weechat_relay_protocol.en.asciidoc +++ b/doc/en/weechat_relay_protocol.en.asciidoc @@ -7,27 +7,26 @@ :docinfo1: -This document is the specification of WeeChat Relay protocol: the protocol used -to relay WeeChat data to clients, which are mostly remote interfaces. - - [[introduction]] == Introduction +This document is the specification of WeeChat Relay protocol: the protocol used +to relay WeeChat data to clients, which are mostly remote interfaces. + [[terminology]] === Terminology The following terms are used in this document: -* 'relay': this is the WeeChat with relay plugin, which acts as "server" and - allows 'clients' to connect -* 'client': this is another software, connected to 'relay' via a network - connection; in most cases, this 'client' is a remote interface. +* _relay_: this is the WeeChat with relay plugin, which acts as "server" and + allows _clients_ to connect +* _client_: this is another software, connected to _relay_ via a network + connection; in most cases, this _client_ is a remote interface. [[network_diagram]] === Network diagram -The 'clients' are connected to 'relay' like shown in this diagram: +The _clients_ are connected to _relay_ like shown in this diagram: .... ┌──────────┐ Workstation @@ -48,20 +47,20 @@ network servers ncurses interface relay remote interfaces .... [NOTE] -All clients here are clients using 'weechat' protocol in 'relay' plugin. The -'relay' plugin also allows IRC clients, then 'relay' plugin acts as an -'IRC proxy' (not described in this document). +All clients here are clients using _weechat_ protocol in _relay_ plugin. The +_relay_ plugin also allows IRC clients, then _relay_ plugin acts as an +_IRC proxy_ (not described in this document). [[protocol_generalities]] == Protocol generalities -* Connections from 'client' to 'relay' are made using TCP sockets on IP/port - used by 'relay' plugin to listen to new connections. -* Number of 'clients' is limited by the option 'relay.network.max_clients'. -* Each 'client' is independent from other clients. -* Messages from 'client' to 'relay' are called 'commands', they are sent as text +* Connections from _client_ to _relay_ are made using TCP sockets on IP/port + used by _relay_ plugin to listen to new connections. +* Number of _clients_ is limited by the option _relay.network.max_clients_. +* Each _client_ is independent from other clients. +* Messages from _client_ to _relay_ are called _commands_, they are sent as text (a string). -* Messages from 'relay' to 'client' are called 'messages', they are sent as +* Messages from _relay_ to _client_ are called _messages_, they are sent as binary data. [[commands]] @@ -71,11 +70,11 @@ Commands have format: "(id) command arguments\n". Fields are: -* 'id': optional message identifier that will be sent in answer from 'relay'; +* _id_: optional message identifier that will be sent in answer from _relay_; it must be enclosed in parentheses, and must not start with an underscore - ("_") (ids starting with underscore are reserved for WeeChat 'event' messages) -* 'command': a command (see table below) -* 'arguments': optional arguments for command (many arguments are separated by + ("_") (ids starting with underscore are reserved for WeeChat _event_ messages) +* _command_: a command (see table below) +* _arguments_: optional arguments for command (many arguments are separated by spaces). List of available commands (detail in next chapters): @@ -83,22 +82,22 @@ List of available commands (detail in next chapters): [width="80%",cols="^3m,14",options="header"] |=== | Command | Description -| init | Initialize connection with 'relay' -| hdata | Request a 'hdata' -| info | Request an 'info' -| infolist | Request an 'infolist' -| nicklist | Request a 'nicklist' +| init | Initialize connection with _relay_ +| hdata | Request a _hdata_ +| info | Request an _info_ +| infolist | Request an _infolist_ +| nicklist | Request a _nicklist_ | input | Send data to a buffer (text or command) | sync | Synchronize buffer(s) (get updates for buffer(s)) | desync | Desynchronize buffer(s) (stop updates for buffer(s)) -| quit | Disconnect from 'relay' +| quit | Disconnect from _relay_ |=== [[command_init]] === init -Initialize connection with 'relay'. This must be first command sent to 'relay'. -If not sent, 'relay' will close connection on first command received, without +Initialize connection with _relay_. This must be first command sent to _relay_. +If not sent, _relay_ will close connection on first command received, without warning. Syntax: @@ -109,15 +108,15 @@ init [