@setfilename riece-ja.info
@settitle Riece -- An IRC client for Emacsen --
@c %**end of header
-@set VERSION 0.0.2
+@set VERSION 0.0.4
@c @documentlanguage ja
@dircategory GNU Emacs Lisp
@section Installation
Riece \e$B$N:G?7HG$O!"\e(B
-@uref{http://wiliki.designflaw.org/index.cgi?Riece&l=jp} \e$B$GG[I[$7$F$$$^\e(B
+@uref{http://wiliki.designflaw.org/riece.cgi} \e$B$GG[I[$7$F$$$^\e(B
\e$B$9!#E83+$7$?$i!"0J2<$N%3%^%s%I$r<B9T$9$k$3$H$G<j85$N4D6-$K%$%s%9%H!<%k$G\e(B
\e$B$-$^$9\e(B
@section Startup file
\e$B$O$8$a$F$D$+$&>l9g$K$O!"$H$/$K2?$b@_Dj$9$kI,MW$O$"$j$^$;$s!#\e(B
-\e$BFI$_Ht$P$7$F$/$@$5$$!#\e(B
+\e$B$3$N>O$OFI$_Ht$P$7$F$/$@$5$$!#\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$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$*$3$J$$$^$;$s!#\e(B
+\e$B$7$^$;$s!#\e(B
@node Basic usage, Advanced usage, Getting started, Top
@chapter Basic usage
\e$B$k$3$H$,$G$-$^$9!#B>$N?M$N2qOC$O2hLL1&>e$N%P%C%U%!$KI=<($5$l$^$9!#\e(B
@menu
+* Windows:: \e$B2hLL9=@.\e(B
+* Indicators:: \e$B<+J,$N>uBV$NI=<(\e(B
* Commands:: \e$B%3%^%s%I$N0lMw\e(B
* Connecting to multiple servers:: \e$BJ#?t$N%5!<%P$K$D$J$0$K$O\e(B
@end menu
-@node Commands, Connecting to multiple servers, Basic usage, Basic usage
+@node Windows, Commands, Basic usage, Basic usage
+@section Windows
+
+\e$B%G%U%)%k%H$N@_Dj$G$O!"%A%c%s%M%k$KF~$k$H!"2<$N?^$K<($9$h$&$J8^$D$N%&%#%s\e(B
+\e$B%I%&$+$i$J$k2hLL$K@Z$jBX$o$j$^$9!#\e(B
+
+@example
++-----+-----------------+
+| | |
+| | |
+| (1) | (2) |
+| | |
+| | |
++-----+-----------------+
+| | (4) |
+| +-----------------+
+| (3) | |
+| | (5) |
+| | |
++-----+-----------------+
+@end example
+
+\e$B$3$l$i$N3F%&%#%s%I%&$KI=<($5$l$k%P%C%U%!$NLr3d$O0J2<$NDL$j$G$9!#\e(B
+
+@enumerate
+@item
+\e$B%f!<%6%j%9%H%P%C%U%!\e(B (@samp{*Users XXX*})\e$B!#%A%c%s%M%k$K$$$k%f!<%6$N0lMw\e(B
+\e$B$,I=<($5$l$^$9!#\e(B
+
+@item
+\e$B%A%c%s%M%k%P%C%U%!\e(B (@samp{*Channel XXX*})\e$B!#%A%c%s%M%kFb$N2qOC$,I=<($5$l\e(B
+\e$B$^$9!#\e(B
+
+@item
+\e$B%A%c%s%M%k%j%9%H%P%C%U%!\e(B (@samp{*Channels*})\e$B!#;22C$7$F$$$k%A%c%s%M%k$N0l\e(B
+\e$BMw$,I=<($5$l$^$9!#\e(B
+
+@item
+\e$B%3%^%s%I%P%C%U%!\e(B (@samp{*Commands*})\e$B!#J8>O$d%3%^%s%I$rAw?.$9$k$?$a$K;H$$\e(B
+\e$B$^$9!#\e(B
+
+@item
+\e$B%"%6!<%:%P%C%U%!\e(B (@samp{*Others*})\e$B!#8=:_$N%A%c%s%M%k0J30$N2qOC$,N.$l$^$9!#\e(B
+@end enumerate
+
+@node Indicators
+@section Indicators
+
+\e$B%3%^%s%I%P%C%U%!$d%A%c%s%M%k%P%C%U%!$N%b!<%I%i%$%s$N:8C<$K$O!"\e(B
+\e$B<+J,$N8=:_$N>uBV$r<($90u$,I=<($5$l$^$9!#\e(B
+
+@example
+Riece: --- ueno #Liece [n]
+@end example
+
+\e$B$3$3$G!"\e(B@samp{---} \e$B$NItJ,$K$O:8$+$i=g$K0J2<$N0UL#$,$"$j$^$9!#\e(B
+
+@enumerate
+@item
+\e$BN%@J>uBV\e(B (\e$BN%@J$7$F$$$l$P\e(B @samp{A})
+
+@item
+\e$B%*%Z%l!<%?>uBV\e(B (IRC \e$B%*%Z%l!<%?$G$"$l$P\e(B @samp{O})
+
+@item
+\e$B%A%c%s%M%k%P%C%U%!!"$^$?$O%@%$%"%m%0%P%C%U%!$N%9%/%m!<%k6X;_>uBV\e(B
+(\e$B40A4$K6X;_$7$F$$$l$P\e(B @samp{F}\e$B!"<+J,$N<!2s$NH/8@$^$G6X;_$7$F$$$k$N$G$"$l\e(B
+\e$B$P\e(B @samp{f})
+@end enumerate
+
+@node Commands, Connecting to multiple servers, Windows, Basic usage
@section Commands
-\e$BJ8>O$rF~NO$7$?%P%C%U%!\e(B @samp{*Commands*} \e$B$O!"%3%^%s%I%P%C%U%!$H8F$P$l!"\e(B
-\e$B%3%^%s%I%P%C%U%!$+$i$OMM!9$J%3%^%s%I$rH/9T$9$k$3$H$,$G$-$^$9!#0J2<$K0lIt\e(B
-\e$B$r5s$2$^$9!#\e(B
+\e$BJ8>O$rF~NO$7$?%P%C%U%!$O!"%3%^%s%I%P%C%U%!$H8F$P$l!"%3%^%s%I%P%C%U%!$+$i\e(B
+\e$B$OMM!9$J%3%^%s%I$rH/9T$9$k$3$H$,$G$-$^$9!#0J2<$K0lIt$r5s$2$^$9!#\e(B
@subsection IRC commands
@table @kbd
@node Connecting to multiple servers, , Commands, Basic usage
@section Connecting to multiple servers
-Riece \e$B$NBg$-$JFCD9$H$7$F!"F1;~$KJ#?t$N%5!<%P$K@\B3$9$k5!G=$,5s$2$i$l$^$9!#\e(B
+Riece \e$B$NBg$-$JFCD9$K!"J#?t$N%5!<%P$KF1;~$K@\B3$9$k5!G=$,$"$j$^$9!#\e(B
-\e$B4{$K\e(B Riece \e$B$r5/F0$7$?>uBV$+$i!"JL$N%5!<%P$K@\B3$7!"$=$N%5!<%P>e$N%A%c%s\e(B
-\e$B%M%k$K;22C$9$k<j=g$O0J2<$N$h$&$K$J$j$^$9!#\e(B
+\e$B?7$?$J%5!<%P$K@\B3$7!"$=$N%5!<%P>e$N%A%c%s%M%k$K;22C$9$k<j=g$O0J2<$N$h$&\e(B
+\e$B$K$J$j$^$9!#\e(B
@enumerate
@item
@example
(setq riece-server-alist
'(("irc6" :host "irc6.nara.wide.ad.jp")
- ("plum" :host "localhost" :service 26667
- :function relay-open-network-stream))
+ ("plum" :host "localhost" :service 26667
+ :function relay-open-network-stream))
riece-server "irc6")
@end example
@item :host
\e$B%5!<%P$N%[%9%HL>$^$?$O\e(B IP \e$B%"%I%l%9\e(B
@item :service
-\e$B%5!<%P$N%5!<%S%9L>$^$?$O%]!<%HHV9f\e(B
+\e$B%5!<%P$N%5!<%S%9L>$^$?$O%]!<%HHV9f\e(B (\e$B%G%U%)%k%H$O\e(B 6667)
@item :nickname
\e$B@\B3;~$N%K%C%/%M!<%`\e(B
@item :username
\e$B@\B3;~$N%Q%9%o!<%I\e(B
@item :function
\e$B@\B3MQ4X?t\e(B
-@item :coding-system
-\e$B%3!<%G%#%s%0%7%9%F%`\e(B
+@item :coding
+\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
@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 Connection) \e$B$K$h$k%U%!%$%kE>Aw\e(B
+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 make-network-process \e$B$K$h$k<BAu\e(B)
+@item riece-mini
+\e$B%_%K%P%C%U%!$N$_$G\e(B IRC \e$B$r$9$k\e(B
+@item riece-log
+\e$B2qOC$N%m%0$N<}=8\e(B
+@item riece-doctor
+doctor.el \e$B$HO"7H$7$F@:?@2J0e$K$J$j$9$^$9\e(B
+@item riece-alias
+\e$B%A%c%s%M%kL>$d%K%C%/%M!<%`$NJLL>$rDj5A\e(B
@end table
\e$B$3$l$i$N$&$A!"\e(B@samp{riece-highlight} \e$B$H\e(B @samp{riece-ctcp} \e$B$O%G%U%)%k%H$G\e(B
\e$BAH$_9~$^$l$F$$$^$9!#\e(B
-\e$B%"%I%*%s$rAH$_9~$`$K$O\e(B @code{riece-addons} \e$B$r@_Dj$7$^$9!#\e(B
-\e$B$?$H$($P\e(B @samp{riece-url} \e$B$rAH$_9~$`>l9g$K$O!"\e(B@code{riece-variables-file} \e$B$K0J2<$N$h$&$K5-=R$7$^$9!#\e(B
+\e$B%"%I%*%s$rAH$_9~$`$K$O\e(B @code{riece-addons} \e$B$r@_Dj$7$^$9!#$?$H$($P\e(B
+@samp{riece-url} \e$B$rAH$_9~$`>l9g$K$O!"\e(B@file{~/.riece/init.el} \e$B$K0J2<$N$h\e(B
+\e$B$&$K5-=R$7$^$9!#\e(B
@vindex riece-addons
@example
-(add-to-list 'riece-addons 'riece-url t)
+(add-to-list 'riece-addons 'riece-url)
@end example
@node Writing add-ons, Handler hooks, Add-ons, Advanced usage
@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 Connection) \e$B$K$h$k%U%!%$%kE>Aw\e(B (Ruby \e$B$K$h$k<BAu\e(B)
+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 Connection) \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)
+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, , Modules, Development
\e$B%m!<%+%kJQ?t$r2p$7$F%"%/%;%9$7$^$9!#\e(B
@subsection Obtaining server buffer
-\e$B%5!<%P$N%P%C%U%!$r<hF@$9$k$K$O!"$^$:$O$8$a$K%5!<%P$NL>A0$rF@$kI,MW$,$"$j\e(B
-\e$B$^$9!#$3$l$K$O\e(B @code{riece-find-server-name} \e$B$r;H$$$^$9!#$3$N4X?t$O!">u\e(B
-\e$B67$K1~$8$FA*Br$9$Y$-%5!<%P$NL>A0$rJV$7$^$9!#6qBNE*$K$O0J2<$N=g=x$G8!:w$r\e(B
-\e$B9T$$$^$9!#\e(B
-@findex riece-find-server-name
+\e$B%5!<%P$N%W%m%;%9$rF@$k$K$O!"$^$:$O$8$a$K%5!<%P$NL>A0$rF@$kI,MW$,$"$j\e(B
+\e$B$^$9!#%5!<%P$NL>A0$O0J2<$K5s$2$k$$$/$D$+$NJ}K!$G<hF@$G$-$^$9!#\e(B
-@enumerate
+@table @samp
@item
@vindex riece-overrinding-server-name
\e$BBg0hJQ?t\e(B @code{riece-overrinding-server-name} \e$B$NCM\e(B
\e$BCM$=$N$b$N\e(B
@item
-@vindex riece-current-channel
-\e$B%f!<%6$,8=:_$$$k%A%c%s%M%k\e(B (@code{riece-current-channel}) \e$B$NBg0hL>\e(B(\e$B8e=R\e(B)
-\e$B$+$i@Z$j=P$7$?%5!<%PL>\e(B
-@end enumerate
+@samp{riece-identity} \e$B%*%V%8%'%/%H$K7k$SIU$1$i$l$?%5!<%PL>\e(B(\e$B8e=R\e(B)
+@end table
-\e$B$3$&$7$FF@$?%5!<%PL>$G\e(B @code{riece-server-process-alist} \e$B$r:w$-!"%5!<%P\e(B
-\e$B$N%W%m%;%9$r<hF@$7$^$9!#%^%/%m\e(B riece-with-server-buffer \e$B$r;H$&$H!"$3$3$^\e(B
-\e$B$G$r0l3g$G$d$C$?$&$($G!"%W%m%;%9$N%P%C%U%!$G<0$rI>2A$9$k$3$H$,$G$-$^$9!#\e(B
-@vindex riece-server-process-alist
+\e$B$3$&$7$FF@$?%5!<%PL>$G\e(B @code{riece-server-process} \e$B$r8F=P$7!"%5!<%P$N\e(B
+\e$B%W%m%;%9$r<hF@$7$^$9!#\e(B
+@findex riece-server-process
-@subsection Global name
-\e$BJ#?t$N%5!<%P$K7R$$$@>l9g!"%A%c%s%M%kL>$d%K%C%/$r\e(B(\e$B%5!<%P$N%P%C%U%!>e$@$1\e(B
-\e$B$G$O$J$/\e(B)\e$BBg0hE*$K6hJL$9$kI,MW$,@8$8$^$9!#$=$3$G!"$3$l$i$NL>A0$r9)IW$7$F!"\e(B
-\e$BL>A0$N8e$K6uGr$r64$s$G%5!<%PL>$r;XDj$9$k<jK!$r:N$C$F$$$^$9!#$3$l$rBg0hL>\e(B
-\e$B$H8F$S$^$9!#$?$H$($P!"\e(B@samp{irc6} \e$B$H$$$&%5!<%P$N\e(B @samp{#Liece} \e$B$H$$$&%A%c\e(B
-\e$B%s%M%k$NBg0hL>$O\e(B @samp{#Liece irc6} \e$B$H$J$j$^$9!#\e(B
+@subsection Identity
+\e$BJ#?t$N%5!<%P$K7R$$$@>l9g!"%A%c%s%M%kL>$d%K%C%/$r\e(B(\e$B%5!<%P$N%P%C%U%!>e$@\e(B
+\e$B$1$G$O$J$/\e(B)\e$BBg0hE*$K6hJL$9$kI,MW$,@8$8$^$9!#$3$N$h$&$JL>A0$rI=8=$9$k$N\e(B
+\e$B$,\e(B @samp{riece-identity} \e$B%*%V%8%'%/%H$G$9!#\e(B
-\e$B$3$3$G6h@Z$j$r6uGr$K$7$F$$$k$N$O!"\e(BRFC2812 \e$B$G%A%c%s%M%k$K;HMQ$G$-$J$$J8;z\e(B
-\e$B$@$+$i$G$9!#\e(B
+@samp{riece-identity} \e$B%*%V%8%'%/%H$O0J2<$N\e(B 2 \e$B$D$NMWAG$r$b$D%Y%/%?!<$G$9!#\e(B
-\e$BBg0hL>$r07$&$K$O!"\e(B@samp{riece-identity} \e$B$H$$$&Cj>]$r2p$7$^$9!#$3$N%b%8%e!<\e(B
-\e$B%k$G$O!"0J2<$N$h$&$J4X?t$,Dj5A$5$l$F$$$^$9!#\e(B
+@table @samp
+@item prefix
+\e$B%5!<%P%m!<%+%k$JL>A0\e(B
+@item server
+\e$B%5!<%P$NL>A0\e(B
+@end table
+
+@samp{riece-identity} \e$B%*%V%8%'%/%H$KBP$9$kA`:n$K$O0J2<$N$h$&$J$b$N$,$"$j$^$9!#\e(B
@defun riece-make-identity prefix &optional server
-\e$BBg0hI=5-$r:n$j=P$7$^$9!#\e(Bserver \e$B$,>JN,$5$l$?>l9g$K$O!"\e(Briece-find-server-name \e$B$r;H$C$F<hF@$7$?%5!<%PL>$r;H$$$^$9\e(B
+@samp{riece-identity} \e$B%*%V%8%'%/%H$r:n@.$7$^$9!#\e(Bserver \e$B$,>JN,$5$l$?>l9g$K$O!"\e(B
+riece-find-server-name \e$B$r;H$C$F<hF@$7$?%5!<%PL>$r;H$$$^$9\e(B
@end defun
@defun riece-identity-prefix identity
-\e$BBg0hI=5-$+$i%5!<%PL>$r=|$/ItJ,$rJV$7$^$9\e(B
+@samp{riece-identity} \e$B%*%V%8%'%/%H$+$i%5!<%P%m!<%+%k$JL>A0$r<h$j=P$7$^$9!#\e(B
@end defun
@defun riece-identity-server identity
-\e$BBg0hI=5-$+$i%5!<%P$r=|$/ItJ,$rJV$7$^$9\e(B
+@samp{riece-identity} \e$B%*%V%8%'%/%H$+$i%5!<%P$NL>A0$r<h$j=P$7$^$9!#\e(B
@end defun
-
-@defun riece-identity-equal a b
-\e$BFs$D$NBg0hI=5-$,F1Ey$+D4$Y$^$9!#0z?t$H$7$FM?$($i$l$?J8;zNs$K%5!<%PL>$,IU\e(B
-\e$B2C$5$l$F$$$J$1$l$P!"IU2C$7$F$+$i8!::$r9T$$$^$9\e(B
+
+@defun riece-identity-equal ident1 ident2
+2 \e$B$D$N\e(B@samp{riece-identity} \e$B%*%V%8%'%/%H$,F1Ey$+D4$Y$^$9!#\e(B
@end defun
-@defun riece-identity-equal-no-server a b
-@code{riece-identity-equal} \e$B$H0l=o$G$9$,!"%5!<%PL>$NIU2C$O9T$$$^$;$s\e(B
+@defun riece-identity-equal-no-server ident1 ident2
+2 \e$B$D$N\e(B@samp{riece-identity} \e$B%*%V%8%'%/%H$N%5!<%P%m!<%+%k$JL>A0$,F1Ey$+\e(B
+\e$BD4$Y$^$9!#\e(B
+@end defun
+
+@defun riece-identity-member elt list
+@samp{riece-identity} \e$B%*%V%8%'%/%H\e(B @var{elt} \e$B$,\e(B @var{list} \e$B$K4^$^$l$k\e(B
+\e$B$+8!::$7$^$9!#\e(B
@end defun
@subsection Channel and user management
-IRC \e$B$N%A%c%s%M%k$H%f!<%6$O4pK\E*$KC1$J$k%Y%/%?!<$H$7$FI=8=$5$l$F$$$^$9!#\e(B
-JOIN \e$B$d\e(B PART \e$B$H$$$C$?FCJL$JA`:n$O!"$3$l$i$N%*%V%8%'%/%H$K$O7k$S$D$1$^$;\e(B
-\e$B$s!#7k$S$D$1$?$[$&$,%*%V%8%'%/%H;X8~$GNI$$$N$G$O$J$$$+!"$H$$$&0U8+$b$"$j\e(B
-\e$B$^$9$,!"$=$N$h$&$K$9$k$H!"Aj8_$N7k$SIU$-$,6[L)$K$J$j$9$.!"%9%Q%2%C%F%#$N\e(B
-\e$B$b$H$K$J$k$3$H$O4{$K7P83:Q$_$G$9!#\e(B
+@samp{riece-identity} \e$B%*%V%8%'%/%H$K$h$C$F<1JL$5$l$k\e(B IRC \e$B$N%A%c%s%M%k\e(B
+\e$B$H%f!<%6$O$=$l$>$l\e(B @samp{riece-channel} \e$B%*%V%8%'%/%H$H\e(B
+@samp{riee-user} \e$B%*%V%8%'%/%H$K$h$jI=8=$5$l$^$9!#\e(B
@subsubsection Channels
@code{riece-channel} \e$B$O!"\e(BIRC \e$B$N%A%c%s%M%k$rI=$9%*%V%8%'%/%H$G$9!#0J2<$N\e(B
\e$BMWAG$r;}$A$^$9!#\e(B
-@table @samp{}
+@table @samp
@item users
\e$B;22C$7$F$$$k%f!<%6$NL>A0\e(B(\e$B6I=jL>\e(B)\e$B$N%j%9%H\e(B
@item operators
@end table
@subsubsection Mediator
-\e$B$5$F!"%A%c%s%M%k$H%f!<%6$N;22C$r4IM}$9$k$?$a$K!"\e(B @code{riece-naming} \e$B$H\e(B
-\e$B$$$&>e0L$N%b%8%e!<%k$rMQ0U$7$F$$$^$9!#$3$l$O!"%G%6%$%s%Q%?!<%s$G$$$&$H$3\e(B
-\e$B$m$N\e(B Mediator \e$B%Q%?!<%s$KAjEv$9$k$b$N$G$9!#\e(B
+\e$B%A%c%s%M%k$H%f!<%6$N;22C!&N%C&$r4IM}$9$k$?$a$K!"\e(B @code{riece-naming}
+\e$B$H$$$&>e0L$N%b%8%e!<%k$rMQ0U$7$F$$$^$9!#$3$l$O!"%G%6%$%s%Q%?!<%s$G$$$&\e(B
+\e$B$H$3$m$N\e(B Mediator \e$B%Q%?!<%s$KAjEv$9$k$b$N$G$9!#\e(B
@code{riece-naming} \e$B$r2p$9$k$3$H$G!"A0=R$N%A%c%s%M%k!&%f!<%6%*%V%8%'%/%H\e(B
\e$B$KD>@\<j$r?($l$k$3$H$J$/!"L>A06u4V$K0BA4$K%"%/%;%9$9$k$3$H$,$G$-$^$9!#\e(B
projects / riece / blobdiff