1 \input texinfo @c -*- mode: texinfo; coding: utf-8 -*-
3 @setfilename riece-ja.info
4 @settitle Riece -- An IRC client for Emacsen --
6 @include version-ja.texi
7 @c @documentlanguage ja
8 @c @documentencoding utf-8
10 @dircategory GNU Emacs Lisp
12 * Riece-ja: (riece-ja). An IRC client for Emacsen
16 This file describes Riece.
18 Copyright (C) 2003,2004,2005,2006,2007,2008,2009,2010 Daiki Ueno.
20 Permission is granted to copy, distribute and/or modify this document
21 under the terms of the GNU Free Documentation License, Version 1.1 or
22 any later version published by the Free Software Foundation; with no
23 Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
24 Texts. A copy of the license is included in the section entitled "GNU
25 Free Documentation License".
36 @vskip 0pt plus 1filll
37 Copyright @copyright{} 2003,2004,2005,2006 Daiki Ueno.
39 Permission is granted to copy, distribute and/or modify this document
40 under the terms of the GNU Free Documentation License, Version 1.1 or
41 any later version published by the Free Software Foundation; with no
42 Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
43 Texts. A copy of the license is included in the section entitled "GNU
44 Free Documentation License".
50 @node Top, Overview, (dir), (dir)
51 @top Riece user's manual
53 このマニュアルでは、Riece バージョン @value{VERSION} について解説します。
54 このマニュアルで扱う範囲を越えた情報は Riece の公式ホームページ
55 @uref{http://www.nongnu.org/riece/} から得られるかもしれません。
59 * Getting started:: IRC サーバに接続して会話してみよう
60 * Basic usage:: 基本的な使い方
61 * Advanced usage:: 進んだ使い方
68 @node Overview, Getting started, Top, Top
71 Riece は IRC (Internet Relay Chat) の世界でチャットを楽しむためのユーザ
72 インターフェースです。Riece は「りーす」と読みます。
77 @item 複数の IRC サーバに同時に接続可能
78 @item アドオンにより機能の追加や取り外しが容易
79 @item 他の elisp パッケージに依存しないため、インストールが簡単
80 @item 設定が簡単で、前回起動時の設定を記録・復元する仕組みを提供
82 @item 最新の IRC のクライアントプロトコル (RFC2812) に準拠
85 @node Getting started, Basic usage, Overview, Top
86 @chapter Getting started
92 @kbd{M-x load-library riece}
98 もし (1) で @samp{Cannot open load file: riece} のエラーが発生する場合に
99 はインストールに失敗しています。自分でソースからインストールした場合には
100 README をもう一度読み直してください。OS・ディストリビューションのパッケー
101 ジからインストールした場合には、パッケージに含まれる文書をご確認ください。
103 Riece を起動すると、IRC サーバの名前を聞かれます。公共に利用可能な IRC
104 サーバの一覧は Web ページなどから得ることができます。
107 @item http://www.ircnet.jp
108 @item http://freenode.net
111 また、以下のようなメッセージが表示されるかもしれません。
114 Nickname "ueno" already in use. Choose a new one:
117 IRC では、参加者を表すのに@emph{ニックネーム}と呼ばれる短い呼称が使われ
118 ます。もし希望のニックネームが他の誰かに使用されている場合、別のニックネー
121 IRC サーバに接続できたら、次は会話をしてみましょう。IRC では@emph{チャンネル}
122 と呼ばれる仮想的な会議室に参加して会話を行ないます。チャンネルに入るには
123 @kbd{C-c j} とタイプします。参加するチャンネル名を尋ねられたら、適切なチャ
124 ンネル名を入力しましょう。IRCnet には @samp{#Riece} というチャンネルがあ
125 るので、テストをしたい場合には自由にお使いください。
127 チャンネルに入ると、下の図に示すような 5 つのウィンドウ
128 @footnote{まぎらわしいですが、Emacs の世界ではバッファを表示する領域をウィ
129 ンドウと呼びます。}からなる画面に切り替わります。
132 +-----+-----------------+
138 +-----+-----------------+
140 | +-----------------+
144 +-----+-----------------+
147 (4) のウィンドウに表示されるバッファに文章を入力してリターンキーを押すと
148 発言できます。他の参加者の発言は (2) のウィンドウに表示されます。
150 @node Basic usage, Advanced usage, Getting started, Top
155 * Indicators:: 自分の状態の表示
159 @node Windows, Indicators, Basic usage, Basic usage
163 +-----+-----------------+
169 +-----+-----------------+
171 | +-----------------+
175 +-----+-----------------+
178 各ウィンドウに表示されるバッファの役割は以下の通りです。
182 ユーザリストバッファ (@samp{ *Users*})。チャンネルに参加しているユー
186 チャンネルバッファ (@samp{ *Channel:XXX*})。チャンネル内の会話が表示され
190 チャンネルリストバッファ (@samp{ *Channels*})。自分が参加しているチャンネ
194 コマンドバッファ (@samp{*Command*})。文章やコマンドを送信するために使い
198 アザーズバッファ (@samp{ *Others*})。現在選択中のチャンネル以外の会話が流
202 @node Indicators, Commands, Windows, Basic usage
205 モードラインの左端には、現在の自分の状態を示す印が表示されます。
206 @footnote{もし画像を表示できる Emacs をお使いなら、左端に "R" のアイコン
210 Riece: ---- ueno #Riece [n]
213 ここで、@samp{----} の部分には左から順に以下の意味があります。
217 離席状態 (離席していれば @samp{A})
220 IRC オペレータ状態 (IRC ネットワークの管理者権限を持っていれば @samp{O})
223 ウィンドウの自動スクロールの禁止 (完全に禁止していれば @samp{F}、自分の
224 次回の発言まで禁止しているのであれば @samp{f})
227 チャンネルオペレータ状態 (チャンネルの管理者権限を持っていれば @samp{@@})
230 @node Commands, , Indicators, Basic usage
233 @ref{Basic usage}で文章を入力したバッファはコマンドバッファと呼ばれます。
234 コマンドバッファからは文章を送信する以外に、様々なコマンドを発行すること
237 最初はなかなか覚えにくいですが、@kbd{C-h b}
238 (@kbd{M-x describe-bindings}) で使用可能なキー操作の一覧が表示されるの
241 @subsection IRC commands
244 @findex riece-command-enter-message
245 文章を送ります(@code{riece-command-enter-message})
247 @findex riece-command-enter-message-as-notice
248 文章を NOTICE として送ります(@code{riece-command-enter-message-as-notice})
250 @findex riece-command-join
251 チャンネルに参加します(@code{riece-command-join})
253 @findex riece-command-part
254 チャンネルから離脱します(@code{riece-command-part})
256 @findex riece-command-enter-message-to-user
257 宛先を指定して現在の行を送ります(@code{riece-command-enter-message-to-user})
259 @findex riece-command-quit
260 IRC をやめます(@code{riece-command-quit})
262 @findex riece-command-change-nickname
263 自分のニックネームを変更します(@code{riece-command-change-nickname})
265 @findex riece-command-finger
266 ユーザの情報を調べます(@code{riece-command-finger})
268 @findex riece-command-kick
269 ユーザをチャンネルから蹴り出します(@code{riece-command-kick})
271 @findex riece-command-invite
272 ユーザをチャンネルに招待します(@code{riece-command-invite})
274 @findex riece-command-list
275 パターンに対して LIST を発行します(@code{riece-command-list})
277 @findex riece-command-names
278 パターンに対して NAMES を発行します(@code{riece-command-names})
280 @findex riece-command-who
281 パターンに対して WHO を発行します(@code{riece-command-who})
283 @findex riece-command-topic
284 チャンネルのトピックを設定します(@code{riece-command-topic})
286 @findex riece-command-change-mode
287 チャンネルのモードを設定します(@code{riece-command-change-mode})
289 @findex riece-command-set-operators
290 ユーザにチャンネルの管理者権限を与えます。@kbd{C-u C-c o} では逆に、ユーザからチャンネルの管理者権限を奪います(@code{riece-command-set-operators})
292 @findex riece-command-set-speakers
293 ユーザにチャンネルでの発言権を与えます。@kbd{C-u C-c v} では逆に、ユーザからチャンネルでの発言権を奪います(@code{riece-command-set-speakers})
295 @findex riece-version
296 Riece のバージョンを表示します。(@kbd{C-u C-c V}) で、より詳細な情報を表示します。
298 @findex riece-command-raw
299 IRC コマンドを直接送ります(@code{riece-command-raw})
302 @subsection Window manipulating commands
305 @findex riece-command-configure-windows
306 フレーム全体を再描画します(@code{riece-command-configure-windows})
307 @item C-c C-j または C-c >
308 @findex riece-command-next-channel
309 チャンネル一覧で次のチャンネルを選択します(@code{riece-command-next-channel})
311 @findex riece-command-previous-channel
312 チャンネル一覧で前のチャンネルを選択します(@code{riece-command-previous-channel})
314 @findex riece-command-list-addons
315 アドオンの一覧を表示します(@code{riece-command-list-addons})
317 @findex riece-command-switch-to-channel-by-number
318 チャンネル一覧で @var{n}番目のチャンネルを選択します(@code{riece-command-switch-to-channel-by-number})
320 @findex riece-command-switch-to-channel-by-number
321 チャンネル一覧で @var{n} + 10番目のチャンネルを選択します(@code{riece-command-switch-to-channel-by-number})
323 @findex riece-command-beginning-of-buffer
324 チャンネルバッファ、またはダイアログバッファを上端までスクロールします(@code{riece-command-beginning-of-buffer})
326 @findex riece-command-end-of-buffer
327 チャンネルバッファ、またはダイアログバッファを下端までスクロールします(@code{riece-command-end-of-buffer})
329 @findex riece-command-scroll-up
330 チャンネルバッファ、またはダイアログバッファを上方向にスクロールします(@code{riece-command-scroll-up})
332 @findex riece-command-scroll-down
333 チャンネルバッファ、またはダイアログバッファを下方向にスクロールします(@code{riece-command-scroll-down})
336 @subsection Status toggle commands
339 @findex riece-command-toggle-channel-buffer-mode
340 チャンネルバッファの表示・非表示を切り替えます(@code{riece-command-toggle-channel-buffer-mode})
342 @findex riece-command-toggle-channel-list-buffer-mode
343 チャンネルリストバッファの表示・非表示を切り替えます(@code{riece-command-toggle-channel-list-buffer-mode})
345 @findex riece-command-toggle-user-list-buffer-mode
346 ユーザリストバッファの表示・非表示を切り替えます(@code{riece-command-toggle-user-list-buffer-mode})
348 @findex riece-command-toggle-freeze
349 チャンネルバッファ、またはダイアログバッファの自動スクロールを禁止しま
350 す(@code{riece-command-toggle-freeze})
352 @findex riece-command-toggle-own-freeze
353 チャンネルバッファ、またはダイアログバッファを、自分が発言するまで、自動
354 スクロールを禁止します(@code{riece-command-toggle-own-freeze})
356 @findex riece-command-toggle-away
357 自分の離席状態を切り替えます(@code{riece-command-toggle-away})
360 @node Advanced usage, Tips, Basic usage, Top
361 @chapter Advanced usage
363 この章では、もっと進んだ使い方を解説します。
366 * Startup File:: 設定ファイル
367 * Server settings:: サーバの詳細設定
368 * Multiple servers:: 複数のサーバに接続するには
372 @node Startup File, Server settings, Advanced usage, Advanced usage
373 @section Startup file
375 Riece の設定は Emacs の設定ファイルに書いても良いですが、Riece に固有の
376 設定はなるべく @file{~/.riece/init} に書くことを推奨します。
378 また、Riece を起動して終了すると @file{~/.riece/save} というファイルが
379 作成されます。このファイルには前回起動時の設定の一部が自動的に保存され
382 起動時には、最初に @file{~/.riece/save} を、次に @file{~/.riece/init}を
383 読み込みます。つまり、前回起動時に @file{~/.riece/save} に保存された内容
384 は、@file{~/.riece/init} の内容で上書きされます。
386 @node Server settings, Multiple servers, Startup File, Advanced usage
387 @section Server settings
389 起動時に接続する IRC サーバは変数 @code{riece-server} で指定します。
392 @code{riece-server} は文字列で、その形式は次のいずれかです。
399 @code{IRC サーバのホスト名:ポート番号}
402 @code{IRC サーバのホスト名:ポート番号:パスワード}
408 4. の場合には、@code{riece-server} の値をキーに
409 @code{riece-server-alist} を検索します。@code{riece-server-alist} は次
411 @vindex riece-server-alist
414 (setq riece-server-alist
415 '(("foo" :host "irc.example.com" :coding shift_jis)
416 ("bar" :host "irc.example.net" :nickname "baz")))
423 @samp{foo} という名前の設定では、IRC サーバのホスト名に @samp{irc.example.com}、使用する文字コードに Shift_JIS を使う
426 @samp{bar} という名前の設定では、IRC サーバのホスト名は @samp{irc.example.net}、このサーバではニックネーム @samp{baz} を使う
429 指定できるキーワードの一覧は以下の通りです。
435 サーバのサービス名またはポート番号 (既定値は @code{6667})
437 接続時のニックネーム (既定値は変数 @code{user-real-login-name} の値)
439 接続時のユーザネーム (既定値は変数 @code{user-full-name} の値)
443 接続用関数 (既定値は @code{open-network-stream})
445 文字コード (既定値は @code{riece-default-coding-system} の値)
448 @code{riece-server-alist} を対話的に設定するには次のコマンドを使うと便利です。
451 M-x load-library riece
452 M-x customize-variable riece-server-alist
455 @node Multiple servers, Add-ons, Server settings, Advanced usage
456 @section Multiple servers
458 同時に複数のサーバに接続する手順を以下に示します。
460 既に特定のサーバに接続している状態で、別のサーバに接続するには @kbd{C-c O} (@code{riece-command-open-server}) を使います。
462 別のサーバ上のチャンネルに参加するには、@kbd{C-c j}
463 (@code{riece-command-join})でチャンネル名に @samp{@@} に続いてサーバ名を
466 たとえば、サーバ @samp{irc.freenode.net} 上の @samp{#Riece} は次のよう
470 #Riece@@irc.freenode.net
473 チャンネル名とサーバの区切り文字 @samp{@@} は
474 変数 @code{riece-alias-alternate-separator} で変更できます。
476 または、空白文字でも代用できます。この時には、@kbd{C-q SPC} と入力する
479 複数の接続を操作するコマンドを以下にまとめます。
483 @findex riece-command-open-server
484 別のサーバに接続します(@code{riece-command-open-server})
486 @findex riece-command-close-server
487 サーバとの接続を切断します(@code{riece-command-close-server})
489 @findex riece-command-universal-server-name-argument
490 特定のサーバに対して、続くコマンドを発行します(@code{riece-command-universal-server-name-argument})
493 @node Add-ons, , Multiple servers, Advanced usage
496 Riece では、雑多な機能を選択的に利用できるよう、アドオンと呼ばれる機構
497 を用意しています。アドオンは通常の elisp モジュールを拡張したもので、
498 安全な取り外しや、アドオン間の初期化処理の依存関係などの面倒をみます。
504 読み込み前。アドオンの elisp モジュールが読み込まれていない状態
507 組み込み済み。アドオンの elisp モジュールが読み込まれ、初期化処理が完了した状態
518 * Add-on browser:: アドオンの一覧表示
519 * Available add-ons:: 標準添付のアドオンの紹介
522 @node Add-on browser, Available add-ons, Add-ons, Add-ons
523 @subsection Add-on browser
525 Riece の動作中にアドオンの一覧を眺めるにはアドオンブラウザを使うと便利です。
526 コマンドバッファで @kbd{C-c ^} とすると、次のように表示されます。
529 + riece-alias Define aliases for IRC names.
530 riece-async Connect to IRC server via async proxy.
531 riece-biff Be notified if messages arrives.
532 + riece-button Display useful buttons in IRC buffers.
533 + riece-ctcp CTCP (Client To Client Protocol) support.
534 + riece-ctlseq Mark up control sequences in IRC buffers.
537 各行の左端のマークはアドオンの状態を表わしています。@samp{+} は組込ま
538 れて有効なアドオン、空白はロードされていないアドオンです。
540 ここで、riece-button を無効にしたい場合、四行目の先頭で @kbd{-} としま
541 す。すると、先頭のマークが @samp{+} から @samp{-} に変化します。
544 + riece-alias Define aliases for IRC names.
545 riece-async Connect to IRC server via async proxy.
546 riece-biff Be notified if messages arrives.
547 - riece-button Display useful buttons in IRC buffers.
548 + riece-ctcp CTCP (Client To Client Protocol) support.
549 + riece-ctlseq Mark up control sequences in IRC buffers.
552 さらに、@samp{u} とすると、riece-button をアドオンの設定から除外します。
553 さらに、@samp{U} とすると、riece-button を完全にアンロードします。
555 この状態で、@samp{s} または @samp{M-x riece-command-save-variables} と
558 @file{~/.riece/init} でアドオンを組み込むには @code{riece-addons} を設
559 定します。たとえば @samp{riece-alias} を組み込む場合には、以下のように
564 (add-to-list 'riece-addons 'riece-mini)
567 @node Available add-ons, , Add-on browser, Add-ons
568 @subsection Available add-ons
570 利用可能なアドオンは次の通りです。これらのうちの多くは標準で組み込まれ
577 Emacs が busy or suspend 状態になることに備え、
578 PING に応答する local proxy 経由で IRC サーバに接続
580 他のバッファにいる時に発言があるとモードラインに印 ("[R]") を表示
584 CTCP (Client To Client Protocol)
586 コントロールシーケンス (^B など) による強調表示
587 @item riece-desktop-notify
590 doctor.el と連携して精神科医になりすます
592 EasyPG @uref{http://www.easypg.org} による会話の暗号化
593 @item riece-eval-ruby
594 入力された文字列を Ruby の式として評価
596 入力された文字列を Emacs Lisp の式として評価
597 @item riece-foolproof
605 @item riece-highlight
614 日本語の通らない端末で、日本語をローマ字で表示
615 @item riece-keepalive
622 アドレス帳 LSDB (Lovely Sister Database)
623 @uref{http://lsdb.sourceforge.jp} と連携
631 DCC (Direct Client to Client protocol) によるファイル転送
634 DCC (Direct Client to Client protocol) によるファイル転送
635 @item riece-shrink-buffer
636 メモリ確保のため、バッファを定期的に切り詰める
637 @item riece-skk-kakutei
638 SKK 使用時に変換モードの印を発言から取り除く
642 CTCP ACTION (@kbd{C-c C-c a}) と同時に Twitter に状態を送信
644 発言のあったチャンネルに@samp{!}マークをつける
648 ユーザリストバッファにユーザの X-Face を表示
650 ユーザリストバッファにユーザの X-Face を表示
651 (BBDB @uref{http://bbdb.sourceforge.net} が必要)
653 @kbd{C-c y} で kill-ring から文字列を送信
656 @node Tips, Index, Advanced usage, Top
657 @comment node-name, next, previous, up
660 この章では、よく聞かれる質問に対する答えと便利な設定例を紹介します。
662 @section 直前に選択していたチャンネルに移動したい
663 @vindex riece-guess-channel-try-functions
665 以下の行を @file{~/.riece/init} に追加することで、@kbd{C-c g} で履歴を辿
666 りつつ移動できます。@samp{riece-guess} アドオンは、チャンネル選択の履歴
667 や未読メッセージの有無などから次に選択するチャンネルを推測してくれるアド
671 (add-hook 'riece-guess-channel-try-functions
672 'riece-guess-channel-from-history)
675 @section 発言があるとバッファがスクロールするのを止めたい
677 @kbd{C-c C-t f} です。@emph{t}oggle @emph{f}reeze と覚えると良いでしょう。
681 @code{riece-addons} から装飾のためのアドオンを除外します。
682 通常有効になっている装飾のためのアドオンは次の通りです。
686 色付け (@samp{riece-highlight})
689 ボタン表示 (@samp{riece-button})
692 アイコン画像の表示 (@samp{riece-icon})
695 たとえば色付けをやめたいのであれば、以下の行を @file{~/.riece/init} に追
699 (setq riece-addons (delq 'riece-highlight riece-addons))
702 @section 特定の文字列を受信したら音を鳴らしたい
703 @vindex riece-keyword-notify-functions
705 以下の設定を @file{~/.riece/init} に加えます。@samp{riece-keywords} アド
706 オンを使うと特定の文字列を受信した際の動作を指定できます。
709 (setq riece-keywords '("ほげ" "ふが"))
710 (add-hook 'riece-keyword-notify-functions
711 (lambda (keyword message) (ding)))
714 @section SKK を使っていて、変換中の印 (▽) を送信してしまうことがある
716 以下の行を @file{~/.riece/init} に追加します。
719 (add-to-list 'riece-addons 'riece-skk-kakutei)
722 @section チャンネル一覧の並び順を固定したい
723 @vindex riece-default-channel-binding
725 以下の行を @file{~/.riece/init} に追加します。
728 (setq riece-default-channel-binding
729 '("#Riece" "#emacsen" nil "#debianjp"))
732 この設定例では、チャンネル一覧の並び順は次のようになります。
745 3 番目のチャンネルが空席となっていることにご注意ください。新たなチャンネ
746 ルに参加した場合、そのチャンネルが 3 番目の位置に割当てられます。
748 @section 起動時に自動的にチャンネルに参加したい
749 @vindex riece-startup-channel-list
751 変数 @samp{riece-startup-channel-list} を設定します。
754 (setq riece-startup-channel-list
755 '("#Riece" "#public"))
758 この設定例は、@samp{#Riece} と @samp{#public} に参加することを意味してい
759 ます。チャンネルに参加する際にパスワードが必要な場合には次のように設定し
763 (setq riece-startup-channel-list
764 '("#Riece" "#public" ("#private" "password")))
767 @section 起動時に自動的に複数の IRC サーバに接続したい
768 @vindex riece-startup-server-list
770 変数 @samp{riece-startup-server-list} を設定します。
773 (setq riece-server "ircnet"
774 riece-server-alist '(("ircnet" :host "irc.tokyo.wide.ad.jp")
775 ("freenode" :host "irc.ipv6.freenode.net")))
778 この設定例では、起動時に接続するのは "ircnet" だけです。
779 @samp{riece-startup-server-list} を以下のように設定すると、
780 "freenode" にも接続するようになります。
783 (setq riece-startup-server-list '("freenode"))
786 @section HTTP プロキシを介して IRC サーバに接続したい
787 @file{relay.el} と @file{connect.c} を使うと、
788 HTTP プロキシを介して IRC サーバに接続することができます。
792 @uref{http://www.taiyo.co.jp/~gotoh/lisp/relay.el}
795 @uref{http://www.taiyo.co.jp/~gotoh/ssh/connect.html}
798 たとえば、@samp{proxy.example.com:8080} 経由で
799 @samp{irc.tokyo.wide.ad.jp} に接続する場合には、以下の行を
800 @file{~/.riece/init} に追加します。
804 (setq relay-command-alist (cons '("^irc\.tokyo\.wide\.ad\.jp$"
805 "connect" "-H" "proxy.example.com:8080"
808 riece-server-alist (cons '("proxy-tokyo" :host "irc.tokyo.wide.ad.jp"
809 :function relay-open-network-stream)
813 @section 会話のログをファイルに保存したい
814 @vindex riece-log-directory-map
816 @samp{riece-log} アドオンを使うと、会話のログをファイルに保存し、再起動
817 時に参照できます。@samp{riece-log} アドオンは標準で組み込まれています。
819 通常は @file{~/.riece/log} の下に IRC サーバの名前、チャンネル名のディレ
820 クリが作成され、その中に日にち毎に分別されて保存されます。
823 @code{file-name-coding-system} の値を適切に設定するか、あるいは
824 @code{riece-log-directory-map} を使ってチャンネル名を US-ASCII 文字列に
828 (setq riece-log-directory-map '(("#りーす" . "riece")))
831 @section ウィンドウ間を自由に移動したい
833 GNU Emacs に附属の @samp{windmove.el} を使うと便利です。詳細は
834 @samp{windmove.el} のコメントを参照ください。@samp{windmove.el} は
835 作者のページ (@uref{http://hovav.net/elisp/}) からも取得できます。
837 @node Index, Function Index, Tips, Top
841 @node Function Index, Variable Index, Index, Top
842 @chapter Function Index
845 @node Variable Index, , Function Index, Top
846 @chapter Variable Index