xsfuncs_args - shabble/irssi-docs GitHub Wiki

Complete list of exposed Irssi functions

These have been extracted automatically from the Irssi source via a script and may not be 100% accurate or useful. In most cases, useful ones have been documented elsewhere on this wiki, try starting at I‌rssi.

Functions marked with a * prefix, especially the *::(de)?init funcions, are unlikely to be of any use in normal scripting, and will probably remain undocumented. Calling the from within in a script is likely to lead to at best undefined behaviour, and at worst, segfaults and potential data corruption.


   # Flags for Format expansion
   Irssi :: EXPAND_FLAG_IGNORE_EMPTY
   Irssi :: EXPAND_FLAG_IGNORE_REPLACES
   Irssi :: EXPAND_FLAG_RECURSIVE_MASK
   
   # Flags for IO Poll Management
   Irssi :: INPUT_READ
   Irssi :: INPUT_WRITE

   # Flags for determining the type of frontend Irssi is using
   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 :: 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 :: SIGNAL_PRIORITY_DEFAULT
   Irssi :: SIGNAL_PRIORITY_HIGH
   Irssi :: SIGNAL_PRIORITY_LOW
   Irssi :: abstracts_register(SVptr $abstracts)
   Irssi :: active_server()
   Irssi :: active_win()
   Irssi :: bits2level(int $bits)
   Irssi :: channel_find(string $channel)
   Irssi :: channels()
   Irssi :: chatnet_find(string $name)
   Irssi :: chatnets()
   Irssi :: combine_level(int $level, string $str)
   Irssi :: command(string $cmd)
   Irssi :: command_bind(...)
   Irssi :: command_bind_first(...)
   Irssi :: command_bind_last(...)
   Irssi :: command_parse_options(string $cmd, string $data)
   Irssi :: command_runsub(string $cmd, string $data, Irssi::Server $server, Irssi::Windowitem $item)
   Irssi :: command_set_options(string $cmd, string $options)
   Irssi :: command_unbind(string $cmd, SVptr $func)
   Irssi :: commands()
   Irssi :: ctcp_register(string $name)
   Irssi :: ctcp_unregister(string $name)
   Irssi :: current_theme()
 * Irssi :: deinit()
   Irssi :: expando_create(string $key, SVptr $func, SVptr $signals)
   Irssi :: expando_destroy(string $name)
   Irssi :: format_create_dest(string $target, int $level, Irssi::UI::Window $window)
   Irssi :: format_get_length(string $str)
   Irssi :: format_real_length(string $str, int $len)
   Irssi :: get_gui()
   Irssi :: get_irssi_binary()
   Irssi :: get_irssi_config()
   Irssi :: get_irssi_dir()
   Irssi :: gui_input_get_pos()
   Irssi :: gui_input_set(string $str)
   Irssi :: gui_input_set_pos(int $pos)
   Irssi :: gui_printtext(int $xpos, int $ypos, string $str)
   Irssi :: ignore_check(string $nick, string $host, string $channel, string $text, int $level)
   Irssi :: ignores()
 * Irssi :: init()
   Irssi :: input_add(int $source, int $condition, SVptr $func, SVptr $data)
   Irssi :: input_remove(int $tag)
   Irssi :: level2bits(string $str)
   Irssi :: log_create_rec(string $fname, int $level)
   Irssi :: log_find(string $fname)
   Irssi :: logs()
   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 :: parse_special(string $cmd, string $data, int $flags)
   Irssi :: pidwait_add(int $pid)
   Irssi :: pidwait_remove(int $pid)
   Irssi :: print(string $str, int $level)
   Irssi :: printformat(int $level, string $format, ...)
   Irssi :: queries()
   Irssi :: query_find(string $nick)
   Irssi :: rawlog_create()
   Irssi :: rawlog_set_size(int $lines)
   Irssi :: reconnects()
   Irssi :: server_create_conn(int $chat_type, string $dest, int $port, string $chatnet, string $password, string $nick)
   Irssi :: server_find_chatnet(string $chatnet)
   Irssi :: server_find_tag(string $tag)
   Irssi :: servers()
   Irssi :: settings_add_bool(string $section, string $key, int $def)
   Irssi :: settings_add_int(string $section, string $key, int $def)
   Irssi :: settings_add_level(string $section, string $key, string $def)
   Irssi :: settings_add_size(string $section, string $key, string $def)
   Irssi :: settings_add_str(string $section, string $key, string $def)
   Irssi :: settings_add_time(string $section, string $key, string $def)
   Irssi :: settings_get_bool(string $key)
   Irssi :: settings_get_int(string $key)
   Irssi :: settings_get_level(string $key)
   Irssi :: settings_get_size(string $key)
   Irssi :: settings_get_str(string $key)
   Irssi :: settings_get_time(string $key)
   Irssi :: settings_remove(string $key)
   Irssi :: settings_set_bool(string $key, int $value)
   Irssi :: settings_set_int(string $key, int $value)
   Irssi :: settings_set_level(string $key, string $value)
   Irssi :: settings_set_size(string $key, string $value)
   Irssi :: settings_set_str(string $key, string $value)
   Irssi :: settings_set_time(string $key, string $value)
   Irssi :: signal_add(...)
   Irssi :: signal_add_first(...)
   Irssi :: signal_add_last(...)
   Irssi :: signal_add_priority(...)
   Irssi :: signal_continue(...)
   Irssi :: signal_emit(string $signal, ...)
   Irssi :: signal_get_emitted()
   Irssi :: signal_get_emitted_id()
   Irssi :: signal_register(...)
   Irssi :: signal_remove(string $signal, SVptr $func)
   Irssi :: signal_stop()
   Irssi :: signal_stop_by_name(string $signal)
   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 :: strip_codes(string $input)
   Irssi :: theme_register(SVptr $formats)
   Irssi :: themes_reload()
   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 :: version()
   Irssi :: window_find_closest(string $name, int $level)
   Irssi :: window_find_item(string $name)
   Irssi :: window_find_level(int $level)
   Irssi :: window_find_name(string $name)
   Irssi :: window_find_refnum(int $refnum)
   Irssi :: window_item_find(string $name)
   Irssi :: window_refnum_next(int $refnum, int $wrap)
   Irssi :: window_refnum_prev(int $refnum, int $wrap)
   Irssi :: windows()
   Irssi :: windows_refnum_last()
   Irssi::Channel :: destroy(Irssi::Channel $channel)
   Irssi::Channel :: nick_find(Irssi::Channel $channel, string $nick)
   Irssi::Channel :: nick_find_mask(Irssi::Channel $channel, string $mask)
   Irssi::Channel :: nick_insert(Irssi::Channel $channel, Irssi::Nick $nick)
   Irssi::Channel :: nick_remove(Irssi::Channel $channel, Irssi::Nick $nick)
   Irssi::Channel :: nicks(Irssi::Channel $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::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::Ignore :: add_rec(Irssi::Ignore $rec)
   Irssi::Ignore :: update_rec(Irssi::Ignore $rec)
   Irssi::Irc :: MASK_DOMAIN
   Irssi::Irc :: MASK_HOST
   Irssi::Irc :: MASK_NICK
   Irssi::Irc :: MASK_USER
   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_find_request(int $type, string $nick, string $arg)
   Irssi::Irc :: dcc_find_request_latest(int $type)
   Irssi::Irc :: dcc_get_download_path(string $fname)
   Irssi::Irc :: dcc_register_type(string $type)
   Irssi::Irc :: dcc_str2type(string $str)
   Irssi::Irc :: dcc_type2str(int $type)
   Irssi::Irc :: dcc_unregister_type(string $type)
   Irssi::Irc :: dccs()
 * Irssi::Irc :: deinit()
   Irssi::Irc :: get_mask(string $nick, string $address, int $flags)
 * Irssi::Irc :: init()
   Irssi::Irc :: modes_join(Irssi::Irc::Server $server, string $old, string $mode, int $channel)
   Irssi::Irc :: notifies()
   Irssi::Irc :: notifylist_add(string $mask, string $ircnets, int $away_check, int $idle_check_time)
   Irssi::Irc :: notifylist_find(string $mask, string $ircnet)
   Irssi::Irc :: notifylist_ison(string $nick, string $serverlist)
   Irssi::Irc :: notifylist_remove(string $mask)
   Irssi::Irc::Dcc :: close(Irssi::Irc::Dcc $dcc)
   Irssi::Irc::Dcc :: destroy(Irssi::Irc::Dcc $dcc)
   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 :: reject(Irssi::Irc::Dcc $dcc, Irssi::Irc::Server $server)
   Irssi::Irc::Notifylist :: ircnets_match(Irssi::Irc::Notifylist $rec, string $ircnet)
   Irssi::Irc::Server :: ctcp_send_reply(Irssi::Irc::Server $server, string $data)
   Irssi::Irc::Server :: get_channels(Irssi::Irc::Server $server)
   Irssi::Irc::Server :: isupport(Irssi::Irc::Server $server, string $name)
   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::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 :: 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 :: redirect_register(string $command, int $remote, int $timeout, SVptr $start, SVptr $stop, SVptr $opt)
   Irssi::Irc::Server :: send_raw(Irssi::Irc::Server $server, string $cmd)
   Irssi::Irc::Server :: send_raw_first(Irssi::Irc::Server $server, string $cmd)
   Irssi::Irc::Server :: send_raw_now(Irssi::Irc::Server $server, string $cmd)
   Irssi::Irc::Server :: send_raw_split(Irssi::Irc::Server $server, string $cmd, int $nickarg, int $max_nicks)
   Irssi::Log :: close(Irssi::Log $log)
   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 :: start_logging(Irssi::Log $log)
   Irssi::Log :: stop_logging(Irssi::Log $log)
   Irssi::Log :: update(Irssi::Log $log)
   Irssi::Log :: write_rec(Irssi::Log $log, string $str, int $level)
   Irssi::Query :: change_server(Irssi::Query $query, Irssi::Server $server)
   Irssi::Query :: destroy(Irssi::Query $query)
   Irssi::Rawlog :: close(Irssi::Rawlog $rawlog)
   Irssi::Rawlog :: destroy(Irssi::Rawlog $rawlog)
   Irssi::Rawlog :: get_lines(Irssi::Rawlog $rawlog)
   Irssi::Rawlog :: input(Irssi::Rawlog $rawlog, string $str)
   Irssi::Rawlog :: open(Irssi::Rawlog $rawlog, string $fname)
   Irssi::Rawlog :: output(Irssi::Rawlog $rawlog, string $str)
   Irssi::Rawlog :: redirect(Irssi::Rawlog $rawlog, string $str)
   Irssi::Rawlog :: save(Irssi::Rawlog $rawlog, string $fname)
   Irssi::Server :: channel_find(Irssi::Server $server, string $name)
   Irssi::Server :: channels(Irssi::Server $server)
   Irssi::Server :: channels_join(Irssi::Server $server, string $channels, int $automatic)
   Irssi::Server :: command(Irssi::Server $server, string $cmd)
   Irssi::Server :: disconnect(Irssi::Server $server)
   Irssi::Server :: format_create_dest(Irssi::Server $server, string $target, int $level, Irssi::UI::Window $window)
   Irssi::Server :: get_nick_flags(Irssi::Server $server)
   Irssi::Server :: ignore_check(Irssi::Server $server, string $nick, string $host, string $channel, string $text, int $level)
   Irssi::Server :: ischannel(Irssi::Server $server, string $data)
   Irssi::Server :: isnickflag(Irssi::Server $server, char $flag)
   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::Server :: nicks_get_same(Irssi::Server $server, string $nick)
   Irssi::Server :: parse_special(Irssi::Server $server, string $cmd, string $data, int $flags)
   Irssi::Server :: print(Irssi::Server $server, string $channel, string $str, int $level)
   Irssi::Server :: printformat(Irssi::Server $server, string $target, int $level, string $format, ...)
   Irssi::Server :: queries(Irssi::Server $server)
   Irssi::Server :: query_find(Irssi::Server $server, string $nick)
   Irssi::Server :: ref(Irssi::Server $server)
   Irssi::Server :: send_message(Irssi::Server $server, string $target, string $msg, int $target_type)
   Irssi::Server :: unref(Irssi::Server $server)
   Irssi::Server :: window_find_closest(Irssi::Server $server, string $name, int $level)
   Irssi::Server :: window_find_item(Irssi::Server $server, string $name)
   Irssi::Server :: window_find_level(Irssi::Server $server, int $level)
   Irssi::Server :: window_item_find(Irssi::Server $server, string $name)
 * Irssi::TextUI :: deinit()
 * Irssi::TextUI :: init()
   Irssi::TextUI::Line :: get_text(Irssi::TextUI::Line $line, int $coloring)
   Irssi::TextUI::Line :: next(Irssi::TextUI::Line $line)
   Irssi::TextUI::Line :: prev(Irssi::TextUI::Line $line)
   Irssi::TextUI::StatusbarItem :: default_handler(Irssi::TextUI::StatusbarItem $item, int $get_size_only, string $str, string $data, int $escape_vars)
   Irssi::TextUI::TextBufferView :: clear(Irssi::TextUI::TextBufferView $view)
   Irssi::TextUI::TextBufferView :: get_bookmark(Irssi::TextUI::TextBufferView $view, string $name)
   Irssi::TextUI::TextBufferView :: get_line_cache(Irssi::TextUI::TextBufferView $view, Irssi::TextUI::Line $line)
   Irssi::TextUI::TextBufferView :: get_lines(Irssi::TextUI::TextBufferView $view)
   Irssi::TextUI::TextBufferView :: redraw(Irssi::TextUI::TextBufferView $view)
   Irssi::TextUI::TextBufferView :: remove_all_lines(Irssi::TextUI::TextBufferView $view)
   Irssi::TextUI::TextBufferView :: remove_line(Irssi::TextUI::TextBufferView $view, Irssi::TextUI::Line $line)
   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 :: 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 :: 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::UI :: deinit()
 * Irssi::UI :: init()
   Irssi::UI :: processes()
   Irssi::UI::Server :: gui_printtext_after(Irssi::Server $server, string $target, Irssi::TextUI::Line $prev, int $level, string $str, time_t $time)
   Irssi::UI::Server :: term_refresh_freeze()
   Irssi::UI::Server :: term_refresh_thaw()
   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::Window :: format_create_dest(Irssi::UI::Window $window, int $level)
   Irssi::UI::Window :: activity(Irssi::UI::Window $window, int $data_level, string $hilight_color)
   Irssi::UI::Window :: change_server(Irssi::UI::Window $window, Irssi::Server $server)
   Irssi::UI::Window :: command(Irssi::UI::Window $window, string $cmd)
   Irssi::UI::Window :: destroy(Irssi::UI::Window $window)
   Irssi::UI::Window :: format_get_text(Irssi::UI::Window $window, string $module, Irssi::Server $server, string $target, int $formatnum, ...)
   Irssi::UI::Window :: get_active_name(Irssi::UI::Window $window)
   Irssi::UI::Window :: get_history_lines(Irssi::UI::Window $window)
   Irssi::UI::Window :: gui_printtext_after(Irssi::UI::Window $window, Irssi::TextUI::Line $prev, int $level, string $str, time_t $time)
   Irssi::UI::Window :: item_add(Irssi::UI::Window $window, Irssi::Windowitem $item, int $automatic)
   Irssi::UI::Window :: item_destroy(Irssi::Windowitem $item)
   Irssi::UI::Window :: item_find(Irssi::UI::Window $window, Irssi::Server $server, string $name)
   Irssi::UI::Window :: item_next(Irssi::UI::Window $window)
   Irssi::UI::Window :: item_prev(Irssi::UI::Window $window)
   Irssi::UI::Window :: item_remove(Irssi::Windowitem $item)
   Irssi::UI::Window :: items(Irssi::UI::Window $window)
   Irssi::UI::Window :: last_line_insert(Irssi::UI::Window $window)
   Irssi::UI::Window :: print(Irssi::UI::Window $window, string $str, int $level)
   Irssi::UI::Window :: print_after(Irssi::UI::Window $window, Irssi::TextUI::Line $prev, int $level, string $str, time_t $time)
   Irssi::UI::Window :: printformat(Irssi::UI::Window $window, int $level, string $format, ...)
   Irssi::UI::Window :: set_active(Irssi::UI::Window $window)
   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 :: set_name(Irssi::UI::Window $window, string $name)
   Irssi::UI::Window :: set_refnum(Irssi::UI::Window $window, int $refnum)
   Irssi::UI::Window :: view(Irssi::UI::Window $window)
   Irssi::Windowitem :: activity(Irssi::Windowitem $item, int $data_level, string $hilight_color)
   Irssi::Windowitem :: change_server(Irssi::Windowitem $item, Irssi::Server $server)
   Irssi::Windowitem :: command(Irssi::Windowitem $item, string $cmd)
   Irssi::Windowitem :: get_dcc(Irssi::Windowitem $item)
   Irssi::Windowitem :: is_active(Irssi::Windowitem $item)
   Irssi::Windowitem :: parse_special(Irssi::Windowitem $item, string $cmd, string $data, int $flags)
   Irssi::Windowitem :: print(Irssi::Windowitem $item, string $str, int $level)
   Irssi::Windowitem :: printformat(Irssi::Windowitem $item, int $level, string $format, ...)
   Irssi::Windowitem :: set_active(Irssi::Windowitem $item)
   Irssi::Windowitem :: window(Irssi::Windowitem $item)
   Irssi::Windowitem :: window_create(Irssi::Windowitem $item, int $automatic)
⚠️ **GitHub.com Fallback** ⚠️