summaryrefslogtreecommitdiff
path: root/doc/ja/weechat_user.ja.adoc
diff options
context:
space:
mode:
authorSébastien Helleu <flashcode@flashtux.org>2021-12-05 14:58:56 +0100
committerSébastien Helleu <flashcode@flashtux.org>2021-12-05 20:59:19 +0100
commit7cb5147e74ef0e8d2eaf39b312051b54d0cf1ba2 (patch)
treedcd891cd7c2472815057ac59c139e40c64da02e3 /doc/ja/weechat_user.ja.adoc
parenta5ffd8b80015f88872d1db82d93ce10b17edfcff (diff)
downloadweechat-7cb5147e74ef0e8d2eaf39b312051b54d0cf1ba2.zip
doc: move section "Relay" at top level after "IRC" (user's guide)
Diffstat (limited to 'doc/ja/weechat_user.ja.adoc')
-rw-r--r--doc/ja/weechat_user.ja.adoc348
1 files changed, 174 insertions, 174 deletions
diff --git a/doc/ja/weechat_user.ja.adoc b/doc/ja/weechat_user.ja.adoc
index c422bd4bf..e03d5ec87 100644
--- a/doc/ja/weechat_user.ja.adoc
+++ b/doc/ja/weechat_user.ja.adoc
@@ -273,7 +273,7 @@ CMake に対するオプションを指定するには、以下の書式を使
Compile <<scripts_plugins,Python plugin>> using Python 2 instead of Python 3.
| ENABLE_RELAY | `ON`, `OFF` | ON |
- <<relay_plugin,リレープラグイン>>のコンパイル。
+ <<relay,リレープラグイン>>のコンパイル。
| ENABLE_RUBY | `ON`, `OFF` | ON |
<<scripts_plugins,Ruby プラグイン>>のコンパイル。
@@ -3738,169 +3738,8 @@ _irc.conf_ ファイル内のセクション:
include::includes/autogen_user_options.ja.adoc[tag=irc_options]
-[[plugins]]
-== プラグイン
-
-プラグインとは動的ライブラリのことで、C
-言語で書かれてコンパイルされています。プラグインは WeeChat によって読み込まれます。GNU/Linux
-の場合、プラグインファイルは ".so" という拡張子を持ち、Windows の場合、".dll" です。
-
-見つかったプラグインは WeeChat の起動時に自動的に読み込まれます。WeeChat
-の起動時にプラグインを読み込むか否かは選択可能です。
-
-_プラグイン_ と _スクリプト_ の違いを明らかにすることは重要です:
-_プラグイン_ とは `/plugin` コマンドで読み込まれるコンパイル済みバイナリファイルです。これに対して、
-_スクリプト_ とは `/python` 等のコマンドで _python_
-等のプラグインとともに読み込まれるテキストファイルです。
-
-`/plugin`
-コマンドを使うことで、プラグインのロード/アンロード、ロード済みプラグインの表示を行うことができます。
-
-// TRANSLATION MISSING
-When a plugin is unloaded, WeeChat removes:
-
-* buffers
-* configuration options (options are written in files)
-* all hooks: commands, modifiers, process, etc.
-* infos and infolists
-* hdata
-* bar items.
-
-プラグインをロード、アンロード、ロード済みプラグインを表示する例:
-
-----
-/plugin load irc
-/plugin unload irc
-/plugin list
-----
-
-デフォルトプラグインのリスト:
-
-[width="100%",cols="1,5",options="header"]
-|===
-| プラグイン | 説明
-| alias | コマンドの別名を定義
-| buflist | バッファリストを表示するためのバー要素
-| charset | バッファの文字コードに従ってデコード/エンコード
-| exec | WeeChat 内部から外部コマンドを実行
-| fifo | 外部から WeeChat にコマンドを送信するための FIFO パイプ
-| fset | WeeChat とプラグインのオプションを高速設定
-| irc | IRC チャットプロトコル
-| logger | バッファの内容をファイルに保存
-| relay | ネットワーク経由でデータを中継
-| script | スクリプトマネージャ
-| python | Python スクリプト API
-| perl | Perl スクリプト API
-| ruby | Ruby スクリプト API
-| lua | Lua スクリプト API
-| tcl | Tcl スクリプト API
-| guile | Guile (scheme) スクリプト API
-| javascript | JavaScript スクリプト API
-| php | PHP スクリプト API
-| spell | コマンドラインのスペルチェック
-| trigger | WeeChat およびプラグインが発生させたイベントに対するテキスト置換とコマンド実行
-// TRANSLATION MISSING
-| typing | Display users currently writing messages.
-| xfer | ファイル転送とダイレクトチャット
-|===
-
-API を使ったプラグインやスクリプトの開発についてより詳しく学ぶには
-link:weechat_plugin_api.ja.html[WeeChat プラグイン API リファレンス]または
-link:weechat_scripting.ja.html[WeeChat スクリプト作成ガイド]を参照してください。
-
-[[exec_plugin]]
-=== Exec
-
-`/exec` コマンドを使うことで WeeChat
-内部から外部コマンドを実行し、その結果を表示したりバッファに送信することが可能になります。
-
-[[exec_commands]]
-==== コマンド
-
-include::includes/autogen_user_commands.ja.adoc[tag=exec_commands]
-
-[[exec_options]]
-==== オプション
-
-_exec.conf_ ファイル内のセクション:
-
-[width="100%",cols="3m,6m,16",options="header"]
-|===
-| セクション | 操作コマンド | 説明
-| command | /set exec.command.* | コマンドに対するオプション
-| color | /set exec.color.* | 色
-|===
-
-オプション:
-
-include::includes/autogen_user_options.ja.adoc[tag=exec_options]
-
-[[fifo_plugin]]
-=== Fifo
-
-外部から WeeChat を操作するには、FIFO パイプにコマンドやテキストを書き込んでください ("fifo.file.enabled"
-オプションが有効化されている必要がありますが、デフォルトで有効化されているはずです)。
-
-// TRANSLATION MISSING
-The FIFO pipe is located in WeeChat runtime directory and is called
-_weechat_fifo_12345_ by default (where _12345_ is the WeeChat process id).
-
-FIFO パイプに書き込むコマンド/テキストの文法は以下の例の一つです:
-
-....
- plugin.buffer *テキストまたはコマンド
- *テキストまたはコマンド
-....
-
-例:
-
-* IRC サーバ libera で使うニックネームを "newnick" に変更する:
-
-----
-$ echo 'irc.server.libera */nick newnick' >/run/user/1000/weechat/weechat_fifo_12345
-----
-
-* IRC チャンネル #weechat に対してテキストを送信:
-
-----
-$ echo 'irc.libera.#weechat *hello!' >/run/user/1000/weechat/weechat_fifo_12345
-----
-
-* 現在のバッファに対してテキストを送信:
-
-----
-$ echo '*hello!' >/run/user/1000/weechat/weechat_fifo_12345
-----
-
-* Python スクリプトのアンロードとロードを行う 2 つのコマンドを送信
- (複数のコマンドは "\n" で分割してください):
-
-----
-$ printf '%b' '*/python unload\n*/python autoload\n' >/run/user/1000/weechat/weechat_fifo_12345
-----
-
-[[fifo_commands]]
-==== コマンド
-
-include::includes/autogen_user_commands.ja.adoc[tag=fifo_commands]
-
-[[fifo_options]]
-==== オプション
-
-_fifo.conf_ ファイル内のセクション:
-
-[width="100%",cols="3m,6m,16",options="header"]
-|===
-| セクション | 操作コマンド | 説明
-| file | /set fifo.file.* | FIFO パイプに関するオプション
-|===
-
-オプション:
-
-include::includes/autogen_user_options.ja.adoc[tag=fifo_options]
-
-[[relay_plugin]]
-=== Relay
+[[relay]]
+== Relay
Relay プラグインはネットワークを介して異なるプロトコルを用いてデータを中継するために利用します:
@@ -3915,7 +3754,7 @@ Relay プラグインはネットワークを介して異なるプロトコル
** WeeCloud (JavaScript): https://github.com/eirikb/weecloud
[[relay_password]]
-==== パスワード
+=== パスワード
// TRANSLATION MISSING
It is highly recommended to set a password for relay, with these commands:
@@ -3928,7 +3767,7 @@ secure set relay mypassword
このパスワードは _irc_ と _weechat_ プロトコルで利用されます。
[[relay_totp]]
-==== TOTP
+=== TOTP
_weechat_ プロトコルでは、パスワードに加えて、二要素認証の
TOTP (時間ベースのワンタイムパスワード) を使うことが可能です。
@@ -3957,7 +3796,7 @@ TOTP の secret は base32 でエンコードされた文字列
----
[[relay_ssl]]
-==== SSL
+=== SSL
証明書と秘密鍵を作り、プロトコル名の最初に "ssl." を付けることで
SSL 経由でリレーを利用することができます。
@@ -3987,7 +3826,7 @@ WeeChat
----
[[relay_irc_proxy]]
-==== IRC プロキシ
+=== IRC プロキシ
Relay プラグインは IRC プロキシとしても使えます: Relay プラグインは IRC
サーバのふりをして、他の IRC クライアント (WeeChat 自身も) は WeeChat に接続できます。
@@ -4029,11 +3868,11 @@ commands:
----
[[relay_weechat_protocol]]
-==== WeeChat プロトコル
+=== WeeChat プロトコル
Relay プラグインは WeeChat プロトコルを使ってリモートインターフェースに対してデータを送信できます。
-リモートインターフェースを使って接続できます、<<relay_plugin>> のリストを参照してください。
+リモートインターフェースを使って接続できます、<<relay>> のリストを参照してください。
[IMPORTANT]
このプロトコルを使った場合 WeeChat から他の WeeChat に接続することはできません。
@@ -4048,7 +3887,7 @@ Relay プラグインは WeeChat プロトコルを使ってリモートイン
番ポートに対して、パスワード "mypass" で接続することができます。
[[relay_websocket]]
-==== WebSocket
+=== WebSocket
Relay プラグインはすべてのプロトコルに対して WebSocket プロトコル
(https://tools.ietf.org/html/rfc6455[RFC 6455]) をサポートします。
@@ -4069,7 +3908,7 @@ websocket = new WebSocket("ws://server.com:9000/weechat");
の最後には必ず "/weechat" をつけます (_irc_ と _weechat_ プロトコルの場合)。
[[relay_unix_socket]]
-==== UNIX ドメインソケット
+=== UNIX ドメインソケット
`/relay add` コマンドにプロトコルオプション "unix" をつけることで、指定したパスで動作する
UNIX ドメインソケット上の任意のプロトコルをリッスンできます。例:
@@ -4092,12 +3931,12 @@ $ ssh -L 9000:.weechat/relay_socket user@hostname
"hostname" 上で動作中の WeeChat インスタンスへ転送されます。
[[relay_commands]]
-==== コマンド
+=== コマンド
include::includes/autogen_user_commands.ja.adoc[tag=relay_commands]
[[relay_options]]
-==== オプション
+=== オプション
_relay.conf_ ファイル内のセクション:
@@ -4116,6 +3955,167 @@ _relay.conf_ ファイル内のセクション:
include::includes/autogen_user_options.ja.adoc[tag=relay_options]
+[[plugins]]
+== プラグイン
+
+プラグインとは動的ライブラリのことで、C
+言語で書かれてコンパイルされています。プラグインは WeeChat によって読み込まれます。GNU/Linux
+の場合、プラグインファイルは ".so" という拡張子を持ち、Windows の場合、".dll" です。
+
+見つかったプラグインは WeeChat の起動時に自動的に読み込まれます。WeeChat
+の起動時にプラグインを読み込むか否かは選択可能です。
+
+_プラグイン_ と _スクリプト_ の違いを明らかにすることは重要です:
+_プラグイン_ とは `/plugin` コマンドで読み込まれるコンパイル済みバイナリファイルです。これに対して、
+_スクリプト_ とは `/python` 等のコマンドで _python_
+等のプラグインとともに読み込まれるテキストファイルです。
+
+`/plugin`
+コマンドを使うことで、プラグインのロード/アンロード、ロード済みプラグインの表示を行うことができます。
+
+// TRANSLATION MISSING
+When a plugin is unloaded, WeeChat removes:
+
+* buffers
+* configuration options (options are written in files)
+* all hooks: commands, modifiers, process, etc.
+* infos and infolists
+* hdata
+* bar items.
+
+プラグインをロード、アンロード、ロード済みプラグインを表示する例:
+
+----
+/plugin load irc
+/plugin unload irc
+/plugin list
+----
+
+デフォルトプラグインのリスト:
+
+[width="100%",cols="1,5",options="header"]
+|===
+| プラグイン | 説明
+| alias | コマンドの別名を定義
+| buflist | バッファリストを表示するためのバー要素
+| charset | バッファの文字コードに従ってデコード/エンコード
+| exec | WeeChat 内部から外部コマンドを実行
+| fifo | 外部から WeeChat にコマンドを送信するための FIFO パイプ
+| fset | WeeChat とプラグインのオプションを高速設定
+| irc | IRC チャットプロトコル
+| logger | バッファの内容をファイルに保存
+| relay | ネットワーク経由でデータを中継
+| script | スクリプトマネージャ
+| python | Python スクリプト API
+| perl | Perl スクリプト API
+| ruby | Ruby スクリプト API
+| lua | Lua スクリプト API
+| tcl | Tcl スクリプト API
+| guile | Guile (scheme) スクリプト API
+| javascript | JavaScript スクリプト API
+| php | PHP スクリプト API
+| spell | コマンドラインのスペルチェック
+| trigger | WeeChat およびプラグインが発生させたイベントに対するテキスト置換とコマンド実行
+// TRANSLATION MISSING
+| typing | Display users currently writing messages.
+| xfer | ファイル転送とダイレクトチャット
+|===
+
+API を使ったプラグインやスクリプトの開発についてより詳しく学ぶには
+link:weechat_plugin_api.ja.html[WeeChat プラグイン API リファレンス]または
+link:weechat_scripting.ja.html[WeeChat スクリプト作成ガイド]を参照してください。
+
+[[exec_plugin]]
+=== Exec
+
+`/exec` コマンドを使うことで WeeChat
+内部から外部コマンドを実行し、その結果を表示したりバッファに送信することが可能になります。
+
+[[exec_commands]]
+==== コマンド
+
+include::includes/autogen_user_commands.ja.adoc[tag=exec_commands]
+
+[[exec_options]]
+==== オプション
+
+_exec.conf_ ファイル内のセクション:
+
+[width="100%",cols="3m,6m,16",options="header"]
+|===
+| セクション | 操作コマンド | 説明
+| command | /set exec.command.* | コマンドに対するオプション
+| color | /set exec.color.* | 色
+|===
+
+オプション:
+
+include::includes/autogen_user_options.ja.adoc[tag=exec_options]
+
+[[fifo_plugin]]
+=== Fifo
+
+外部から WeeChat を操作するには、FIFO パイプにコマンドやテキストを書き込んでください ("fifo.file.enabled"
+オプションが有効化されている必要がありますが、デフォルトで有効化されているはずです)。
+
+// TRANSLATION MISSING
+The FIFO pipe is located in WeeChat runtime directory and is called
+_weechat_fifo_12345_ by default (where _12345_ is the WeeChat process id).
+
+FIFO パイプに書き込むコマンド/テキストの文法は以下の例の一つです:
+
+....
+ plugin.buffer *テキストまたはコマンド
+ *テキストまたはコマンド
+....
+
+例:
+
+* IRC サーバ libera で使うニックネームを "newnick" に変更する:
+
+----
+$ echo 'irc.server.libera */nick newnick' >/run/user/1000/weechat/weechat_fifo_12345
+----
+
+* IRC チャンネル #weechat に対してテキストを送信:
+
+----
+$ echo 'irc.libera.#weechat *hello!' >/run/user/1000/weechat/weechat_fifo_12345
+----
+
+* 現在のバッファに対してテキストを送信:
+
+----
+$ echo '*hello!' >/run/user/1000/weechat/weechat_fifo_12345
+----
+
+* Python スクリプトのアンロードとロードを行う 2 つのコマンドを送信
+ (複数のコマンドは "\n" で分割してください):
+
+----
+$ printf '%b' '*/python unload\n*/python autoload\n' >/run/user/1000/weechat/weechat_fifo_12345
+----
+
+[[fifo_commands]]
+==== コマンド
+
+include::includes/autogen_user_commands.ja.adoc[tag=fifo_commands]
+
+[[fifo_options]]
+==== オプション
+
+_fifo.conf_ ファイル内のセクション:
+
+[width="100%",cols="3m,6m,16",options="header"]
+|===
+| セクション | 操作コマンド | 説明
+| file | /set fifo.file.* | FIFO パイプに関するオプション
+|===
+
+オプション:
+
+include::includes/autogen_user_options.ja.adoc[tag=fifo_options]
+
[[scripts_plugins]]
=== スクリプト