summaryrefslogtreecommitdiff
path: root/doc/en/user
diff options
context:
space:
mode:
Diffstat (limited to 'doc/en/user')
-rw-r--r--doc/en/user/plugin_alias.en.xml63
-rw-r--r--doc/en/user/plugin_aspell.en.xml50
-rw-r--r--doc/en/user/plugin_charset.en.xml118
-rw-r--r--doc/en/user/plugin_fifo.en.xml21
-rw-r--r--doc/en/user/plugin_irc.en.xml34
-rw-r--r--doc/en/user/plugin_logger.en.xml178
-rw-r--r--doc/en/user/plugin_scripts.en.xml57
-rw-r--r--doc/en/user/plugin_xfer.en.xml40
-rw-r--r--doc/en/user/plugins.en.xml141
-rw-r--r--doc/en/user/usage.en.xml48
-rw-r--r--doc/en/user/weechat_user.en.xml9
11 files changed, 656 insertions, 103 deletions
diff --git a/doc/en/user/plugin_alias.en.xml b/doc/en/user/plugin_alias.en.xml
new file mode 100644
index 000000000..0fcae6ed5
--- /dev/null
+++ b/doc/en/user/plugin_alias.en.xml
@@ -0,0 +1,63 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+
+WeeChat documentation (english version)
+
+Copyright (c) 2003-2008 by FlashCode <flashcode@flashtux.org>
+
+This manual is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 3 of the License, or
+(at your option) any later version.
+
+This manual is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+-->
+
+<section id="secPluginAlias">
+ <title>Alias plugin</title>
+
+ <para>
+ Alias plugin lets you create alias for commands (from WeeChat or other
+ plugins).
+ </para>
+
+ <section id="secAliasCommands">
+ <title>Commands</title>
+
+ <para>
+ &alias_commands.xml;
+ </para>
+
+ </section>
+
+ <section id="secAliasInfosHooked">
+ <title>Infos and infolists</title>
+
+ <para>
+ <informaltable colsep="0" frame="none">
+ <tgroup cols="3">
+ <thead>
+ <row>
+ <entry>Type</entry>
+ <entry>Name</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ &alias_infos.xml;
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+
+ </section>
+
+</section>
diff --git a/doc/en/user/plugin_aspell.en.xml b/doc/en/user/plugin_aspell.en.xml
new file mode 100644
index 000000000..c4037fcab
--- /dev/null
+++ b/doc/en/user/plugin_aspell.en.xml
@@ -0,0 +1,50 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+
+WeeChat documentation (english version)
+
+Copyright (c) 2003-2008 by FlashCode <flashcode@flashtux.org>
+
+This manual is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 3 of the License, or
+(at your option) any later version.
+
+This manual is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+-->
+
+<section id="secPluginAspell">
+ <title>Aspell plugin</title>
+
+ <para>
+ Aspell plugin lets you check spelling in command line.
+ It is possible to use many languages by buffer.
+ </para>
+
+ <section id="secAspellOptions">
+ <title>Options (file aspell.conf)</title>
+
+ <para>
+ &aspell_options.xml;
+ </para>
+
+ </section>
+
+ <section id="secAspellCommands">
+ <title>Commands</title>
+
+ <para>
+ &aspell_commands.xml;
+ </para>
+
+ </section>
+
+</section>
diff --git a/doc/en/user/plugin_charset.en.xml b/doc/en/user/plugin_charset.en.xml
index e83aa1ea2..9cddb50df 100644
--- a/doc/en/user/plugin_charset.en.xml
+++ b/doc/en/user/plugin_charset.en.xml
@@ -21,20 +21,20 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
-->
-<section id="secCharset">
+<section id="secPluginCharset">
<title>Charset plugin</title>
<para>
- Charset plugin lets you encode or decode data using charsets, with 3
- levels: global, by server, or by channel.
+ Charset plugin lets you decode or encode data using charsets.
+ There is default charset for decode/encode, and specific charsets
+ for buffers (or group of buffers).
This plugin is optional, but recommended: if it's not loaded, WeeChat
can only read/write UTF-8 data.
</para>
<para>
Charset plugin should be autoloaded by WeeChat at startup.
- To be sure plugin is loaded, try:
- "<literal>/charset</literal>".
+ To be sure plugin is loaded, try: <command>/charset</command>.
If command is not found, then load plugin with command:
<screen>/plugin load charset</screen>
If plugin is not found, then you should compile again WeeChat with
@@ -45,54 +45,80 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
When Charset plugin starts, it displays terminal and internal charsets.
Terminal charset depends on your locale, and internal is UTF-8.
For example :
-<screen>
--P- Charset plugin starting, terminal charset: ISO-8859-15 (WeeChat internal: UTF-8)
-</screen>
+ <screen>charset: terminal: ISO-8859-15, internal: UTF-8</screen>
</para>
- <section id="secCharsetSettings">
- <title>Settings</title>
+ <section id="secCharsetOptions">
+ <title>Options (file charset.conf)</title>
+
+ <para>
+ &charset_options.xml;
+ </para>
- <itemizedlist>
- <listitem>
- <para>
- To set global decode and encode charsets, use
- "<literal>/setp</literal>" command.
- For example:
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ To set global decode and encode charsets, use command
+ <command>/set</command>.
+ For example:
<screen>
-/setp charset.global.decode = ISO-8859-15
-/setp charset.global.encode = ISO-8859-15
+/set charset.default.decode = ISO-8859-15
+/set charset.default.encode = ISO-8859-15
</screen>
- If global decode charset is not set (for example during first
- load of Charset plugin), it will be automatically set to terminal
- charset (if it's different from UTF-8), or by default to
- "<literal>ISO-8859-1</literal>".
- Default encode value is empty, so it sends by default with
- internal charset (UTF-8).
- </para>
- </listitem>
- <listitem>
- <para>
- To set server charset, use "<literal>/charset</literal>" command
- on server buffer.
- If you give only charset, then it will set "decode" and "encode"
- values.
- For example:
- <screen>/charset ISO-8859-15</screen>
- It's equivalent to:
+ If global decode charset is not set (for example during first
+ load of Charset plugin), it will be automatically set to terminal
+ charset (if it's different from UTF-8), or by default to
+ "<literal>ISO-8859-1</literal>".
+ Default encode value is empty, so it sends by default with
+ internal charset (UTF-8).
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ To set IRC server charset, use command <command>/charset</command> on
+ server buffer.
+ If you give only charset, then it will set "decode" and "encode"
+ values.
+ For example:
+ <screen>/charset ISO-8859-15</screen>
+ It's equivalent to:
<screen>
/charset decode ISO-8859-15
/charset encode ISO-8859-15
</screen>
- </para>
- </listitem>
- <listitem>
- <para>
- To set channel (or private) charset, use same commands as server,
- but on channel (or private) buffer.
- </para>
- </listitem>
- </itemizedlist>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ To set IRC channel (or private) charset, use same commands as server,
+ but on channel (or private) buffer.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ To set charset for all IRC channels (and privates) of an IRC server,
+ use following command:
+ <screen>/set charset.decode.irc.freenode = ISO-8859-15</screen>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ To see all charsets used, use following command:
+ <screen>/set charset.*</screen>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+
+ </section>
+
+ <section id="secCharsetCommands">
+ <title>Commands</title>
+
+ <para>
+ &charset_commands.xml;
+ </para>
</section>
@@ -111,7 +137,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
</listitem>
<listitem>
<para>
- check charset line (on server buffer), you should see
+ check charset line (on WeeChat buffer), you should see
ISO-XXXXXX or UTF-8 for terminal charset. If you see
ANSI_X3.4-1968 or other values, probably your locale is wrong.
</para>
@@ -119,7 +145,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
<listitem>
<para>
setup global decode value, for example:
- <screen>/setp charset.global.decode = ISO-8859-15</screen>
+ <screen>/set charset.default.decode = ISO-8859-15</screen>
</para>
</listitem>
</itemizedlist>
diff --git a/doc/en/user/plugin_fifo.en.xml b/doc/en/user/plugin_fifo.en.xml
index 0b181b999..528041084 100644
--- a/doc/en/user/plugin_fifo.en.xml
+++ b/doc/en/user/plugin_fifo.en.xml
@@ -38,8 +38,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
<para>
Syntax for the FIFO pipe commands/text is one of following:
<screen>
- category,name *text or command here
- name *text or command here
+ plugin.buffer *text or command here
*text or command here
</screen>
</para>
@@ -49,19 +48,19 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
<itemizedlist>
<listitem>
<para>
- nick change on freenode to "mynick|out" :
- <screen><prompt>$ </prompt><userinput>echo 'freenode,freenode */nick mynick|out' &gt;~/.weechat/weechat_fifo_12345</userinput></screen>
+ nick change on IRC server freenode to "newnick" :
+ <screen><prompt>$ </prompt><userinput>echo 'irc.server.freenode */nick newnick' &gt;~/.weechat/weechat_fifo_12345</userinput></screen>
</para>
</listitem>
<listitem>
<para>
- display text on #weechat channel:
- <screen><prompt>$ </prompt><userinput>echo 'freenode,#weechat *hello everybody!' >~/.weechat/weechat_fifo_12345</userinput></screen>
+ display text on IRC #weechat channel:
+ <screen><prompt>$ </prompt><userinput>echo 'irc.freenode.#weechat *hello everybody!' >~/.weechat/weechat_fifo_12345</userinput></screen>
</para>
</listitem>
<listitem>
<para>
- display text on current channel (buffer displayed by WeeChat):
+ display text on current buffer:
<screen><prompt>$ </prompt><userinput>echo '*hello!' >~/.weechat/weechat_fifo_12345</userinput></screen>
<emphasis>Warning:</emphasis> this is dangerous and you should
not do that except if you know what you do!
@@ -69,9 +68,9 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
</listitem>
<listitem>
<para>
- send two commands to unload/reload Perl scripts (you have to
- separate them with "\n"):
- <screen><prompt>$ </prompt><userinput>echo -e " weechat,weechat */perl unload\nweechat,weechat */perl autoload" >~/.weechat/weechat_fifo_12345</userinput></screen>
+ send two commands to unload/reload Perl scripts (you have to separate
+ them with "\n"):
+ <screen><prompt>$ </prompt><userinput>echo -e '*/perl unload\n*/perl autoload' >~/.weechat/weechat_fifo_12345</userinput></screen>
</para>
</listitem>
</itemizedlist>
@@ -90,7 +89,7 @@ if [ $# -eq 1 ]; then
fi
</screen>
If the script is called "auto_weechat_command", you can run it with:
-<screen><prompt>$ </prompt><userinput>./auto_weechat_command "freenode,#weechat *hello"</userinput></screen>
+<screen><prompt>$ </prompt><userinput>./auto_weechat_command 'irc.freenode.#weechat *hello'</userinput></screen>
</para>
</section>
diff --git a/doc/en/user/plugin_irc.en.xml b/doc/en/user/plugin_irc.en.xml
index 266a59ce5..ec94b36df 100644
--- a/doc/en/user/plugin_irc.en.xml
+++ b/doc/en/user/plugin_irc.en.xml
@@ -24,11 +24,14 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
<section id="secPluginIrc">
<title>IRC plugin</title>
- The IRC plugin is designed to chat thru IRC protocols with other people.
- It is multi-servers, and offers all expected IRC commands including DCC chat and
- file transfer (via xfer plugin, see <xref linkend="secPluginXfer" />).
+ <para>
+ The IRC plugin is designed to chat thru IRC protocols with other people.
+ It is multi-servers, and offers all supported IRC commands including DCC
+ chat and file transfer (via xfer plugin, see
+ <xref linkend="secPluginXfer" />).
+ </para>
- <section id="ircCommandLineOptions">
+ <section id="secIrcCommandLineOptions">
<title>Command line options</title>
<para>
@@ -43,8 +46,8 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
</section>
- <section id="ircOptions">
- <title>Configuration options</title>
+ <section id="secIrcOptions">
+ <title>Options (file irc.conf)</title>
<para>
&irc_options.xml;
@@ -52,7 +55,22 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
</section>
- <section id="ircInfosHooked">
+ <section id="secIrcCommands">
+ <title>Commands</title>
+
+ <para>
+ Almost all commands must be executed on a server or channel buffer.
+ Exceptions are: <command>/server</command>, <command>/connect</command>
+ and <command>/ignore</command>.
+ </para>
+
+ <para>
+ &irc_commands.xml;
+ </para>
+
+ </section>
+
+ <section id="secIrcInfosHooked">
<title>Infos and infolists</title>
<para>
@@ -66,9 +84,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
</row>
</thead>
<tbody>
-
&irc_infos.xml;
-
</tbody>
</tgroup>
</informaltable>
diff --git a/doc/en/user/plugin_logger.en.xml b/doc/en/user/plugin_logger.en.xml
new file mode 100644
index 000000000..06dfe8ae2
--- /dev/null
+++ b/doc/en/user/plugin_logger.en.xml
@@ -0,0 +1,178 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+
+WeeChat documentation (english version)
+
+Copyright (c) 2003-2008 by FlashCode <flashcode@flashtux.org>
+
+This manual is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 3 of the License, or
+(at your option) any later version.
+
+This manual is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+-->
+
+<section id="secPluginLogger">
+ <title>Logger plugin</title>
+
+ <para>
+ The Logger plugin lets you save content of buffers to files, with options
+ about what and how it is saved.
+ </para>
+
+ <section id="secLoggerOptions">
+ <title>Options (file logger.conf)</title>
+
+ <para>
+ &logger_options.xml;
+ </para>
+
+ </section>
+
+ <section id="secLoggerCommands">
+ <title>Commands</title>
+
+ <para>
+ &logger_commands.xml;
+ </para>
+
+ </section>
+
+ <section id="secLoggerInfosHooked">
+ <title>Infos and infolists</title>
+
+ <para>
+ <informaltable colsep="0" frame="none">
+ <tgroup cols="3">
+ <thead>
+ <row>
+ <entry>Type</entry>
+ <entry>Name</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ &logger_infos.xml;
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+
+ </section>
+
+ <section id="secLoggerLevels">
+ <title>Levels</title>
+
+ <para>
+ Logging is made with a level for each buffer. Default level is 9 (log
+ all messages displayed on buffer).
+ You can change level for one buffer, or a group of buffers.
+ </para>
+
+ <para>
+ Possible levels are 0 to 9. Zero means "<literal>do not log
+ anything</literal>" and 9 means "<literal>log all messages</literal>".
+ </para>
+
+ <para>
+ Plugins are using different levels for messages displayed.
+ IRC plugin uses following levels:
+ <itemizedlist>
+ <listitem>
+ <para>
+ Level 1: message from user (on channel or private)
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Level 2: nick change (you or someone else)
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Level 3: any server message (except join/part/quit)
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Level 4: server message join/part/quit
+ </para>
+ </listitem>
+ </itemizedlist>
+ So if you set level 3 for an IRC channel, WeeChat will log all messages,
+ but not join/part/quit.
+ </para>
+
+ <para>
+ Some examples:
+ <itemizedlist>
+ <listitem>
+ <para>
+ set level 3 for IRC channel #weechat:
+ <screen>/set logger.level.irc.freenode.#weechat = 3</screen>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ set level 3 for freenode server buffer:
+ <screen>/set logger.level.irc.server.freenode = 3</screen>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ set level 3 for all channels on server freenode:
+ <screen>/set logger.level.irc.freenode = 3</screen>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ set level 2 for all IRC buffers:
+ <screen>/set logger.level.irc = 2</screen>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+
+ </section>
+
+ <section id="secLoggerMasks">
+ <title>Filename masks</title>
+
+ <para>
+ It is possible to define a filename mask for each buffer, and use local
+ buffer variables to build filename (to see local variables for current
+ buffer: <command>/buffer localvar</command>).
+ </para>
+
+ <para>
+ For example if you want one directory by IRC server and one file by
+ channel inside:
+ <screen>/set logger.mask.irc = "irc/$server/$channel.weechatlog"</screen>
+ You'll have following files:
+<screen>
+~/.weechat/
+ |--- logs/
+ |--- irc/
+ |--- freenode/
+ | freenode.weechatlog
+ | #weechat.weechatlog
+ | #mychan.weechatlog
+ |--- oftc/
+ | oftc.weechatlog
+ | #chan1.weechatlog
+ | #chan2.weechatlog
+</screen>
+ </para>
+
+ </section>
+
+</section>
diff --git a/doc/en/user/plugin_scripts.en.xml b/doc/en/user/plugin_scripts.en.xml
new file mode 100644
index 000000000..2f8ffab51
--- /dev/null
+++ b/doc/en/user/plugin_scripts.en.xml
@@ -0,0 +1,57 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+
+WeeChat documentation (english version)
+
+Copyright (c) 2003-2008 by FlashCode <flashcode@flashtux.org>
+
+This manual is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 3 of the License, or
+(at your option) any later version.
+
+This manual is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+-->
+
+<section id="secPluginScripts">
+ <title>Scripts plugins</title>
+
+ <para>
+ WeeChat provides 5 scripting plugins: Perl, Python, Ruby, Lua and Tcl.
+ These plugins can load, execute and unload scripts for these languages.
+ </para>
+
+ <para>
+ For more information about how to write scripts, or WeeChat API for
+ scripts, please read "<literal>WeeChat developer guide</literal>".
+ </para>
+
+ <para>
+ You can find some scripts for WeeChat here:
+ <ulink url="http://weechat.flashtux.org/plugins.php">
+ http://weechat.flashtux.org/plugins.php
+ </ulink>
+ </para>
+
+ <section id="secScriptsCommands">
+ <title>Commands</title>
+
+ <para>
+ &perl_commands.xml;
+ &python_commands.xml;
+ &ruby_commands.xml;
+ &lua_commands.xml;
+ &tcl_commands.xml;
+ </para>
+
+ </section>
+
+</section>
diff --git a/doc/en/user/plugin_xfer.en.xml b/doc/en/user/plugin_xfer.en.xml
index 5bb5981d8..82467f8b9 100644
--- a/doc/en/user/plugin_xfer.en.xml
+++ b/doc/en/user/plugin_xfer.en.xml
@@ -24,4 +24,44 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
<section id="secPluginXfer">
<title>Xfer plugin</title>
+ <section id="secXferOptions">
+ <title>Options (file xfer.conf)</title>
+
+ <para>
+ &xfer_options.xml;
+ </para>
+
+ </section>
+
+ <section id="secXferCommands">
+ <title>Commands</title>
+
+ <para>
+ &xfer_commands.xml;
+ </para>
+
+ </section>
+
+ <section id="secXferInfosHooked">
+ <title>Infos and infolists</title>
+
+ <para>
+ <informaltable colsep="0" frame="none">
+ <tgroup cols="3">
+ <thead>
+ <row>
+ <entry>Type</entry>
+ <entry>Name</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ &xfer_infos.xml;
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+
+ </section>
+
</section>
diff --git a/doc/en/user/plugins.en.xml b/doc/en/user/plugins.en.xml
new file mode 100644
index 000000000..d54c5d282
--- /dev/null
+++ b/doc/en/user/plugins.en.xml
@@ -0,0 +1,141 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+
+WeeChat documentation (english version)
+
+Copyright (c) 2003-2008 by FlashCode <flashcode@flashtux.org>
+
+This manual is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 3 of the License, or
+(at your option) any later version.
+
+This manual is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+-->
+
+<chapter id="chapPlugins">
+ <title>Plugins</title>
+
+ <para>
+ This chapter describes WeeChat plugin mechanism and default plugins
+ provided with WeeChat.
+ </para>
+
+ <para>
+ To learn more about plugin or script development (thru API), please read
+ "<literal>WeeChat developer guide</literal>".
+ </para>
+
+ <section id="secPluginsInWeeChat">
+ <title>Plugins in WeeChat</title>
+
+ <para>
+ A plugin is dynamic library, written in C and compiled, which is loaded
+ by WeeChat.
+ Under GNU/Linux, the file has ".so" extension, ".dll" under Windows.
+ </para>
+
+ <para>
+ Plugins found are automatically loaded when WeeChat is starting, and it
+ is possible to load or unload plugins while WeeChat is running.
+ </para>
+
+ <para>
+ It's important to make difference between a <literal>plugin</literal> and
+ a <literal>script</literal>: a plugin is a binary file compiled and
+ loaded with command<command>/plugin</command>, whereas a script is a text
+ file loaded with a plugin like <literal>Perl</literal> with command
+ <command>/perl</command>.
+ </para>
+
+ <para>
+ You can use command <command>/plugin</command> to load/unload a plugin,
+ or list all loaded plugins.
+ When a plugin is unloaded, all buffers created by this plugin are
+ automatically closed.
+ </para>
+
+ <para>
+ Examples to load, unload or list plugins:
+<screen>
+/plugin load irc
+/plugin unload irc
+/plugin list
+</screen>
+ </para>
+
+ <para>
+ Default plugins are:
+ <itemizedlist>
+ <listitem>
+ <para>alias: define alias for commands</para>
+ </listitem>
+ <listitem>
+ <para>aspell: spell checking for command line</para>
+ </listitem>
+ <listitem>
+ <para>charset: charset decoding/encoding for buffers</para>
+ </listitem>
+ <listitem>
+ <para>demo: demo plugin (not compiled by default, not documented)</para>
+ </listitem>
+ <listitem>
+ <para>fifo: FIFO pipe used to remotely send commands to WeeChat</para>
+ </listitem>
+ <listitem>
+ <para>irc: IRC chat protocol</para>
+ </listitem>
+ <listitem>
+ <para>logger: log buffers to files</para>
+ </listitem>
+ <listitem>
+ <para>notify: notify level for buffers</para>
+ </listitem>
+ <listitem>
+ <para>perl: Perl scripting API</para>
+ </listitem>
+ <listitem>
+ <para>python: Python scripting API</para>
+ </listitem>
+ <listitem>
+ <para>ruby: Ruby scripting API</para>
+ </listitem>
+ <listitem>
+ <para>lua: Lua scripting API</para>
+ </listitem>
+ <listitem>
+ <para>tcl: Tcl scripting API</para>
+ </listitem>
+ <listitem>
+ <para>xfer: file transfert and direct chat</para>
+ </listitem>
+ </itemizedlist>
+ </para>
+
+ </section>
+
+ &plugin_alias.en.xml;
+
+ &plugin_aspell.en.xml;
+
+ &plugin_charset.en.xml;
+
+ &plugin_fifo.en.xml;
+
+ &plugin_irc.en.xml;
+
+ &plugin_logger.en.xml;
+
+ &plugin_scripts.en.xml;
+
+ &plugin_xfer.en.xml;
+
+</chapter>
diff --git a/doc/en/user/usage.en.xml b/doc/en/user/usage.en.xml
index f30dec2f6..36b0ef064 100644
--- a/doc/en/user/usage.en.xml
+++ b/doc/en/user/usage.en.xml
@@ -135,7 +135,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
<para>
You can edit this file at your convenience to configure WeeChat
or you can set parameters with "<literal>/set</literal>" command in
- WeeChat (see <xref linkend="secWeeChatCommands" />)
+ WeeChat (see <xref linkend="secWeechatCommands" />)
</para>
</section>
@@ -668,42 +668,11 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
</section>
- <section id="secWeeChatCommands">
- <title>WeeChat commands</title>
-
- <para>
- This chapter lists all WeeChat commands.
- </para>
-
- <para>
- &weechat_commands.xml;
- </para>
-
- </section>
-
- <section id="secConfigurationFile">
- <title>Configuration file</title>
+ <section id="secWeechatOptions">
+ <title>WeeChat options (file weechat.conf)</title>
<para>
- List of options for config file:
- <informaltable colsep="0" frame="none">
- <tgroup cols="5">
- <thead>
- <row>
- <entry>Option</entry>
- <entry>Type</entry>
- <entry>Values</entry>
- <entry>Default</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
-
- &weechat_options.xml;
-
- </tbody>
- </tgroup>
- </informaltable>
+ &weechat_options.xml;
</para>
<para>
@@ -784,4 +753,13 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
</section>
+ <section id="secWeechatCommands">
+ <title>WeeChat commands</title>
+
+ <para>
+ &weechat_commands.xml;
+ </para>
+
+ </section>
+
</chapter>
diff --git a/doc/en/user/weechat_user.en.xml b/doc/en/user/weechat_user.en.xml
index d66d85c65..190c84870 100644
--- a/doc/en/user/weechat_user.en.xml
+++ b/doc/en/user/weechat_user.en.xml
@@ -33,9 +33,14 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
<!ENTITY intro.en.xml SYSTEM "intro.en.xml">
<!ENTITY install.en.xml SYSTEM "install.en.xml">
<!ENTITY usage.en.xml SYSTEM "usage.en.xml">
- <!ENTITY plugin_irc.en.xml SYSTEM "plugin_irc.en.xml">
+ <!ENTITY plugins.en.xml SYSTEM "plugins.en.xml">
+ <!ENTITY plugin_alias.en.xml SYSTEM "plugin_alias.en.xml">
+ <!ENTITY plugin_aspell.en.xml SYSTEM "plugin_aspell.en.xml">
<!ENTITY plugin_charset.en.xml SYSTEM "plugin_charset.en.xml">
<!ENTITY plugin_fifo.en.xml SYSTEM "plugin_fifo.en.xml">
+ <!ENTITY plugin_irc.en.xml SYSTEM "plugin_irc.en.xml">
+ <!ENTITY plugin_logger.en.xml SYSTEM "plugin_logger.en.xml">
+ <!ENTITY plugin_scripts.en.xml SYSTEM "plugin_scripts.en.xml">
<!ENTITY plugin_xfer.en.xml SYSTEM "plugin_xfer.en.xml">
<!ENTITY authors.en.xml SYSTEM "authors.en.xml">
]>
@@ -100,7 +105,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
&usage.en.xml;
- <!-- &plugins.en.xml; -->
+ &plugins.en.xml;
&authors.en.xml;