Add riece-*-description to add-on API.
[riece] / doc / riece-ja.texi
index 43dc952..681195b 100644 (file)
@@ -3,7 +3,7 @@
 @setfilename riece-ja.info
 @settitle Riece -- An IRC client for Emacsen --
 @c %**end of header
-@set VERSION 0.2.1
+@set VERSION 0.2.2
 @c @documentlanguage ja
 
 @dircategory GNU Emacs Lisp
@@ -141,25 +141,28 @@ XEmacs \e$B$N%Q%C%1!<%8$H$7$F%$%s%9%H!<%k$7$?>l9g$K$OI,MW$"$j$^$;$s$,!"\e(B
 @node Startup File,  , Installation, Getting started
 @section Startup file
 
-\e$B=i$a$F;H$&>l9g$K$O!"FC$K2?$b@_Dj$9$kI,MW$O$"$j$^$;$s!#\e(B
-\e$B$3$N>O$OFI$_Ht$P$7$F$/$@$5$$!#\e(B
+\e$B$3$N>O$G$O!"@_Dj%U%!%$%k$K$D$$$F2r@b$7$^$9!#\e(B
+
+\e$B;n$7$K;H$C$F$_$k>l9g$K$O!"FC$K2?$b@_Dj$9$kI,MW$O$"$j$^$;$s!#\e(B
+\e$B$3$N>O$OFI$_Ht$P$7$F$b9=$$$^$;$s!#\e(B
 
 Riece \e$B$O@_Dj%U%!%$%k$rJQ?t\e(B @code{riece-directory} \e$B$G;X<($5$l$k%G%#%l%/%H\e(B
 \e$B%j\e(B (\e$B%G%U%)%k%H$O\e(B @file{~/.riece/}) \e$B$+$iFI$_9~$_$^$9!#$3$N%G%#%l%/%H%j$K\e(B
-\e$B$O0J2<$N\e(B 2 \e$B$D$N@_Dj%U%!%$%k$,3JG<$5$l$^$9!#\e(B
+\e$B$O0J2<$N\e(B 2 \e$B$D$N@_Dj%U%!%$%k$,G[CV$5$l$^$9!#\e(B
 
 @table @code
 @item riece-saved-variables-file
 @vindex riece-saved-variables-file
-\e$BA02s$N%;%C%7%g%s$N>pJs$r3JG<$7$^$9\e(B(\e$B%G%U%)%k%H$O\e(B @file{~/.riece/save})
+\e$BA02s$N%;%C%7%g%s$G99?7$5$l$?@_Dj$,<+F0E*$KJ]B8$5$l$^$9\e(B(\e$B%G%U%)%k%H$O\e(B @file{~/.riece/save})
 @item riece-variables-file
 @vindex riece-variables-file
 \e$B%f!<%6$K8GM-$N@_Dj$r5-=R$7$^$9\e(B(\e$B%G%U%)%k%H$O\e(B @file{~/.riece/init})
 @end table
 
 \e$B5/F0;~$K$O!":G=i$K\e(B @code{riece-saved-variables-file} \e$B$r!"<!$K\e(B 
-@code{riece-variables-file} \e$B$rFI$_9~$_$^$9!#%U%!%$%k$,B8:_$7$J$1$l$P2?$b\e(B
-\e$B$7$^$;$s!#\e(B
+@code{riece-variables-file} \e$B$rFI$_9~$_$^$9!#$D$^$j!"\e(B
+@file{~/.riece/save} \e$B$K<+F0E*$KJ]B8$5$l$?FbMF$O!"\e(B@file{~/.riece/init} \e$B$K\e(B
+\e$B5-=R$5$l$?FbMF$G>e=q$-$5$l$^$9!#\e(B
 
 @node Basic usage, Advanced usage, Getting started, Top
 @chapter Basic usage
@@ -485,7 +488,7 @@ Riece \e$B$NBg$-$JFCD9$K!"J#?t$N%5!<%P$KF1;~$K@\B3$9$k5!G=$,$"$j$^$9!#\e(B
 \e$B%3!<%G%#%s%0%7%9%F%`\e(B (\e$B%G%U%)%k%H$O\e(B @code{riece-default-coding-system} \e$B$NCM\e(B)
 @end table
 
-@node Add-ons, Writing add-ons, Server settings, Advanced usage
+@node Add-ons,  , Server settings, Advanced usage
 @section Add-ons
 
 Riece \e$B$G$O!"%f!<%6$,?7$?$J5!G=$rDI2C$7!"<+M3$K<h$j30$7$G$-$k$h$&!"%"%I%*\e(B
@@ -556,73 +559,19 @@ PING \e$B$K1~Ez$9$k\e(B local proxy \e$B7PM3$G\e(B IRC \e$B%5!<%P$K@\B3\e(B
 (add-to-list 'riece-addons 'riece-alias)
 @end example
 
-@node Writing add-ons, Handler hooks, Add-ons, Advanced usage
-@section Writing add-ons
-
-\e$B%"%I%*%s$N>r7o$rK~$?$9%b%8%e!<%k$O0J2<$N4X?t$rDs6!$7$^$9!#\e(B
-
-@table @samp
-@item <\e$B%b%8%e!<%kL>\e(B>-requires
-\e$B0MB8$9$kB>$N%"%I%*%s\e(B(\e$B%7%s%\%k$N%j%9%H\e(B)\e$B$rJV$7$^$9\e(B(\e$B%*%W%7%g%s\e(B)
-@item <\e$B%b%8%e!<%kL>\e(B>-insinuate
-\e$B=i4|2==hM}$r9T$$$^$9\e(B
-@end table
-
-Riece \e$BB&$G$O0J2<$N=hM}$r9T$$$^$9!#\e(B
-
-@enumerate
-@item
-\e$BJQ?t\e(B @code{riece-addons} \e$B$KNs5s$5$l$?%b%8%e!<%k$rFI$_9~$`\e(B
-
-@item
-\e$B$=$l$>$l$N%b%8%e!<%k$KBP$7!"\e(B@samp{<\e$B%b%8%e!<%kL>\e(B>-requires} \e$B$,MQ0U$5$l$F$$$l$P8F$S=P$7$F0MB8%0%i%U$r:n$k\e(B
-
-@item
-\e$B0MB8%0%i%U$KBP$7$F%H%]%m%8%+%k%=!<%H\e(B (cf. tsort(1)) \e$B$r9T$&\e(B
-
-@item
-\e$BF@$?0MB8=g=x$K=>$C$F\e(B @samp{<\e$B%b%8%e!<%kL>\e(B>-insinuate} \e$B8F$S=P$9\e(B
-@end enumerate
-
-\e$B:n@.$7$?%"%I%*%s$O!"\e(B@code{load-path} \e$B$NDL$C$?%G%#%l%/%H%j!"$^$?$O\e(B 
-@code{riece-addon-directory} (\e$B%G%U%)%k%H$G$O\e(B @file{~/.riece/addons/}) \e$B$K\e(B
-\e$BCV$/$3$H$GAH$_9~$_2DG=$J>uBV$K$J$j$^$9!#\e(B
-@vindex riece-addon-directory
-
-@node Handler hooks,  , Writing add-ons, Advanced usage
-@section Handler hooks
-
-Riece \e$B$K$O!"%O%s%I%i%U%C%/$H8F$P$l$kFC<l$J%U%C%/$,$"$j$^$9!#$3$l$i$O\e(B IRC 
-\e$B$N%a%C%;!<%8$r<u$1<h$C$?A08e$G<B9T$5$l$k%U%C%/$G$9!#\e(B
-
-\e$B@bL@$N$?$a$K\e(B @samp{message} \e$B$r\e(B IRC \e$B$N%a%C%;!<%8L>\e(B(PRIVMSG \e$B$J$I\e(B)\e$B$rA4$F>.\e(B
-\e$BJ8;z$K$7$?$b$N$H$7$^$9!#\e(B
-
-@table @code
-@item riece-<message>-hook
-@samp{message} \e$B$,FO$$$?$H$-$K:G=i$K8F$P$l$k%U%C%/\e(B
-@item riece-after-<message>-hook
-@samp{message} \e$B$N=hM}$,=*$o$C$?8e$K8F$P$l$k%U%C%/\e(B
-@end table
-
-\e$B$3$3$G\e(B @code{riece-<message>-hook} \e$B$NJV$jCM$K$O0UL#$,$"$j!"Hs\e(B nil \e$B$rJV$9\e(B
-\e$B$b$N$,$"$l$P!"$=$N8e$N=hM}$r$*$3$J$$$^$;$s!#$^$?!"$=$N>l9g$K$O\e(B 
-@code{riece-after-<message>-hook} \e$B$b8F$S=P$5$l$^$;$s!#\e(B
-
-\e$B%U%C%/$N0z?t$O\e(B RFC2812 \e$B$N\e(B @samp{prefix} \e$B$H\e(B @samp{Parameters} \e$B$KAjEv$9$k\e(B 
-2 \e$B$D$N0z?t$,EO$j$^$9!#\e(B
-
 @node Development, Index, Advanced usage, Top
 @chapter Development
 
 \e$B3+H/<TJg=8Cf!#\e(B
 
 @menu
-* CVS::                         
-* Debugging::                   
-* Modules::                     
+* CVS::                         \e$B3+H/Cf$N%=!<%9$N<hF@\e(B
+* Debugging::                   \e$B%G%P%C%0$N$?$a$N@_Dj\e(B
+* Modules::                     \e$B9=@.%b%8%e!<%k$N@bL@\e(B
 * Namespace management::        
 * Signals::                     
+* Writing add-ons::             \e$B%"%I%*%s$N=q$-$+$?\e(B
+* Handler hooks::               
 @end menu
 
 @node CVS, Debugging, Development, Development
@@ -668,7 +617,6 @@ autoreconf -f -i -v
 
 \e$B4pK\E*$K0MB84X78$N>e0L$K$"$k$b$N$+$i!'\e(B
 
-@subsection Core modules
 @table @samp
 @item riece-globals
 \e$BBg0hJQ?t$NDj5A\e(B 
@@ -683,6 +631,8 @@ autoreconf -f -i -v
 @item riece-complete
 \e$B%_%K%P%C%U%!$G$NJd40$r=u$1$k4X?t$NDj5A\e(B 
 
+@item riece-mode
+channel/user \e$B$N%b!<%I4IM}\e(B
 @item riece-identity
 channel/user object \e$B$NBg0hI=5-$rA`:n$9$k4X?t$NDj5A\e(B 
 @item riece-channel
@@ -707,17 +657,17 @@ message object \e$B4XO"$NDj5A\e(B
 @item riece-filter
 \e$B%W%m%;%9%U%#%k%?$N%(%s%H%j%]%$%s%H\e(B 
 @item riece-handle
-\e$BDL>o$N%a%C%;!<%8$N%O%s%I%i!#\e(Briece-filter \e$B$N$_$+$i8F$P$l$k\e(B 
+\e$BDL>o$N%a%C%;!<%8$N%O%s%I%i!#\e(Briece-filter \e$B$+$i8F$P$l$k\e(B 
 @item riece-000
-000\e$BHVBf$N\e(B numeric reply \e$B$N%O%s%I%i!#\e(Briece-filter \e$B$N$_$+$i8F$P$l$k\e(B 
+000\e$BHVBf$N\e(B numeric reply \e$B$N%O%s%I%i!#\e(Briece-filter \e$B$+$i8F$P$l$k\e(B 
 @item riece-200
-200\e$BHVBf$N\e(B numeric reply \e$B$N%O%s%I%i!#\e(Briece-filter \e$B$N$_$+$i8F$P$l$k\e(B 
+200\e$BHVBf$N\e(B numeric reply \e$B$N%O%s%I%i!#\e(Briece-filter \e$B$+$i8F$P$l$k\e(B 
 @item riece-300
-300\e$BHVBf$N\e(B numeric reply \e$B$N%O%s%I%i!#\e(Briece-filter \e$B$N$_$+$i8F$P$l$k\e(B 
+300\e$BHVBf$N\e(B numeric reply \e$B$N%O%s%I%i!#\e(Briece-filter \e$B$+$i8F$P$l$k\e(B 
 @item riece-400
-400\e$BHVBf$N\e(B numeric reply \e$B$N%O%s%I%i!#\e(Briece-filter \e$B$N$_$+$i8F$P$l$k\e(B 
+400\e$BHVBf$N\e(B numeric reply \e$B$N%O%s%I%i!#\e(Briece-filter \e$B$+$i8F$P$l$k\e(B 
 @item riece-500
-500\e$BHVBf$N\e(B numeric reply \e$B$N%O%s%I%i!#\e(Briece-filter \e$B$N$_$+$i8F$P$l$k\e(B 
+500\e$BHVBf$N\e(B numeric reply \e$B$N%O%s%I%i!#\e(Briece-filter \e$B$+$i8F$P$l$k\e(B 
 
 @item riece-commands
 \e$B%3%^%s%I$NDj5A\e(B 
@@ -725,23 +675,6 @@ message object \e$B4XO"$NDj5A\e(B
 \e$B%(%s%H%j%]%$%s%H!#3F%P%C%U%!$N%b!<%IDj5A$J$I\e(B 
 @end table
 
-@subsection Add-ons
-@table @samp
-@item riece-highlight
-\e$B%P%C%U%!$N?'IU$1\e(B
-@item riece-ctcp
-CTCP (Client To Client Protocol)
-@item riece-url
-\e$B2qOC$K8=$l$?\e(B URL \e$B$N<}=8\e(B
-@item riece-unread
-\e$BH/8@$N$"$C$?%A%c%s%M%k$K\e(B@samp{!}\e$B%^!<%/$r$D$1$k\e(B
-@item riece-rdcc
-DCC (Direct Client to Client protocol) \e$B$K$h$k%U%!%$%kE>Aw\e(B (Ruby \e$B$K$h$k<BAu\e(B)
-@item riece-ndcc
-DCC (Direct Client to Client protocol) \e$B$K$h$k%U%!%$%kE>Aw\e(B (Emacs 21.3 \e$B$N\e(B 
-@code{make-network-connection} \e$B$K$h$k<BAu\e(B)
-@end table
-
 @node Namespace management, Signals, Modules, Development
 @section Namespace management
 
@@ -878,7 +811,7 @@ AWAY \e$BCf$+$I$&$+\e(B
 \e$B%f!<%6$NL>A0$,JQ99$5$l$?$3$H$rI=L@$7$^$9\e(B 
 @end defun
 
-@node Signals,  , Namespace management, Development
+@node Signals, Writing add-ons, Namespace management, Development
 @section Signals
 
 \e$B2hLL$N:FIA2h$r8zN(NI$/9T$&$?$a$K!"%$%Y%s%H$HIA2hBP>]$N%*%V%8%'%/%H\e(B(\e$B%P%C\e(B
@@ -960,6 +893,75 @@ Qt \e$B$d\e(B GTK+ \e$B$H$$$C$?\e(B GUI \e$B%D!<%k%-%C%H$KMQ0U$5$l$F$$$k$b$N$HF1MM$G$
 (\e$B0z?t$O%P%C%U%!\e(B)
 @end table
 
+@node Writing add-ons, Handler hooks, Signals, Development
+@section Writing add-ons
+
+\e$B%"%I%*%s$N>r7o$rK~$?$9%b%8%e!<%k$O0J2<$N4X?t$rDs6!$7$^$9!#\e(B
+
+@table @samp
+@item <\e$B%b%8%e!<%kL>\e(B>-requires
+\e$B0MB8$9$kB>$N%"%I%*%s\e(B(\e$B%7%s%\%k$N%j%9%H\e(B)\e$B$rJV$7$^$9\e(B(\e$B%*%W%7%g%s\e(B)
+@item <\e$B%b%8%e!<%kL>\e(B>-insinuate
+\e$B=i4|2==hM}$r9T$$$^$9\e(B
+@item <\e$B%b%8%e!<%kL>\e(B>-description
+\e$B%"%I%*%s$N@bL@J8;zNs$rJV$7$^$9\e(B(\e$B%*%W%7%g%s\e(B)
+@end table
+
+\e$BL58z2=$KBP1~$7$?%"%I%*%s$O!"JQ?t\e(B @samp{<\e$B%b%8%e!<%kL>\e(B>-enabled} \e$B$K8=:_$N\e(B
+\e$B>uBV$rJ];}$7$^$9!#CM$,\e(B @samp{nil} \e$B$G$"$l$PL58z!"\e(B@samp{t} \e$B$G$"$l$PM-8z$G\e(B
+\e$B$9!#2C$($F!"0J2<$N4X?t$rDs6!$7$^$9!#\e(B
+
+@table @samp
+@item <\e$B%b%8%e!<%kL>\e(B>-enable
+\e$B%"%I%*%s$rM-8z$K$7$^$9\e(B
+@item <\e$B%b%8%e!<%kL>\e(B>-disable
+\e$B%"%I%*%s$rL58z$K$7$^$9\e(B
+@end table
+
+Riece \e$BB&$G$O0J2<$N=hM}$r9T$$$^$9!#\e(B
+
+@enumerate
+@item
+\e$BJQ?t\e(B @code{riece-addons} \e$B$KNs5s$5$l$?%b%8%e!<%k$rFI$_9~$`\e(B
+
+@item
+\e$B$=$l$>$l$N%b%8%e!<%k$KBP$7!"\e(B@samp{<\e$B%b%8%e!<%kL>\e(B>-requires} \e$B$,MQ0U$5$l$F$$$l$P8F$S=P$7$F0MB8%0%i%U$r:n$k\e(B
+
+@item
+\e$B0MB8%0%i%U$KBP$7$F%H%]%m%8%+%k%=!<%H\e(B (cf. tsort(1)) \e$B$r9T$&\e(B
+
+@item
+\e$BF@$i$l$?0MB8=g=x$K=>$C$F\e(B @samp{<\e$B%b%8%e!<%kL>\e(B>-insinuate} \e$B8F$S=P$9\e(B
+@end enumerate
+
+\e$B:n@.$7$?%"%I%*%s$O!"\e(B@code{load-path} \e$B$NDL$C$?%G%#%l%/%H%j!"$^$?$O\e(B 
+@code{riece-addon-directory} (\e$B%G%U%)%k%H$G$O\e(B @file{~/.riece/addons/}) \e$B$K\e(B
+\e$BCV$/$3$H$GAH$_9~$_2DG=$J>uBV$K$J$j$^$9!#\e(B
+@vindex riece-addon-directory
+
+@node Handler hooks,  , Writing add-ons, Development
+@section Handler hooks
+
+Riece \e$B$K$O!"%O%s%I%i%U%C%/$H8F$P$l$kFC<l$J%U%C%/$,$"$j$^$9!#$3$l$i$O\e(B IRC 
+\e$B$N%a%C%;!<%8$r<u$1<h$C$?A08e$G<B9T$5$l$k%U%C%/$G$9!#\e(B
+
+\e$B@bL@$N$?$a$K\e(B @samp{message} \e$B$r\e(B IRC \e$B$N%a%C%;!<%8L>\e(B(PRIVMSG \e$B$J$I\e(B)\e$B$rA4$F>.\e(B
+\e$BJ8;z$K$7$?$b$N$H$7$^$9!#\e(B
+
+@table @code
+@item riece-<message>-hook
+@samp{message} \e$B$,FO$$$?$H$-$K:G=i$K8F$P$l$k%U%C%/\e(B
+@item riece-after-<message>-hook
+@samp{message} \e$B$N=hM}$,=*$o$C$?8e$K8F$P$l$k%U%C%/\e(B
+@end table
+
+\e$B$3$3$G\e(B @code{riece-<message>-hook} \e$B$NJV$jCM$K$O0UL#$,$"$j!"Hs\e(B nil \e$B$rJV$9\e(B
+\e$B$b$N$,$"$l$P!"$=$N8e$N=hM}$r$*$3$J$$$^$;$s!#$^$?!"$=$N>l9g$K$O\e(B 
+@code{riece-after-<message>-hook} \e$B$b8F$S=P$5$l$^$;$s!#\e(B
+
+\e$B%U%C%/$N0z?t$O\e(B RFC2812 \e$B$N\e(B @samp{prefix} \e$B$H\e(B @samp{Parameters} \e$B$KAjEv$9$k\e(B 
+2 \e$B$D$N0z?t$,EO$j$^$9!#\e(B
+
 @node Index, Function Index, Development, Top
 @chapter Index
 @printindex cp