Merge http://wiliki.designflaw.org/riece.cgi?Tips
[riece] / doc / riece-ja.texi
index ce35d64..67ec14e 100644 (file)
@@ -56,6 +56,7 @@ Riece \e$B$O\e(B Emacs \e$B$G\e(B IRC (Internet Relay Chat) \e$B$K;22C$9$k$?$a$N%W%m%
 * Getting started::             
 * Basic usage::                 \e$B4pK\E*$J$D$+$$$+$?\e(B
 * Advanced usage::              \e$B?J$s$@$D$+$$$+$?\e(B
+* Tips::                        \e$BJXMx$J@_Dj\e(B
 * Development::                 \e$B3+H/<T8~$1>pJs\e(B
 * Index::                       
 * Function Index::              
@@ -423,7 +424,7 @@ Riece \e$B$NBg$-$JFCD9$K!"J#?t$N%5!<%P$KF1;~$K@\B3$9$k5!G=$,$"$j$^$9!#\e(B
 \e$BFCDj$N%5!<%P$KBP$7$F!"B3$/%3%^%s%I$rH/9T$7$^$9\e(B(@code{riece-command-universal-server-name-argument})
 @end table
 
-@node Advanced usage, Development, Basic usage, Top
+@node Advanced usage, Tips, Basic usage, Top
 @chapter Advanced usage
 
 \e$B$3$N>O$G$O!"$b$C$H?J$s$@;H$$J}$r2r@b$7$^$9!#\e(B
@@ -431,8 +432,6 @@ Riece \e$B$NBg$-$JFCD9$K!"J#?t$N%5!<%P$KF1;~$K@\B3$9$k5!G=$,$"$j$^$9!#\e(B
 @menu
 * Server settings::             \e$B%5!<%P$N>\:Y@_Dj\e(B
 * Add-ons::                     \e$B%"%I%*%s$H$O\e(B
-* Writing add-ons::             \e$B@lMQ$N%"%I%*%s$r=q$/$K$O\e(B
-* Handler hooks::               \e$B%O%s%I%i$N?6Iq$$$NJQ99\e(B
 @end menu
 
 @node Server settings, Add-ons, Advanced usage, Advanced usage
@@ -559,7 +558,181 @@ 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 Development, Index, Advanced usage, Top
+@node Tips, Development, Advanced usage, Top
+@comment  node-name,  next,  previous,  up
+@chapter Tips
+
+\e$B$3$N>O$G$O!"$h$/J9$+$l$k<ALd$KBP$9$kEz$($d!"JXMx$J@_Dj$r>R2p$7$^$9!#\e(B
+
+@section \e$B%A%c%s%M%kL>!V\e(B#\e$B$[$2\e(B:*.jp\e$B!W$r!V\e(B%\e$B$[$2!W$HN,5-$7$?$$\e(B
+
+\e$B0J2<$N9T$r\e(B @file{~/.riece/init.el} \e$B$KDI2C$7$^$9!'\e(B
+
+@example
+(add-to-list 'riece-addons 'riece-alias)
+@end example
+
+@section \e$BD>A0$K$$$?%A%c%s%M%k$KLa$j$?$$\e(B
+
+\e$B0J2<$N9T$r\e(B @file{~/.riece/init.el} \e$B$KDI2C$9$k$3$H$G!"\e(B
+@kbd{C-c g} \e$B$GMzNr$rC)$j$D$D0\F0$G$-$^$9!#\e(B
+
+@example
+(add-hook 'riece-guess-channel-try-functions
+          'riece-guess-channel-from-history)
+@end example
+
+@section \e$BH/8@$,$"$k$H%P%C%U%!$,%9%/%m!<%k$9$k$N$r;_$a$?$$\e(B
+
+@kbd{C-c C-t f} \e$B$G$9!#\e(B(irchat \e$B$G$O\e(B @kbd{C-c C-f}) "t"oggle "f"reeze \e$B$H3P\e(B
+\e$B$($^$7$g$&!#\e(B
+
+@section \e$BGI<j$JAu>~$rM^@)$7$?$$\e(B
+
+@code{riece-addons} \e$B$+$i!"?'IU$1\e(B (@samp{riece-highlight})\e$B!"%\%?%s\e(B 
+(@samp{riece-button})\e$B!"%"%$%3%s\e(B (@samp{riece-icon}) \e$B$r=|$-$^$9!#\e(B
+
+\e$B$?$H$($P?'IU$1$r$d$a$?$$$N$G$"$l$P!"0J2<$N9T$r\e(B @file{~/.riece/init.el} 
+\e$B$KDI2C$7$^$9!'\e(B
+
+@example
+(setq riece-addons (delq 'riece-highlight riece-addons))
+@end example
+
+@section \e$B%-!<%o!<%I$KH?1~$7$F2;$rLD$i$7$?$$\e(B
+
+XEmacs \e$B$G$O!"0J2<$N@_Dj$r\e(B @file{~/.riece/init.el} \e$B$K2C$($k$3$H$G!"\e(B"\e$B$[$2\e(B" 
+\e$B$d\e(B "\e$B$U$,\e(B" \e$B$KH?1~$7$F8z2L2;\e(B(\e$B$3$NNc$G$O!"%+%C%3!<$NLD$-@<\e(B)\e$B$rLD$i$9$3$H$,$G\e(B
+\e$B$-$^$9!#\e(B
+
+@example
+(load-default-sounds)
+(setq riece-keywords '("\e$B$[$2\e(B" "\e$B$U$,\e(B"))
+(add-hook 'riece-keyword-notify-functions
+          (lambda (keyword message) (play-sound 'cuckoo)))
+@end example
+
+Emacs \e$B$N>l9g$O\e(B,\e$B0J2<$N@_Dj$r\e(B @file{~/.riece/init.el} \e$B$K2C$($k$3$H$G\e(B,
+"\e$B$[$2\e(B" \e$B$d\e(B "\e$B$U$,\e(B" \e$B$KH?1~$7$F2;$rLD$i$9$3$H$,$G$-$^$9!#\e(B
+
+@example
+(defun cuckoo ()
+  "play cuckoo.au"
+  (call-process "play" nil 0 t
+                ".../cuckoo.au"))
+  (setq riece-keywords '("\e$B$[$2\e(B" "\e$B$U$,\e(B"))
+  (add-hook 'riece-keyword-notify-functions
+            (lambda (keyword message) (cuckoo)))
+@end example
+
+\e$B8z2L2;$G$O$J$/%7%s%W%k$K%S!<%W2;$rLD$i$7$?$$>l9g$O!"0J2<$N@_Dj$r\e(B 
+@file{~/.riece/init.el} \e$B$K2C$($^$9!#\e(B
+
+@example
+(setq riece-keywords '("\e$B$[$2\e(B" "\e$B$U$,\e(B"))
+(add-hook 'riece-keyword-notify-functions
+          (lambda (keyword message) (ding)))
+@end example
+
+@section SKK \e$B$r;H$C$F$$$F!"JQ49%b!<%I$N0u\e(B (\e$B"&\e(B) \e$B$rAw?.$7$?$/$J$$\e(B
+
+\e$B0J2<$N9T$r\e(B @file{~/.riece/init.el} \e$B$KDI2C$7$^$9!'\e(B
+
+@example
+(add-to-list 'riece-addons 'riece-skk-kakutei)
+@end example
+
+@section \e$B%A%c%s%M%k$NHV9f$r8GDj$7$?$$\e(B
+
+\e$B0J2<$N9T$r\e(B @file{~/.riece/init.el} \e$B$KDI2C$7$^$9!'\e(B
+
+@example
+(setq riece-default-channel-binding
+     '("#Liece" "#emacsen" nil "#debianjp"))
+@end example
+
+1: #Liece, 2: #emacsen, 4: #debianjp \e$B$N$h$&$K3dEv$F$i$l$^$9!#\e(Bnil \e$B$O%G%U%)\e(B
+\e$B%k%H$G$O<+F03dEv$F$NBP>]$K$J$i$J$$$3$H0UL#$7!"?7$?$J%A%c%s%M%k$K;22C$7$?\e(B
+\e$B>l9g!"$=$N%A%c%s%M%k$,\e(B 3 \e$BHVL\$N%A%c%s%M%k$H$7$F07$o$l$^$9!#\e(B
+
+@section \e$B5/F0;~$K%Q%9%o!<%I$D$-$N%A%c%s%M%k$K;22C$7$?$$\e(B
+
+\e$B0J2<$N9T$r\e(B @file{~/.riece/init.el} \e$B$KDI2C$7$^$9!'\e(B
+
+@example
+(setq riece-startup-channel-list
+     '(("#secret" "password") "#Liece"))
+@end example
+
+\e$BJ#?t$N%5!<%P>e$N%A%c%s%M%k$K;22C$9$k$K$O!"\e(B
+@code{riece-startup-server-list} \e$B$bJ;$;$F@_Dj$9$kI,MW$,$"$j$^$9!#\e(B
+
+\e$BNc$H$7$F!"\e(B@code{riece-server} \e$B$H\e(B @code{riece-server-alist} \e$B$r0J2<$N$h$&\e(B
+\e$B$K@_Dj$7$?$H$7$^$9!#\e(B
+
+@example
+(setq riece-server "ircnet"
+      riece-server-alist '(("ircnet" :host "irc6.nara.wide.ad.jp")
+                           ("freenode" :host "irc.ipv6.freenode.net")))
+@end example
+
+\e$B$3$N>l9g!"%G%U%)%k%H$G$O\e(B "ircnet" \e$B$@$1$K@\B3$7$^$9$,!"\e(B
+@code{riece-startup-server-list} \e$B$r0J2<$N$h$&$K@_Dj$9$k$3$H$G!"\e(B
+"freenode" \e$B$K$b@\B3$9$k$h$&$K$J$j$^$9!#\e(B
+
+@example
+(setq riece-startup-server-list '("freenode"))
+@end example
+
+@section HTTP \e$B%W%m%-%71[$7$K\e(B IRC \e$B%5!<%P$K@\B3$7$?$$\e(B
+relay.el \e$B$H\e(B connect.c \e$B$r;H$&$H!"\e(B
+HTTP \e$B%W%m%-%7$r2p$7$F\e(B IRC \e$B%5!<%P$K@\B3$9$k$3$H$,$G$-$^$9!#\e(B
+
+@table
+@item relay.el
+@uref{http://www.imasy.or.jp/~gotoh/lisp/relay.el}
+
+@item connect.c
+@uref{http://www.imasy.or.jp/~gotoh/ssh/connect.html}
+@end table
+
+\e$B$?$H$($P!"\e(B"proxy.example.com:8080" \e$B7PM3$G\e(B irc.tokyo.wide.ad.jp \e$B$K@\B3$9\e(B
+\e$B$k>l9g$K$O!"0J2<$N9T$r\e(B @file{~/.riece/init.el} \e$B$KDI2C$7$^$9!'\e(B
+
+@example
+(require 'relay)
+(setq relay-command-alist (cons '("^irc\.tokyo\.wide\.ad\.jp$"
+                                  "connect" "-H" "proxy.example.com:8080"
+                                  host service)
+                                relay-command-alist)
+      riece-server-alist (cons '("proxy-tokyo" :host "irc.tokyo.wide.ad.jp"
+                                 :function relay-open-network-stream)
+                               riece-server-alist))
+@end example
+
+@section IRC \e$B%m%0$r%U%!%$%k$KJ]B8$7$?$$\e(B
+
+\e$B0J2<$N9T$r\e(B @file{~/.riece/init.el} \e$B$KDI2C$7$^$9!'\e(B
+
+@example
+(add-to-list 'riece-addons 'riece-log)
+@end example
+
+\e$B%m%0%U%!%$%k$O%G%U%)%k%H$G$O\e(B @file{~/.riece/log} \e$B$N2<$K%5!<%PL>!"%A%c%s\e(B
+\e$B%M%kL>$N%G%#%l%/%j$,:n@.$5$l!"$=$NCf$KF|$K$AKh$KJ]B8$5$l$^$9!#$?$@$7%G%U%)\e(B
+\e$B%k%H$N%5!<%P$N>l9g$O!"%5!<%PL>$N%G%#%l%/%H%j$O>JN,$5$l$^$9!#\e(B
+
+US-ASCII \e$B0J30$N%G%#%l%/%H%jL>$,J8;z2=$1$9$k$H$$$&?M$O!"\e(B
+@code{file-name-coding-system} \e$B$NCM$rE,@Z$K@_Dj$9$k$+!"$"$k$$$O\e(B 
+@code{riece-log-directory-map} \e$B$G%A%c%s%M%kL>$HJ]B8@h$N%G%#%l%/%H%jL>$H\e(B
+\e$B$NBP1~%j%9%H$r0J2<$NNc$N$h$&$K!"\e(BUS-ASCII \e$B$N$_$r;HMQ$7$?%G%#%l%/%H%jL>$K\e(B
+\e$B$J$k$h$&$K@_Dj$9$k;v$G2sHr=PMh$^$9!'\e(B
+
+@example
+(setq riece-log-directory-map '(("#\e$B$j!<$9\e(B" . "riece")))
+@end example
+
+@node Development, Index, Tips, Top
 @chapter Development
 
 \e$B3+H/<TJg=8Cf!#\e(B
@@ -905,15 +1078,19 @@ 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$B=i4|2==hM}$r9T$$$^$9\e(B
 @end table
 
+\e$B$^$?!"%"%I%*%s$N@bL@$r!"JQ?t\e(B @samp{<\e$B%b%8%e!<%kL>\e(B>-description} \e$B$K@_Dj$9\e(B
+\e$B$k$3$H$b$G$-$^$9!#$3$NJ8;zNs$O\e(B @kbd{M-x riece-command-list-addons} \e$B$K$h\e(B
+\e$B$k%"%I%*%s$N0lMwI=<($K;H$o$l$^$9!#\e(B
+
 \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(\e$B%*%W%7%g%s\e(B)
+\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(\e$B%*%W%7%g%s\e(B)
+\e$B%"%I%*%s$rL58z$K$7$^$9\e(B
 @end table
 
 Riece \e$BB&$G$O0J2<$N=hM}$r9T$$$^$9!#\e(B