summaryrefslogtreecommitdiff
path: root/doc/en/user/plugin_irc.en.xml
blob: ec94b36df71e8303f882eae508899c1bdefc14bf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
<?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>
  
  <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="secIrcCommandLineOptions">
    <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="secIrcOptions">
    <title>Options (file irc.conf)</title>
    
    <para>
      &irc_options.xml;
    </para>
    
  </section>
  
  <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>
      <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>