aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorTom Feist <shabble@cowu.be>2010-07-16 19:22:49 +0000
committerTom Feist <shabble@cowu.be>2010-07-16 19:22:49 +0000
commit241fb7c85ce61372385b0beabf5bf3bd3211338e (patch)
tree7553b34aaf6d0965a6ec960d1a33965fe95940b5 /docs
parentremoved irssi/window since it was only a placeholder (diff)
downloadirssi-scripts-241fb7c85ce61372385b0beabf5bf3bd3211338e.tar.gz
irssi-scripts-241fb7c85ce61372385b0beabf5bf3bd3211338e.zip
moved process to ui namespace
Diffstat (limited to 'docs')
-rw-r--r--docs/Irssi/Dcc.pod19
-rw-r--r--docs/Irssi/TextUI.pm1
-rw-r--r--docs/Irssi/UI/Process.pod (renamed from docs/Irssi/Process.pod)3
-rw-r--r--docs/Irssi/Windowitem.pod26
4 files changed, 31 insertions, 18 deletions
diff --git a/docs/Irssi/Dcc.pod b/docs/Irssi/Dcc.pod
index 546f112..5a68dd4 100644
--- a/docs/Irssi/Dcc.pod
+++ b/docs/Irssi/Dcc.pod
@@ -7,6 +7,7 @@ Irssi::Dcc
=head1 FIELDS
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
@@ -29,11 +30,13 @@ Dcc->{}
transfd - Bytes transferred
Dcc::Chat->{}
+
id - Unique identifier - usually same as nick
mirc_ctcp - Send CTCPs without the CTCP_MESSAGE prefix
connection_lost - Other side closed connection
Dcc::Get->{}
+
(..contains all the same data as core Dcc object..)
size - File size
skipped - Bytes skipped from start (resuming file)
@@ -44,6 +47,7 @@ Dcc::Get->{}
file_quoted - 1 if file name was received quoted ("file name")
Dcc::Send->{}
+
(..contains all the same data as core Dcc object..)
size - File size
skipped - Bytes skipped from start (resuming file)
@@ -55,11 +59,14 @@ Dcc::Send->{}
=head1 METHODS
-Dcc::destroy()
- Destroy DCC connection.
+=head2 C<destroy>
+
+Destroy DCC connection.
+
+=head2 C<chat_send $data>
+
+Send `data' to dcc chat.
-Dcc::chat_send(data)
- Send `data' to dcc chat.
+=head2 C<ctcp_message $target, $notice, $msg>
-Dcc::ctcp_message(target, notice, msg)
- Send a CTCP message/notify to target.
+Send a CTCP message/notify to target.
diff --git a/docs/Irssi/TextUI.pm b/docs/Irssi/TextUI.pm
new file mode 100644
index 0000000..f66cf7a
--- /dev/null
+++ b/docs/Irssi/TextUI.pm
@@ -0,0 +1 @@
+=head1 Empty
diff --git a/docs/Irssi/Process.pod b/docs/Irssi/UI/Process.pod
index 4b311a2..43442eb 100644
--- a/docs/Irssi/Process.pod
+++ b/docs/Irssi/UI/Process.pod
@@ -2,11 +2,12 @@ __END__
=head1 NAME
-Irssi::Query
+Irssi::UI::Process
=head1 FIELDS
Process->{}
+
id - ID for the process
name - Name for the process (if given)
args - The command that is being executed
diff --git a/docs/Irssi/Windowitem.pod b/docs/Irssi/Windowitem.pod
index 7781a44..f91183c 100644
--- a/docs/Irssi/Windowitem.pod
+++ b/docs/Irssi/Windowitem.pod
@@ -22,6 +22,7 @@ didn't work :)
=head1 FIELDS
Windowitem->{}
+
type - Type of the window item, for example "CHANNEL" or "QUERY"
chat_type - String ID of chat protocol, for example "IRC"
@@ -34,22 +35,25 @@ Windowitem->{}
=head1 METHODS
-Windowitem::print(str[, level])
+=head2 C<print $str, [$level]>
+
+=head2 C<command $cmd>
+
+=head2 C<set_active>
+
+Change window item active in parent window.
-Windowitem::command(cmd)
+=head2 C<change_server $server>
+Change server in window item.
-Windowitem::set_active()
- Change window item active in parent window.
+=head2 C<is_active>
+Returns 1 if window item is the active item in parent window.
-Windowitem::change_server(server)
- Change server in window item.
-Windowitem::is_active()
- Returns 1 if window item is the active item in parent window.
+=head2 C<get_dcc $item>
-Dcc
-Windowitem::get_dcc(item)
- If `item' is a query of a =nick, return DCC chat record of nick.
+If `item' is a query of a =nick, return DCC chat record of nick.
+returns L<Irssi::Dcc> object.