35 |
|
|
36 |
@title WeeChat - User guide |
@title WeeChat - User guide |
37 |
@subtitle Fast, light and extensible IRC client |
@subtitle Fast, light and extensible IRC client |
38 |
@subtitle Documentation for WeeChat v0.1.2 - May, 21 2005 |
@subtitle Documentation for WeeChat v0.1.3 - July, 03 2005 |
39 |
|
|
40 |
@image{weechat_image} |
@image{weechat_image} |
41 |
|
|
84 |
@node Description, Pre-requisites, Introduction, Introduction |
@node Description, Pre-requisites, Introduction, Introduction |
85 |
@section Description |
@section Description |
86 |
|
|
87 |
WeeChat (Wee Enhanced Environment for Chat) is a free IRC client, fast and light, |
WeeChat (Wee Enhanced Environment for Chat) is a free IRC client, fast and light, |
88 |
designed for many operating systems.@* |
designed for many operating systems.@* |
89 |
@* |
@* |
90 |
Main features are: |
Main features are: |
91 |
@itemize @minus |
@itemize @minus |
92 |
@item |
@item |
93 |
multi-servers connection |
multi-servers connection (with SSL, IPv6, proxy) |
94 |
@item |
@item |
95 |
many GUI (Graphical User Interface): Curses, Gtk and Qt |
many GUI: Curses, wxWidgets, Gtk and Qt |
96 |
@item |
@item |
97 |
small, fast and light |
small, fast and light |
98 |
@item |
@item |
99 |
customizable and extensible with scripts |
customizable and extensible with scripts |
100 |
@item |
@item |
101 |
compliant with RFCs 1459, 2810, 2811, 2812, and 2813 |
compliant with RFCs 1459, 2810, 2811, 2812, and 2813 |
102 |
@item |
@item |
103 |
multi-platform (Gnu/Linux, *BSD, Windows and other) |
multi-platform (Gnu/Linux, *BSD, MacOS X, Windows and other) |
104 |
@item |
@item |
105 |
100% GPL, free software |
100% GPL, free software |
106 |
@end itemize |
@end itemize |
107 |
|
|
108 |
@* |
@* |
109 |
WeeChat homepage is here:@* |
WeeChat homepage is here:@* |
110 |
@uref{http://weechat.flashtux.org}@* |
@uref{http://weechat.flashtux.org}@* |
116 |
|
|
117 |
@itemize @bullet |
@itemize @bullet |
118 |
@item |
@item |
119 |
A running Gnu/Linux system (with compiler tools for source package) |
A running Gnu/Linux system (with compiler tools for source package) |
120 |
@item |
@item |
121 |
"root" privileges (to install WeeChat) |
"root" privileges (to install WeeChat) |
122 |
@item |
@item |
123 |
According to GUI, one of the following libraries: |
According to GUI, one of the following libraries: |
124 |
@itemize @minus |
@itemize @minus |
125 |
@item |
@item |
126 |
Curses: ncurses library, |
Curses: ncurses library, |
127 |
@item |
@item |
128 |
Gtk: *** GUI not developed ***, |
Gtk: *** GUI not developed ***, |
129 |
@item |
@item |
130 |
Qt: *** GUI not developed ***, |
Qt: *** GUI not developed ***, |
131 |
|
@end itemize |
132 |
@end itemize |
@end itemize |
|
@end itemize |
|
133 |
|
|
134 |
|
|
135 |
@c ******************************* Installation ******************************* |
@c ******************************* Installation ******************************* |
139 |
|
|
140 |
@menu |
@menu |
141 |
* Binary package:: |
* Binary package:: |
142 |
* Source package:: |
* Source package:: |
143 |
* CVS sources:: |
* CVS sources:: |
144 |
@end menu |
@end menu |
145 |
|
|
146 |
@node Binary package, Source package, Installation, Installation |
@node Binary package, Source package, Installation, Installation |
147 |
@section Binary package |
@section Binary package |
148 |
|
|
149 |
Binary packages are available for these distributions: |
Binary packages are available for these distributions: |
150 |
@itemize @bullet |
@itemize @bullet |
151 |
@item |
@item |
152 |
Debian (or any Debian compatible distribution)@* |
Debian (or any Debian compatible distribution)@* |
153 |
To install: @kbd{dpkg -i /path/weechat_x.y.z-1_i386.deb} |
To install: @kbd{dpkg -i /path/weechat_x.y.z-1_i386.deb} |
154 |
@item |
@item |
155 |
Mandrake/Redhat (or any RPM compatible distribution)@* |
Mandriva/Redhat (or any RPM compatible distribution)@* |
156 |
To install: @kbd{rpm -i /path/weechat-x.y.z-1.i386.rpm} |
To install: @kbd{rpm -i /path/weechat-x.y.z-1.i386.rpm} |
157 |
@item |
@item |
158 |
Gentoo@* |
Gentoo@* |
159 |
To install: @kbd{emerge weechat} |
To install: @kbd{emerge weechat} |
160 |
@item |
@item |
161 |
*BSD (not available!) |
*BSD (not available!) |
162 |
@item |
@item |
163 |
Slackware (not available!) |
Slackware (not available!) |
164 |
@item |
@item |
165 |
Windows (not available!) |
Windows (not available!) |
166 |
@end itemize |
@end itemize |
167 |
|
|
168 |
where x.y.z is the version (for example 0.0.1) |
where x.y.z is the version (for example 0.0.1) |
169 |
@* |
@* |
176 |
@kbd{make}@* |
@kbd{make}@* |
177 |
Nota: to build only some interfaces, you can give parameters |
Nota: to build only some interfaces, you can give parameters |
178 |
to ./configure, type @kbd{./configure --help} for help about options.@* |
to ./configure, type @kbd{./configure --help} for help about options.@* |
179 |
|
|
180 |
Then get root privileges and install WeeChat:@* |
Then get root privileges and install WeeChat:@* |
181 |
@kbd{su}@* |
@kbd{su}@* |
182 |
(enter root password)@* |
(enter root password)@* |
183 |
@kbd{make install}@* |
@kbd{make install}@* |
184 |
|
|
185 |
@node CVS sources, , Source package, Installation |
@node CVS sources, , Source package, Installation |
186 |
@section CVS sources |
@section CVS sources |
187 |
|
|
188 |
Warning: CVS sources are for advanced users: it may not compile or not be stable. |
Warning: CVS sources are for advanced users: it may not compile or not be stable. |
189 |
You're warned!@* |
You're warned!@* |
190 |
|
|
191 |
To get CVS sources, issue these commands:@* |
To get CVS sources, issue these commands:@* |
192 |
@kbd{cvs -d:pserver:anoncvs@@subversions.gnu.org:/cvsroot/weechat login}@* |
@kbd{cvs -d:pserver:anoncvs@@subversions.gnu.org:/cvsroot/weechat login}@* |
193 |
@kbd{cvs -z3 -d:pserver:anoncvs@@subversions.gnu.org:/cvsroot/weechat co weechat}@* |
@kbd{cvs -z3 -d:pserver:anoncvs@@subversions.gnu.org:/cvsroot/weechat co weechat}@* |
194 |
(when prompted for a password, just press Enter key)@* |
(when prompted for a password, just press Enter key)@* |
195 |
|
|
196 |
Execute this script:@* |
Execute this script:@* |
197 |
@kbd{./autogen.sh}@* |
@kbd{./autogen.sh}@* |
198 |
|
|
199 |
Then follow instructions for source package - @xref{Source package}. |
Then follow instructions for source package - @xref{Source package}. |
200 |
|
|
201 |
|
|
202 |
@c ********************************** Usage *********************************** |
@c ********************************** Usage *********************************** |
206 |
|
|
207 |
@menu |
@menu |
208 |
* Run WeeChat:: |
* Run WeeChat:: |
209 |
* Config file:: |
* Config file:: |
210 |
* Key bindings:: |
* Key bindings:: |
211 |
* WeeChat commands:: |
* WeeChat commands:: |
212 |
* FIFO pipe:: |
* FIFO pipe:: |
213 |
@end menu |
@end menu |
214 |
|
|
215 |
@node Run WeeChat, Config file, Usage, Usage |
@node Run WeeChat, Config file, Usage, Usage |
216 |
@section Run WeeChat |
@section Run WeeChat |
217 |
|
|
218 |
@subsection Command line parameters |
@subsection Command line parameters |
219 |
|
|
220 |
@table @code |
@table @code |
221 |
@item -c, --config |
@item -c, --config |
222 |
Display config file help (list of options)@* |
Display config file help (list of options)@* |
223 |
@item -h, --help |
@item -h, --help |
224 |
Display help screen@* |
Display help screen@* |
225 |
|
@item -i, --irc-commands |
226 |
|
Display IRC commands list@* |
227 |
@item -l, --license |
@item -l, --license |
228 |
Display WeeChat license@* |
Display WeeChat license@* |
229 |
@item -v, --version |
@item -v, --version |
230 |
Display WeeChat version@* |
Display WeeChat version@* |
231 |
@end table |
@item -w, --weechat-commands |
232 |
|
Display WeeChat commands list@* |
233 |
@subsection Run WeeChat |
@end table |
234 |
|
|
235 |
Just issue this command to run WeeChat:@* |
@subsection Run WeeChat |
236 |
|
|
237 |
|
Just issue this command to run WeeChat:@* |
238 |
@kbd{weechat-curses} (for Curses front-end)@* |
@kbd{weechat-curses} (for Curses front-end)@* |
239 |
|
or @kbd{weechat-wxwidgets} (for wxWidgets front-end)@* |
240 |
or @kbd{weechat-gtk} (for Gtk front-end)@* |
or @kbd{weechat-gtk} (for Gtk front-end)@* |
241 |
or @kbd{weechat-qt} (for Qt front-end)@* |
or @kbd{weechat-qt} (for Qt front-end)@* |
242 |
|
|
243 |
When you run WeeChat for the first time, a default configuration file is |
When you run WeeChat for the first time, a default configuration file is |
244 |
created, with default options.@* |
created, with default options.@* |
245 |
The default configuration file is: ~/.weechat/weechat.rc@* |
The default configuration file is: ~/.weechat/weechat.rc@* |
246 |
|
|
247 |
You can edit this file at your convenience to configure WeeChat, or you can |
You can edit this file at your convenience to configure WeeChat, or you can |
248 |
set parameters with @kbd{/set} command in WeeChat - @xref{WeeChat commands}. |
set parameters with @kbd{/set} command in WeeChat - @xref{WeeChat commands}. |
249 |
|
|
250 |
@node Config file, Key bindings, Run WeeChat, Usage |
@node Config file, Key bindings, Run WeeChat, Usage |
253 |
List of options for config file:@* |
List of options for config file:@* |
254 |
|
|
255 |
@table @kbd |
@table @kbd |
|
|
|
256 |
@item look_set_title |
@item look_set_title |
257 |
Set title for window (terminal for Curses GUI) with name & version@* |
Set title for window (terminal for Curses GUI) with name & version@* |
258 |
Type: boolean (values: 'on' or 'off'), default value: 'on'@* |
Type: boolean (values: 'on' or 'off'), default value: 'on'@* |
492 |
Type: string (any string), default value: 'away'@* |
Type: string (any string), default value: 'away'@* |
493 |
@item irc_default_msg_part |
@item irc_default_msg_part |
494 |
Default part message (leaving channel)@* |
Default part message (leaving channel)@* |
495 |
Type: string (any string), default value: ''@* |
Type: string (any string), default value: 'WeeChat %v'@* |
496 |
@item irc_default_msg_quit |
@item irc_default_msg_quit |
497 |
Default quit message ('%v' will be replaced by WeeChat version in string)@* |
Default quit message ('%v' will be replaced by WeeChat version in string)@* |
498 |
Type: string (any string), default value: 'WeeChat %v'@* |
Type: string (any string), default value: 'WeeChat %v'@* |
541 |
@item proxy_use |
@item proxy_use |
542 |
Use a proxy server to connect to irc server@* |
Use a proxy server to connect to irc server@* |
543 |
Type: boolean (values: 'on' or 'off'), default value: 'off'@* |
Type: boolean (values: 'on' or 'off'), default value: 'off'@* |
544 |
|
@item proxy_type |
545 |
|
Proxy type (http (default), socks4, socks5)@* |
546 |
|
Type: string (values: 'http', 'socks4', 'socks5'), default value: 'http'@* |
547 |
|
@item proxy_ipv6 |
548 |
|
Connect to proxy in ipv6@* |
549 |
|
Type: boolean (values: 'on' or 'off'), default value: 'off'@* |
550 |
@item proxy_address |
@item proxy_address |
551 |
Proxy server address (IP or hostname)@* |
Proxy server address (IP or hostname)@* |
552 |
Type: string (any string), default value: ''@* |
Type: string (any string), default value: ''@* |
553 |
@item proxy_port |
@item proxy_port |
554 |
Port for connecting to proxy server@* |
Port for connecting to proxy server@* |
555 |
Type: integer (values: between 0 and 65535), default value: 1080@* |
Type: integer (values: between 0 and 65535), default value: 3128@* |
556 |
|
@item proxy_username |
557 |
|
Username for proxy server@* |
558 |
|
Type: string (any string), default value: ''@* |
559 |
@item proxy_password |
@item proxy_password |
560 |
Password for proxy server@* |
Password for proxy server@* |
561 |
Type: string (any string), default value: ''@* |
Type: string (any string), default value: ''@* |
577 |
@item server_port |
@item server_port |
578 |
Port for connecting to server@* |
Port for connecting to server@* |
579 |
Type: integer (values: between 0 and 65535), default value: 6667@* |
Type: integer (values: between 0 and 65535), default value: 6667@* |
580 |
|
@item server_ipv6 |
581 |
|
Use IPv6 protocol for server communication@* |
582 |
|
Type: boolean (values: 'on' or 'off'), default value: 'off'@* |
583 |
|
@item server_ssl |
584 |
|
Use SSL for server communication@* |
585 |
|
Type: boolean (values: 'on' or 'off'), default value: 'off'@* |
586 |
@item server_password |
@item server_password |
587 |
Password for IRC server@* |
Password for IRC server@* |
588 |
Type: string (any string), default value: ''@* |
Type: string (any string), default value: ''@* |
613 |
@item server_autorejoin |
@item server_autorejoin |
614 |
Automatically rejoin channels when kicked@* |
Automatically rejoin channels when kicked@* |
615 |
Type: boolean (values: 'on' or 'off'), default value: 'on'@* |
Type: boolean (values: 'on' or 'off'), default value: 'on'@* |
616 |
|
@item server_notify_levels |
617 |
|
Comma separated list of notify levels for channels of this server (format: #channel:1,..)@* |
618 |
|
Type: string (any string), default value: ''@* |
619 |
@end table |
@end table |
620 |
|
|
621 |
Colors for Curses GUI are:@* |
Colors for Curses GUI are:@* |
654 |
|
|
655 |
@node Key bindings, WeeChat commands, Config file, Usage |
@node Key bindings, WeeChat commands, Config file, Usage |
656 |
@section Key bindings |
@section Key bindings |
657 |
|
|
658 |
@table @kbd |
@table @kbd |
659 |
@item Left arrow / Right arrow |
@item Left arrow / Right arrow |
660 |
Go to previous / next char in command line@* |
Go to previous / next char in command line@* |
661 |
@* |
@* |
662 |
@item Ctrl + left arrow / Ctrl + right arrow |
@item Ctrl + left arrow / Ctrl + right arrow |
663 |
Go to previous / next word in command line@* |
Go to previous / next word in command line@* |
664 |
@* |
@* |
668 |
@item End / Ctrl + E |
@item End / Ctrl + E |
669 |
Go to the end of command line@* |
Go to the end of command line@* |
670 |
@* |
@* |
671 |
@item Backspace / Delete |
@item Backspace / Delete |
672 |
Erase previous / next char of command line@* |
Erase previous / next char of command line@* |
673 |
@* |
@* |
674 |
@item Ctrl + Backspace / Ctrl + W |
@item Ctrl + Backspace / Ctrl + W |
675 |
Erase previous word of command line@* |
Erase previous word of command line@* |
676 |
@* |
@* |
677 |
@item Tab |
@item Tab |
678 |
Complete command or nick (@kbd{Tab} again: find next completion)@* |
Complete command or nick (@kbd{Tab} again: find next completion)@* |
679 |
@* |
@* |
680 |
@item Any char |
@item Any char |
681 |
Insert char to cursor position in the command line@* |
Insert char to cursor position in the command line@* |
682 |
@* |
@* |
683 |
@item Enter |
@item Enter |
684 |
Execute command or send message@* |
Execute command or send message@* |
685 |
@* |
@* |
686 |
@item Up arrow / Down arrow |
@item Up arrow / Down arrow |
687 |
Call again last commands/messages@* |
Call again last commands/messages@* |
688 |
@* |
@* |
689 |
@item PageUp / PageDown |
@item PageUp / PageDown |
690 |
Show buffer history@* |
Show buffer history@* |
691 |
@* |
@* |
692 |
@item F5 / F6 |
@item F5 / F6 |
693 |
Switch to previous / next buffer@* |
Switch to previous / next buffer@* |
694 |
@* |
@* |
695 |
@item F7 / F8 |
@item F7 / F8 |
703 |
@* |
@* |
704 |
@item Ctrl + L |
@item Ctrl + L |
705 |
Redraw whole window@* |
Redraw whole window@* |
706 |
@* |
@* |
707 |
@item Alt + left arrow / Alt + right arrow |
@item Alt + left arrow / Alt + right arrow |
708 |
Same as F5 / F6@* |
Same as F5 / F6@* |
709 |
@* |
@* |
710 |
@item Alt + A |
@item Alt + A |
736 |
WeeChat internal commands:@* |
WeeChat internal commands:@* |
737 |
|
|
738 |
@table @kbd |
@table @kbd |
|
|
|
739 |
@item alias [alias_name [command [arguments]] |
@item alias [alias_name [command [arguments]] |
740 |
@* |
@* |
741 |
create an alias for a command@* |
create an alias for a command@* |
799 |
filename: Python script (file) to load@* |
filename: Python script (file) to load@* |
800 |
Without argument, /python command lists all loaded Python scripts.@* |
Without argument, /python command lists all loaded Python scripts.@* |
801 |
@* |
@* |
802 |
@item server [servername] | [servername hostname port [-auto | -noauto] [-pwd password] [-nicks nick1 [nick2 [nick3]]] [-username username] [-realname realname] [-command command] [-autojoin channel[,channel]] ] | [del servername] |
@item server [servername] | [servername hostname port [-auto | -noauto] [-ipv6] [-ssl] [-pwd password] [-nicks nick1 [nick2 [nick3]]] [-username username] [-realname realname] [-command command] [-autojoin channel[,channel]] ] | [del servername] |
803 |
@* |
@* |
804 |
list, add or remove servers@* |
list, add or remove servers@* |
805 |
@* |
@* |
806 |
servername: server name, for internal & display use@* |
servername: server name, for internal & display use@* |
807 |
hostname: name or IP address of server@* |
hostname: name or IP address of server@* |
808 |
port: port for server (integer)@* |
port: port for server (integer)@* |
809 |
|
ipv6: use IPv6 protocol@* |
810 |
|
ssl: use SSL protocol@* |
811 |
password: password for server@* |
password: password for server@* |
812 |
nick1: first nick for server@* |
nick1: first nick for server@* |
813 |
nick2: alternate nick for server@* |
nick2: alternate nick for server@* |
843 |
splitv: split current window vertically@* |
splitv: split current window vertically@* |
844 |
merge: merge window with another@* |
merge: merge window with another@* |
845 |
@* |
@* |
|
|
|
846 |
@end table |
@end table |
847 |
|
|
848 |
IRC commands:@* |
IRC commands:@* |
849 |
|
|
850 |
@table @kbd |
@table @kbd |
|
|
|
851 |
@item admin [target] |
@item admin [target] |
852 |
@* |
@* |
853 |
find information about the administrator of the server@* |
find information about the administrator of the server@* |
1214 |
count: number of replies to return (full search if negative number)@* |
count: number of replies to return (full search if negative number)@* |
1215 |
target: reply should match this mask@* |
target: reply should match this mask@* |
1216 |
@* |
@* |
|
|
|
1217 |
@end table |
@end table |
1218 |
|
|
1219 |
@node FIFO pipe, , WeeChat commands, Usage |
@node FIFO pipe, , WeeChat commands, Usage |
1679 |
@node Copyright, , Get support, Authors / Support |
@node Copyright, , Get support, Authors / Support |
1680 |
@section Copyright |
@section Copyright |
1681 |
|
|
1682 |
This manual documents WeeChat IRC client, it is part of WeeChat.@* |
This manual documents WeeChat IRC client, it is part of WeeChat.@* |
1683 |
|
|
1684 |
Copyright @copyright{} 2005 FlashCode |
Copyright @copyright{} 2005 FlashCode |
1685 |
<@email{flashcode@@flashtux.org, flashcode AT flashtux.org}>@* |
<@email{flashcode@@flashtux.org, flashcode AT flashtux.org}>@* |