diff options
Diffstat (limited to 'doc/en/plugin_irc.en.xml')
| -rw-r--r-- | doc/en/plugin_irc.en.xml | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/doc/en/plugin_irc.en.xml b/doc/en/plugin_irc.en.xml index d602dfdae..266a59ce5 100644 --- a/doc/en/plugin_irc.en.xml +++ b/doc/en/plugin_irc.en.xml @@ -24,4 +24,56 @@ 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> |