diff options
Diffstat (limited to 'docs/Irssi')
| -rw-r--r-- | docs/Irssi/Channel.pod | 67 | ||||
| -rw-r--r-- | docs/Irssi/Irc/Dcc.pod | 8 | ||||
| -rw-r--r-- | docs/Irssi/Log.pod | 36 | ||||
| -rw-r--r-- | docs/Irssi/Logitem.pod | 4 | ||||
| -rw-r--r-- | docs/Irssi/Nick.pod | 3 | ||||
| -rw-r--r-- | docs/Irssi/Rawlog.pod | 42 | ||||
| -rw-r--r-- | docs/Irssi/UI/Theme.pod | 56 |
7 files changed, 146 insertions, 70 deletions
diff --git a/docs/Irssi/Channel.pod b/docs/Irssi/Channel.pod index bb6789d..baeff6c 100644 --- a/docs/Irssi/Channel.pod +++ b/docs/Irssi/Channel.pod @@ -6,7 +6,8 @@ Irssi::Channel =head1 FIELDS -Channel->{} +C<Channel-E<gt>{}> + type - "CHANNEL" text chat_type - String ID of chat protocol, for example "IRC" @@ -35,45 +36,51 @@ Channel->{} -Server::channels_join(channels, automatic) - Join to channels in server. `channels' may also contain keys for - channels just like with /JOIN command. `automatic' specifies if this - channel was joined "automatically" or if it was joined because join - was requested by user. If channel join is "automatic", irssi doesn't - jump to the window where the channel was joined. +=head2 C<channels_join(channels, automatic)> + +Join to channels in server. `channels' may also contain keys for +channels just like with /JOIN command. `automatic' specifies if this +channel was joined "automatically" or if it was joined because join +was requested by user. If channel join is "automatic", irssi doesn't +jump to the window where the channel was joined. + +=head2 C<destroy> + +Destroy channel. + +=head2 C<bans> + +Return a list of bans in channel. + +=head2 C<ban_get_mask $nick> + +Get ban mask for `nick'. + +=head2 C<banlist_add $ban, $nick, $time> + +Add a new ban to channel. +=head2 C<banlist_remove $ban> -Channel::destroy() - Destroy channel. +Remove a ban from channel. -Channel::bans() - Return a list of bans in channel. +=head2 C<nick_insert $nick, $op, $voice, $send_massjoin> -Channel::ban_get_mask(nick) - Get ban mask for `nick'. +Add nick to nicklist. Returns a L<Irssi::Nick>. -Channel::banlist_add(ban, nick, time) - Add a new ban to channel. +=head2 C<nick_remove $nick> -Channel::banlist_remove(ban) - Remove a ban from channel. +Remove nick from nicklist. +=head2 C<nick_find $nick> -Nick -Channel::nick_insert(nick, op, voice, send_massjoin) - Add nick to nicklist. +Find nick from nicklist. Returns L<Irssi::Nick>. -Channel::nick_remove(nick) - Remove nick from nicklist. +=head2 C<nick_find_mask $mask> -Nick -Channel::nick_find(nick) - Find nick from nicklist. +Find nick mask from nicklist, wildcards allowed. Returns L<Irssi::Nick>. -Nick -Channel::nick_find_mask(mask) - Find nick mask from nicklist, wildcards allowed. +=head2 C<nicks> -Channel::nicks() - Return a list of all nicks in channel. +Return a list of all nicks in channel. diff --git a/docs/Irssi/Irc/Dcc.pod b/docs/Irssi/Irc/Dcc.pod index 5950a92..5ba52b9 100644 --- a/docs/Irssi/Irc/Dcc.pod +++ b/docs/Irssi/Irc/Dcc.pod @@ -6,7 +6,7 @@ Irssi::Irc::Dcc =head1 FIELDS -=head2 C<Dcc->{}> +=head2 C<Dcc-E<gt>{}> type - Type of the DCC: chat, send, get orig_type - Original DCC type that was sent to us - same as type except @@ -29,13 +29,13 @@ Irssi::Irc::Dcc starttime - Unix time stamp when the DCC transfer was started transfd - Bytes transferred -=head2 C<Dcc::Chat->{}> +=head2 C<Dcc::Chat-E<gt>{}> 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->{}> +=head2 C<Dcc::Get-E<gt>{}> (..contains all the same data as core Dcc object..) size - File size @@ -47,7 +47,7 @@ Irssi::Irc::Dcc file - The real file name which we use. file_quoted - 1 if file name was received quoted ("file name") -=head2 C<Dcc::Send->{}> +=head2 C<Dcc::Send-E<gt>{}> (..contains all the same data as core Dcc object..) size - File size diff --git a/docs/Irssi/Log.pod b/docs/Irssi/Log.pod index 673a183..68163a2 100644 --- a/docs/Irssi/Log.pod +++ b/docs/Irssi/Log.pod @@ -6,7 +6,8 @@ Irssi::Log =head1 FIELDS -Log->{} +C<Log-E<gt>{}> + fname - Log file name real_fname - The actual opened log file (after %d.%m.Y etc. are expanded) opened - Log file is open @@ -20,27 +21,30 @@ Log->{} =head1 METHODS +=head2 C<update> + +Add log to list of logs / save changes to config file. + +=head2 C<close> + +Destroy log file. + +=head2 C<start_logging> -Log::update() - Add log to list of logs / save changes to config file. +Open log file and start logging. +=head2 C<stop_logging> -Log::close() - Destroy log file. +Close log file. -Log::start_logging() - Open log file and start logging. +=head2 C<item_add $type, $name, $server> -Log::stop_logging() - Close log file. +Add log item to log. -Log::item_add(type, name, server) - Add log item to log. +=head2 C<item_destroy $item> -Log::item_destroy(item) - Remove log item from log. +Remove log item from log. +=head2 C<item_find $type, $item, $server> -Logitem -Log::item_find(type, item, server) - Find item from log. +Find item from log. Returns L<Irssi::Logitem> diff --git a/docs/Irssi/Logitem.pod b/docs/Irssi/Logitem.pod index 6db0c7b..f30d4b8 100644 --- a/docs/Irssi/Logitem.pod +++ b/docs/Irssi/Logitem.pod @@ -6,11 +6,11 @@ Irssi::Logitem =head1 FIELDS -Logitem->{} +C<Logitem-E<gt>{}> + type - 0=target, 1=window refnum name - Name servertag - Server tag - =head1 METHODS diff --git a/docs/Irssi/Nick.pod b/docs/Irssi/Nick.pod index b20d43a..3e85256 100644 --- a/docs/Irssi/Nick.pod +++ b/docs/Irssi/Nick.pod @@ -6,7 +6,8 @@ Irssi::Nick =head1 FIELDS -Nick->{} +C<Nick-E<gt>{}> + type - "NICK" text chat_type - String ID of chat protocol, for example "IRC" diff --git a/docs/Irssi/Rawlog.pod b/docs/Irssi/Rawlog.pod index 7f89c64..a5428bf 100644 --- a/docs/Irssi/Rawlog.pod +++ b/docs/Irssi/Rawlog.pod @@ -7,34 +7,42 @@ Irssi::Rawlog =head1 FIELDS -Rawlog->{} +C<Rawlog-E<gt>{}> + logging - The rawlog is being written to file currently nlines - Number of lines in rawlog =head1 METHODS +=head2 C<destroy> + +Destroy the rawlog. + +=head2 C<get_lines> + +Returns all lines in rawlog. + +=head2 C<open $filename> + +Start logging new messages in rawlog to specified file. + +=head2 C<close> + +Stop logging to file. -Rawlog::destroy() - Destroy the rawlog. +=head2 C<save $filename> -Rawlog::get_lines() - Returns all lines in rawlog. +Save the current rawlog history to specified file. -Rawlog::open(filename) - Start logging new messages in rawlog to specified file. +=head2 C<input $str> -Rawlog::close() - Stop logging to file. +Send `str' to raw log as input text. -Rawlog::save(filename) - Save the current rawlog history to specified file. +=head2 C<output $str> -Rawlog::input(str) - Send `str' to raw log as input text. +Send `str' to raw log as output text. -Rawlog::output(str) - Send `str' to raw log as output text. +=head2 C<redirect $str> -Rawlog::redirect(str) - Send `str' to raw log as redirection text. +Send `str' to raw log as redirection text. diff --git a/docs/Irssi/UI/Theme.pod b/docs/Irssi/UI/Theme.pod index 56e3a3f..4fff169 100644 --- a/docs/Irssi/UI/Theme.pod +++ b/docs/Irssi/UI/Theme.pod @@ -1,3 +1,5 @@ +__END__ + =head1 NAME Irssi::UI::Theme @@ -6,3 +8,57 @@ Irssi::UI::Theme =head1 METHODS +=head1 THEME DOCUMENTATION + +When testing changes, the easiest way to reload the theme is with /RELOAD. +This reloads the configuration file too, so if you did any changes remember +to /SAVE it first. Remember also that /SAVE overwrites the theme file with +old data so keep backups :) + +=head2 TEMPLATES + +The real text formats that irssi uses are the ones you can find with +/FORMAT command. Back in the old days all the colors and texts were mixed +up in those formats, and it was really hard to change the colors since you +might have had to change them in tens of different places. So, then came +this templating system. + +Now the C</FORMAT>s don't have any colors in them, and they also have very +little other styling. Most of the stuff you need to change is in this +theme file. If you can't change something here, you can always go back +to change the /FORMATs directly, they're also saved in these .theme files. + +So .. the templates. They're those C<{blahblah}> parts you see all over the +/FORMATs and here. Their usage is simply C<{name parameter1 parameter2}>. + +When irssi sees this kind of text, it goes to find "name" from abstracts block +below and sets C<parameter1> into C<$0> and C<parameter2> into C<$1> (you can +have more parameters of course). Templates can have subtemplates. Here's a +small example: + + /FORMAT format hello {colorify {underline world}} + + abstracts = { colorify = "%G$0-%n"; underline = "%U$0-%U"; } + +When irssi expands the templates in "format", the final string would be: + + hello %G%Uworld%U%n + +ie. underlined bright green "world" text. +and why C<$0->, why not C<$0>? C<$0> would only mean the first parameter, +$0- means all the parameters. With {underline hello world} you'd really +want to underline both of the words, not just the hello (and world would +actually be removed entirely). + +=head2 COLORS + +You can find definitions for the color format codes in L<Formats> + +There's one difference here though. %n format. Normally it means the +default color of the terminal (white mostly), but here it means the +"reset color back to the one it was in higher template". For example +if there was /FORMAT test %g{foo}bar, and foo = "%Y$0%n", irssi would +print yellow "foo" (as set with %Y) but "bar" would be green, which was +set at the beginning before the {foo} template. If there wasn't the %g +at start, the normal behaviour of %n would occur. If you _really_ want +to use the terminal's default color, use %N. |