Improved Perl Scripting and Irssi Internals Documentation

[irssibot]

• • • Issue #762 opened by @shabble

I am working on converting the existing irssi scripting documentation (primarily working from docs/perl.txt and signals.txt) into perl POD format, such that they can be rendered into html, manpages, etc.

Can any devs advise if:

a) This is a good idea? b) You're ok with me doing this (I'll keep the original copyright notices on the footer of each page) c) There are any significant undocumented objects/methods/gotchas that would be worth including in a revised version of the documentation.

The whole effort is still a work in progress, and is currently hosted at:

http://github.com/shabble/shab-irssi-scripts/tree/master/docs/

Through the magic of github, I'm also hosting the autogenerated pod2html pages at:

http://shabble.github.com/shab-irssi-scripts/docs/

Any suggestions, comments, etc please comment on this ticket, or feel free to contact me directly and I'll add you as a github contributor so you can push directly to the repo.

Many thanks,

Tom

[irssibot]

• • • Comment 1218 by @coekie

The perl.txt can definately use a better format, and POD would make sense. That's a good idea ideed!

For signals.txt, that file is also used by irssi to generate the Perl glue. So if that format is changed, either the original signals.txt just has to be kept too (so having it in two places), or the thing that parses signals.txt has to get updated too. So probably best to try to keep it in a format that wouldn't be too hard to write a parser for (even if you or we don't do that part right now).

For undocumented parts, you could look at the source code (mostly the .xs files I guess) for functions that aren't documented. But there are probably a bunch there which are better left undocumented (and never should have been exposed to Perl in the first place). And there's no clear difference between what should get documented and what's better not used. So the first step is to get a list of undocumented functions, and then the next step is to make a selection.

I only took a very quick look at what you did for now, but what I've seen looks pretty good. Thanks!

[irssibot]

• • • Comment 1225 by @shabble

I've put together the basis now (at the same shabble.github.com url above), and started to flesh it out.

I've attached a list of functions to this post, although I haven't filtered it for ones already documented in perl.txt

If anyone wants to specify things that I explicitly /shouldn't/ document, I'll make a note. For now, I'm thinking that the various ::init() and ::deinit() ones shouldn't be touched, but other than that, I have no idea.

The autogeneration thing is ongoing, I've managed to get a simple proof of concept (buildsignals.pl in the repo), but will take a bit more work to generate the same content as the current header file. As far as I can tell, that header is the only thing autogenerated?

Cheers.

[irssibot]

• • • Attachment 222 by @shabble

xsfuncs.txt

Irssi::Channel::destroy
Irssi::Channel::nick_find
Irssi::Channel::nick_find_mask
Irssi::Channel::nick_insert
Irssi::Channel::nick_remove
Irssi::Channel::nicks

Irssi::EXPAND_FLAG_IGNORE_EMPTY
Irssi::EXPAND_FLAG_IGNORE_REPLACES
Irssi::EXPAND_FLAG_RECURSIVE_MASK
Irssi::INPUT_READ
Irssi::INPUT_WRITE
Irssi::IRSSI_GUI_GNOME
Irssi::IRSSI_GUI_GTK
Irssi::IRSSI_GUI_KDE
Irssi::IRSSI_GUI_NONE
Irssi::IRSSI_GUI_QT
Irssi::IRSSI_GUI_TEXT

Irssi::Ignore::add_rec
Irssi::Ignore::update_rec

Irssi::Irc::Channel::ban_get_mask
Irssi::Irc::Channel::banlist_add
Irssi::Irc::Channel::banlist_remove
Irssi::Irc::Channel::bans
Irssi::Irc::Channel::nick_insert

Irssi::Irc::Dcc::close
Irssi::Irc::Dcc::destroy
Irssi::Irc::Dcc::init_rec
Irssi::Irc::Dcc::reject

Irssi::Irc::MASK_DOMAIN
Irssi::Irc::MASK_HOST
Irssi::Irc::MASK_NICK
Irssi::Irc::MASK_USER

Irssi::Irc::Notifylist::ircnets_match

Irssi::Irc::Server::ctcp_send_reply
Irssi::Irc::Server::get_channels
Irssi::Irc::Server::isupport
Irssi::Irc::Server::netsplit_find
Irssi::Irc::Server::netsplit_find_channel
Irssi::Irc::Server::notifylist_ison_server
Irssi::Irc::Server::query_create
Irssi::Irc::Server::redirect_event
Irssi::Irc::Server::redirect_get_signal
Irssi::Irc::Server::redirect_peek_signal
Irssi::Irc::Server::redirect_register
Irssi::Irc::Server::send_raw
Irssi::Irc::Server::send_raw_first
Irssi::Irc::Server::send_raw_now
Irssi::Irc::Server::send_raw_split

Irssi::Irc::dcc_chat_find_id
Irssi::Irc::dcc_chat_send
Irssi::Irc::dcc_ctcp_message
Irssi::Irc::dcc_find_request
Irssi::Irc::dcc_find_request_latest
Irssi::Irc::dcc_get_download_path
Irssi::Irc::dcc_register_type
Irssi::Irc::dcc_str2type
Irssi::Irc::dcc_type2str
Irssi::Irc::dcc_unregister_type
Irssi::Irc::dccs
Irssi::Irc::deinit
Irssi::Irc::get_mask
Irssi::Irc::init
Irssi::Irc::modes_join
Irssi::Irc::notifies
Irssi::Irc::notifylist_add
Irssi::Irc::notifylist_find
Irssi::Irc::notifylist_ison
Irssi::Irc::notifylist_remove

Irssi::Log::close
Irssi::Log::item_add
Irssi::Log::item_destroy
Irssi::Log::item_find
Irssi::Log::start_logging
Irssi::Log::stop_logging
Irssi::Log::update
Irssi::Log::write_rec

Irssi::MSGLEVEL_ACTIONS
Irssi::MSGLEVEL_ALL
Irssi::MSGLEVEL_CLIENTCRAP
Irssi::MSGLEVEL_CLIENTERROR
Irssi::MSGLEVEL_CLIENTNOTICE
Irssi::MSGLEVEL_CRAP
Irssi::MSGLEVEL_CTCPS
Irssi::MSGLEVEL_DCC
Irssi::MSGLEVEL_DCCMSGS
Irssi::MSGLEVEL_HILIGHT
Irssi::MSGLEVEL_INVITES
Irssi::MSGLEVEL_JOINS
Irssi::MSGLEVEL_KICKS
Irssi::MSGLEVEL_LASTLOG
Irssi::MSGLEVEL_MODES
Irssi::MSGLEVEL_MSGS
Irssi::MSGLEVEL_NEVER
Irssi::MSGLEVEL_NICKS
Irssi::MSGLEVEL_NOHILIGHT
Irssi::MSGLEVEL_NOTICES
Irssi::MSGLEVEL_NO_ACT
Irssi::MSGLEVEL_PARTS
Irssi::MSGLEVEL_PUBLIC
Irssi::MSGLEVEL_QUITS
Irssi::MSGLEVEL_SNOTES
Irssi::MSGLEVEL_TOPICS
Irssi::MSGLEVEL_WALLOPS

Irssi::Query::change_server
Irssi::Query::destroy

Irssi::Rawlog::close
Irssi::Rawlog::destroy
Irssi::Rawlog::get_lines
Irssi::Rawlog::input
Irssi::Rawlog::open
Irssi::Rawlog::output
Irssi::Rawlog::redirect
Irssi::Rawlog::save

Irssi::SIGNAL_PRIORITY_DEFAULT
Irssi::SIGNAL_PRIORITY_HIGH
Irssi::SIGNAL_PRIORITY_LOW

Irssi::Server::channel_find
Irssi::Server::channels
Irssi::Server::channels_join
Irssi::Server::command
Irssi::Server::disconnect
Irssi::Server::format_create_dest
Irssi::Server::get_nick_flags
Irssi::Server::ignore_check
Irssi::Server::ischannel
Irssi::Server::isnickflag
Irssi::Server::mask_match
Irssi::Server::mask_match_address
Irssi::Server::masks_match
Irssi::Server::nicks_get_same
Irssi::Server::parse_special
Irssi::Server::print
Irssi::Server::printformat
Irssi::Server::queries
Irssi::Server::query_find
Irssi::Server::ref
Irssi::Server::send_message
Irssi::Server::unref
Irssi::Server::window_find_closest
Irssi::Server::window_find_item
Irssi::Server::window_find_level
Irssi::Server::window_item_find

Irssi::TextUI::Line::get_text
Irssi::TextUI::Line::next
Irssi::TextUI::Line::prev

Irssi::TextUI::StatusbarItem::default_handler

Irssi::TextUI::TextBufferView::clear
Irssi::TextUI::TextBufferView::get_bookmark
Irssi::TextUI::TextBufferView::get_line_cache
Irssi::TextUI::TextBufferView::get_lines
Irssi::TextUI::TextBufferView::redraw
Irssi::TextUI::TextBufferView::remove_all_lines
Irssi::TextUI::TextBufferView::remove_line
Irssi::TextUI::TextBufferView::scroll
Irssi::TextUI::TextBufferView::scroll_line
Irssi::TextUI::TextBufferView::set_bookmark
Irssi::TextUI::TextBufferView::set_bookmark_bottom
Irssi::TextUI::TextBufferView::set_default_indent
Irssi::TextUI::TextBufferView::set_scroll

Irssi::TextUI::deinit
Irssi::TextUI::init

Irssi::UI::Server::gui_printtext_after
Irssi::UI::Server::term_refresh_freeze
Irssi::UI::Server::term_refresh_thaw

Irssi::UI::TextDest::print

Irssi::UI::Theme::format_expand
Irssi::UI::Theme::get_format

Irssi::UI::Window::activity
Irssi::UI::Window::change_server
Irssi::UI::Window::command
Irssi::UI::Window::destroy
Irssi::UI::Window::format_get_text
Irssi::UI::Window::get_active_name
Irssi::UI::Window::get_history_lines
Irssi::UI::Window::gui_printtext_after
Irssi::UI::Window::item_add
Irssi::UI::Window::item_destroy
Irssi::UI::Window::item_find
Irssi::UI::Window::item_next
Irssi::UI::Window::item_prev
Irssi::UI::Window::item_remove
Irssi::UI::Window::items
Irssi::UI::Window::last_line_insert
Irssi::UI::Window::print
Irssi::UI::Window::print_after
Irssi::UI::Window::printformat
Irssi::UI::Window::set_active
Irssi::UI::Window::set_history
Irssi::UI::Window::set_level
Irssi::UI::Window::set_name
Irssi::UI::Window::set_refnum
Irssi::UI::Window::view

Irssi::UI::deinit
Irssi::UI::init
Irssi::UI::processes

Irssi::Window::format_create_dest

Irssi::Windowitem::activity
Irssi::Windowitem::change_server
Irssi::Windowitem::command
Irssi::Windowitem::get_dcc
Irssi::Windowitem::is_active
Irssi::Windowitem::parse_special
Irssi::Windowitem::print
Irssi::Windowitem::printformat
Irssi::Windowitem::set_active
Irssi::Windowitem::window
Irssi::Windowitem::window_create

Irssi::abstracts_register
Irssi::active_server
Irssi::active_win
Irssi::bits2level
Irssi::channel_find
Irssi::channels
Irssi::chatnet_find
Irssi::chatnets
Irssi::combine_level
Irssi::command
Irssi::command_bind
Irssi::command_bind_first
Irssi::command_bind_last
Irssi::command_parse_options
Irssi::command_runsub
Irssi::command_set_options
Irssi::command_unbind
Irssi::commands
Irssi::ctcp_register
Irssi::ctcp_unregister
Irssi::current_theme
Irssi::deinit
Irssi::expando_create
Irssi::expando_destroy
Irssi::format_create_dest
Irssi::format_get_length
Irssi::format_real_length
Irssi::get_gui
Irssi::get_irssi_binary
Irssi::get_irssi_config
Irssi::get_irssi_dir
Irssi::gui_input_get_pos
Irssi::gui_input_set
Irssi::gui_input_set_pos
Irssi::gui_printtext
Irssi::ignore_check
Irssi::ignores
Irssi::init
Irssi::input_add
Irssi::input_remove
Irssi::level2bits
Irssi::log_create_rec
Irssi::log_find
Irssi::logs
Irssi::mask_match
Irssi::mask_match_address
Irssi::masks_match
Irssi::parse_special
Irssi::pidwait_add
Irssi::pidwait_remove
Irssi::print
Irssi::printformat
Irssi::queries
Irssi::query_find
Irssi::rawlog_create
Irssi::rawlog_set_size
Irssi::reconnects
Irssi::server_create_conn
Irssi::server_find_chatnet
Irssi::server_find_tag
Irssi::servers
Irssi::settings_add_bool
Irssi::settings_add_int
Irssi::settings_add_level
Irssi::settings_add_size
Irssi::settings_add_str
Irssi::settings_add_time
Irssi::settings_get_bool
Irssi::settings_get_int
Irssi::settings_get_level
Irssi::settings_get_size
Irssi::settings_get_str
Irssi::settings_get_time
Irssi::settings_remove
Irssi::settings_set_bool
Irssi::settings_set_int
Irssi::settings_set_level
Irssi::settings_set_size
Irssi::settings_set_str
Irssi::settings_set_time
Irssi::signal_add
Irssi::signal_add_first
Irssi::signal_add_last
Irssi::signal_add_priority
Irssi::signal_continue
Irssi::signal_emit
Irssi::signal_get_emitted
Irssi::signal_get_emitted_id
Irssi::signal_register
Irssi::signal_remove
Irssi::signal_stop
Irssi::signal_stop_by_name
Irssi::statusbar_item_register
Irssi::statusbar_item_unregister
Irssi::statusbar_items_redraw
Irssi::statusbars_recreate_items
Irssi::strip_codes
Irssi::theme_register
Irssi::themes_reload
Irssi::timeout_add
Irssi::timeout_add_once
Irssi::timeout_remove
Irssi::version
Irssi::window_find_closest
Irssi::window_find_item
Irssi::window_find_level
Irssi::window_find_name
Irssi::window_find_refnum
Irssi::window_item_find
Irssi::window_refnum_next
Irssi::window_refnum_prev
Irssi::windows
Irssi::windows_refnum_last

[irssibot]

• • • Comment 1228 by @shabble

Re: suggestion by coekie on IRC, here's a copy of the function list with arguments added where possible.

[irssibot]

• • • Attachment 225 by @shabble

xsfuncs_args.txt

=over

Irssi::Channel::destroy(Irssi::Channel $channel)
Irssi::Channel::nick_insert(Irssi::Channel $channel, Irssi::Nick $nick)
Irssi::Channel::nick_remove(Irssi::Channel $channel, Irssi::Nick $nick)
Irssi::Channel::nick_find(Irssi::Channel $channel, string $nick)
Irssi::Channel::nick_find_mask(Irssi::Channel $channel, string $mask)
Irssi::Channel::nicks(Irssi::Channel $channel)
Irssi::Server::channels(Irssi::Server $server)
Irssi::Server::channels_join(Irssi::Server $server, string $channels, int $automatic)
Irssi::Server::channel_find(Irssi::Server $server, string $name)
Irssi::Server::nicks_get_same(Irssi::Server $server, string $nick)
Irssi::channels()
Irssi::channel_find(string $channel)
Irssi::Server::parse_special(Irssi::Server $server, string $cmd, string $data, int $flags)
Irssi::Server::command(Irssi::Server $server, string $cmd)
Irssi::signal_emit(string $signal, ...)
Irssi::signal_continue(...)
Irssi::signal_add(...)
Irssi::signal_add_first(...)
Irssi::signal_add_last(...)
Irssi::signal_add_priority(...)
Irssi::signal_register(...)
Irssi::SIGNAL_PRIORITY_LOW()
Irssi::SIGNAL_PRIORITY_DEFAULT()
Irssi::SIGNAL_PRIORITY_HIGH()
Irssi::signal_remove(string $signal, SVptr $func)
Irssi::signal_stop()
Irssi::signal_stop_by_name(string $signal)
Irssi::signal_get_emitted()
Irssi::signal_get_emitted_id()
Irssi::timeout_add(int $msecs, SVptr $func, SVptr $data)
Irssi::timeout_add_once(int $msecs, SVptr $func, SVptr $data)
Irssi::timeout_remove(int $tag)
Irssi::INPUT_READ()
Irssi::INPUT_WRITE()
Irssi::input_add(int $source, int $condition, SVptr $func, SVptr $data)
Irssi::input_remove(int $tag)
Irssi::MSGLEVEL_CRAP()
Irssi::MSGLEVEL_MSGS()
Irssi::MSGLEVEL_PUBLIC()
Irssi::MSGLEVEL_NOTICES()
Irssi::MSGLEVEL_SNOTES()
Irssi::MSGLEVEL_CTCPS()
Irssi::MSGLEVEL_ACTIONS()
Irssi::MSGLEVEL_JOINS()
Irssi::MSGLEVEL_PARTS()
Irssi::MSGLEVEL_QUITS()
Irssi::MSGLEVEL_KICKS()
Irssi::MSGLEVEL_MODES()
Irssi::MSGLEVEL_TOPICS()
Irssi::MSGLEVEL_WALLOPS()
Irssi::MSGLEVEL_INVITES()
Irssi::MSGLEVEL_NICKS()
Irssi::MSGLEVEL_DCC()
Irssi::MSGLEVEL_DCCMSGS()
Irssi::MSGLEVEL_CLIENTNOTICE()
Irssi::MSGLEVEL_CLIENTCRAP()
Irssi::MSGLEVEL_CLIENTERROR()
Irssi::MSGLEVEL_HILIGHT()
Irssi::MSGLEVEL_ALL()
Irssi::MSGLEVEL_NOHILIGHT()
Irssi::MSGLEVEL_NO_ACT()
Irssi::MSGLEVEL_NEVER()
Irssi::MSGLEVEL_LASTLOG()
Irssi::level2bits(string $str)
Irssi::bits2level(int $bits)
Irssi::combine_level(int $level, string $str)
Irssi::command(string $cmd)
Irssi::commands()
Irssi::command_bind_first(...)
Irssi::command_bind(...)
Irssi::command_bind_last(...)
Irssi::command_runsub(string $cmd, string $data, Irssi::Server $server, Irssi::Windowitem $item)
Irssi::command_unbind(string $cmd, SVptr $func)
Irssi::command_set_options(string $cmd, string $options)
Irssi::command_parse_options(string $cmd, string $data)
Irssi::pidwait_add(int $pid)
Irssi::pidwait_remove(int $pid)
Irssi::parse_special(string $cmd, string $data, int $flags)
Irssi::get_irssi_dir()
Irssi::get_irssi_config()
Irssi::get_irssi_binary()
Irssi::version()
Irssi::get_gui()
Irssi::IRSSI_GUI_NONE()
Irssi::IRSSI_GUI_TEXT()
Irssi::IRSSI_GUI_GTK()
Irssi::IRSSI_GUI_GNOME()
Irssi::IRSSI_GUI_QT()
Irssi::IRSSI_GUI_KDE()
Irssi::Windowitem::parse_special(Irssi::Windowitem $item, string $cmd, string $data, int $flags)
Irssi::Windowitem::command(Irssi::Windowitem $item, string $cmd)
Irssi::expando_create(string $key, SVptr $func, SVptr $signals)
Irssi::expando_destroy(string $name)
Irssi::Server::ignore_check(Irssi::Server $server, string $nick, string $host, string $channel, string $text, int $level)
Irssi::ignores()
Irssi::ignore_check(string $nick, string $host, string $channel, string $text, int $level)
Irssi::Ignore::add_rec(Irssi::Ignore $rec)
Irssi::Ignore::update_rec(Irssi::Ignore $rec)
Irssi::init()
Irssi::deinit()
Irssi::logs()
Irssi::log_create_rec(string $fname, int $level)
Irssi::log_find(string $fname)
Irssi::Log::item_add(Irssi::Log $log, int $type, string $name, string $servertag)
Irssi::Log::item_destroy(Irssi::Log $log, Irssi::Logitem $item)
Irssi::Log::item_find(Irssi::Log $log, int $type, string $item, string $servertag)
Irssi::Log::update(Irssi::Log $log)
Irssi::Log::close(Irssi::Log $log)
Irssi::Log::write_rec(Irssi::Log $log, string $str, int $level)
Irssi::Log::start_logging(Irssi::Log $log)
Irssi::Log::stop_logging(Irssi::Log $log)
Irssi::Server::mask_match(Irssi::Server $server, string $mask, string $nick, string $user, string $host)
Irssi::Server::mask_match_address(Irssi::Server $server, string $mask, string $nick, string $address)
Irssi::Server::masks_match(Irssi::Server $server, string $masks, string $nick, string $address)
Irssi::mask_match(string $mask, string $nick, string $user, string $host)
Irssi::mask_match_address(string $mask, string $nick, string $address)
Irssi::masks_match(string $masks, string $nick, string $address)
Irssi::Query::destroy(Irssi::Query $query)
Irssi::Query::change_server(Irssi::Query $query, Irssi::Server $server)
Irssi::Server::queries(Irssi::Server $server)
Irssi::Server::query_find(Irssi::Server $server, string $nick)
Irssi::queries()
Irssi::query_find(string $nick)
Irssi::rawlog_set_size(int $lines)
Irssi::rawlog_create()
Irssi::Rawlog::get_lines(Irssi::Rawlog $rawlog)
Irssi::Rawlog::destroy(Irssi::Rawlog $rawlog)
Irssi::Rawlog::input(Irssi::Rawlog $rawlog, string $str)
Irssi::Rawlog::output(Irssi::Rawlog $rawlog, string $str)
Irssi::Rawlog::redirect(Irssi::Rawlog $rawlog, string $str)
Irssi::Rawlog::open(Irssi::Rawlog $rawlog, string $fname)
Irssi::Rawlog::close(Irssi::Rawlog $rawlog)
Irssi::Rawlog::save(Irssi::Rawlog $rawlog, string $fname)
Irssi::Server::disconnect(Irssi::Server $server)
Irssi::Server::ref(Irssi::Server $server)
Irssi::Server::unref(Irssi::Server $server)
Irssi::Server::isnickflag(Irssi::Server $server, char $flag)
Irssi::Server::ischannel(Irssi::Server $server, string $data)
Irssi::Server::get_nick_flags(Irssi::Server $server)
Irssi::Server::send_message(Irssi::Server $server, string $target, string $msg, int $target_type)
Irssi::servers()
Irssi::reconnects()
Irssi::chatnets()
Irssi::server_create_conn(int $chat_type, string $dest, int $port, string $chatnet, string $password, string $nick)
Irssi::server_find_tag(string $tag)
Irssi::server_find_chatnet(string $chatnet)
Irssi::chatnet_find(string $name)
Irssi::settings_get_str(string $key)
Irssi::settings_get_int(string $key)
Irssi::settings_get_bool(string $key)
Irssi::settings_get_time(string $key)
Irssi::settings_get_level(string $key)
Irssi::settings_get_size(string $key)
Irssi::settings_set_str(string $key, string $value)
Irssi::settings_set_int(string $key, int $value)
Irssi::settings_set_bool(string $key, int $value)
Irssi::settings_set_time(string $key, string $value)
Irssi::settings_set_level(string $key, string $value)
Irssi::settings_set_size(string $key, string $value)
Irssi::settings_add_str(string $section, string $key, string $def)
Irssi::settings_add_int(string $section, string $key, int $def)
Irssi::settings_add_bool(string $section, string $key, int $def)
Irssi::settings_add_time(string $section, string $key, string $def)
Irssi::settings_add_level(string $section, string $key, string $def)
Irssi::settings_add_size(string $section, string $key, string $def)
Irssi::settings_remove(string $key)
Irssi::Irc::get_mask(string $nick, string $address, int $flags)
Irssi::Irc::MASK_NICK()
Irssi::Irc::MASK_USER()
Irssi::Irc::MASK_HOST()
Irssi::Irc::MASK_DOMAIN()
Irssi::Irc::Channel::bans(Irssi::Irc::Channel $channel)
Irssi::Irc::Channel::nick_insert(Irssi::Irc::Channel $channel, string $nick, int $op, int $halfop, int $voice, int $send_massjoin)
Irssi::ctcp_register(string $name)
Irssi::ctcp_unregister(string $name)
Irssi::Irc::Server::ctcp_send_reply(Irssi::Irc::Server $server, string $data)
Irssi::Irc::Dcc::init_rec(Irssi::Irc::Dcc $dcc, Irssi::Irc::Server $server, Irssi::Irc::Dcc::Chat $chat, string $nick, string $arg)
Irssi::Irc::Dcc::destroy(Irssi::Irc::Dcc $dcc)
Irssi::Irc::Dcc::close(Irssi::Irc::Dcc $dcc)
Irssi::Irc::Dcc::reject(Irssi::Irc::Dcc $dcc, Irssi::Irc::Server $server)
Irssi::Irc::dccs()
Irssi::Irc::dcc_register_type(string $type)
Irssi::Irc::dcc_unregister_type(string $type)
Irssi::Irc::dcc_str2type(string $str)
Irssi::Irc::dcc_type2str(int $type)
Irssi::Irc::dcc_find_request_latest(int $type)
Irssi::Irc::dcc_find_request(int $type, string $nick, string $arg)
Irssi::Irc::dcc_chat_find_id(string $id)
Irssi::Irc::dcc_chat_send(Irssi::Irc::Dcc::Chat $dcc, string $data)
Irssi::Irc::dcc_ctcp_message(Irssi::Irc::Server $server, string $target, Irssi::Irc::Dcc::Chat $chat, int $notice, string $msg)
Irssi::Irc::dcc_get_download_path(string $fname)
Irssi::Windowitem::get_dcc(Irssi::Windowitem $item)
Irssi::Irc::init()
Irssi::Irc::deinit()
Irssi::Irc::modes_join(Irssi::Irc::Server $server, string $old, string $mode, int $channel)
Irssi::Irc::Channel::ban_get_mask(Irssi::Irc::Channel $channel, string $nick, int $ban_type)
Irssi::Irc::Channel::banlist_add(Irssi::Irc::Channel $channel, string $ban, string $nick, time_t $time)
Irssi::Irc::Channel::banlist_remove(Irssi::Irc::Channel $channel, string $ban, string $nick)
Irssi::Irc::Server::netsplit_find(Irssi::Irc::Server $server, string $nick, string $address)
Irssi::Irc::Server::netsplit_find_channel(Irssi::Irc::Server $server, string $nick, string $address, string $channel)
Irssi::Irc::notifies()
Irssi::Irc::notifylist_add(string $mask, string $ircnets, int $away_check, int $idle_check_time)
Irssi::Irc::notifylist_remove(string $mask)
Irssi::Irc::notifylist_ison(string $nick, string $serverlist)
Irssi::Irc::notifylist_find(string $mask, string $ircnet)
Irssi::Irc::Notifylist::ircnets_match(Irssi::Irc::Notifylist $rec, string $ircnet)
Irssi::Irc::Server::notifylist_ison_server(Irssi::Irc::Server $server, string $nick)
Irssi::Irc::Server::query_create(string $server_tag, string $nick, int $automatic)
Irssi::Irc::Server::get_channels(Irssi::Irc::Server $server)
Irssi::Irc::Server::send_raw(Irssi::Irc::Server $server, string $cmd)
Irssi::Irc::Server::send_raw_now(Irssi::Irc::Server $server, string $cmd)
Irssi::Irc::Server::send_raw_first(Irssi::Irc::Server $server, string $cmd)
Irssi::Irc::Server::send_raw_split(Irssi::Irc::Server $server, string $cmd, int $nickarg, int $max_nicks)
Irssi::Irc::Server::redirect_register(string $command, int $remote, int $timeout, SVptr $start, SVptr $stop, SVptr $opt)
Irssi::Irc::Server::redirect_event(Irssi::Irc::Server $server, string $command, int $count, string $arg, int $remote, string $failure_signal, SVptr $signals)
Irssi::Irc::Server::redirect_get_signal(Irssi::Irc::Server $server, string $prefix, string $event, string $args)
Irssi::Irc::Server::redirect_peek_signal(Irssi::Irc::Server $server, string $prefix, string $event, string $args)
Irssi::Irc::Server::isupport(Irssi::Irc::Server $server, string $name)
Irssi::statusbar_item_register(string $name, string $value, string $func)
Irssi::statusbar_item_unregister(string $name)
Irssi::statusbar_items_redraw(string $name)
Irssi::statusbars_recreate_items()
Irssi::TextUI::StatusbarItem::default_handler(Irssi::TextUI::StatusbarItem $item, int $get_size_only, string $str, string $data, int $escape_vars)
Irssi::TextUI::Line::prev(Irssi::TextUI::Line $line)
Irssi::TextUI::Line::next(Irssi::TextUI::Line $line)
Irssi::TextUI::Line::get_text(Irssi::TextUI::Line $line, int $coloring)
Irssi::TextUI::TextBufferView::set_default_indent(Irssi::TextUI::TextBufferView $view, int $default_indent, int $longword_noindent)
Irssi::TextUI::TextBufferView::set_scroll(Irssi::TextUI::TextBufferView $view, int $scroll)
Irssi::TextUI::TextBufferView::clear(Irssi::TextUI::TextBufferView $view)
Irssi::TextUI::TextBufferView::get_lines(Irssi::TextUI::TextBufferView $view)
Irssi::TextUI::TextBufferView::scroll(Irssi::TextUI::TextBufferView $view, int $lines)
Irssi::TextUI::TextBufferView::scroll_line(Irssi::TextUI::TextBufferView $view, Irssi::TextUI::Line $line)
Irssi::TextUI::TextBufferView::get_line_cache(Irssi::TextUI::TextBufferView $view, Irssi::TextUI::Line $line)
Irssi::TextUI::TextBufferView::remove_line(Irssi::TextUI::TextBufferView $view, Irssi::TextUI::Line $line)
Irssi::TextUI::TextBufferView::remove_all_lines(Irssi::TextUI::TextBufferView $view)
Irssi::TextUI::TextBufferView::set_bookmark(Irssi::TextUI::TextBufferView $view, string $name, Irssi::TextUI::Line $line)
Irssi::TextUI::TextBufferView::set_bookmark_bottom(Irssi::TextUI::TextBufferView $view, string $name)
Irssi::TextUI::TextBufferView::get_bookmark(Irssi::TextUI::TextBufferView $view, string $name)
Irssi::TextUI::TextBufferView::redraw(Irssi::TextUI::TextBufferView $view)
Irssi::UI::Window::view(Irssi::UI::Window $window)
Irssi::gui_printtext(int $xpos, int $ypos, string $str)
Irssi::gui_input_set(string $str)
Irssi::gui_input_get_pos()
Irssi::gui_input_set_pos(int $pos)
Irssi::UI::Server::gui_printtext_after(Irssi::Server $server, string $target, Irssi::TextUI::Line $prev, int $level, string $str)
Irssi::UI::Server::term_refresh_freeze()
Irssi::UI::Server::term_refresh_thaw()
Irssi::UI::Window::print_after(Irssi::UI::Window $window, Irssi::TextUI::Line $prev, int $level, string $str)
Irssi::UI::Window::gui_printtext_after(Irssi::UI::Window $window, Irssi::TextUI::Line $prev, int $level, string $str)
Irssi::UI::Window::last_line_insert(Irssi::UI::Window $window)
Irssi::TextUI::init()
Irssi::TextUI::deinit()
Irssi::Server::format_create_dest(Irssi::Server $server, string $target, int $level, Irssi::UI::Window $window)
Irssi::format_get_length(string $str)
Irssi::format_real_length(string $str, int $len)
Irssi::strip_codes(string $input)
Irssi::format_create_dest(string $target, int $level, Irssi::UI::Window $window)
Irssi::Window::format_create_dest(Irssi::UI::Window $window, int $level)
Irssi::UI::Window::format_get_text(Irssi::UI::Window $window, string $module, Irssi::Server $server, string $target, int $formatnum, ...)
Irssi::UI::TextDest::print(Irssi::UI::TextDest $dest, string $str)
Irssi::UI::Theme::format_expand(Irssi::UI::Theme $theme, string $format, int $flags)
Irssi::UI::Theme::get_format(Irssi::UI::Theme $theme, string $module, string $tag)
Irssi::Server::printformat(Irssi::Server $server, string $target, int $level, string $format, ...)
Irssi::current_theme()
Irssi::EXPAND_FLAG_IGNORE_REPLACES()
Irssi::EXPAND_FLAG_IGNORE_EMPTY()
Irssi::EXPAND_FLAG_RECURSIVE_MASK()
Irssi::theme_register(SVptr $formats)
Irssi::printformat(int $level, string $format, ...)
Irssi::abstracts_register(SVptr $abstracts)
Irssi::themes_reload()
Irssi::UI::Window::printformat(Irssi::UI::Window $window, int $level, string $format, ...)
Irssi::Windowitem::printformat(Irssi::Windowitem $item, int $level, string $format, ...)
Irssi::UI::processes()
Irssi::UI::init()
Irssi::UI::deinit()
Irssi::Server::print(Irssi::Server $server, string $channel, string $str, int $level)
Irssi::Server::window_item_find(Irssi::Server $server, string $name)
Irssi::Server::window_find_item(Irssi::Server $server, string $name)
Irssi::Server::window_find_level(Irssi::Server $server, int $level)
Irssi::Server::window_find_closest(Irssi::Server $server, string $name, int $level)
Irssi::windows()
Irssi::active_win()
Irssi::active_server()
Irssi::print(string $str, int $level)
Irssi::window_find_name(string $name)
Irssi::window_find_refnum(int $refnum)
Irssi::window_refnum_prev(int $refnum, int $wrap)
Irssi::window_refnum_next(int $refnum, int $wrap)
Irssi::windows_refnum_last()
Irssi::window_find_level(int $level)
Irssi::window_find_item(string $name)
Irssi::window_find_closest(string $name, int $level)
Irssi::window_item_find(string $name)
Irssi::UI::Window::items(Irssi::UI::Window $window)
Irssi::UI::Window::print(Irssi::UI::Window $window, string $str, int $level)
Irssi::UI::Window::command(Irssi::UI::Window $window, string $cmd)
Irssi::UI::Window::item_add(Irssi::UI::Window $window, Irssi::Windowitem $item, int $automatic)
Irssi::UI::Window::item_remove(Irssi::Windowitem $item)
Irssi::UI::Window::item_destroy(Irssi::Windowitem $item)
Irssi::UI::Window::item_prev(Irssi::UI::Window $window)
Irssi::UI::Window::item_next(Irssi::UI::Window $window)
Irssi::UI::Window::destroy(Irssi::UI::Window $window)
Irssi::UI::Window::set_active(Irssi::UI::Window $window)
Irssi::UI::Window::change_server(Irssi::UI::Window $window, Irssi::Server $server)
Irssi::UI::Window::set_refnum(Irssi::UI::Window $window, int $refnum)
Irssi::UI::Window::set_name(Irssi::UI::Window $window, string $name)
Irssi::UI::Window::set_history(Irssi::UI::Window $window, string $name)
Irssi::UI::Window::set_level(Irssi::UI::Window $window, int $level)
Irssi::UI::Window::activity(Irssi::UI::Window $window, int $data_level, string $hilight_color)
Irssi::UI::Window::get_active_name(Irssi::UI::Window $window)
Irssi::UI::Window::item_find(Irssi::UI::Window $window, Irssi::Server $server, string $name)
Irssi::UI::Window::get_history_lines(Irssi::UI::Window $window)
Irssi::Windowitem::print(Irssi::Windowitem $item, string $str, int $level)
Irssi::Windowitem::window_create(Irssi::Windowitem $item, int $automatic)
Irssi::Windowitem::window(Irssi::Windowitem $item)
Irssi::Windowitem::change_server(Irssi::Windowitem $item, Irssi::Server $server)
Irssi::Windowitem::is_active(Irssi::Windowitem $item)
Irssi::Windowitem::set_active(Irssi::Windowitem $item)
Irssi::Windowitem::activity(Irssi::Windowitem $item, int $data_level, string $hilight_color)
=back

[irssibot]

• • • Comment 1283 by @shabble

I've recently moved the doc project to a wiki hosted on github at https://github.com/shabble/irssi-docs/wiki

Happily, it's git-backed, and is using mostly-unmangled POD still as the doc source, so there's a chance of it being folded into the project some way down the line when it's good enough.