From 7c1e24dd5a3afe9c8c43e70c57b10b2a89d4d9e2 Mon Sep 17 00:00:00 2001
From: Tom Feist <shabble@cowu.be>
Date: Fri, 16 Jul 2010 20:32:51 +0100
Subject: more fixing and moving

---
 docs/Irssi/Irc/Ban.pod        | 15 +++++++++
 docs/Irssi/Irc/Client.pod     | 20 ++++++++++++
 docs/Irssi/Irc/Dcc.pod        | 72 +++++++++++++++++++++++++++++++++++++++++++
 docs/Irssi/Irc/Notifylist.pod | 21 +++++++++++++
 4 files changed, 128 insertions(+)
 create mode 100644 docs/Irssi/Irc/Ban.pod
 create mode 100644 docs/Irssi/Irc/Client.pod
 create mode 100644 docs/Irssi/Irc/Dcc.pod
 create mode 100644 docs/Irssi/Irc/Notifylist.pod

(limited to 'docs/Irssi/Irc')

diff --git a/docs/Irssi/Irc/Ban.pod b/docs/Irssi/Irc/Ban.pod
new file mode 100644
index 0000000..ba8381f
--- /dev/null
+++ b/docs/Irssi/Irc/Ban.pod
@@ -0,0 +1,15 @@
+__END__
+
+=head1 NAME
+
+Irssi::Ban
+
+=head1 FIELDS
+
+Ban->{}
+  ban - The ban
+  setby - Nick of who set the ban
+  time - Timestamp when ban was set
+
+
+=head1 METHODS
diff --git a/docs/Irssi/Irc/Client.pod b/docs/Irssi/Irc/Client.pod
new file mode 100644
index 0000000..e07bed7
--- /dev/null
+++ b/docs/Irssi/Irc/Client.pod
@@ -0,0 +1,20 @@
+__END__
+
+=head1 NAME
+
+Irssi::Client
+
+=head1 FIELDS
+Client->{}
+  nick - nick of the client
+  host - host of the client
+  proxy_address - address of the proxy server
+  server - Irc::Server for which we proxy to this client
+  pass_sent - whether the client already send a PASS command
+  user_sent - whether the client already send a USER command
+  connected - whether the client is connected and ready
+  want_ctcp - whether the client wants to receive CTCPs
+  ircnet - network tag of the network we proxy
+
+
+=head1 METHODS
diff --git a/docs/Irssi/Irc/Dcc.pod b/docs/Irssi/Irc/Dcc.pod
new file mode 100644
index 0000000..d7ab4a3
--- /dev/null
+++ b/docs/Irssi/Irc/Dcc.pod
@@ -0,0 +1,72 @@
+__END__
+
+=head1 NAME
+
+Irssi::Dcc
+
+=head1 FIELDS
+
+=head2 C<Dcc->{}>
+
+  type - Type of the DCC: chat, send, get
+  orig_type - Original DCC type that was sent to us - same as type except
+              GET and SEND are swapped
+  created - Time stamp when the DCC record was created
+
+  server - Server record where the DCC was initiated.
+  servertag - Tag of the server where the DCC was initiated.
+  mynick - Our nick to use in DCC chat.
+  nick - Other side's nick name.
+
+  chat - Dcc chat record if the request came through DCC chat
+  target - Who the request was sent to - your nick, channel or empty
+           if you sent the request
+  arg - Given argument .. file name usually
+
+  addr - Other side's IP address.
+  port - Port we're connecting in.
+
+  starttime - Unix time stamp when the DCC transfer was started
+  transfd - Bytes transferred
+
+=head2 C<Dcc::Chat->{}>
+
+  id - Unique identifier - usually same as nick
+  mirc_ctcp - Send CTCPs without the CTCP_MESSAGE prefix
+  connection_lost - Other side closed connection
+
+=head2 C<Dcc::Get->{}>
+
+  (..contains all the same data as core Dcc object..)
+  size - File size
+  skipped - Bytes skipped from start (resuming file)
+
+  get_type - What to do if file exists?
+               0=default, 1=rename, 2=overwrite, 3=resume
+
+  file - The real file name which we use.
+  file_quoted - 1 if file name was received quoted ("file name")
+
+=head2 C<Dcc::Send->{}>
+
+  (..contains all the same data as core Dcc object..)
+  size - File size
+  skipped - Bytes skipped from start (resuming file)
+
+  file_quoted - 1 if file name was received quoted ("file name")
+  waitforend - File is sent, just wait for the replies from the other side
+  gotalldata - Got all acks from the other end
+
+=head1 METHODS
+
+=head2 C<destroy>
+
+Destroy DCC connection.
+
+=head2 C<chat_send $data>
+
+Send `data' to dcc chat.
+
+=head2 C<ctcp_message $target, $notice, $msg>
+
+Send a CTCP message/notify to target.
diff --git a/docs/Irssi/Irc/Notifylist.pod b/docs/Irssi/Irc/Notifylist.pod
new file mode 100644
index 0000000..5b2628a
--- /dev/null
+++ b/docs/Irssi/Irc/Notifylist.pod
@@ -0,0 +1,21 @@
+__END__
+
+=head1 NAME
+
+Irssi::Notifylist
+
+=head1 FIELDS
+
+Notifylist->{}
+  mask - Notify nick mask
+  away_check - Notify away status changes
+  idle_check_time - Notify when idle time is reset and idle was bigger
+                    than this (seconds)
+  ircnets - List of ircnets (strings) the notify is checked
+
+
+=head1 METHODS
+
+Notifylist::ircnets_match(ircnet)
+  Returns 1 if notify is checked in `ircnet'.
+
-- 
cgit v1.2.3