weechat/doc/en/plugin_irc.en.xml
2008-09-05 18:52:59 +02:00

80 lines
2.2 KiB
XML

<?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="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" />).
<section id="ircCommandLineOptions">
<title>Command line options</title>
<para>
It is possible to give URL for one or many IRC servers, as
follow:
<screen>irc[6][s]://[pseudo[:mot_passe]@]irc.example.org[:port][/channel][,channel[...]</screen>
Example to join #weechat and #toto on
"<literal>irc.freenode.net</literal>" server, default port (6667),
with "nono" nick:
<screen><prompt>$ </prompt><userinput>weechat-curses irc://nono@irc.freenode.net/#weechat,#toto</userinput></screen>
</para>
</section>
<section id="ircOptions">
<title>Configuration options</title>
<para>
&irc_options.xml;
</para>
</section>
<section id="ircInfosHooked">
<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>
&irc_infos.xml;
</tbody>
</tgroup>
</informaltable>
</para>
</section>
</section>