diff options
Diffstat (limited to 'doc/weechat_doc_en.texi')
-rw-r--r-- | doc/weechat_doc_en.texi | 243 |
1 files changed, 131 insertions, 112 deletions
diff --git a/doc/weechat_doc_en.texi b/doc/weechat_doc_en.texi index 862adccb9..f9eb6ef8a 100644 --- a/doc/weechat_doc_en.texi +++ b/doc/weechat_doc_en.texi @@ -35,7 +35,7 @@ @title WeeChat - User guide @subtitle Fast, light and extensible IRC client -@subtitle Documentation for WeeChat v0.1.2 - May, 21 2005 +@subtitle Documentation for WeeChat v0.1.3 - July, 03 2005 @image{weechat_image} @@ -84,27 +84,27 @@ version 2 or higher. @node Description, Pre-requisites, Introduction, Introduction @section Description -WeeChat (Wee Enhanced Environment for Chat) is a free IRC client, fast and light,
-designed for many operating systems.@*
+WeeChat (Wee Enhanced Environment for Chat) is a free IRC client, fast and light, +designed for many operating systems.@* @* -Main features are:
+Main features are: @itemize @minus -@item
-multi-servers connection
-@item
-many GUI (Graphical User Interface): Curses, Gtk and Qt
-@item
-small, fast and light
-@item
-customizable and extensible with scripts
-@item
-compliant with RFCs 1459, 2810, 2811, 2812, and 2813
-@item
-multi-platform (Gnu/Linux, *BSD, Windows and other)
-@item
+@item +multi-servers connection (with SSL, IPv6, proxy) +@item +many GUI: Curses, wxWidgets, Gtk and Qt +@item +small, fast and light +@item +customizable and extensible with scripts +@item +compliant with RFCs 1459, 2810, 2811, 2812, and 2813 +@item +multi-platform (Gnu/Linux, *BSD, MacOS X, Windows and other) +@item 100% GPL, free software -@end itemize
-
+@end itemize + @* WeeChat homepage is here:@* @uref{http://weechat.flashtux.org}@* @@ -116,20 +116,20 @@ In order to install WeeChat, you @b{need}:@* @itemize @bullet @item -A running Gnu/Linux system (with compiler tools for source package)
+A running Gnu/Linux system (with compiler tools for source package) @item "root" privileges (to install WeeChat) @item -According to GUI, one of the following libraries:
-@itemize @minus
-@item
-Curses: ncurses library,
-@item
-Gtk: *** GUI not developed ***,
-@item
-Qt: *** GUI not developed ***,
+According to GUI, one of the following libraries: +@itemize @minus +@item +Curses: ncurses library, +@item +Gtk: *** GUI not developed ***, +@item +Qt: *** GUI not developed ***, +@end itemize @end itemize -@end itemize
@c ******************************* Installation ******************************* @@ -139,31 +139,31 @@ Qt: *** GUI not developed ***, @menu * Binary package:: -* Source package::
+* Source package:: * CVS sources:: @end menu @node Binary package, Source package, Installation, Installation @section Binary package -Binary packages are available for these distributions:
-@itemize @bullet
-@item
-Debian (or any Debian compatible distribution)@*
-To install: @kbd{dpkg -i /path/weechat_x.y.z-1_i386.deb}
-@item
-Mandrake/Redhat (or any RPM compatible distribution)@*
-To install: @kbd{rpm -i /path/weechat-x.y.z-1.i386.rpm}
-@item
-Gentoo@*
-To install: @kbd{emerge weechat}
-@item
-*BSD (not available!)
-@item
-Slackware (not available!)
-@item
-Windows (not available!)
-@end itemize
+Binary packages are available for these distributions: +@itemize @bullet +@item +Debian (or any Debian compatible distribution)@* +To install: @kbd{dpkg -i /path/weechat_x.y.z-1_i386.deb} +@item +Mandriva/Redhat (or any RPM compatible distribution)@* +To install: @kbd{rpm -i /path/weechat-x.y.z-1.i386.rpm} +@item +Gentoo@* +To install: @kbd{emerge weechat} +@item +*BSD (not available!) +@item +Slackware (not available!) +@item +Windows (not available!) +@end itemize where x.y.z is the version (for example 0.0.1) @* @@ -176,27 +176,27 @@ All you have to do is to run in a console or a terminal:@* @kbd{make}@* Nota: to build only some interfaces, you can give parameters to ./configure, type @kbd{./configure --help} for help about options.@* -
-Then get root privileges and install WeeChat:@*
-@kbd{su}@*
-(enter root password)@*
-@kbd{make install}@*
-
+ +Then get root privileges and install WeeChat:@* +@kbd{su}@* +(enter root password)@* +@kbd{make install}@* + @node CVS sources, , Source package, Installation @section CVS sources
-
-Warning: CVS sources are for advanced users: it may not compile or not be stable.
-You're warned!@*
-
-To get CVS sources, issue these commands:@*
-@kbd{cvs -d:pserver:anoncvs@@subversions.gnu.org:/cvsroot/weechat login}@*
-@kbd{cvs -z3 -d:pserver:anoncvs@@subversions.gnu.org:/cvsroot/weechat co weechat}@*
-(when prompted for a password, just press Enter key)@*
+ +Warning: CVS sources are for advanced users: it may not compile or not be stable. +You're warned!@* + +To get CVS sources, issue these commands:@* +@kbd{cvs -d:pserver:anoncvs@@subversions.gnu.org:/cvsroot/weechat login}@* +@kbd{cvs -z3 -d:pserver:anoncvs@@subversions.gnu.org:/cvsroot/weechat co weechat}@* +(when prompted for a password, just press Enter key)@* Execute this script:@* @kbd{./autogen.sh}@* -
-Then follow instructions for source package - @xref{Source package}.
+ +Then follow instructions for source package - @xref{Source package}. @c ********************************** Usage *********************************** @@ -206,40 +206,45 @@ Then follow instructions for source package - @xref{Source package}. @menu * Run WeeChat:: -* Config file::
-* Key bindings::
+* Config file:: +* Key bindings:: * WeeChat commands:: * FIFO pipe:: @end menu @node Run WeeChat, Config file, Usage, Usage @section Run WeeChat -
-@subsection Command line parameters
-
+ +@subsection Command line parameters + @table @code @item -c, --config Display config file help (list of options)@* @item -h, --help Display help screen@* +@item -i, --irc-commands +Display IRC commands list@* @item -l, --license Display WeeChat license@* -@item -v, --version
+@item -v, --version Display WeeChat version@* -@end table
-
-@subsection Run WeeChat
-
-Just issue this command to run WeeChat:@*
+@item -w, --weechat-commands +Display WeeChat commands list@* +@end table + +@subsection Run WeeChat + +Just issue this command to run WeeChat:@* @kbd{weechat-curses} (for Curses front-end)@* +or @kbd{weechat-wxwidgets} (for wxWidgets front-end)@* or @kbd{weechat-gtk} (for Gtk front-end)@* -or @kbd{weechat-qt} (for Qt front-end)@*
-
-When you run WeeChat for the first time, a default configuration file is
-created, with default options.@*
-The default configuration file is: ~/.weechat/weechat.rc@*
-
-You can edit this file at your convenience to configure WeeChat, or you can
+or @kbd{weechat-qt} (for Qt front-end)@* + +When you run WeeChat for the first time, a default configuration file is +created, with default options.@* +The default configuration file is: ~/.weechat/weechat.rc@* + +You can edit this file at your convenience to configure WeeChat, or you can set parameters with @kbd{/set} command in WeeChat - @xref{WeeChat commands}. @node Config file, Key bindings, Run WeeChat, Usage @@ -248,7 +253,6 @@ set parameters with @kbd{/set} command in WeeChat - @xref{WeeChat commands}. List of options for config file:@* @table @kbd - @item look_set_title Set title for window (terminal for Curses GUI) with name & version@* Type: boolean (values: 'on' or 'off'), default value: 'on'@* @@ -488,7 +492,7 @@ Default message when away@* Type: string (any string), default value: 'away'@* @item irc_default_msg_part Default part message (leaving channel)@* -Type: string (any string), default value: ''@* +Type: string (any string), default value: 'WeeChat %v'@* @item irc_default_msg_quit Default quit message ('%v' will be replaced by WeeChat version in string)@* Type: string (any string), default value: 'WeeChat %v'@* @@ -537,12 +541,21 @@ Type: boolean (values: 'on' or 'off'), default value: 'on'@* @item proxy_use Use a proxy server to connect to irc server@* Type: boolean (values: 'on' or 'off'), default value: 'off'@* +@item proxy_type +Proxy type (http (default), socks4, socks5)@* +Type: string (values: 'http', 'socks4', 'socks5'), default value: 'http'@* +@item proxy_ipv6 +Connect to proxy in ipv6@* +Type: boolean (values: 'on' or 'off'), default value: 'off'@* @item proxy_address Proxy server address (IP or hostname)@* Type: string (any string), default value: ''@* @item proxy_port Port for connecting to proxy server@* -Type: integer (values: between 0 and 65535), default value: 1080@* +Type: integer (values: between 0 and 65535), default value: 3128@* +@item proxy_username +Username for proxy server@* +Type: string (any string), default value: ''@* @item proxy_password Password for proxy server@* Type: string (any string), default value: ''@* @@ -564,6 +577,12 @@ Type: string (any string), default value: ''@* @item server_port Port for connecting to server@* Type: integer (values: between 0 and 65535), default value: 6667@* +@item server_ipv6 +Use IPv6 protocol for server communication@* +Type: boolean (values: 'on' or 'off'), default value: 'off'@* +@item server_ssl +Use SSL for server communication@* +Type: boolean (values: 'on' or 'off'), default value: 'off'@* @item server_password Password for IRC server@* Type: string (any string), default value: ''@* @@ -594,7 +613,9 @@ Type: string (any string), default value: ''@* @item server_autorejoin Automatically rejoin channels when kicked@* Type: boolean (values: 'on' or 'off'), default value: 'on'@* - +@item server_notify_levels +Comma separated list of notify levels for channels of this server (format: #channel:1,..)@* +Type: string (any string), default value: ''@* @end table Colors for Curses GUI are:@* @@ -633,11 +654,11 @@ Colors for Curses GUI are:@* @node Key bindings, WeeChat commands, Config file, Usage @section Key bindings -
+ @table @kbd @item Left arrow / Right arrow Go to previous / next char in command line@* -@*
+@* @item Ctrl + left arrow / Ctrl + right arrow Go to previous / next word in command line@* @* @@ -647,28 +668,28 @@ Go to the beginning of command line@* @item End / Ctrl + E Go to the end of command line@* @* -@item Backspace / Delete
+@item Backspace / Delete Erase previous / next char of command line@* -@*
-@item Ctrl + Backspace / Ctrl + W
+@* +@item Ctrl + Backspace / Ctrl + W Erase previous word of command line@* -@*
-@item Tab
+@* +@item Tab Complete command or nick (@kbd{Tab} again: find next completion)@* -@*
-@item Any char
-Insert char to cursor position in the command line@*
-@*
-@item Enter
+@* +@item Any char +Insert char to cursor position in the command line@* +@* +@item Enter Execute command or send message@* -@*
-@item Up arrow / Down arrow
-Call again last commands/messages@*
-@*
-@item PageUp / PageDown
+@* +@item Up arrow / Down arrow +Call again last commands/messages@* +@* +@item PageUp / PageDown Show buffer history@* @*
-@item F5 / F6
+@item F5 / F6 Switch to previous / next buffer@* @* @item F7 / F8 @@ -682,8 +703,8 @@ Scroll nicklist@* @* @item Ctrl + L Redraw whole window@* -@*
-@item Alt + left arrow / Alt + right arrow
+@* +@item Alt + left arrow / Alt + right arrow Same as F5 / F6@* @* @item Alt + A @@ -715,7 +736,6 @@ Scroll nicklist@* WeeChat internal commands:@* @table @kbd - @item alias [alias_name [command [arguments]] @* create an alias for a command@* @@ -779,13 +799,15 @@ list/load/unload Python scripts@* filename: Python script (file) to load@* Without argument, /python command lists all loaded Python scripts.@* @* -@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] @* list, add or remove servers@* @* servername: server name, for internal & display use@* hostname: name or IP address of server@* port: port for server (integer)@* +ipv6: use IPv6 protocol@* +ssl: use SSL protocol@* password: password for server@* nick1: first nick for server@* nick2: alternate nick for server@* @@ -821,13 +843,11 @@ splith: split current window horizontally@* splitv: split current window vertically@* merge: merge window with another@* @* - @end table IRC commands:@* @table @kbd - @item admin [target] @* find information about the administrator of the server@* @@ -1194,7 +1214,6 @@ nickname: nickname to search@* count: number of replies to return (full search if negative number)@* target: reply should match this mask@* @* - @end table @node FIFO pipe, , WeeChat commands, Usage @@ -1660,7 +1679,7 @@ Look for WeeChat support page for detail:@* @node Copyright, , Get support, Authors / Support @section Copyright -This manual documents WeeChat IRC client, it is part of WeeChat.@*
+This manual documents WeeChat IRC client, it is part of WeeChat.@* Copyright @copyright{} 2005 FlashCode <@email{flashcode@@flashtux.org, flashcode AT flashtux.org}>@* |