1
0
mirror of https://github.com/weechat/weechat.git synced 2026-06-12 14:14:48 +02:00

doc: fix some styles in relay protocol

This commit is contained in:
Sébastien Helleu
2017-08-11 19:13:18 +02:00
parent eba5060e8a
commit 6e366095f9
3 changed files with 27 additions and 15 deletions
+9 -5
View File
@@ -67,13 +67,17 @@ _IRC proxy_ (not described in this document).
[[commands]]
== Commands (client → relay)
Commands have format: "(id) command arguments\n".
Commands have format:
----
(id) command arguments\n
----
Fields are:
* _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)
(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).
@@ -89,8 +93,8 @@ List of available commands (detail in next chapters):
| 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)).
| sync | Synchronize buffer(s): get updates for buffer(s).
| desync | Desynchronize buffer(s): stop updates for buffer(s).
| quit | Disconnect from _relay_.
|===
@@ -524,7 +528,7 @@ There are two types of identifiers (_id_):
WeeChat reserved identifiers:
[width="100%",cols="5,5,3,4,7",options="header"]
[width="100%",cols="5m,5,3,4,7",options="header"]
|===
| Identifier | Received with _sync_ | Data sent |
Description | Recommended action in client
+9 -5
View File
@@ -71,13 +71,17 @@ un _proxy IRC_ (non décrit dans ce document).
[[commands]]
== Commandes (client → relay)
Les commandes ont le format : "(id) commande paramètres\n".
Les commandes ont le format :
----
(id) commande paramètres\n
----
Les champs sont :
* _id_ : identifiant du message (facultatif) qui sera envoyée dans la réponse de
_relay_; elle doit être entre parenthèses, et ne doit pas commencer par un
underscore ("_") (les identifiants commençant par un underscore sont réservés
underscore (les identifiants commençant par un underscore sont réservés
pour les messages _évènements_ de WeeChat)
* _commande_ : une commande (voir le tableau ci-dessous)
* _paramètres_ : paramètres facultatifs pour la commande (plusieurs paramètres
@@ -94,8 +98,8 @@ Liste des commandes disponibles (détail dans les chapitres suivants) :
| infolist | Demander une _infolist_.
| nicklist | Demander une _nicklist_ (liste de pseudos).
| input | Envoyer des données à un tampon (texte ou commande).
| sync | Synchroniser un/des tampon(s) (recevoir les mises à jour pour le(s) tampon(s)).
| desync | Désynchroniser un/des tampon(s) (stopper les mises à jour pour le(s) tampon(s)).
| sync | Synchroniser un/des tampon(s) : recevoir les mises à jour pour le(s) tampon(s).
| desync | Désynchroniser un/des tampon(s) : stopper les mises à jour pour le(s) tampon(s).
| quit | Se déconnecter de _relay_.
|===
@@ -544,7 +548,7 @@ Il y a deux types d'identifiants (_id_) :
Les identifiants réservés par WeeChat :
[width="100%",cols="5,5,3,4,7",options="header"]
[width="100%",cols="5m,5,3,4,7",options="header"]
|===
| Identifiant | Reçu avec _sync_ | Données envoyées |
Description | Action recommandée dans le client
+9 -5
View File
@@ -74,12 +74,16 @@ _リレー_ プラグインは _IRC プロキシ_ のように振舞います (
[[commands]]
== コマンド (クライアント → リレー)
コマンドの書式は以下です: "(id) command arguments\n".
コマンドの書式は以下です:
----
(id) command arguments\n
----
フィールドは:
* _id_: _リレー_ からの応答に含まれる任意指定のメッセージ識別子;
識別子は必ず括弧で括り、アンダースコア ("_") を最初につけるのは禁止されています
識別子は必ず括弧で括り、アンダースコア を最初につけるのは禁止されています
(アンダースコアが最初についている識別子は WeeChat _event_ メッセージ用に予約されています)
* _command_: コマンド (以下のテーブルを参照)
* _arguments_: コマンドに対する任意指定の引数
@@ -96,8 +100,8 @@ _リレー_ プラグインは _IRC プロキシ_ のように振舞います (
| infolist | _インフォリスト_ を要求
| nicklist | _ニックネームリスト_ を要求
| input | バッファにデータを送信 (テキストまたはコマンド)
| sync | バッファを同期 (バッファの最新情報を取得)
| desync | バッファを非同期 (バッファの更新を止める)
| sync | バッファを同期: バッファの最新情報を取得
| desync | バッファを非同期: バッファの更新を止める
| quit | _リレー_ から切断
|===
@@ -531,7 +535,7 @@ _compression_ フラグが 0x01 の場合、これ以降の *全ての* デー
WeeChat の予約識別子:
[width="100%",cols="5,5,3,4,7",options="header"]
[width="100%",cols="5m,5,3,4,7",options="header"]
|===
| 識別子 | _sync_ で受信 | 送信されるデータ |
説明 | 推奨するクライアントの挙動