diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 20:18:39 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 20:18:39 +0000 |
| commit | fff5217f02d91268ce90c8c05665602c059faaef (patch) | |
| tree | 2ba24d32dc96eafe7ed0a85269548e76796d849d /docs/help | |
| parent | Initial commit. (diff) | |
| download | irssi-fff5217f02d91268ce90c8c05665602c059faaef.tar.xz irssi-fff5217f02d91268ce90c8c05665602c059faaef.zip | |
Adding upstream version 1.4.5.upstream/1.4.5upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'docs/help')
237 files changed, 8574 insertions, 0 deletions
diff --git a/docs/help/Makefile.am b/docs/help/Makefile.am new file mode 100644 index 0000000..7659d22 --- /dev/null +++ b/docs/help/Makefile.am @@ -0,0 +1,127 @@ +# Makefile.am is autogenerated by autogen.sh from Makefile.am.gen + +helpdir = $(datadir)/irssi/help + +help_DATA = \ + accept \ + action \ + admin \ + alias \ + away \ + ban \ + beep \ + bind \ + cat \ + cd \ + channel \ + clear \ + completion \ + connect \ + ctcp \ + cycle \ + dcc \ + dehilight \ + deop \ + devoice \ + die \ + disconnect \ + echo \ + eval \ + exec \ + flushbuffer \ + format \ + hash \ + help \ + hilight \ + ignore \ + info \ + invite \ + irssiproxy \ + ison \ + join \ + kick \ + kickban \ + kill \ + knock \ + knockout \ + lastlog \ + layout \ + levels \ + links \ + list \ + load \ + log \ + lusers \ + map \ + me \ + mircdcc \ + mode \ + motd \ + msg \ + names \ + nctcp \ + netsplit \ + network \ + nick \ + notice \ + notify \ + op \ + oper \ + otr \ + part \ + ping \ + query \ + quit \ + quote \ + rawlog \ + recode \ + reconnect \ + rehash \ + reload \ + restart \ + rmreconns \ + rmrejoins \ + save \ + sconnect \ + script \ + scrollback \ + server \ + servlist \ + set \ + silence \ + squery \ + squit \ + stats \ + statusbar \ + time \ + toggle \ + topic \ + trace \ + ts \ + unalias \ + unban \ + unignore \ + unload \ + unnotify \ + unquery \ + unsilence \ + upgrade \ + uptime \ + userhost \ + ver \ + version \ + voice \ + wait \ + wall \ + wallops \ + who \ + whois \ + whowas \ + window + +EXTRA_DIST = \ + Makefile.am.gen \ + $(help_DATA) \ + meson.build + +SUBDIRS = in diff --git a/docs/help/Makefile.am.gen b/docs/help/Makefile.am.gen new file mode 100644 index 0000000..917abe6 --- /dev/null +++ b/docs/help/Makefile.am.gen @@ -0,0 +1,13 @@ +# Makefile.am is autogenerated by autogen.sh from Makefile.am.gen + +helpdir = $(datadir)/irssi/help + +help_DATA = \ +@HELPFILES@ + +EXTRA_DIST = \ + Makefile.am.gen \ + $(help_DATA) \ + meson.build + +SUBDIRS = in diff --git a/docs/help/Makefile.in b/docs/help/Makefile.in new file mode 100644 index 0000000..40d7600 --- /dev/null +++ b/docs/help/Makefile.in @@ -0,0 +1,850 @@ +# Makefile.in generated by automake 1.16.5 from Makefile.am. +# @configure_input@ + +# Copyright (C) 1994-2021 Free Software Foundation, Inc. + +# This Makefile.in is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY, to the extent permitted by law; without +# even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. + +@SET_MAKE@ + +# Makefile.am is autogenerated by autogen.sh from Makefile.am.gen + +VPATH = @srcdir@ +am__is_gnu_make = { \ + if test -z '$(MAKELEVEL)'; then \ + false; \ + elif test -n '$(MAKE_HOST)'; then \ + true; \ + elif test -n '$(MAKE_VERSION)' && test -n '$(CURDIR)'; then \ + true; \ + else \ + false; \ + fi; \ +} +am__make_running_with_option = \ + case $${target_option-} in \ + ?) ;; \ + *) echo "am__make_running_with_option: internal error: invalid" \ + "target option '$${target_option-}' specified" >&2; \ + exit 1;; \ + esac; \ + has_opt=no; \ + sane_makeflags=$$MAKEFLAGS; \ + if $(am__is_gnu_make); then \ + sane_makeflags=$$MFLAGS; \ + else \ + case $$MAKEFLAGS in \ + *\\[\ \ ]*) \ + bs=\\; \ + sane_makeflags=`printf '%s\n' "$$MAKEFLAGS" \ + | sed "s/$$bs$$bs[$$bs $$bs ]*//g"`;; \ + esac; \ + fi; \ + skip_next=no; \ + strip_trailopt () \ + { \ + flg=`printf '%s\n' "$$flg" | sed "s/$$1.*$$//"`; \ + }; \ + for flg in $$sane_makeflags; do \ + test $$skip_next = yes && { skip_next=no; continue; }; \ + case $$flg in \ + *=*|--*) continue;; \ + -*I) strip_trailopt 'I'; skip_next=yes;; \ + -*I?*) strip_trailopt 'I';; \ + -*O) strip_trailopt 'O'; skip_next=yes;; \ + -*O?*) strip_trailopt 'O';; \ + -*l) strip_trailopt 'l'; skip_next=yes;; \ + -*l?*) strip_trailopt 'l';; \ + -[dEDm]) skip_next=yes;; \ + -[JT]) skip_next=yes;; \ + esac; \ + case $$flg in \ + *$$target_option*) has_opt=yes; break;; \ + esac; \ + done; \ + test $$has_opt = yes +am__make_dryrun = (target_option=n; $(am__make_running_with_option)) +am__make_keepgoing = (target_option=k; $(am__make_running_with_option)) +pkgdatadir = $(datadir)/@PACKAGE@ +pkgincludedir = $(includedir)/@PACKAGE@ +pkglibdir = $(libdir)/@PACKAGE@ +pkglibexecdir = $(libexecdir)/@PACKAGE@ +am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd +install_sh_DATA = $(install_sh) -c -m 644 +install_sh_PROGRAM = $(install_sh) -c +install_sh_SCRIPT = $(install_sh) -c +INSTALL_HEADER = $(INSTALL_DATA) +transform = $(program_transform_name) +NORMAL_INSTALL = : +PRE_INSTALL = : +POST_INSTALL = : +NORMAL_UNINSTALL = : +PRE_UNINSTALL = : +POST_UNINSTALL = : +build_triplet = @build@ +host_triplet = @host@ +subdir = docs/help +ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 +am__aclocal_m4_deps = $(top_srcdir)/m4/glib-2.0.m4 \ + $(top_srcdir)/m4/glibtests.m4 $(top_srcdir)/m4/libgcrypt.m4 \ + $(top_srcdir)/m4/libotr.m4 $(top_srcdir)/m4/libtool.m4 \ + $(top_srcdir)/m4/ltoptions.m4 $(top_srcdir)/m4/ltsugar.m4 \ + $(top_srcdir)/m4/ltversion.m4 $(top_srcdir)/m4/lt~obsolete.m4 \ + $(top_srcdir)/m4/pkg.m4 $(top_srcdir)/configure.ac +am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ + $(ACLOCAL_M4) +DIST_COMMON = $(srcdir)/Makefile.am $(am__DIST_COMMON) +mkinstalldirs = $(install_sh) -d +CONFIG_HEADER = $(top_builddir)/irssi-config.h +CONFIG_CLEAN_FILES = +CONFIG_CLEAN_VPATH_FILES = +AM_V_P = $(am__v_P_@AM_V@) +am__v_P_ = $(am__v_P_@AM_DEFAULT_V@) +am__v_P_0 = false +am__v_P_1 = : +AM_V_GEN = $(am__v_GEN_@AM_V@) +am__v_GEN_ = $(am__v_GEN_@AM_DEFAULT_V@) +am__v_GEN_0 = @echo " GEN " $@; +am__v_GEN_1 = +AM_V_at = $(am__v_at_@AM_V@) +am__v_at_ = $(am__v_at_@AM_DEFAULT_V@) +am__v_at_0 = @ +am__v_at_1 = +SOURCES = +DIST_SOURCES = +RECURSIVE_TARGETS = all-recursive check-recursive cscopelist-recursive \ + ctags-recursive dvi-recursive html-recursive info-recursive \ + install-data-recursive install-dvi-recursive \ + install-exec-recursive install-html-recursive \ + install-info-recursive install-pdf-recursive \ + install-ps-recursive install-recursive installcheck-recursive \ + installdirs-recursive pdf-recursive ps-recursive \ + tags-recursive uninstall-recursive +am__can_run_installinfo = \ + case $$AM_UPDATE_INFO_DIR in \ + n|no|NO) false;; \ + *) (install-info --version) >/dev/null 2>&1;; \ + esac +am__vpath_adj_setup = srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; +am__vpath_adj = case $$p in \ + $(srcdir)/*) f=`echo "$$p" | sed "s|^$$srcdirstrip/||"`;; \ + *) f=$$p;; \ + esac; +am__strip_dir = f=`echo $$p | sed -e 's|^.*/||'`; +am__install_max = 40 +am__nobase_strip_setup = \ + srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*|]/\\\\&/g'` +am__nobase_strip = \ + for p in $$list; do echo "$$p"; done | sed -e "s|$$srcdirstrip/||" +am__nobase_list = $(am__nobase_strip_setup); \ + for p in $$list; do echo "$$p $$p"; done | \ + sed "s| $$srcdirstrip/| |;"' / .*\//!s/ .*/ ./; s,\( .*\)/[^/]*$$,\1,' | \ + $(AWK) 'BEGIN { files["."] = "" } { files[$$2] = files[$$2] " " $$1; \ + if (++n[$$2] == $(am__install_max)) \ + { print $$2, files[$$2]; n[$$2] = 0; files[$$2] = "" } } \ + END { for (dir in files) print dir, files[dir] }' +am__base_list = \ + sed '$$!N;$$!N;$$!N;$$!N;$$!N;$$!N;$$!N;s/\n/ /g' | \ + sed '$$!N;$$!N;$$!N;$$!N;s/\n/ /g' +am__uninstall_files_from_dir = { \ + test -z "$$files" \ + || { test ! -d "$$dir" && test ! -f "$$dir" && test ! -r "$$dir"; } \ + || { echo " ( cd '$$dir' && rm -f" $$files ")"; \ + $(am__cd) "$$dir" && rm -f $$files; }; \ + } +am__installdirs = "$(DESTDIR)$(helpdir)" +DATA = $(help_DATA) +RECURSIVE_CLEAN_TARGETS = mostlyclean-recursive clean-recursive \ + distclean-recursive maintainer-clean-recursive +am__recursive_targets = \ + $(RECURSIVE_TARGETS) \ + $(RECURSIVE_CLEAN_TARGETS) \ + $(am__extra_recursive_targets) +AM_RECURSIVE_TARGETS = $(am__recursive_targets:-recursive=) TAGS CTAGS \ + distdir distdir-am +am__tagged_files = $(HEADERS) $(SOURCES) $(TAGS_FILES) $(LISP) +# Read a list of newline-separated strings from the standard input, +# and print each of them once, without duplicates. Input order is +# *not* preserved. +am__uniquify_input = $(AWK) '\ + BEGIN { nonempty = 0; } \ + { items[$$0] = 1; nonempty = 1; } \ + END { if (nonempty) { for (i in items) print i; }; } \ +' +# Make sure the list of sources is unique. This is necessary because, +# e.g., the same source file might be shared among _SOURCES variables +# for different programs/libraries. +am__define_uniq_tagged_files = \ + list='$(am__tagged_files)'; \ + unique=`for i in $$list; do \ + if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \ + done | $(am__uniquify_input)` +DIST_SUBDIRS = $(SUBDIRS) +am__DIST_COMMON = $(srcdir)/Makefile.in +DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) +am__relativize = \ + dir0=`pwd`; \ + sed_first='s,^\([^/]*\)/.*$$,\1,'; \ + sed_rest='s,^[^/]*/*,,'; \ + sed_last='s,^.*/\([^/]*\)$$,\1,'; \ + sed_butlast='s,/*[^/]*$$,,'; \ + while test -n "$$dir1"; do \ + first=`echo "$$dir1" | sed -e "$$sed_first"`; \ + if test "$$first" != "."; then \ + if test "$$first" = ".."; then \ + dir2=`echo "$$dir0" | sed -e "$$sed_last"`/"$$dir2"; \ + dir0=`echo "$$dir0" | sed -e "$$sed_butlast"`; \ + else \ + first2=`echo "$$dir2" | sed -e "$$sed_first"`; \ + if test "$$first2" = "$$first"; then \ + dir2=`echo "$$dir2" | sed -e "$$sed_rest"`; \ + else \ + dir2="../$$dir2"; \ + fi; \ + dir0="$$dir0"/"$$first"; \ + fi; \ + fi; \ + dir1=`echo "$$dir1" | sed -e "$$sed_rest"`; \ + done; \ + reldir="$$dir2" +ACLOCAL = @ACLOCAL@ +AMTAR = @AMTAR@ +AM_DEFAULT_VERBOSITY = @AM_DEFAULT_VERBOSITY@ +AR = @AR@ +AUTOCONF = @AUTOCONF@ +AUTOHEADER = @AUTOHEADER@ +AUTOMAKE = @AUTOMAKE@ +AWK = @AWK@ +CC = @CC@ +CCDEPMODE = @CCDEPMODE@ +CFLAGS = @CFLAGS@ +CHAT_MODULES = @CHAT_MODULES@ +COMMON_LIBS = @COMMON_LIBS@ +COMMON_NOUI_LIBS = @COMMON_NOUI_LIBS@ +CPP = @CPP@ +CPPFLAGS = @CPPFLAGS@ +CSCOPE = @CSCOPE@ +CTAGS = @CTAGS@ +CYGPATH_W = @CYGPATH_W@ +DEFS = @DEFS@ +DEPDIR = @DEPDIR@ +DLLTOOL = @DLLTOOL@ +DSYMUTIL = @DSYMUTIL@ +DUMPBIN = @DUMPBIN@ +ECHO_C = @ECHO_C@ +ECHO_N = @ECHO_N@ +ECHO_T = @ECHO_T@ +EGREP = @EGREP@ +ETAGS = @ETAGS@ +EXEEXT = @EXEEXT@ +FGREP = @FGREP@ +FILECMD = @FILECMD@ +FUZZER_LIBS = @FUZZER_LIBS@ +GLIB_CFLAGS = @GLIB_CFLAGS@ +GLIB_GENMARSHAL = @GLIB_GENMARSHAL@ +GLIB_LIBS = @GLIB_LIBS@ +GLIB_MKENUMS = @GLIB_MKENUMS@ +GOBJECT_QUERY = @GOBJECT_QUERY@ +GREP = @GREP@ +INSTALL = @INSTALL@ +INSTALL_DATA = @INSTALL_DATA@ +INSTALL_PROGRAM = @INSTALL_PROGRAM@ +INSTALL_SCRIPT = @INSTALL_SCRIPT@ +INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ +LD = @LD@ +LDFLAGS = @LDFLAGS@ +LIBGCRYPT_CFLAGS = @LIBGCRYPT_CFLAGS@ +LIBGCRYPT_CONFIG = @LIBGCRYPT_CONFIG@ +LIBGCRYPT_LIBS = @LIBGCRYPT_LIBS@ +LIBOBJS = @LIBOBJS@ +LIBOTR_CFLAGS = @LIBOTR_CFLAGS@ +LIBOTR_LIBS = @LIBOTR_LIBS@ +LIBS = @LIBS@ +LIBTOOL = @LIBTOOL@ +LIPO = @LIPO@ +LN_S = @LN_S@ +LTLIBOBJS = @LTLIBOBJS@ +LT_SYS_LIBRARY_PATH = @LT_SYS_LIBRARY_PATH@ +MAINT = @MAINT@ +MAKEINFO = @MAKEINFO@ +MANIFEST_TOOL = @MANIFEST_TOOL@ +MKDIR_P = @MKDIR_P@ +NM = @NM@ +NMEDIT = @NMEDIT@ +OBJDUMP = @OBJDUMP@ +OBJEXT = @OBJEXT@ +OPENSSL_CFLAGS = @OPENSSL_CFLAGS@ +OPENSSL_LIBS = @OPENSSL_LIBS@ +OTOOL = @OTOOL@ +OTOOL64 = @OTOOL64@ +OTR_CFLAGS = @OTR_CFLAGS@ +OTR_LDFLAGS = @OTR_LDFLAGS@ +OTR_LINK_FLAGS = @OTR_LINK_FLAGS@ +OTR_LINK_LIBS = @OTR_LINK_LIBS@ +PACKAGE = @PACKAGE@ +PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ +PACKAGE_NAME = @PACKAGE_NAME@ +PACKAGE_STRING = @PACKAGE_STRING@ +PACKAGE_TARNAME = @PACKAGE_TARNAME@ +PACKAGE_URL = @PACKAGE_URL@ +PACKAGE_VERSION = @PACKAGE_VERSION@ +PATH_SEPARATOR = @PATH_SEPARATOR@ +PERL_CFLAGS = @PERL_CFLAGS@ +PERL_EXTRA_OPTS = @PERL_EXTRA_OPTS@ +PERL_FE_LINK_LIBS = @PERL_FE_LINK_LIBS@ +PERL_LDFLAGS = @PERL_LDFLAGS@ +PERL_LINK_FLAGS = @PERL_LINK_FLAGS@ +PERL_LINK_LIBS = @PERL_LINK_LIBS@ +PERL_MM_OPT = @PERL_MM_OPT@ +PERL_MM_PARAMS = @PERL_MM_PARAMS@ +PERL_STATIC_LIBS = @PERL_STATIC_LIBS@ +PERL_USE_LIB = @PERL_USE_LIB@ +PKG_CONFIG = @PKG_CONFIG@ +PKG_CONFIG_LIBDIR = @PKG_CONFIG_LIBDIR@ +PKG_CONFIG_PATH = @PKG_CONFIG_PATH@ +PROG_LIBS = @PROG_LIBS@ +RANLIB = @RANLIB@ +SED = @SED@ +SET_MAKE = @SET_MAKE@ +SHELL = @SHELL@ +STRIP = @STRIP@ +TEXTUI_LIBS = @TEXTUI_LIBS@ +VERSION = @VERSION@ +abs_builddir = @abs_builddir@ +abs_srcdir = @abs_srcdir@ +abs_top_builddir = @abs_top_builddir@ +abs_top_srcdir = @abs_top_srcdir@ +ac_ct_AR = @ac_ct_AR@ +ac_ct_CC = @ac_ct_CC@ +ac_ct_DUMPBIN = @ac_ct_DUMPBIN@ +am__include = @am__include@ +am__leading_dot = @am__leading_dot@ +am__quote = @am__quote@ +am__tar = @am__tar@ +am__untar = @am__untar@ +bindir = @bindir@ +build = @build@ +build_alias = @build_alias@ +build_cpu = @build_cpu@ +build_os = @build_os@ +build_vendor = @build_vendor@ +builddir = @builddir@ +datadir = @datadir@ +datarootdir = @datarootdir@ +docdir = @docdir@ +dvidir = @dvidir@ +exec_prefix = @exec_prefix@ +host = @host@ +host_alias = @host_alias@ +host_cpu = @host_cpu@ +host_os = @host_os@ +host_vendor = @host_vendor@ +htmldir = @htmldir@ +includedir = @includedir@ +infodir = @infodir@ +install_sh = @install_sh@ +installed_test_metadir = @installed_test_metadir@ +installed_testdir = @installed_testdir@ +irc_MODULES = @irc_MODULES@ +libdir = @libdir@ +libexecdir = @libexecdir@ +localedir = @localedir@ +localstatedir = @localstatedir@ +mandir = @mandir@ +mkdir_p = @mkdir_p@ +oldincludedir = @oldincludedir@ +otr_module_lib = @otr_module_lib@ +otr_static_lib = @otr_static_lib@ +pdfdir = @pdfdir@ +perl_module_fe_lib = @perl_module_fe_lib@ +perl_module_lib = @perl_module_lib@ +perl_static_fe_lib = @perl_static_fe_lib@ +perl_static_lib = @perl_static_lib@ +perlpath = @perlpath@ +pkgconfigdir = @pkgconfigdir@ +prefix = @prefix@ +program_transform_name = @program_transform_name@ +psdir = @psdir@ +runstatedir = @runstatedir@ +sbindir = @sbindir@ +sedpath = @sedpath@ +sharedstatedir = @sharedstatedir@ +srcdir = @srcdir@ +sysconfdir = @sysconfdir@ +target_alias = @target_alias@ +top_build_prefix = @top_build_prefix@ +top_builddir = @top_builddir@ +top_srcdir = @top_srcdir@ +helpdir = $(datadir)/irssi/help +help_DATA = \ + accept \ + action \ + admin \ + alias \ + away \ + ban \ + beep \ + bind \ + cat \ + cd \ + channel \ + clear \ + completion \ + connect \ + ctcp \ + cycle \ + dcc \ + dehilight \ + deop \ + devoice \ + die \ + disconnect \ + echo \ + eval \ + exec \ + flushbuffer \ + format \ + hash \ + help \ + hilight \ + ignore \ + info \ + invite \ + irssiproxy \ + ison \ + join \ + kick \ + kickban \ + kill \ + knock \ + knockout \ + lastlog \ + layout \ + levels \ + links \ + list \ + load \ + log \ + lusers \ + map \ + me \ + mircdcc \ + mode \ + motd \ + msg \ + names \ + nctcp \ + netsplit \ + network \ + nick \ + notice \ + notify \ + op \ + oper \ + otr \ + part \ + ping \ + query \ + quit \ + quote \ + rawlog \ + recode \ + reconnect \ + rehash \ + reload \ + restart \ + rmreconns \ + rmrejoins \ + save \ + sconnect \ + script \ + scrollback \ + server \ + servlist \ + set \ + silence \ + squery \ + squit \ + stats \ + statusbar \ + time \ + toggle \ + topic \ + trace \ + ts \ + unalias \ + unban \ + unignore \ + unload \ + unnotify \ + unquery \ + unsilence \ + upgrade \ + uptime \ + userhost \ + ver \ + version \ + voice \ + wait \ + wall \ + wallops \ + who \ + whois \ + whowas \ + window + +EXTRA_DIST = \ + Makefile.am.gen \ + $(help_DATA) \ + meson.build + +SUBDIRS = in +all: all-recursive + +.SUFFIXES: +$(srcdir)/Makefile.in: @MAINTAINER_MODE_TRUE@ $(srcdir)/Makefile.am $(am__configure_deps) + @for dep in $?; do \ + case '$(am__configure_deps)' in \ + *$$dep*) \ + ( cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh ) \ + && { if test -f $@; then exit 0; else break; fi; }; \ + exit 1;; \ + esac; \ + done; \ + echo ' cd $(top_srcdir) && $(AUTOMAKE) --foreign docs/help/Makefile'; \ + $(am__cd) $(top_srcdir) && \ + $(AUTOMAKE) --foreign docs/help/Makefile +Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status + @case '$?' in \ + *config.status*) \ + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh;; \ + *) \ + echo ' cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__maybe_remake_depfiles)'; \ + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__maybe_remake_depfiles);; \ + esac; + +$(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh + +$(top_srcdir)/configure: @MAINTAINER_MODE_TRUE@ $(am__configure_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(ACLOCAL_M4): @MAINTAINER_MODE_TRUE@ $(am__aclocal_m4_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(am__aclocal_m4_deps): + +mostlyclean-libtool: + -rm -f *.lo + +clean-libtool: + -rm -rf .libs _libs +install-helpDATA: $(help_DATA) + @$(NORMAL_INSTALL) + @list='$(help_DATA)'; test -n "$(helpdir)" || list=; \ + if test -n "$$list"; then \ + echo " $(MKDIR_P) '$(DESTDIR)$(helpdir)'"; \ + $(MKDIR_P) "$(DESTDIR)$(helpdir)" || exit 1; \ + fi; \ + for p in $$list; do \ + if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \ + echo "$$d$$p"; \ + done | $(am__base_list) | \ + while read files; do \ + echo " $(INSTALL_DATA) $$files '$(DESTDIR)$(helpdir)'"; \ + $(INSTALL_DATA) $$files "$(DESTDIR)$(helpdir)" || exit $$?; \ + done + +uninstall-helpDATA: + @$(NORMAL_UNINSTALL) + @list='$(help_DATA)'; test -n "$(helpdir)" || list=; \ + files=`for p in $$list; do echo $$p; done | sed -e 's|^.*/||'`; \ + dir='$(DESTDIR)$(helpdir)'; $(am__uninstall_files_from_dir) + +# This directory's subdirectories are mostly independent; you can cd +# into them and run 'make' without going through this Makefile. +# To change the values of 'make' variables: instead of editing Makefiles, +# (1) if the variable is set in 'config.status', edit 'config.status' +# (which will cause the Makefiles to be regenerated when you run 'make'); +# (2) otherwise, pass the desired values on the 'make' command line. +$(am__recursive_targets): + @fail=; \ + if $(am__make_keepgoing); then \ + failcom='fail=yes'; \ + else \ + failcom='exit 1'; \ + fi; \ + dot_seen=no; \ + target=`echo $@ | sed s/-recursive//`; \ + case "$@" in \ + distclean-* | maintainer-clean-*) list='$(DIST_SUBDIRS)' ;; \ + *) list='$(SUBDIRS)' ;; \ + esac; \ + for subdir in $$list; do \ + echo "Making $$target in $$subdir"; \ + if test "$$subdir" = "."; then \ + dot_seen=yes; \ + local_target="$$target-am"; \ + else \ + local_target="$$target"; \ + fi; \ + ($(am__cd) $$subdir && $(MAKE) $(AM_MAKEFLAGS) $$local_target) \ + || eval $$failcom; \ + done; \ + if test "$$dot_seen" = "no"; then \ + $(MAKE) $(AM_MAKEFLAGS) "$$target-am" || exit 1; \ + fi; test -z "$$fail" + +ID: $(am__tagged_files) + $(am__define_uniq_tagged_files); mkid -fID $$unique +tags: tags-recursive +TAGS: tags + +tags-am: $(TAGS_DEPENDENCIES) $(am__tagged_files) + set x; \ + here=`pwd`; \ + if ($(ETAGS) --etags-include --version) >/dev/null 2>&1; then \ + include_option=--etags-include; \ + empty_fix=.; \ + else \ + include_option=--include; \ + empty_fix=; \ + fi; \ + list='$(SUBDIRS)'; for subdir in $$list; do \ + if test "$$subdir" = .; then :; else \ + test ! -f $$subdir/TAGS || \ + set "$$@" "$$include_option=$$here/$$subdir/TAGS"; \ + fi; \ + done; \ + $(am__define_uniq_tagged_files); \ + shift; \ + if test -z "$(ETAGS_ARGS)$$*$$unique"; then :; else \ + test -n "$$unique" || unique=$$empty_fix; \ + if test $$# -gt 0; then \ + $(ETAGS) $(ETAGSFLAGS) $(AM_ETAGSFLAGS) $(ETAGS_ARGS) \ + "$$@" $$unique; \ + else \ + $(ETAGS) $(ETAGSFLAGS) $(AM_ETAGSFLAGS) $(ETAGS_ARGS) \ + $$unique; \ + fi; \ + fi +ctags: ctags-recursive + +CTAGS: ctags +ctags-am: $(TAGS_DEPENDENCIES) $(am__tagged_files) + $(am__define_uniq_tagged_files); \ + test -z "$(CTAGS_ARGS)$$unique" \ + || $(CTAGS) $(CTAGSFLAGS) $(AM_CTAGSFLAGS) $(CTAGS_ARGS) \ + $$unique + +GTAGS: + here=`$(am__cd) $(top_builddir) && pwd` \ + && $(am__cd) $(top_srcdir) \ + && gtags -i $(GTAGS_ARGS) "$$here" +cscopelist: cscopelist-recursive + +cscopelist-am: $(am__tagged_files) + list='$(am__tagged_files)'; \ + case "$(srcdir)" in \ + [\\/]* | ?:[\\/]*) sdir="$(srcdir)" ;; \ + *) sdir=$(subdir)/$(srcdir) ;; \ + esac; \ + for i in $$list; do \ + if test -f "$$i"; then \ + echo "$(subdir)/$$i"; \ + else \ + echo "$$sdir/$$i"; \ + fi; \ + done >> $(top_builddir)/cscope.files + +distclean-tags: + -rm -f TAGS ID GTAGS GRTAGS GSYMS GPATH tags +distdir: $(BUILT_SOURCES) + $(MAKE) $(AM_MAKEFLAGS) distdir-am + +distdir-am: $(DISTFILES) + @srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + topsrcdirstrip=`echo "$(top_srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + list='$(DISTFILES)'; \ + dist_files=`for file in $$list; do echo $$file; done | \ + sed -e "s|^$$srcdirstrip/||;t" \ + -e "s|^$$topsrcdirstrip/|$(top_builddir)/|;t"`; \ + case $$dist_files in \ + */*) $(MKDIR_P) `echo "$$dist_files" | \ + sed '/\//!d;s|^|$(distdir)/|;s,/[^/]*$$,,' | \ + sort -u` ;; \ + esac; \ + for file in $$dist_files; do \ + if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \ + if test -d $$d/$$file; then \ + dir=`echo "/$$file" | sed -e 's,/[^/]*$$,,'`; \ + if test -d "$(distdir)/$$file"; then \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \ + cp -fpR $(srcdir)/$$file "$(distdir)$$dir" || exit 1; \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + cp -fpR $$d/$$file "$(distdir)$$dir" || exit 1; \ + else \ + test -f "$(distdir)/$$file" \ + || cp -p $$d/$$file "$(distdir)/$$file" \ + || exit 1; \ + fi; \ + done + @list='$(DIST_SUBDIRS)'; for subdir in $$list; do \ + if test "$$subdir" = .; then :; else \ + $(am__make_dryrun) \ + || test -d "$(distdir)/$$subdir" \ + || $(MKDIR_P) "$(distdir)/$$subdir" \ + || exit 1; \ + dir1=$$subdir; dir2="$(distdir)/$$subdir"; \ + $(am__relativize); \ + new_distdir=$$reldir; \ + dir1=$$subdir; dir2="$(top_distdir)"; \ + $(am__relativize); \ + new_top_distdir=$$reldir; \ + echo " (cd $$subdir && $(MAKE) $(AM_MAKEFLAGS) top_distdir="$$new_top_distdir" distdir="$$new_distdir" \\"; \ + echo " am__remove_distdir=: am__skip_length_check=: am__skip_mode_fix=: distdir)"; \ + ($(am__cd) $$subdir && \ + $(MAKE) $(AM_MAKEFLAGS) \ + top_distdir="$$new_top_distdir" \ + distdir="$$new_distdir" \ + am__remove_distdir=: \ + am__skip_length_check=: \ + am__skip_mode_fix=: \ + distdir) \ + || exit 1; \ + fi; \ + done +check-am: all-am +check: check-recursive +all-am: Makefile $(DATA) +installdirs: installdirs-recursive +installdirs-am: + for dir in "$(DESTDIR)$(helpdir)"; do \ + test -z "$$dir" || $(MKDIR_P) "$$dir"; \ + done +install: install-recursive +install-exec: install-exec-recursive +install-data: install-data-recursive +uninstall: uninstall-recursive + +install-am: all-am + @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am + +installcheck: installcheck-recursive +install-strip: + if test -z '$(STRIP)'; then \ + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + install; \ + else \ + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'" install; \ + fi +mostlyclean-generic: + +clean-generic: + +distclean-generic: + -test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES) + -test . = "$(srcdir)" || test -z "$(CONFIG_CLEAN_VPATH_FILES)" || rm -f $(CONFIG_CLEAN_VPATH_FILES) + +maintainer-clean-generic: + @echo "This command is intended for maintainers to use" + @echo "it deletes files that may require special tools to rebuild." +clean: clean-recursive + +clean-am: clean-generic clean-libtool mostlyclean-am + +distclean: distclean-recursive + -rm -f Makefile +distclean-am: clean-am distclean-generic distclean-tags + +dvi: dvi-recursive + +dvi-am: + +html: html-recursive + +html-am: + +info: info-recursive + +info-am: + +install-data-am: install-helpDATA + +install-dvi: install-dvi-recursive + +install-dvi-am: + +install-exec-am: + +install-html: install-html-recursive + +install-html-am: + +install-info: install-info-recursive + +install-info-am: + +install-man: + +install-pdf: install-pdf-recursive + +install-pdf-am: + +install-ps: install-ps-recursive + +install-ps-am: + +installcheck-am: + +maintainer-clean: maintainer-clean-recursive + -rm -f Makefile +maintainer-clean-am: distclean-am maintainer-clean-generic + +mostlyclean: mostlyclean-recursive + +mostlyclean-am: mostlyclean-generic mostlyclean-libtool + +pdf: pdf-recursive + +pdf-am: + +ps: ps-recursive + +ps-am: + +uninstall-am: uninstall-helpDATA + +.MAKE: $(am__recursive_targets) install-am install-strip + +.PHONY: $(am__recursive_targets) CTAGS GTAGS TAGS all all-am check \ + check-am clean clean-generic clean-libtool cscopelist-am ctags \ + ctags-am distclean distclean-generic distclean-libtool \ + distclean-tags distdir dvi dvi-am html html-am info info-am \ + install install-am install-data install-data-am install-dvi \ + install-dvi-am install-exec install-exec-am install-helpDATA \ + install-html install-html-am install-info install-info-am \ + install-man install-pdf install-pdf-am install-ps \ + install-ps-am install-strip installcheck installcheck-am \ + installdirs installdirs-am maintainer-clean \ + maintainer-clean-generic mostlyclean mostlyclean-generic \ + mostlyclean-libtool pdf pdf-am ps ps-am tags tags-am uninstall \ + uninstall-am uninstall-helpDATA + +.PRECIOUS: Makefile + + +# Tell versions [3.59,3.63) of GNU make to not export all variables. +# Otherwise a system limit (for SysV at least) may be exceeded. +.NOEXPORT: diff --git a/docs/help/accept b/docs/help/accept new file mode 100644 index 0000000..774f495 --- /dev/null +++ b/docs/help/accept @@ -0,0 +1,30 @@ + +%9Syntax:%9 + +ACCEPT %|[[-]nick,...] + +%9Parameters:%9 + + A comma-separated list of nicknames to add or remove; if no argument is + given, your accept list will be displayed. + +%9Description:%9 + + Allows you to specify who you want to receive private messages and notices + from while you have callerid enabled. + + When you have callerid enabled, messages from other users are blocked and + the sender is notified. + + Users are automatically removed from the accept list if they quit, split + or change nickname; the accept list is lost when you disconnect. + + This command only works on IRC servers that support the callerid user mode. + +%9Examples:%9 + + /ACCEPT mike,bob,-john,-sarah + /ACCEPT sarah,-bob + +%9See also:%9 IGNORE, SILENCE + diff --git a/docs/help/action b/docs/help/action new file mode 100644 index 0000000..a815f06 --- /dev/null +++ b/docs/help/action @@ -0,0 +1,23 @@ + +%9Syntax:%9 + +ACTION %|[-<server tag>] <target> <message> + +%9Parameters:%9 + + -<server tag>: The server tag you want to send the action emote to. + + A target nickname or channel and the message to emote. + +%9Description:%9 + + Sends an action emote to a nickname or a channel. + +%9Examples:%9 + + /ACTION #irssi is hungry! + /ACTION mike had an awesome day @ work + /ACTION -efnet #irssi is happy it's Friday + +%9See also:%9 ME + diff --git a/docs/help/admin b/docs/help/admin new file mode 100644 index 0000000..6196b75 --- /dev/null +++ b/docs/help/admin @@ -0,0 +1,22 @@ + +%9Syntax:%9 + +ADMIN %|[<server>|<nickname>] + +%9Parameters:%9 + + A nickname or server for which you want to know the administrative details; + if no argument is given, the server you are connected to will be used. + +%9Description:%9 + + Displays the administrative details of a server. + +%9Examples:%9 + + /ADMIN + /ADMIN irc.libera.chat + /ADMIN mike + +%9See also:%9 INFO + diff --git a/docs/help/alias b/docs/help/alias new file mode 100644 index 0000000..dfa6179 --- /dev/null +++ b/docs/help/alias @@ -0,0 +1,37 @@ + +%9Syntax:%9 + +ALIAS %|[[-]<alias> [<command>]] + +%9Parameters:%9 + + A name of the alias and the command to execute. You can prepend the alias + with the '-' character to remove the alias; if no argument is given, your + aliases will be displayed. + +%9Description:%9 + + Creates or updates an alias; you can use the ';' character to separate + multiple commands. + + The parameters given to the alias are expanded in '$[\d]'; for example $0, + $1, $2, $8, ..., as well as any other special variable. + + If you don't use any parameters in your alias, all parameters will be + automatically appended after it. + +%9Examples:%9 + + /ALIAS + /ALIAS UH USERHOST + /ALIAS COMEBACK SAY I was hoping for a battle of wits, but you seem to be unarmed. + /ALIAS -COMEBACK + /ALIAS UNACT SCRIPT EXEC \$_->activity(0) for Irssi::windows + /ALIAS QOP ^MSG Q op $C + +%9References:%9 + + https://github.com/irssi/irssi/blob/master/docs/special_vars.txt + +%9See also:%9 BIND, UNALIAS + diff --git a/docs/help/away b/docs/help/away new file mode 100644 index 0000000..cbf2e7f --- /dev/null +++ b/docs/help/away @@ -0,0 +1,33 @@ + +%9Syntax:%9 + +AWAY %|[-one | -all] [<reason>] + +%9Parameters:%9 + + -one: Marks yourself as away on the active server. + -all: Marks yourself as away on all the servers you are connected to. + + Your away message; if no argument is given, your away status will be removed. + +%9Description:%9 + + Marks yourself as 'away'; this method is used to inform people that you + are not paying attention to your screen. + + You might use it when you are taking a nap, in the shower, getting some + food, or otherwise engaged. When you're 'away' you will see '(zZzZ)' in + your statusbar. + + Anyone who does a WHOIS on your nickname will see that you are away, as + well as your away message. + +%9Examples:%9 + + /AWAY + /AWAY I'm getting some food. + /AWAY zZzZ + /AWAY -one Feeding the cat! + +%9See also:%9 DISCONNECT + diff --git a/docs/help/ban b/docs/help/ban new file mode 100644 index 0000000..a65c000 --- /dev/null +++ b/docs/help/ban @@ -0,0 +1,43 @@ + +%9Syntax:%9 + +BAN %|[<channel>] [<nicks>] +BAN %|[-normal | -user | -host | -domain | -custom <type>] <nicks/masks> + +%9Parameters:%9 + + -normal: Uses the *!*user@*.domain.tld format. + -user: Uses the *!*user@* format. + -host: Uses the *!*@host.domain.tld format. + -domain: Uses the *!*@*.domain.tld format. + -custom: Uses the custom format. + + A channel and the nicknames or hostnames to ban; if no arguments are given + the bans in the active channel are displayed. + + If no ban format parameter is given, the value of the ban_type setting will + be used to generate the hostmask to ban. + +%9Description:%9 + + Adds one or more bans to a channel. + +%9Configuring the custom format:%9 + + You must set the custom ban_type to the format you would like to use. For + example, if you set the custom ban_type to 'nick domain', it will generate + a ban based on the nick!*@*.domain.tld format. + +%9Examples:%9 + + /BAN + /BAN mike + /BAN -host bob + /BAN *!*@*.irssi.org + /BAN -domain sarah + + /SET ban_type custom nick domain + /SET ban_type custom user host + +%9See also:%9 DEOP, KICKBAN, KNOCKOUT, OP, UNBAN + diff --git a/docs/help/beep b/docs/help/beep new file mode 100644 index 0000000..415c6ff --- /dev/null +++ b/docs/help/beep @@ -0,0 +1,15 @@ + +%9Syntax:%9 + +BEEP + +%9Description:%9 + + Outputs the bell-character, usually causing your terminal to beep. + +%9Examples:%9 + + /BEEP + +%9See also:%9 CLEAR + diff --git a/docs/help/bind b/docs/help/bind new file mode 100644 index 0000000..384ffff --- /dev/null +++ b/docs/help/bind @@ -0,0 +1,35 @@ + +%9Syntax:%9 + +BIND %|[-list] [-delete | -reset] [<key> [<command> [<data>]]] + +%9Parameters:%9 + + -list: Displays a list of all the bindable commands. + -delete: Removes the binding. + -reset: Reset a key to its default binding. + + A name of the binding and the command to perform; if no parameter is given, + the list of bindings will be displayed. + +Details: + + Adds or removes a binding; the binding itself is case-sensitive and may + contain as many characters as you want. + + Uppercase characters usually indicate that you need to keep the shift-key + pressed to use the binding. + +%9Examples:%9 + + /BIND + /BIND meta-c /CLEAR + /BIND meta-q change_window 16 + /BIND -delete meta-y + /BIND ^W^C /WINDOW NEW HIDE + /BIND ^W^K /WINDOW KILL + /BIND ^[[11~ command AWAY I'm off for today :) + /BIND ^[[12~ command AWAY + +%9See also:%9 ALIAS + diff --git a/docs/help/cat b/docs/help/cat new file mode 100644 index 0000000..250e157 --- /dev/null +++ b/docs/help/cat @@ -0,0 +1,28 @@ + +%9Syntax:%9 + +CAT %|[-window] <file> [<seek position>] + +%9Parameters:%9 + + -window: Displays the output in the active window. + + The file to display and optionally a position to seek in the file, + in bytes. + +%9Description:%9 + + Displays the contents of the specified file in the active window if -window + is specified, otherwise to the closest matching window depending on levels. + + The seek position parameter is used internally to display away logs, if + omitted the whole file is shown. + +%9Examples:%9 + + /CAT -window /etc/network/interfaces + /CAT /home/mike/resume.txt + /CAT contact_details.txt + +%9See also:%9 CD, EXEC + diff --git a/docs/help/cd b/docs/help/cd new file mode 100644 index 0000000..beaf866 --- /dev/null +++ b/docs/help/cd @@ -0,0 +1,21 @@ + +%9Syntax:%9 + +CD %|<directory> + +%9Parameters:%9 + + The directory to change into. + +%9Description:%9 + + Changes the current active directory. + +%9Examples:%9 + + /CD /home/public_ftp + /CD /home/mike + /CD /var/log + +%9See also:%9 CAT + diff --git a/docs/help/channel b/docs/help/channel new file mode 100644 index 0000000..afec8f4 --- /dev/null +++ b/docs/help/channel @@ -0,0 +1,50 @@ + +%9Syntax:%9 + +CHANNEL LIST%| +CHANNEL ADD%||MODIFY [-auto | -noauto] [-bots <masks>] [-botcmd <command>] <channel> <network> [<password>] +CHANNEL REMOVE %|<channel> <network> + +%9Parameters:%9 + + LIST: Displays the list of configured channels. + ADD: Adds a channel to your configuration. + MODIFY: Modifies a channel in your configuration. + REMOVE: Removes a channel from your configuration. + + -auto: Automatically join the channel. + -noauto: Don't join the channel automatically. + -bots: The list of hostnames send automated commands to. + -botcmd: The automated commands to perform. + + The channel and network to add to the configuration; you can optionally + specify the password of a channel. + + If no parameters are given, the list of channels you have joined will be + displayed. + +%9Description:%9 + + Adds, removes or displays the configuration of channels; this method is + used to automate and simplify your workflow. + + You can use the ADDALLCHANS command, which is a default alias, to add all + the channels you are present on into the configuration. + +%9Examples:%9 + + /CHANNEL + /CHANNEL LIST + /CHANNEL ADD -auto #irssi liberachat + /CHANNEL ADD -auto #basementcat Quakenet secret_lair + /CHANNEL ADD -auto -bots '*!@*.irssi.org *!bot@irssi.org' -botcmd 'msg $0 op WzerTrzq' #hideout liberachat + /CHANNEL ADD -auto -bots 'Q!TheQBot@CServe.quakenet.org' -botcmd '^MSG Q op #irssi' #irssi Quakenet + /CHANNEL MODIFY -noauto #irssi liberachat + /CHANNEL REMOVE #hideout liberachat + +%9Special Example:%9 + + /ADDALLCHANS + +%9See also:%9 JOIN, TS + diff --git a/docs/help/clear b/docs/help/clear new file mode 100644 index 0000000..b9b8124 --- /dev/null +++ b/docs/help/clear @@ -0,0 +1,19 @@ + +%9Syntax:%9 + +CLEAR %|[-all] [<refnum>] + +%9Parameters:%9 + + -all: Clear all the windows + + The window number to clear; if no argument is given, the active window + will be used. + +%9Description:%9 + + Scrolls up the text in the window and fills the window with blank lines; you + may want to use this to make new text start at the top of the window again. + +%9See also:%9 REDRAW, SCROLLBACK CLEAR + diff --git a/docs/help/completion b/docs/help/completion new file mode 100644 index 0000000..8d695a3 --- /dev/null +++ b/docs/help/completion @@ -0,0 +1,35 @@ + +%9Syntax:%9 + +COMPLETION %|[-auto] [-delete] <key> <value> + +%9Parameters:%9 + + -auto: Inserts the completion without pressing a word completion + character. + -delete: Removes the completion from the configuration. + + A key and the value to use as a replacement. If no argument is given, the + list of completions will be displayed. + +%9Description:%9 + + Replaces or completed words or letters; you can write just the first few + letters of the word and press TAB to insert a replacement. + + When a replacement has been found, Irssi will choose the most probable + matching word and replaces it; you may press TAB repeatedly to swap between + matches. + + If you want to remove a completion which has the auto parameter set, you + need to enclose the completion between "'" characters. + +%9Examples:%9 + + /COMPLETION w/h without + /COMPLETION -auto anywya anyway + /COMPLETION -delete 'anywya' + /COMPLETION -delete without + +%9See also:%9 BIND + diff --git a/docs/help/connect b/docs/help/connect new file mode 100644 index 0000000..762ab7d --- /dev/null +++ b/docs/help/connect @@ -0,0 +1,44 @@ + +%9Syntax:%9 + +CONNECT %|[-4 | -6] [-tls_cert <cert>] [-tls_pkey <pkey>] [-tls_pass <password>] [-tls_verify] [-tls_cafile <cafile>] [-tls_capath <capath>] [-tls_ciphers <list>] [-tls_pinned_cert <fingerprint>] [-tls_pinned_pubkey <fingerprint>] [-!] [-noautosendcmd] [-tls | -notls] [-nocap] [-starttls | -disallow_starttls] [-noproxy] [-network <network>] [-host <hostname>] [-rawlog <file>] <address>|<chatnet> [<port> [<password> [<nick>]]] + +%9Parameters:%9 + + -4: Connects using IPv4. + -6: Connects using IPv6. + -tls: Connects using TLS encryption. + -tls_cert: The TLS client certificate file. + -tls_pkey: The TLS client private key, if not included in the certificate file. + -tls_pass: The password for the TLS client private key or certificate. + -tls_verify: Verifies the TLS certificate of the server. + -tls_cafile: The file with the list of CA certificates. + -tls_capath: The directory which contains the CA certificates. + -tls_ciphers: TLS cipher suite preference lists. + -tls_pinned_cert: Pinned x509 certificate fingerprint. + -tls_pinned_pubkey: Pinned public key fingerprint. + -nocap: Disable CAPREQ during connect + -noproxy: Ignores the global proxy configuration. + -network: The network this connection belongs to. + -host: The hostname you would like to connect from. + -rawlog: Immediately open rawlog after connecting. + -!: Doesn't autojoin channels. + -noautosendcmd: Doesn't execute autosendcmd. + + A network or server to connect to; you can optionally specify a custom port, + password and nickname. + +%9Description:%9 + + Opens a new connection to the specified network or server; existing + connections are kept. + +%9Examples:%9 + + /CONNECT liberachat + /CONNECT -6 liberachat + /CONNECT -4 -! -host staff.irssi.org -network liberachat irc.libera.chat + /CONNECT irc.irssi.org 6667 WzerT8zq mike + +%9See also:%9 DISCONNECT, RMRECONNS, SERVER + diff --git a/docs/help/ctcp b/docs/help/ctcp new file mode 100644 index 0000000..c75103b --- /dev/null +++ b/docs/help/ctcp @@ -0,0 +1,23 @@ + +%9Syntax:%9 + +CTCP %|<targets> <ctcp command> [<ctcp data>] + +%9Parameters:%9 + + A target nickname or channel and a command. + +%9Description:%9 + + Sends a CTCP request towards the given target nickname or channel. + +%9Examples:%9 + + /CTCP mike PING + /CTCP #irssi VERSION + /CTCP bob USERINFO + /CTCP sarah CLIENTINFO + /CTCP john TIME + +%9See also:%9 ACTION, ME + diff --git a/docs/help/cycle b/docs/help/cycle new file mode 100644 index 0000000..a871e2f --- /dev/null +++ b/docs/help/cycle @@ -0,0 +1,22 @@ + +%9Syntax:%9 + +CYCLE %|[<channel>] [<message>] + +%9Parameters:%9 + + A channel and the message. If no argument is given, the active channel + will be used. + +%9Description:%9 + + Leaves and rejoins a channel. + +%9Examples:%9 + + /CYCLE + /CYCLE #irssi + /CYCLE #irssi BRB :) + +%9See also:%9 JOIN, PART + diff --git a/docs/help/dcc b/docs/help/dcc new file mode 100644 index 0000000..f549b30 --- /dev/null +++ b/docs/help/dcc @@ -0,0 +1,49 @@ + +%9Syntax:%9 + +DCC CHAT %|[-passive] [<nick>] +DCC GET %|[<nick> [<file>]] +DCC RESUME %|[<nick> [<file>]] +DCC SERVER %|[+|-scf] [port] +DCC CLOSE %|<type> <nick> [<file>] + +%9Parameters:%9 + + CHAT: Initiates or accept a chat request. + GET: Accepts a file transfer request. + RESUME: Resumes a file transfer. + SERVER: Starts a DCC server. + CLOSE: Closes a DCC connection. + LIST: Displays all the open DCC connections. + + -passive: Uses the passive DCC protocol. + -scf: Use any combination of the flags to indicate: + 's' - send + 'c' - chat + 'f' - fserver + + The nickname of the person to chat with, or the name of the file to + transfer. + +%9Description:%9 + + The DCC protocol is used to initiate client-to-client chat connections + and file transfers. + + If you are behind NAT, or if the firewall is too restrictive, you might + want to try if using the passive parameter resolves your connection + problem. + + You can send files which contain special character or spaces by enclosing + the filename within quotes. For example: 'my file with spaces.txt'. + +%9Examples:%9 + + /DCC CHAT mike + /DCC GET bob "summer vacation.mkv" + /DCC SEND sarah "summer vacation.mkv" + /DCC CLOSE get mike + /DCC CLOSE send bob "summer vacation.mkv" + +%9See also:%9 CD + diff --git a/docs/help/dehilight b/docs/help/dehilight new file mode 100644 index 0000000..4937a43 --- /dev/null +++ b/docs/help/dehilight @@ -0,0 +1,20 @@ + +%9Syntax:%9 + +DEHILIGHT %|<id>|<mask> + +%9Parameters:%9 + + The id or mask of the highlight to remove. + +%9Description:%9 + + Removes the specified highlight from the configuration. + +%9Examples:%9 + + /DEHILIGHT 1 + /DEHILIGHT 31 + +%9See also:%9 HILIGHT + diff --git a/docs/help/deop b/docs/help/deop new file mode 100644 index 0000000..fa2d0a5 --- /dev/null +++ b/docs/help/deop @@ -0,0 +1,23 @@ + +%9Syntax:%9 + +DEOP %|<nicks> + +%9Parameters:%9 + + A list of nicknames to deop. + +%9Description:%9 + + Removes the channel operator privileges from the given nicknames; you may + use the wildcard character '*' in a nickname. + +%9Examples:%9 + + /DEOP mike + /DEOP bob sarah + /DEOP jo*n + /DEOP * + +%9See also:%9 DEVOICE, MODE, OP, VOICE + diff --git a/docs/help/devoice b/docs/help/devoice new file mode 100644 index 0000000..a85f9f0 --- /dev/null +++ b/docs/help/devoice @@ -0,0 +1,26 @@ + +%9Syntax:%9 + +DEVOICE %|<nicks> + +%9Parameters:%9 + + A list of nicknames to devoice. + +%9Description:%9 + + Removes the channel voice privileges from the given nicknames; you may use + the wildcard character '*' in a nickname. + + If a channel is moderated, the users will require a voice or op in order to + be able to send messages to the channel. + +%9Examples:%9 + + /DEVOICE mike + /DEVOICE bob sarah + /DEVOICE jo*n + /DEVOICE * + +%9See also:%9 DEOP, MODE, OP, VOICE + diff --git a/docs/help/die b/docs/help/die new file mode 100644 index 0000000..16e17f4 --- /dev/null +++ b/docs/help/die @@ -0,0 +1,15 @@ + +%9Syntax:%9 + +DIE + +%9Description:%9 + + Terminates the IRC server; this command is reserved for IRC operators. + +%9Examples:%9 + + /DIE + +%9See also:%9 KILL, OPER, WALLOPS + diff --git a/docs/help/disconnect b/docs/help/disconnect new file mode 100644 index 0000000..e85657a --- /dev/null +++ b/docs/help/disconnect @@ -0,0 +1,26 @@ + +%9Syntax:%9 + +DISCONNECT %|*|<tag> [<message>] + +%9Parameters:%9 + + The network to disconnect from and the message to advertise; if no + parameters are given, the active server will be used. + +%9Description:%9 + + Disconnects from an IRC server; the list of all the servers you are + connected to can be retrieved via the SERVER command. + + Use the wildcard character '*' if you want to disconnect from the active + server. + +%9Examples:%9 + + /DISCONNECT liberachat I'm off for today, take care! + /DISCONNECT * Vacation time :D + /DISCONNECT + +%9See also:%9 CONNECT, SERVER + diff --git a/docs/help/echo b/docs/help/echo new file mode 100644 index 0000000..6fe174e --- /dev/null +++ b/docs/help/echo @@ -0,0 +1,24 @@ + +%9Syntax:%9 + +ECHO %|[-window <name>] [-level <level>] <text> + +%9Parameters:%9 + + -window: Displays the output in the target window. + -level: Displays the output with a given message level. + + The text output; if no target is given, the active window will be used. + +%9Description:%9 + + Displays the given text. + +%9Examples:%9 + + /ECHO 1 + 1 = 2 :D + /ECHO Testing the ECHO command + /ECHO -window #irssi Special variables such as ${N} will not be expanded. + +%9See also:%9 CAT, EVAL, EXEC, LEVELS + diff --git a/docs/help/eval b/docs/help/eval new file mode 100644 index 0000000..08d1dc1 --- /dev/null +++ b/docs/help/eval @@ -0,0 +1,35 @@ + +%9Syntax:%9 + +EVAL %|<command(s)> + +%9Parameters:%9 + + The commands to evaluate. + +%9Description:%9 + + Evaluates the given commands and executes them; you can use internal + variables and separate multiple commands by using the `;' character. + If the command contains a string with `$', `\' or `;' those characters + need to be escaped: + + `$' -> `$$' + `\' -> `\\' (or even `\\\\', depending on where they are used) + `;' -> `\;' + +%9Examples:%9 + + /EVAL echo I am connected to ${S} on ${chatnet} as ${N} + /EVAL echo My user privileges are +${usermode}; echo Let's party! + + to print `1;2$3\4': + + /EVAL echo 1\;2$$3\\4 + +%9References:%9 + + https://github.com/irssi/irssi/blob/master/docs/special_vars.txt + +%9See also:%9 CAT, CD, ECHO, EXEC + diff --git a/docs/help/exec b/docs/help/exec new file mode 100644 index 0000000..bb6f4f1 --- /dev/null +++ b/docs/help/exec @@ -0,0 +1,52 @@ + +%9Syntax:%9 + +EXEC %|[-] [-nosh] [-out | -msg <target> | -notice <target>] [-name <name>] <cmd line> +EXEC %|-out | -window | -msg <target> | -notice <target> | -close | -<signal> %<id> +EXEC %|-in %<id> <text to send to process> + +%9Parameters:%9 + + -: Suppresses the process termination notification. + -nosh: Doesn't execute the command through /bin/sh. + -out: Sends the output to the active channel or query. + -msg: Sends the output to the specified nickname or channel. + -notice: Sends the output to the specified nickname or channel as + notices. + -name: Gives the process the specified name. + -window: Displays the output in the active window. + -close: Forcibly closes a process that doesn't die. + -<signal>: Sends the given signal to the process. + -in: Sends text to the standard input of the process. + -interactive: Executes the process in a new window item. + + The command to execute; if no output parameter is given, the active window + will be used and if no parameters are given at all, the list of active + processes will be displayed. + +%9Description:%9 + + Executes the specified command in the background; the process can be + accessed by its id or the name you gave it. + + The output of the process can be redirected to various targets, such as + a window, a channel, a nickname or a query. + + The process identifier must always begin with the '%%' character. For + example %%0. + + If you remove a process with the close parameter, it will only make Irssi + detach from it; the process will keep running until it terminates. + +%9Examples:%9 + + /EXEC + /EXEC ls + /EXEC -msg #irssi cat unicorn.txt + /EXEC -out cat /etc/passwd | grep $USER | awk -F: '{print $5}' + /EXEC -name ssh -nosh -interactive -window ssh staff.irssi.org + /EXEC -close mailserver + /EXEC -close %%0 + +%9See also:%9 CAT, CD, ECHO, EVAL + diff --git a/docs/help/flushbuffer b/docs/help/flushbuffer new file mode 100644 index 0000000..a19ef04 --- /dev/null +++ b/docs/help/flushbuffer @@ -0,0 +1,18 @@ + +%9Syntax:%9 + + +%9Description:%9 + + Forces an immediate flush of the buffers if the related settings are + enabled. + +%9Examples:%9 + + /FLUSHBUFFER + + /SET write_buffer_size + /SET write_buffer_timeout + +%9See also:%9 REDRAW, SCROLLBACK + diff --git a/docs/help/format b/docs/help/format new file mode 100644 index 0000000..f21c7b6 --- /dev/null +++ b/docs/help/format @@ -0,0 +1,25 @@ + +%9Syntax:%9 + +FORMAT %|[-delete | -reset] [<module>] [<key> [<value>]] + +%9Parameters:%9 + + -reset: Restores the original value. + -delete: Removes the format from the configuration. + + The module name, the format name and the value; if no arguments are given, + the list of formats are displayed. + +%9Description:%9 + + Allows you to reconfigure the way messages are displayed. + +%9Examples:%9 + + /FORMAT irc away You have left planet earth + /FORMAT core not_good_idea I'm sorry sir, this broke my irony sensor; add -YES if you really mean it! + /FORMAT -reset irc away + +%9See also:%9 RELOAD, SAVE, SET + diff --git a/docs/help/hash b/docs/help/hash new file mode 100644 index 0000000..8864515 --- /dev/null +++ b/docs/help/hash @@ -0,0 +1,22 @@ + +%9Syntax:%9 + +HASH + +%9Description:%9 + + This is an ancient command that is no longer used; if you on an IRC server + that supports this command, please contact us to we can update the + documentation. + +%9Examples:%9 + + /HASH + +%9References:%9 + + https://irssi.org + https://github.com/irssi + +%9See also:%9 DIE, KILL, OPER + diff --git a/docs/help/help b/docs/help/help new file mode 100644 index 0000000..c5e699c --- /dev/null +++ b/docs/help/help @@ -0,0 +1,27 @@ + +%9Syntax:%9 + +HELP %|[<command>] + +%9Parameters:%9 + + The command to display the documentation for; if no argument is given, the + list of commands will be displayed. + +%9Description:%9 + + Displays the documentation for the given command. + +%9Examples:%9 + + /HELP + /HELP AWAY + /HELP CONNECT + +%9References:%9 + + https://irssi.org + https://github.com/irssi + +%9See also:%9 CONNECT, MSG, NETWORK, SERVER + diff --git a/docs/help/hilight b/docs/help/hilight new file mode 100644 index 0000000..8841416 --- /dev/null +++ b/docs/help/hilight @@ -0,0 +1,43 @@ + +%9Syntax:%9 + +HILIGHT %|[-nick | -word | -line] [-mask | -full | -matchcase | -regexp] [-color <color>] [-actcolor <color>] [-level <level>] [-network <network>] [-channels <channels>] <text> + +%9Parameters:%9 + + -nick: Highlights only the nickname and not the whole line. + -word: Highlights only the word and not the whole line. + -line: Highlights the whole line. + -mask: Highlights all messages from users matching the mask. + -full: The text must match the full word. + -matchcase: The text must match case. + -regexp: The text is a regular expression. + -color: The color to display the highlight in. + -actcolor: The color to mark the highlight activity in the statusbar. + -level: Matches only on the given message level. + -network: Matches only on the given network. + -channels: Matches only on the given channels. + -priority: The priority to use when multiple highlights match. + + The text to highlight on; if no argument is given, the list of highlights + will be displayed. + +%9Description:%9 + + Highlights the keyword or pattern to make sure that you don't miss any + important messages. + +%9Examples:%9 + + /HILIGHT + /HILIGHT mike + /HILIGHT -regexp mi+ke+ + /HILIGHT -mask -color %%G bob!*@*.irssi.org + /HILIGHT -full -color %%G -actcolor %%Y redbull + +%9References:%9 + + https://github.com/irssi/irssi/blob/master/docs/formats.txt + +%9See also:%9 DEHILIGHT, LEVELS + diff --git a/docs/help/ignore b/docs/help/ignore new file mode 100644 index 0000000..86ce63d --- /dev/null +++ b/docs/help/ignore @@ -0,0 +1,56 @@ + +%9Syntax:%9 + +IGNORE %|[-regexp | -full] [-pattern <pattern>] [-except] [-replies] [-network <network>] [-channels <channel>] [-time <time>] <mask> [<levels>] +IGNORE %|[-regexp | -full] [-pattern <pattern>] [-except] [-replies] [-network <network>] [-time <time>] <channels> [<levels>] + +%9Parameters:%9 + + -regexp: Indicates that the pattern is a regular expression. + -full: Indicates that the pattern must match a full word. + -pattern: The text pattern to ignore. + -except: Negates the ignore. + -replies: Also ignore nicknames who are talking to anyone who matches + the ignore. + -network: Ignores only on a specific network. + -channels: Ignores only on specific channels. + -time: The timeout to automatically remove the ignore. + Accepts units specified in days, hours, minutes, seconds, + milliseconds, or no unit for seconds. + + The mask, channels and levels to ignore; if no argument is provided, the + list of ignores will be displayed. + +%9Description:%9 + + Ignores nicknames or text that matches a pattern. + + The special level 'NO_ACT' can be used to ignore activity in the statusbar + without actually ignoring the message; this behavior is somewhat special + because it is allowed in addition to other ignores for the same target. + The special level 'HIDDEN' can be used to hide matching messages that can + later be revealed using /WINDOW HIDELEVEL -HIDDEN + The special level 'NOHILIGHT' can be used to suppress hilights without actually + ignoring the message. + +%9Examples:%9 + + /IGNORE + /IGNORE * JOINS + /IGNORE * CTCPS + /IGNORE -except *!*@*.irssi.org CTCPS + /IGNORE #irssi ALL -PUBLIC -ACTIONS + /IGNORE -replies *!*@*.irssi.org ALL + /IGNORE -regexp -pattern (away|gone|back|playing|returned) * ACTIONS + /IGNORE -regexp -pattern (away|gone|back|playing|returned) #channel ACTIONS + /IGNORE *zzz* NICKS + /IGNORE *afk* NICKS + /IGNORE *away* NICKS + /IGNORE #irssi NO_ACT JOINS PARTS QUITS + /IGNORE mike NO_ACT -MSGS + /IGNORE mike HIDDEN PUBLIC JOINS PARTS QUITS + /IGNORE -time 5days christmas PUBLICS + /IGNORE -time 300 mike PUBLICS + +%9See also:%9 ACCEPT, SILENCE, UNIGNORE + diff --git a/docs/help/in/Makefile.am b/docs/help/in/Makefile.am new file mode 100644 index 0000000..116f00b --- /dev/null +++ b/docs/help/in/Makefile.am @@ -0,0 +1,119 @@ +# Makefile.am is autogenerated by autogen.sh from Makefile.am.gen + +EXTRA_DIST = \ + Makefile.am.gen \ + accept.in \ + action.in \ + admin.in \ + alias.in \ + away.in \ + ban.in \ + beep.in \ + bind.in \ + cat.in \ + cd.in \ + channel.in \ + clear.in \ + completion.in \ + connect.in \ + ctcp.in \ + cycle.in \ + dcc.in \ + dehilight.in \ + deop.in \ + devoice.in \ + die.in \ + disconnect.in \ + echo.in \ + eval.in \ + exec.in \ + flushbuffer.in \ + format.in \ + hash.in \ + help.in \ + hilight.in \ + ignore.in \ + info.in \ + invite.in \ + irssiproxy.in \ + ison.in \ + join.in \ + kick.in \ + kickban.in \ + kill.in \ + knock.in \ + knockout.in \ + lastlog.in \ + layout.in \ + levels.in \ + links.in \ + list.in \ + load.in \ + log.in \ + lusers.in \ + map.in \ + me.in \ + mircdcc.in \ + mode.in \ + motd.in \ + msg.in \ + names.in \ + nctcp.in \ + netsplit.in \ + network.in \ + nick.in \ + notice.in \ + notify.in \ + op.in \ + oper.in \ + otr.in \ + part.in \ + ping.in \ + query.in \ + quit.in \ + quote.in \ + rawlog.in \ + recode.in \ + reconnect.in \ + rehash.in \ + reload.in \ + restart.in \ + rmreconns.in \ + rmrejoins.in \ + save.in \ + sconnect.in \ + script.in \ + scrollback.in \ + server.in \ + servlist.in \ + set.in \ + silence.in \ + squery.in \ + squit.in \ + stats.in \ + statusbar.in \ + time.in \ + toggle.in \ + topic.in \ + trace.in \ + ts.in \ + unalias.in \ + unban.in \ + unignore.in \ + unload.in \ + unnotify.in \ + unquery.in \ + unsilence.in \ + upgrade.in \ + uptime.in \ + userhost.in \ + ver.in \ + version.in \ + voice.in \ + wait.in \ + wall.in \ + wallops.in \ + who.in \ + whois.in \ + whowas.in \ + window.in diff --git a/docs/help/in/Makefile.am.gen b/docs/help/in/Makefile.am.gen new file mode 100644 index 0000000..9b0f2aa --- /dev/null +++ b/docs/help/in/Makefile.am.gen @@ -0,0 +1,5 @@ +# Makefile.am is autogenerated by autogen.sh from Makefile.am.gen + +EXTRA_DIST = \ + Makefile.am.gen \ +@HELPFILES@ diff --git a/docs/help/in/Makefile.in b/docs/help/in/Makefile.in new file mode 100644 index 0000000..4511319 --- /dev/null +++ b/docs/help/in/Makefile.in @@ -0,0 +1,611 @@ +# Makefile.in generated by automake 1.16.5 from Makefile.am. +# @configure_input@ + +# Copyright (C) 1994-2021 Free Software Foundation, Inc. + +# This Makefile.in is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY, to the extent permitted by law; without +# even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. + +@SET_MAKE@ + +# Makefile.am is autogenerated by autogen.sh from Makefile.am.gen +VPATH = @srcdir@ +am__is_gnu_make = { \ + if test -z '$(MAKELEVEL)'; then \ + false; \ + elif test -n '$(MAKE_HOST)'; then \ + true; \ + elif test -n '$(MAKE_VERSION)' && test -n '$(CURDIR)'; then \ + true; \ + else \ + false; \ + fi; \ +} +am__make_running_with_option = \ + case $${target_option-} in \ + ?) ;; \ + *) echo "am__make_running_with_option: internal error: invalid" \ + "target option '$${target_option-}' specified" >&2; \ + exit 1;; \ + esac; \ + has_opt=no; \ + sane_makeflags=$$MAKEFLAGS; \ + if $(am__is_gnu_make); then \ + sane_makeflags=$$MFLAGS; \ + else \ + case $$MAKEFLAGS in \ + *\\[\ \ ]*) \ + bs=\\; \ + sane_makeflags=`printf '%s\n' "$$MAKEFLAGS" \ + | sed "s/$$bs$$bs[$$bs $$bs ]*//g"`;; \ + esac; \ + fi; \ + skip_next=no; \ + strip_trailopt () \ + { \ + flg=`printf '%s\n' "$$flg" | sed "s/$$1.*$$//"`; \ + }; \ + for flg in $$sane_makeflags; do \ + test $$skip_next = yes && { skip_next=no; continue; }; \ + case $$flg in \ + *=*|--*) continue;; \ + -*I) strip_trailopt 'I'; skip_next=yes;; \ + -*I?*) strip_trailopt 'I';; \ + -*O) strip_trailopt 'O'; skip_next=yes;; \ + -*O?*) strip_trailopt 'O';; \ + -*l) strip_trailopt 'l'; skip_next=yes;; \ + -*l?*) strip_trailopt 'l';; \ + -[dEDm]) skip_next=yes;; \ + -[JT]) skip_next=yes;; \ + esac; \ + case $$flg in \ + *$$target_option*) has_opt=yes; break;; \ + esac; \ + done; \ + test $$has_opt = yes +am__make_dryrun = (target_option=n; $(am__make_running_with_option)) +am__make_keepgoing = (target_option=k; $(am__make_running_with_option)) +pkgdatadir = $(datadir)/@PACKAGE@ +pkgincludedir = $(includedir)/@PACKAGE@ +pkglibdir = $(libdir)/@PACKAGE@ +pkglibexecdir = $(libexecdir)/@PACKAGE@ +am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd +install_sh_DATA = $(install_sh) -c -m 644 +install_sh_PROGRAM = $(install_sh) -c +install_sh_SCRIPT = $(install_sh) -c +INSTALL_HEADER = $(INSTALL_DATA) +transform = $(program_transform_name) +NORMAL_INSTALL = : +PRE_INSTALL = : +POST_INSTALL = : +NORMAL_UNINSTALL = : +PRE_UNINSTALL = : +POST_UNINSTALL = : +build_triplet = @build@ +host_triplet = @host@ +subdir = docs/help/in +ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 +am__aclocal_m4_deps = $(top_srcdir)/m4/glib-2.0.m4 \ + $(top_srcdir)/m4/glibtests.m4 $(top_srcdir)/m4/libgcrypt.m4 \ + $(top_srcdir)/m4/libotr.m4 $(top_srcdir)/m4/libtool.m4 \ + $(top_srcdir)/m4/ltoptions.m4 $(top_srcdir)/m4/ltsugar.m4 \ + $(top_srcdir)/m4/ltversion.m4 $(top_srcdir)/m4/lt~obsolete.m4 \ + $(top_srcdir)/m4/pkg.m4 $(top_srcdir)/configure.ac +am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ + $(ACLOCAL_M4) +DIST_COMMON = $(srcdir)/Makefile.am $(am__DIST_COMMON) +mkinstalldirs = $(install_sh) -d +CONFIG_HEADER = $(top_builddir)/irssi-config.h +CONFIG_CLEAN_FILES = +CONFIG_CLEAN_VPATH_FILES = +AM_V_P = $(am__v_P_@AM_V@) +am__v_P_ = $(am__v_P_@AM_DEFAULT_V@) +am__v_P_0 = false +am__v_P_1 = : +AM_V_GEN = $(am__v_GEN_@AM_V@) +am__v_GEN_ = $(am__v_GEN_@AM_DEFAULT_V@) +am__v_GEN_0 = @echo " GEN " $@; +am__v_GEN_1 = +AM_V_at = $(am__v_at_@AM_V@) +am__v_at_ = $(am__v_at_@AM_DEFAULT_V@) +am__v_at_0 = @ +am__v_at_1 = +SOURCES = +DIST_SOURCES = +am__can_run_installinfo = \ + case $$AM_UPDATE_INFO_DIR in \ + n|no|NO) false;; \ + *) (install-info --version) >/dev/null 2>&1;; \ + esac +am__tagged_files = $(HEADERS) $(SOURCES) $(TAGS_FILES) $(LISP) +am__DIST_COMMON = $(srcdir)/Makefile.in +DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) +ACLOCAL = @ACLOCAL@ +AMTAR = @AMTAR@ +AM_DEFAULT_VERBOSITY = @AM_DEFAULT_VERBOSITY@ +AR = @AR@ +AUTOCONF = @AUTOCONF@ +AUTOHEADER = @AUTOHEADER@ +AUTOMAKE = @AUTOMAKE@ +AWK = @AWK@ +CC = @CC@ +CCDEPMODE = @CCDEPMODE@ +CFLAGS = @CFLAGS@ +CHAT_MODULES = @CHAT_MODULES@ +COMMON_LIBS = @COMMON_LIBS@ +COMMON_NOUI_LIBS = @COMMON_NOUI_LIBS@ +CPP = @CPP@ +CPPFLAGS = @CPPFLAGS@ +CSCOPE = @CSCOPE@ +CTAGS = @CTAGS@ +CYGPATH_W = @CYGPATH_W@ +DEFS = @DEFS@ +DEPDIR = @DEPDIR@ +DLLTOOL = @DLLTOOL@ +DSYMUTIL = @DSYMUTIL@ +DUMPBIN = @DUMPBIN@ +ECHO_C = @ECHO_C@ +ECHO_N = @ECHO_N@ +ECHO_T = @ECHO_T@ +EGREP = @EGREP@ +ETAGS = @ETAGS@ +EXEEXT = @EXEEXT@ +FGREP = @FGREP@ +FILECMD = @FILECMD@ +FUZZER_LIBS = @FUZZER_LIBS@ +GLIB_CFLAGS = @GLIB_CFLAGS@ +GLIB_GENMARSHAL = @GLIB_GENMARSHAL@ +GLIB_LIBS = @GLIB_LIBS@ +GLIB_MKENUMS = @GLIB_MKENUMS@ +GOBJECT_QUERY = @GOBJECT_QUERY@ +GREP = @GREP@ +INSTALL = @INSTALL@ +INSTALL_DATA = @INSTALL_DATA@ +INSTALL_PROGRAM = @INSTALL_PROGRAM@ +INSTALL_SCRIPT = @INSTALL_SCRIPT@ +INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ +LD = @LD@ +LDFLAGS = @LDFLAGS@ +LIBGCRYPT_CFLAGS = @LIBGCRYPT_CFLAGS@ +LIBGCRYPT_CONFIG = @LIBGCRYPT_CONFIG@ +LIBGCRYPT_LIBS = @LIBGCRYPT_LIBS@ +LIBOBJS = @LIBOBJS@ +LIBOTR_CFLAGS = @LIBOTR_CFLAGS@ +LIBOTR_LIBS = @LIBOTR_LIBS@ +LIBS = @LIBS@ +LIBTOOL = @LIBTOOL@ +LIPO = @LIPO@ +LN_S = @LN_S@ +LTLIBOBJS = @LTLIBOBJS@ +LT_SYS_LIBRARY_PATH = @LT_SYS_LIBRARY_PATH@ +MAINT = @MAINT@ +MAKEINFO = @MAKEINFO@ +MANIFEST_TOOL = @MANIFEST_TOOL@ +MKDIR_P = @MKDIR_P@ +NM = @NM@ +NMEDIT = @NMEDIT@ +OBJDUMP = @OBJDUMP@ +OBJEXT = @OBJEXT@ +OPENSSL_CFLAGS = @OPENSSL_CFLAGS@ +OPENSSL_LIBS = @OPENSSL_LIBS@ +OTOOL = @OTOOL@ +OTOOL64 = @OTOOL64@ +OTR_CFLAGS = @OTR_CFLAGS@ +OTR_LDFLAGS = @OTR_LDFLAGS@ +OTR_LINK_FLAGS = @OTR_LINK_FLAGS@ +OTR_LINK_LIBS = @OTR_LINK_LIBS@ +PACKAGE = @PACKAGE@ +PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ +PACKAGE_NAME = @PACKAGE_NAME@ +PACKAGE_STRING = @PACKAGE_STRING@ +PACKAGE_TARNAME = @PACKAGE_TARNAME@ +PACKAGE_URL = @PACKAGE_URL@ +PACKAGE_VERSION = @PACKAGE_VERSION@ +PATH_SEPARATOR = @PATH_SEPARATOR@ +PERL_CFLAGS = @PERL_CFLAGS@ +PERL_EXTRA_OPTS = @PERL_EXTRA_OPTS@ +PERL_FE_LINK_LIBS = @PERL_FE_LINK_LIBS@ +PERL_LDFLAGS = @PERL_LDFLAGS@ +PERL_LINK_FLAGS = @PERL_LINK_FLAGS@ +PERL_LINK_LIBS = @PERL_LINK_LIBS@ +PERL_MM_OPT = @PERL_MM_OPT@ +PERL_MM_PARAMS = @PERL_MM_PARAMS@ +PERL_STATIC_LIBS = @PERL_STATIC_LIBS@ +PERL_USE_LIB = @PERL_USE_LIB@ +PKG_CONFIG = @PKG_CONFIG@ +PKG_CONFIG_LIBDIR = @PKG_CONFIG_LIBDIR@ +PKG_CONFIG_PATH = @PKG_CONFIG_PATH@ +PROG_LIBS = @PROG_LIBS@ +RANLIB = @RANLIB@ +SED = @SED@ +SET_MAKE = @SET_MAKE@ +SHELL = @SHELL@ +STRIP = @STRIP@ +TEXTUI_LIBS = @TEXTUI_LIBS@ +VERSION = @VERSION@ +abs_builddir = @abs_builddir@ +abs_srcdir = @abs_srcdir@ +abs_top_builddir = @abs_top_builddir@ +abs_top_srcdir = @abs_top_srcdir@ +ac_ct_AR = @ac_ct_AR@ +ac_ct_CC = @ac_ct_CC@ +ac_ct_DUMPBIN = @ac_ct_DUMPBIN@ +am__include = @am__include@ +am__leading_dot = @am__leading_dot@ +am__quote = @am__quote@ +am__tar = @am__tar@ +am__untar = @am__untar@ +bindir = @bindir@ +build = @build@ +build_alias = @build_alias@ +build_cpu = @build_cpu@ +build_os = @build_os@ +build_vendor = @build_vendor@ +builddir = @builddir@ +datadir = @datadir@ +datarootdir = @datarootdir@ +docdir = @docdir@ +dvidir = @dvidir@ +exec_prefix = @exec_prefix@ +host = @host@ +host_alias = @host_alias@ +host_cpu = @host_cpu@ +host_os = @host_os@ +host_vendor = @host_vendor@ +htmldir = @htmldir@ +includedir = @includedir@ +infodir = @infodir@ +install_sh = @install_sh@ +installed_test_metadir = @installed_test_metadir@ +installed_testdir = @installed_testdir@ +irc_MODULES = @irc_MODULES@ +libdir = @libdir@ +libexecdir = @libexecdir@ +localedir = @localedir@ +localstatedir = @localstatedir@ +mandir = @mandir@ +mkdir_p = @mkdir_p@ +oldincludedir = @oldincludedir@ +otr_module_lib = @otr_module_lib@ +otr_static_lib = @otr_static_lib@ +pdfdir = @pdfdir@ +perl_module_fe_lib = @perl_module_fe_lib@ +perl_module_lib = @perl_module_lib@ +perl_static_fe_lib = @perl_static_fe_lib@ +perl_static_lib = @perl_static_lib@ +perlpath = @perlpath@ +pkgconfigdir = @pkgconfigdir@ +prefix = @prefix@ +program_transform_name = @program_transform_name@ +psdir = @psdir@ +runstatedir = @runstatedir@ +sbindir = @sbindir@ +sedpath = @sedpath@ +sharedstatedir = @sharedstatedir@ +srcdir = @srcdir@ +sysconfdir = @sysconfdir@ +target_alias = @target_alias@ +top_build_prefix = @top_build_prefix@ +top_builddir = @top_builddir@ +top_srcdir = @top_srcdir@ +EXTRA_DIST = \ + Makefile.am.gen \ + accept.in \ + action.in \ + admin.in \ + alias.in \ + away.in \ + ban.in \ + beep.in \ + bind.in \ + cat.in \ + cd.in \ + channel.in \ + clear.in \ + completion.in \ + connect.in \ + ctcp.in \ + cycle.in \ + dcc.in \ + dehilight.in \ + deop.in \ + devoice.in \ + die.in \ + disconnect.in \ + echo.in \ + eval.in \ + exec.in \ + flushbuffer.in \ + format.in \ + hash.in \ + help.in \ + hilight.in \ + ignore.in \ + info.in \ + invite.in \ + irssiproxy.in \ + ison.in \ + join.in \ + kick.in \ + kickban.in \ + kill.in \ + knock.in \ + knockout.in \ + lastlog.in \ + layout.in \ + levels.in \ + links.in \ + list.in \ + load.in \ + log.in \ + lusers.in \ + map.in \ + me.in \ + mircdcc.in \ + mode.in \ + motd.in \ + msg.in \ + names.in \ + nctcp.in \ + netsplit.in \ + network.in \ + nick.in \ + notice.in \ + notify.in \ + op.in \ + oper.in \ + otr.in \ + part.in \ + ping.in \ + query.in \ + quit.in \ + quote.in \ + rawlog.in \ + recode.in \ + reconnect.in \ + rehash.in \ + reload.in \ + restart.in \ + rmreconns.in \ + rmrejoins.in \ + save.in \ + sconnect.in \ + script.in \ + scrollback.in \ + server.in \ + servlist.in \ + set.in \ + silence.in \ + squery.in \ + squit.in \ + stats.in \ + statusbar.in \ + time.in \ + toggle.in \ + topic.in \ + trace.in \ + ts.in \ + unalias.in \ + unban.in \ + unignore.in \ + unload.in \ + unnotify.in \ + unquery.in \ + unsilence.in \ + upgrade.in \ + uptime.in \ + userhost.in \ + ver.in \ + version.in \ + voice.in \ + wait.in \ + wall.in \ + wallops.in \ + who.in \ + whois.in \ + whowas.in \ + window.in + +all: all-am + +.SUFFIXES: +$(srcdir)/Makefile.in: @MAINTAINER_MODE_TRUE@ $(srcdir)/Makefile.am $(am__configure_deps) + @for dep in $?; do \ + case '$(am__configure_deps)' in \ + *$$dep*) \ + ( cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh ) \ + && { if test -f $@; then exit 0; else break; fi; }; \ + exit 1;; \ + esac; \ + done; \ + echo ' cd $(top_srcdir) && $(AUTOMAKE) --foreign docs/help/in/Makefile'; \ + $(am__cd) $(top_srcdir) && \ + $(AUTOMAKE) --foreign docs/help/in/Makefile +Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status + @case '$?' in \ + *config.status*) \ + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh;; \ + *) \ + echo ' cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__maybe_remake_depfiles)'; \ + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__maybe_remake_depfiles);; \ + esac; + +$(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh + +$(top_srcdir)/configure: @MAINTAINER_MODE_TRUE@ $(am__configure_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(ACLOCAL_M4): @MAINTAINER_MODE_TRUE@ $(am__aclocal_m4_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(am__aclocal_m4_deps): + +mostlyclean-libtool: + -rm -f *.lo + +clean-libtool: + -rm -rf .libs _libs +tags TAGS: + +ctags CTAGS: + +cscope cscopelist: + +distdir: $(BUILT_SOURCES) + $(MAKE) $(AM_MAKEFLAGS) distdir-am + +distdir-am: $(DISTFILES) + @srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + topsrcdirstrip=`echo "$(top_srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + list='$(DISTFILES)'; \ + dist_files=`for file in $$list; do echo $$file; done | \ + sed -e "s|^$$srcdirstrip/||;t" \ + -e "s|^$$topsrcdirstrip/|$(top_builddir)/|;t"`; \ + case $$dist_files in \ + */*) $(MKDIR_P) `echo "$$dist_files" | \ + sed '/\//!d;s|^|$(distdir)/|;s,/[^/]*$$,,' | \ + sort -u` ;; \ + esac; \ + for file in $$dist_files; do \ + if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \ + if test -d $$d/$$file; then \ + dir=`echo "/$$file" | sed -e 's,/[^/]*$$,,'`; \ + if test -d "$(distdir)/$$file"; then \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \ + cp -fpR $(srcdir)/$$file "$(distdir)$$dir" || exit 1; \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + cp -fpR $$d/$$file "$(distdir)$$dir" || exit 1; \ + else \ + test -f "$(distdir)/$$file" \ + || cp -p $$d/$$file "$(distdir)/$$file" \ + || exit 1; \ + fi; \ + done +check-am: all-am +check: check-am +all-am: Makefile +installdirs: +install: install-am +install-exec: install-exec-am +install-data: install-data-am +uninstall: uninstall-am + +install-am: all-am + @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am + +installcheck: installcheck-am +install-strip: + if test -z '$(STRIP)'; then \ + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + install; \ + else \ + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'" install; \ + fi +mostlyclean-generic: + +clean-generic: + +distclean-generic: + -test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES) + -test . = "$(srcdir)" || test -z "$(CONFIG_CLEAN_VPATH_FILES)" || rm -f $(CONFIG_CLEAN_VPATH_FILES) + +maintainer-clean-generic: + @echo "This command is intended for maintainers to use" + @echo "it deletes files that may require special tools to rebuild." +clean: clean-am + +clean-am: clean-generic clean-libtool mostlyclean-am + +distclean: distclean-am + -rm -f Makefile +distclean-am: clean-am distclean-generic + +dvi: dvi-am + +dvi-am: + +html: html-am + +html-am: + +info: info-am + +info-am: + +install-data-am: + +install-dvi: install-dvi-am + +install-dvi-am: + +install-exec-am: + +install-html: install-html-am + +install-html-am: + +install-info: install-info-am + +install-info-am: + +install-man: + +install-pdf: install-pdf-am + +install-pdf-am: + +install-ps: install-ps-am + +install-ps-am: + +installcheck-am: + +maintainer-clean: maintainer-clean-am + -rm -f Makefile +maintainer-clean-am: distclean-am maintainer-clean-generic + +mostlyclean: mostlyclean-am + +mostlyclean-am: mostlyclean-generic mostlyclean-libtool + +pdf: pdf-am + +pdf-am: + +ps: ps-am + +ps-am: + +uninstall-am: + +.MAKE: install-am install-strip + +.PHONY: all all-am check check-am clean clean-generic clean-libtool \ + cscopelist-am ctags-am distclean distclean-generic \ + distclean-libtool distdir dvi dvi-am html html-am info info-am \ + install install-am install-data install-data-am install-dvi \ + install-dvi-am install-exec install-exec-am install-html \ + install-html-am install-info install-info-am install-man \ + install-pdf install-pdf-am install-ps install-ps-am \ + install-strip installcheck installcheck-am installdirs \ + maintainer-clean maintainer-clean-generic mostlyclean \ + mostlyclean-generic mostlyclean-libtool pdf pdf-am ps ps-am \ + tags-am uninstall uninstall-am + +.PRECIOUS: Makefile + + +# Tell versions [3.59,3.63) of GNU make to not export all variables. +# Otherwise a system limit (for SysV at least) may be exceeded. +.NOEXPORT: diff --git a/docs/help/in/accept.in b/docs/help/in/accept.in new file mode 100644 index 0000000..699441a --- /dev/null +++ b/docs/help/in/accept.in @@ -0,0 +1,30 @@ + +%9Syntax:%9 + +@SYNTAX:accept@ + +%9Parameters:%9 + + A comma-separated list of nicknames to add or remove; if no argument is + given, your accept list will be displayed. + +%9Description:%9 + + Allows you to specify who you want to receive private messages and notices + from while you have callerid enabled. + + When you have callerid enabled, messages from other users are blocked and + the sender is notified. + + Users are automatically removed from the accept list if they quit, split + or change nickname; the accept list is lost when you disconnect. + + This command only works on IRC servers that support the callerid user mode. + +%9Examples:%9 + + /ACCEPT mike,bob,-john,-sarah + /ACCEPT sarah,-bob + +%9See also:%9 IGNORE, SILENCE + diff --git a/docs/help/in/action.in b/docs/help/in/action.in new file mode 100644 index 0000000..9a2912c --- /dev/null +++ b/docs/help/in/action.in @@ -0,0 +1,23 @@ + +%9Syntax:%9 + +@SYNTAX:action@ + +%9Parameters:%9 + + -<server tag>: The server tag you want to send the action emote to. + + A target nickname or channel and the message to emote. + +%9Description:%9 + + Sends an action emote to a nickname or a channel. + +%9Examples:%9 + + /ACTION #irssi is hungry! + /ACTION mike had an awesome day @ work + /ACTION -efnet #irssi is happy it's Friday + +%9See also:%9 ME + diff --git a/docs/help/in/admin.in b/docs/help/in/admin.in new file mode 100644 index 0000000..acb6e1a --- /dev/null +++ b/docs/help/in/admin.in @@ -0,0 +1,22 @@ + +%9Syntax:%9 + +@SYNTAX:admin@ + +%9Parameters:%9 + + A nickname or server for which you want to know the administrative details; + if no argument is given, the server you are connected to will be used. + +%9Description:%9 + + Displays the administrative details of a server. + +%9Examples:%9 + + /ADMIN + /ADMIN irc.libera.chat + /ADMIN mike + +%9See also:%9 INFO + diff --git a/docs/help/in/alias.in b/docs/help/in/alias.in new file mode 100644 index 0000000..5cea00c --- /dev/null +++ b/docs/help/in/alias.in @@ -0,0 +1,37 @@ + +%9Syntax:%9 + +@SYNTAX:alias@ + +%9Parameters:%9 + + A name of the alias and the command to execute. You can prepend the alias + with the '-' character to remove the alias; if no argument is given, your + aliases will be displayed. + +%9Description:%9 + + Creates or updates an alias; you can use the ';' character to separate + multiple commands. + + The parameters given to the alias are expanded in '$[\d]'; for example $0, + $1, $2, $8, ..., as well as any other special variable. + + If you don't use any parameters in your alias, all parameters will be + automatically appended after it. + +%9Examples:%9 + + /ALIAS + /ALIAS UH USERHOST + /ALIAS COMEBACK SAY I was hoping for a battle of wits, but you seem to be unarmed. + /ALIAS -COMEBACK + /ALIAS UNACT SCRIPT EXEC \$_->activity(0) for Irssi::windows + /ALIAS QOP ^MSG Q op $C + +%9References:%9 + + https://github.com/irssi/irssi/blob/master/docs/special_vars.txt + +%9See also:%9 BIND, UNALIAS + diff --git a/docs/help/in/away.in b/docs/help/in/away.in new file mode 100644 index 0000000..75bc46c --- /dev/null +++ b/docs/help/in/away.in @@ -0,0 +1,33 @@ + +%9Syntax:%9 + +@SYNTAX:away@ + +%9Parameters:%9 + + -one: Marks yourself as away on the active server. + -all: Marks yourself as away on all the servers you are connected to. + + Your away message; if no argument is given, your away status will be removed. + +%9Description:%9 + + Marks yourself as 'away'; this method is used to inform people that you + are not paying attention to your screen. + + You might use it when you are taking a nap, in the shower, getting some + food, or otherwise engaged. When you're 'away' you will see '(zZzZ)' in + your statusbar. + + Anyone who does a WHOIS on your nickname will see that you are away, as + well as your away message. + +%9Examples:%9 + + /AWAY + /AWAY I'm getting some food. + /AWAY zZzZ + /AWAY -one Feeding the cat! + +%9See also:%9 DISCONNECT + diff --git a/docs/help/in/ban.in b/docs/help/in/ban.in new file mode 100644 index 0000000..724815a --- /dev/null +++ b/docs/help/in/ban.in @@ -0,0 +1,42 @@ + +%9Syntax:%9 + +@SYNTAX:ban@ + +%9Parameters:%9 + + -normal: Uses the *!*user@*.domain.tld format. + -user: Uses the *!*user@* format. + -host: Uses the *!*@host.domain.tld format. + -domain: Uses the *!*@*.domain.tld format. + -custom: Uses the custom format. + + A channel and the nicknames or hostnames to ban; if no arguments are given + the bans in the active channel are displayed. + + If no ban format parameter is given, the value of the ban_type setting will + be used to generate the hostmask to ban. + +%9Description:%9 + + Adds one or more bans to a channel. + +%9Configuring the custom format:%9 + + You must set the custom ban_type to the format you would like to use. For + example, if you set the custom ban_type to 'nick domain', it will generate + a ban based on the nick!*@*.domain.tld format. + +%9Examples:%9 + + /BAN + /BAN mike + /BAN -host bob + /BAN *!*@*.irssi.org + /BAN -domain sarah + + /SET ban_type custom nick domain + /SET ban_type custom user host + +%9See also:%9 DEOP, KICKBAN, KNOCKOUT, OP, UNBAN + diff --git a/docs/help/in/beep.in b/docs/help/in/beep.in new file mode 100644 index 0000000..d8a06ff --- /dev/null +++ b/docs/help/in/beep.in @@ -0,0 +1,15 @@ + +%9Syntax:%9 + +@SYNTAX:beep@ + +%9Description:%9 + + Outputs the bell-character, usually causing your terminal to beep. + +%9Examples:%9 + + /BEEP + +%9See also:%9 CLEAR + diff --git a/docs/help/in/bind.in b/docs/help/in/bind.in new file mode 100644 index 0000000..8fcc744 --- /dev/null +++ b/docs/help/in/bind.in @@ -0,0 +1,35 @@ + +%9Syntax:%9 + +@SYNTAX:bind@ + +%9Parameters:%9 + + -list: Displays a list of all the bindable commands. + -delete: Removes the binding. + -reset: Reset a key to its default binding. + + A name of the binding and the command to perform; if no parameter is given, + the list of bindings will be displayed. + +Details: + + Adds or removes a binding; the binding itself is case-sensitive and may + contain as many characters as you want. + + Uppercase characters usually indicate that you need to keep the shift-key + pressed to use the binding. + +%9Examples:%9 + + /BIND + /BIND meta-c /CLEAR + /BIND meta-q change_window 16 + /BIND -delete meta-y + /BIND ^W^C /WINDOW NEW HIDE + /BIND ^W^K /WINDOW KILL + /BIND ^[[11~ command AWAY I'm off for today :) + /BIND ^[[12~ command AWAY + +%9See also:%9 ALIAS + diff --git a/docs/help/in/cat.in b/docs/help/in/cat.in new file mode 100644 index 0000000..370c179 --- /dev/null +++ b/docs/help/in/cat.in @@ -0,0 +1,28 @@ + +%9Syntax:%9 + +@SYNTAX:cat@ + +%9Parameters:%9 + + -window: Displays the output in the active window. + + The file to display and optionally a position to seek in the file, + in bytes. + +%9Description:%9 + + Displays the contents of the specified file in the active window if -window + is specified, otherwise to the closest matching window depending on levels. + + The seek position parameter is used internally to display away logs, if + omitted the whole file is shown. + +%9Examples:%9 + + /CAT -window /etc/network/interfaces + /CAT /home/mike/resume.txt + /CAT contact_details.txt + +%9See also:%9 CD, EXEC + diff --git a/docs/help/in/cd.in b/docs/help/in/cd.in new file mode 100644 index 0000000..bc6b7aa --- /dev/null +++ b/docs/help/in/cd.in @@ -0,0 +1,21 @@ + +%9Syntax:%9 + +@SYNTAX:cd@ + +%9Parameters:%9 + + The directory to change into. + +%9Description:%9 + + Changes the current active directory. + +%9Examples:%9 + + /CD /home/public_ftp + /CD /home/mike + /CD /var/log + +%9See also:%9 CAT + diff --git a/docs/help/in/channel.in b/docs/help/in/channel.in new file mode 100644 index 0000000..d9be8cf --- /dev/null +++ b/docs/help/in/channel.in @@ -0,0 +1,48 @@ + +%9Syntax:%9 + +@SYNTAX:channel@ + +%9Parameters:%9 + + LIST: Displays the list of configured channels. + ADD: Adds a channel to your configuration. + MODIFY: Modifies a channel in your configuration. + REMOVE: Removes a channel from your configuration. + + -auto: Automatically join the channel. + -noauto: Don't join the channel automatically. + -bots: The list of hostnames send automated commands to. + -botcmd: The automated commands to perform. + + The channel and network to add to the configuration; you can optionally + specify the password of a channel. + + If no parameters are given, the list of channels you have joined will be + displayed. + +%9Description:%9 + + Adds, removes or displays the configuration of channels; this method is + used to automate and simplify your workflow. + + You can use the ADDALLCHANS command, which is a default alias, to add all + the channels you are present on into the configuration. + +%9Examples:%9 + + /CHANNEL + /CHANNEL LIST + /CHANNEL ADD -auto #irssi liberachat + /CHANNEL ADD -auto #basementcat Quakenet secret_lair + /CHANNEL ADD -auto -bots '*!@*.irssi.org *!bot@irssi.org' -botcmd 'msg $0 op WzerTrzq' #hideout liberachat + /CHANNEL ADD -auto -bots 'Q!TheQBot@CServe.quakenet.org' -botcmd '^MSG Q op #irssi' #irssi Quakenet + /CHANNEL MODIFY -noauto #irssi liberachat + /CHANNEL REMOVE #hideout liberachat + +%9Special Example:%9 + + /ADDALLCHANS + +%9See also:%9 JOIN, TS + diff --git a/docs/help/in/clear.in b/docs/help/in/clear.in new file mode 100644 index 0000000..3b76a7c --- /dev/null +++ b/docs/help/in/clear.in @@ -0,0 +1,19 @@ + +%9Syntax:%9 + +@SYNTAX:clear@ + +%9Parameters:%9 + + -all: Clear all the windows + + The window number to clear; if no argument is given, the active window + will be used. + +%9Description:%9 + + Scrolls up the text in the window and fills the window with blank lines; you + may want to use this to make new text start at the top of the window again. + +%9See also:%9 REDRAW, SCROLLBACK CLEAR + diff --git a/docs/help/in/completion.in b/docs/help/in/completion.in new file mode 100644 index 0000000..4275e34 --- /dev/null +++ b/docs/help/in/completion.in @@ -0,0 +1,35 @@ + +%9Syntax:%9 + +@SYNTAX:completion@ + +%9Parameters:%9 + + -auto: Inserts the completion without pressing a word completion + character. + -delete: Removes the completion from the configuration. + + A key and the value to use as a replacement. If no argument is given, the + list of completions will be displayed. + +%9Description:%9 + + Replaces or completed words or letters; you can write just the first few + letters of the word and press TAB to insert a replacement. + + When a replacement has been found, Irssi will choose the most probable + matching word and replaces it; you may press TAB repeatedly to swap between + matches. + + If you want to remove a completion which has the auto parameter set, you + need to enclose the completion between "'" characters. + +%9Examples:%9 + + /COMPLETION w/h without + /COMPLETION -auto anywya anyway + /COMPLETION -delete 'anywya' + /COMPLETION -delete without + +%9See also:%9 BIND + diff --git a/docs/help/in/connect.in b/docs/help/in/connect.in new file mode 100644 index 0000000..4c6acc9 --- /dev/null +++ b/docs/help/in/connect.in @@ -0,0 +1,44 @@ + +%9Syntax:%9 + +@SYNTAX:connect@ + +%9Parameters:%9 + + -4: Connects using IPv4. + -6: Connects using IPv6. + -tls: Connects using TLS encryption. + -tls_cert: The TLS client certificate file. + -tls_pkey: The TLS client private key, if not included in the certificate file. + -tls_pass: The password for the TLS client private key or certificate. + -tls_verify: Verifies the TLS certificate of the server. + -tls_cafile: The file with the list of CA certificates. + -tls_capath: The directory which contains the CA certificates. + -tls_ciphers: TLS cipher suite preference lists. + -tls_pinned_cert: Pinned x509 certificate fingerprint. + -tls_pinned_pubkey: Pinned public key fingerprint. + -nocap: Disable CAPREQ during connect + -noproxy: Ignores the global proxy configuration. + -network: The network this connection belongs to. + -host: The hostname you would like to connect from. + -rawlog: Immediately open rawlog after connecting. + -!: Doesn't autojoin channels. + -noautosendcmd: Doesn't execute autosendcmd. + + A network or server to connect to; you can optionally specify a custom port, + password and nickname. + +%9Description:%9 + + Opens a new connection to the specified network or server; existing + connections are kept. + +%9Examples:%9 + + /CONNECT liberachat + /CONNECT -6 liberachat + /CONNECT -4 -! -host staff.irssi.org -network liberachat irc.libera.chat + /CONNECT irc.irssi.org 6667 WzerT8zq mike + +%9See also:%9 DISCONNECT, RMRECONNS, SERVER + diff --git a/docs/help/in/ctcp.in b/docs/help/in/ctcp.in new file mode 100644 index 0000000..9381806 --- /dev/null +++ b/docs/help/in/ctcp.in @@ -0,0 +1,23 @@ + +%9Syntax:%9 + +@SYNTAX:ctcp@ + +%9Parameters:%9 + + A target nickname or channel and a command. + +%9Description:%9 + + Sends a CTCP request towards the given target nickname or channel. + +%9Examples:%9 + + /CTCP mike PING + /CTCP #irssi VERSION + /CTCP bob USERINFO + /CTCP sarah CLIENTINFO + /CTCP john TIME + +%9See also:%9 ACTION, ME + diff --git a/docs/help/in/cycle.in b/docs/help/in/cycle.in new file mode 100644 index 0000000..c44a976 --- /dev/null +++ b/docs/help/in/cycle.in @@ -0,0 +1,22 @@ + +%9Syntax:%9 + +@SYNTAX:cycle@ + +%9Parameters:%9 + + A channel and the message. If no argument is given, the active channel + will be used. + +%9Description:%9 + + Leaves and rejoins a channel. + +%9Examples:%9 + + /CYCLE + /CYCLE #irssi + /CYCLE #irssi BRB :) + +%9See also:%9 JOIN, PART + diff --git a/docs/help/in/dcc.in b/docs/help/in/dcc.in new file mode 100644 index 0000000..2e58c9b --- /dev/null +++ b/docs/help/in/dcc.in @@ -0,0 +1,45 @@ + +%9Syntax:%9 + +@SYNTAX:dcc@ + +%9Parameters:%9 + + CHAT: Initiates or accept a chat request. + GET: Accepts a file transfer request. + RESUME: Resumes a file transfer. + SERVER: Starts a DCC server. + CLOSE: Closes a DCC connection. + LIST: Displays all the open DCC connections. + + -passive: Uses the passive DCC protocol. + -scf: Use any combination of the flags to indicate: + 's' - send + 'c' - chat + 'f' - fserver + + The nickname of the person to chat with, or the name of the file to + transfer. + +%9Description:%9 + + The DCC protocol is used to initiate client-to-client chat connections + and file transfers. + + If you are behind NAT, or if the firewall is too restrictive, you might + want to try if using the passive parameter resolves your connection + problem. + + You can send files which contain special character or spaces by enclosing + the filename within quotes. For example: 'my file with spaces.txt'. + +%9Examples:%9 + + /DCC CHAT mike + /DCC GET bob "summer vacation.mkv" + /DCC SEND sarah "summer vacation.mkv" + /DCC CLOSE get mike + /DCC CLOSE send bob "summer vacation.mkv" + +%9See also:%9 CD + diff --git a/docs/help/in/dehilight.in b/docs/help/in/dehilight.in new file mode 100644 index 0000000..7c7fe15 --- /dev/null +++ b/docs/help/in/dehilight.in @@ -0,0 +1,20 @@ + +%9Syntax:%9 + +@SYNTAX:dehilight@ + +%9Parameters:%9 + + The id or mask of the highlight to remove. + +%9Description:%9 + + Removes the specified highlight from the configuration. + +%9Examples:%9 + + /DEHILIGHT 1 + /DEHILIGHT 31 + +%9See also:%9 HILIGHT + diff --git a/docs/help/in/deop.in b/docs/help/in/deop.in new file mode 100644 index 0000000..9f70cde --- /dev/null +++ b/docs/help/in/deop.in @@ -0,0 +1,23 @@ + +%9Syntax:%9 + +@SYNTAX:deop@ + +%9Parameters:%9 + + A list of nicknames to deop. + +%9Description:%9 + + Removes the channel operator privileges from the given nicknames; you may + use the wildcard character '*' in a nickname. + +%9Examples:%9 + + /DEOP mike + /DEOP bob sarah + /DEOP jo*n + /DEOP * + +%9See also:%9 DEVOICE, MODE, OP, VOICE + diff --git a/docs/help/in/devoice.in b/docs/help/in/devoice.in new file mode 100644 index 0000000..11e3d53 --- /dev/null +++ b/docs/help/in/devoice.in @@ -0,0 +1,26 @@ + +%9Syntax:%9 + +@SYNTAX:devoice@ + +%9Parameters:%9 + + A list of nicknames to devoice. + +%9Description:%9 + + Removes the channel voice privileges from the given nicknames; you may use + the wildcard character '*' in a nickname. + + If a channel is moderated, the users will require a voice or op in order to + be able to send messages to the channel. + +%9Examples:%9 + + /DEVOICE mike + /DEVOICE bob sarah + /DEVOICE jo*n + /DEVOICE * + +%9See also:%9 DEOP, MODE, OP, VOICE + diff --git a/docs/help/in/die.in b/docs/help/in/die.in new file mode 100644 index 0000000..1af9c5b --- /dev/null +++ b/docs/help/in/die.in @@ -0,0 +1,15 @@ + +%9Syntax:%9 + +@SYNTAX:die@ + +%9Description:%9 + + Terminates the IRC server; this command is reserved for IRC operators. + +%9Examples:%9 + + /DIE + +%9See also:%9 KILL, OPER, WALLOPS + diff --git a/docs/help/in/disconnect.in b/docs/help/in/disconnect.in new file mode 100644 index 0000000..c53b1e6 --- /dev/null +++ b/docs/help/in/disconnect.in @@ -0,0 +1,26 @@ + +%9Syntax:%9 + +@SYNTAX:disconnect@ + +%9Parameters:%9 + + The network to disconnect from and the message to advertise; if no + parameters are given, the active server will be used. + +%9Description:%9 + + Disconnects from an IRC server; the list of all the servers you are + connected to can be retrieved via the SERVER command. + + Use the wildcard character '*' if you want to disconnect from the active + server. + +%9Examples:%9 + + /DISCONNECT liberachat I'm off for today, take care! + /DISCONNECT * Vacation time :D + /DISCONNECT + +%9See also:%9 CONNECT, SERVER + diff --git a/docs/help/in/echo.in b/docs/help/in/echo.in new file mode 100644 index 0000000..7f08018 --- /dev/null +++ b/docs/help/in/echo.in @@ -0,0 +1,24 @@ + +%9Syntax:%9 + +@SYNTAX:echo@ + +%9Parameters:%9 + + -window: Displays the output in the target window. + -level: Displays the output with a given message level. + + The text output; if no target is given, the active window will be used. + +%9Description:%9 + + Displays the given text. + +%9Examples:%9 + + /ECHO 1 + 1 = 2 :D + /ECHO Testing the ECHO command + /ECHO -window #irssi Special variables such as ${N} will not be expanded. + +%9See also:%9 CAT, EVAL, EXEC, LEVELS + diff --git a/docs/help/in/eval.in b/docs/help/in/eval.in new file mode 100644 index 0000000..c53c624 --- /dev/null +++ b/docs/help/in/eval.in @@ -0,0 +1,35 @@ + +%9Syntax:%9 + +@SYNTAX:eval@ + +%9Parameters:%9 + + The commands to evaluate. + +%9Description:%9 + + Evaluates the given commands and executes them; you can use internal + variables and separate multiple commands by using the `;' character. + If the command contains a string with `$', `\' or `;' those characters + need to be escaped: + + `$' -> `$$' + `\' -> `\\' (or even `\\\\', depending on where they are used) + `;' -> `\;' + +%9Examples:%9 + + /EVAL echo I am connected to ${S} on ${chatnet} as ${N} + /EVAL echo My user privileges are +${usermode}; echo Let's party! + + to print `1;2$3\4': + + /EVAL echo 1\;2$$3\\4 + +%9References:%9 + + https://github.com/irssi/irssi/blob/master/docs/special_vars.txt + +%9See also:%9 CAT, CD, ECHO, EXEC + diff --git a/docs/help/in/exec.in b/docs/help/in/exec.in new file mode 100644 index 0000000..2947ae2 --- /dev/null +++ b/docs/help/in/exec.in @@ -0,0 +1,50 @@ + +%9Syntax:%9 + +@SYNTAX:exec@ + +%9Parameters:%9 + + -: Suppresses the process termination notification. + -nosh: Doesn't execute the command through /bin/sh. + -out: Sends the output to the active channel or query. + -msg: Sends the output to the specified nickname or channel. + -notice: Sends the output to the specified nickname or channel as + notices. + -name: Gives the process the specified name. + -window: Displays the output in the active window. + -close: Forcibly closes a process that doesn't die. + -<signal>: Sends the given signal to the process. + -in: Sends text to the standard input of the process. + -interactive: Executes the process in a new window item. + + The command to execute; if no output parameter is given, the active window + will be used and if no parameters are given at all, the list of active + processes will be displayed. + +%9Description:%9 + + Executes the specified command in the background; the process can be + accessed by its id or the name you gave it. + + The output of the process can be redirected to various targets, such as + a window, a channel, a nickname or a query. + + The process identifier must always begin with the '%%' character. For + example %%0. + + If you remove a process with the close parameter, it will only make Irssi + detach from it; the process will keep running until it terminates. + +%9Examples:%9 + + /EXEC + /EXEC ls + /EXEC -msg #irssi cat unicorn.txt + /EXEC -out cat /etc/passwd | grep $USER | awk -F: '{print $5}' + /EXEC -name ssh -nosh -interactive -window ssh staff.irssi.org + /EXEC -close mailserver + /EXEC -close %%0 + +%9See also:%9 CAT, CD, ECHO, EVAL + diff --git a/docs/help/in/flushbuffer.in b/docs/help/in/flushbuffer.in new file mode 100644 index 0000000..8549303 --- /dev/null +++ b/docs/help/in/flushbuffer.in @@ -0,0 +1,19 @@ + +%9Syntax:%9 + +@SYNTAX:flushbuffer@ + +%9Description:%9 + + Forces an immediate flush of the buffers if the related settings are + enabled. + +%9Examples:%9 + + /FLUSHBUFFER + + /SET write_buffer_size + /SET write_buffer_timeout + +%9See also:%9 REDRAW, SCROLLBACK + diff --git a/docs/help/in/format.in b/docs/help/in/format.in new file mode 100644 index 0000000..2b65a6b --- /dev/null +++ b/docs/help/in/format.in @@ -0,0 +1,25 @@ + +%9Syntax:%9 + +@SYNTAX:format@ + +%9Parameters:%9 + + -reset: Restores the original value. + -delete: Removes the format from the configuration. + + The module name, the format name and the value; if no arguments are given, + the list of formats are displayed. + +%9Description:%9 + + Allows you to reconfigure the way messages are displayed. + +%9Examples:%9 + + /FORMAT irc away You have left planet earth + /FORMAT core not_good_idea I'm sorry sir, this broke my irony sensor; add -YES if you really mean it! + /FORMAT -reset irc away + +%9See also:%9 RELOAD, SAVE, SET + diff --git a/docs/help/in/hash.in b/docs/help/in/hash.in new file mode 100644 index 0000000..2d5a355 --- /dev/null +++ b/docs/help/in/hash.in @@ -0,0 +1,22 @@ + +%9Syntax:%9 + +@SYNTAX:hash@ + +%9Description:%9 + + This is an ancient command that is no longer used; if you on an IRC server + that supports this command, please contact us to we can update the + documentation. + +%9Examples:%9 + + /HASH + +%9References:%9 + + https://irssi.org + https://github.com/irssi + +%9See also:%9 DIE, KILL, OPER + diff --git a/docs/help/in/help.in b/docs/help/in/help.in new file mode 100644 index 0000000..35ab9b7 --- /dev/null +++ b/docs/help/in/help.in @@ -0,0 +1,27 @@ + +%9Syntax:%9 + +@SYNTAX:help@ + +%9Parameters:%9 + + The command to display the documentation for; if no argument is given, the + list of commands will be displayed. + +%9Description:%9 + + Displays the documentation for the given command. + +%9Examples:%9 + + /HELP + /HELP AWAY + /HELP CONNECT + +%9References:%9 + + https://irssi.org + https://github.com/irssi + +%9See also:%9 CONNECT, MSG, NETWORK, SERVER + diff --git a/docs/help/in/hilight.in b/docs/help/in/hilight.in new file mode 100644 index 0000000..49a73a7 --- /dev/null +++ b/docs/help/in/hilight.in @@ -0,0 +1,43 @@ + +%9Syntax:%9 + +@SYNTAX:hilight@ + +%9Parameters:%9 + + -nick: Highlights only the nickname and not the whole line. + -word: Highlights only the word and not the whole line. + -line: Highlights the whole line. + -mask: Highlights all messages from users matching the mask. + -full: The text must match the full word. + -matchcase: The text must match case. + -regexp: The text is a regular expression. + -color: The color to display the highlight in. + -actcolor: The color to mark the highlight activity in the statusbar. + -level: Matches only on the given message level. + -network: Matches only on the given network. + -channels: Matches only on the given channels. + -priority: The priority to use when multiple highlights match. + + The text to highlight on; if no argument is given, the list of highlights + will be displayed. + +%9Description:%9 + + Highlights the keyword or pattern to make sure that you don't miss any + important messages. + +%9Examples:%9 + + /HILIGHT + /HILIGHT mike + /HILIGHT -regexp mi+ke+ + /HILIGHT -mask -color %%G bob!*@*.irssi.org + /HILIGHT -full -color %%G -actcolor %%Y redbull + +%9References:%9 + + https://github.com/irssi/irssi/blob/master/docs/formats.txt + +%9See also:%9 DEHILIGHT, LEVELS + diff --git a/docs/help/in/ignore.in b/docs/help/in/ignore.in new file mode 100644 index 0000000..26dd63b --- /dev/null +++ b/docs/help/in/ignore.in @@ -0,0 +1,55 @@ + +%9Syntax:%9 + +@SYNTAX:ignore@ + +%9Parameters:%9 + + -regexp: Indicates that the pattern is a regular expression. + -full: Indicates that the pattern must match a full word. + -pattern: The text pattern to ignore. + -except: Negates the ignore. + -replies: Also ignore nicknames who are talking to anyone who matches + the ignore. + -network: Ignores only on a specific network. + -channels: Ignores only on specific channels. + -time: The timeout to automatically remove the ignore. + Accepts units specified in days, hours, minutes, seconds, + milliseconds, or no unit for seconds. + + The mask, channels and levels to ignore; if no argument is provided, the + list of ignores will be displayed. + +%9Description:%9 + + Ignores nicknames or text that matches a pattern. + + The special level 'NO_ACT' can be used to ignore activity in the statusbar + without actually ignoring the message; this behavior is somewhat special + because it is allowed in addition to other ignores for the same target. + The special level 'HIDDEN' can be used to hide matching messages that can + later be revealed using /WINDOW HIDELEVEL -HIDDEN + The special level 'NOHILIGHT' can be used to suppress hilights without actually + ignoring the message. + +%9Examples:%9 + + /IGNORE + /IGNORE * JOINS + /IGNORE * CTCPS + /IGNORE -except *!*@*.irssi.org CTCPS + /IGNORE #irssi ALL -PUBLIC -ACTIONS + /IGNORE -replies *!*@*.irssi.org ALL + /IGNORE -regexp -pattern (away|gone|back|playing|returned) * ACTIONS + /IGNORE -regexp -pattern (away|gone|back|playing|returned) #channel ACTIONS + /IGNORE *zzz* NICKS + /IGNORE *afk* NICKS + /IGNORE *away* NICKS + /IGNORE #irssi NO_ACT JOINS PARTS QUITS + /IGNORE mike NO_ACT -MSGS + /IGNORE mike HIDDEN PUBLIC JOINS PARTS QUITS + /IGNORE -time 5days christmas PUBLICS + /IGNORE -time 300 mike PUBLICS + +%9See also:%9 ACCEPT, SILENCE, UNIGNORE + diff --git a/docs/help/in/info.in b/docs/help/in/info.in new file mode 100644 index 0000000..d8d8cfc --- /dev/null +++ b/docs/help/in/info.in @@ -0,0 +1,21 @@ + +%9Syntax:%9 + +@SYNTAX:info@ + +%9Parameters:%9 + + The server to display the information for; if no argument is given, the + active server will be used. + +%9Description:%9 + + Displays information about the IRC server software. + +%9Examples:%9 + + /INFO + /INFO irc.libera.chat + +%9See also:%9 ADMIN + diff --git a/docs/help/in/invite.in b/docs/help/in/invite.in new file mode 100644 index 0000000..7c0babb --- /dev/null +++ b/docs/help/in/invite.in @@ -0,0 +1,21 @@ + +%9Syntax:%9 + +@SYNTAX:invite@ + +%9Parameters:%9 + + The nickname to invite and the channel to invite him or her to; if no + channel is given, the active channel will be used. + +%9Description:%9 + + Invites the specified nick to a channel. + +%9Examples:%9 + + /INVITE mike + /INVITE bob #irssi + +%9See also:%9 MODE, WHOIS + diff --git a/docs/help/in/irssiproxy.in b/docs/help/in/irssiproxy.in new file mode 100644 index 0000000..79d75b9 --- /dev/null +++ b/docs/help/in/irssiproxy.in @@ -0,0 +1,14 @@ + +@SYNTAX:irssiproxy@ + +%9Description:%9 + + Displays the list of clients connected to irssiproxy. + +%9Examples:%9 + + /IRSSIPROXY + /IRSSIPROXY STATUS + +%9See also:%9 LOAD PROXY, SET irssiproxy + diff --git a/docs/help/in/ison.in b/docs/help/in/ison.in new file mode 100644 index 0000000..e9e54ee --- /dev/null +++ b/docs/help/in/ison.in @@ -0,0 +1,20 @@ + +%9Syntax:%9 + +@SYNTAX:ison@ + +%9Parameters:%9 + + The nicknames, separated by space, to check. + +%9Description:%9 + + Displays whether the specified nicknames are online. + +%9Examples:%9 + + /ISON mike + /ISON sarah bob + +%9See also:%9 NOTIFY, WHOWAS, WHOIS + diff --git a/docs/help/in/join.in b/docs/help/in/join.in new file mode 100644 index 0000000..adf7158 --- /dev/null +++ b/docs/help/in/join.in @@ -0,0 +1,26 @@ + +%9Syntax:%9 + +@SYNTAX:join@ + +%9Parameters:%9 + + -window Joins a channel in the active window. + -invite Joins the channel you were last invited to. + -<server tag> The server tag on which you want to join the channel. + + The channel names, separated by a comma, to join and the channel key. + +%9Description:%9 + + Joins the given channels. + +%9Examples:%9 + + /JOIN #irssi + /JOIN #basementcat secret_lair + /JOIN -invite + /JOIN -liberachat #github,#libera,#irssi + +%9See also:%9 KICK, PART + diff --git a/docs/help/in/kick.in b/docs/help/in/kick.in new file mode 100644 index 0000000..eb926c0 --- /dev/null +++ b/docs/help/in/kick.in @@ -0,0 +1,24 @@ + +%9Syntax:%9 + +@SYNTAX:kick@ + +%9Parameters:%9 + + The channel and the nicknames, separated by a comma, to kick from the + channel and the reason thereof; if no channel is given, the active channel + will be used. + +%9Description:%9 + + Removes the given nicknames from the specified channel; this command is + typically used to remove troublemakers, flooders or people otherwise making + a nuisance of themselves. + +%9Examples:%9 + + /KICK mike Please... chill down! + /KICK #irssi bob,sarah Stop flooding! + +%9See also:%9 BAN, KICKBAN, KNOCKOUT + diff --git a/docs/help/in/kickban.in b/docs/help/in/kickban.in new file mode 100644 index 0000000..b2950f4 --- /dev/null +++ b/docs/help/in/kickban.in @@ -0,0 +1,22 @@ + +%9Syntax:%9 + +@SYNTAX:kickban@ + +%9Parameters:%9 + + The channel and the nicknames, separated by a comma, to kick and ban from + the channel and the reason thereof; if no channel is given, the active + channel will be used. + +%9Description:%9 + + Removes and then bans the given nicknames from the specified channel. + +%9Examples:%9 + + /KICKBAN mike Please... chill down! + /KICKBAN #irssi bob,sarah You guys broke the rules for the last time. + +%9See also:%9 BAN, KICK, KNOCKOUT + diff --git a/docs/help/in/kill.in b/docs/help/in/kill.in new file mode 100644 index 0000000..37bfc58 --- /dev/null +++ b/docs/help/in/kill.in @@ -0,0 +1,24 @@ + +%9Syntax:%9 + +@SYNTAX:kill@ + +%9Parameters:%9 + + The nickname to remove from the network and the reason thereof. + +%9Description:%9 + + Terminates a nickname's connection from the network; this command is + reserved for IRC operators. + + You should not use this command for personal vendettas or for trolling; + these practices are generally frowned upon. + +%9Examples:%9 + + /KILL mike Get off my lawn + /KILL bob Stop breaking the network rules! + +%9See also:%9 DIE, OPER, WALLOPS + diff --git a/docs/help/in/knock.in b/docs/help/in/knock.in new file mode 100644 index 0000000..ce8f9aa --- /dev/null +++ b/docs/help/in/knock.in @@ -0,0 +1,30 @@ + +%9Syntax:%9 + +@SYNTAX:knock@ + +%9Parameters:%9 + + The channel you wish to get invited to. + +%9Description:%9 + + Sends an invitation request to the channel operators of the target channel; + this command may not work on all IRC servers. + + The following conditions must be met: + + * You are not banned from the channel. + * The channel is not private. + * You may not be already in the channel. + * The channel must be invite only, have a key or has exceeded its user + limit. + +%9Examples:%9 + + /KNOCK #irssi + /KNOCK #libera + /KNOCK #github + +%9See also:%9 INVITE, JOIN + diff --git a/docs/help/in/knockout.in b/docs/help/in/knockout.in new file mode 100644 index 0000000..cbaa8dd --- /dev/null +++ b/docs/help/in/knockout.in @@ -0,0 +1,26 @@ + +%9Syntax:%9 + +@SYNTAX:knockout@ + +%9Parameters:%9 + + The time, expressed in seconds, the nicknames, separated by a comma, and the + reason thereof; if no time is provided, the ban will be lifted after 5 + minutes. + +%9Description:%9 + + Removes and then bans the given nicknames from the active channel; the ban + will be automatically lifted after the specified time. + + The ban will not be lifted if you leave the channel or disconnect from the + network. + +%9Examples:%9 + + /KNOCKOUT 3600 mike Your connection is unstable. + /KNOCKOUT bob,sarah Chill down a bit. + +%9See also:%9 BAN, KICK, KICKBAN + diff --git a/docs/help/in/lastlog.in b/docs/help/in/lastlog.in new file mode 100644 index 0000000..e96e2ed --- /dev/null +++ b/docs/help/in/lastlog.in @@ -0,0 +1,43 @@ + +%9Syntax:%9 + +@SYNTAX:lastlog@ + +%9Parameters:%9 + + -: Doesn't print the 'Lastlog:' and 'End of Lastlog' messages. + -file: Output the lastlog to a file instead of the active window. + -window: Specifies the window to check. + -new: Only displays results since the previous lastlog. + -away: Only displays results since you previous away status. + -<level>: Specifies the levels to check (e.g. -joins -quits -hilight) + -clear: Removes the previous results from the active window. + -count: Displays how many lines match. + -case: Performs a case-sensitive matching. + -date: Prepends each row with the message's date + -regexp: The given text pattern is a regular expression. + -word: The text must match full words. + -force: Forces to display the lastlog, even if it exceeds 1000 lines. + -after: Include this many lines of content after the match. + -before: Include this many lines of content before the match. + -<#>: Include this many lines of content around the match. + <count>: Display a maximum number of `count' lines. + <start>: Skip the last `start' lines. + + The pattern to search for and the maximum of lines to display; if no + parameter is given, the entire window buffer will be displayed. + +%9Description:%9 + + Searches the active window for a pattern and displays the result. + +%9Examples:%9 + + /LASTLOG holiday + /LASTLOG 'is on vacation' 10 + /LASTLOG -force -file ~/mike.log 'mike' + /LASTLOG -hilight + /LASTLOG -5 searchterm + +%9See also:%9 HILIGHT, SCROLLBACK + diff --git a/docs/help/in/layout.in b/docs/help/in/layout.in new file mode 100644 index 0000000..4b0a2ef --- /dev/null +++ b/docs/help/in/layout.in @@ -0,0 +1,28 @@ + +%9Syntax:%9 + +@SYNTAX:layout@ + +%9Parameters:%9 + + SAVE: Saves your layout to the configuration. + RESET: Removes the saved layout from the configuration. + +%9Description:%9 + + Saves the layout of your window configuration; the next time you connect + to the server, you will join the channels in the same window as before. + + This method enables you to keep the same window layout when you start Irssi + the next time. + + You will need to use the SAVE command to confirm and commit the changes + into the configuration file. + +%9Examples:%9 + + /LAYOUT SAVE + /LAYOUT RESET + +%9See also:%9 SAVE, WINDOW + diff --git a/docs/help/in/levels.in b/docs/help/in/levels.in new file mode 100644 index 0000000..b6eb9fb --- /dev/null +++ b/docs/help/in/levels.in @@ -0,0 +1,42 @@ + +%9Description:%9 + + These are the message levels that are used throughout Irssi; they describe + what kind of message is displayed. + + These are the common levels you can use: + + ACTIONS Actions by a nickname. + CLIENTCRAP Irssi's internal messages. + CLIENTERROR Irssi's internal error messages. + CLIENTNOTICE Irssi's internal notices. + CRAP Can be almost anything. + CTCPS CTCP messages. + DCC DCC protocol related messages. + DCCMSGS DCC chat messages. + INVITES An invite is received. + JOINS A nickname joins a channel. + KICKS A nickname gets kicked from a channel. + MODES A channel mode is modified. + MSGS Private messages. + NICKS A nickname changes to another nickname. + NOTICES Notices sent from a nickname. + PARTS A nickname leaves a channel. + PUBLIC Public messages in a channel. + QUITS A nickname disconnects from IRC. + SNOTES Notices sent from a server. + TOPICS A channel topic is modified. + WALLOPS A wallop is received. + + These are the special levels you can use: + + HILIGHT The text is highlighted. + NEVER Never ignores or logs the message. + HIDDEN Hides the message when window HIDELEVEL includes HIDDEN. + NO_ACT Doesn't trigger any activity in the statusbar. + NOHILIGHT The text is not highlighted. + Suppresses hilights when used with /ignore. + + When using levels from Irssi scripts, you need to prepend the level with + 'MSGLEVEL_'; for example 'CRAP' becomes 'MSGLEVEL_CRAP'. + diff --git a/docs/help/in/links.in b/docs/help/in/links.in new file mode 100644 index 0000000..a2aaa68 --- /dev/null +++ b/docs/help/in/links.in @@ -0,0 +1,22 @@ + +%9Syntax:%9 + +@SYNTAX:links@ + +%9Parameters:%9 + + The server to search on and the string to match on; if no arguments are + given, the list of links of the active server will be displayed. + +%9Description:%9 + + Displays the links between an IRC server and its connections. + +%9Examples:%9 + + /LINKS + /LINKS ircsource.irssi.org + /LINKS ircsource.irssi.org *.hub + +%9See also:%9 LUSERS, MAP + diff --git a/docs/help/in/list.in b/docs/help/in/list.in new file mode 100644 index 0000000..6dda79e --- /dev/null +++ b/docs/help/in/list.in @@ -0,0 +1,38 @@ + +%9Syntax:%9 + +@SYNTAX:list@ + +%9Parameters:%9 + + -yes: Confirms that you want to receive a large amount of data. + + If the exact name of a channel is given, the only information about this + channel is requested; otherwise, a list of all channels will be displayed. + +%9Description:%9 + + Displays the channel names that match your request; requesting all channels + may cause the server to disconnect you for flooding. + +%9Examples:%9 + + /LIST + /LIST -yes + /LIST #ubuntu + /LIST #*ubuntu*,>1 + +%9Remarks:%9 + + Not all networks support server-side filtering. Some provide a network + service or service bot instead; on IRCnet, you may use the List service: + + /SQUERY Alis HELP + + Other networks with service bots (like ChanServ) may also provide a list + service bot (confirm with /WHOIS ALIS): + + /MSG Alis HELP + +%9See also:%9 STATS, SQUERY, WHOIS + diff --git a/docs/help/in/load.in b/docs/help/in/load.in new file mode 100644 index 0000000..56f7836 --- /dev/null +++ b/docs/help/in/load.in @@ -0,0 +1,23 @@ + +%9Syntax:%9 + +@SYNTAX:load@ + +%9Parameters:%9 + + The name of the module and submodule to load. + +%9Description:%9 + + Loads a plugin; if the full path isn't given, it will attempt to load from + common directories in your installation path. + + To load a perl script, you must use the SCRIPT command. + +%9Examples:%9 + + /LOAD fish + /LOAD ~/irssi-fish/libfish.so + +%9See also:%9 SCRIPT, UNLOAD + diff --git a/docs/help/in/log.in b/docs/help/in/log.in new file mode 100644 index 0000000..3ca8782 --- /dev/null +++ b/docs/help/in/log.in @@ -0,0 +1,48 @@ + +%9Syntax:%9 + +@SYNTAX:log@ + +%9Parameters:%9 + + OPEN: Opens a log file. + CLOSE: Closes a log file. + START: Starts logging a log entry. + STOP: Stops logging a log entry. + + -noopen: Saves the entry in the configuration, but doesn't actually + start logging. + -autoopen: Automatically opens the log at startup. + -window: Displays the output to the active window, or the window + specified in the targets parameter. + -<server tag>: The server tag the targets must be on. + -targets: Logs the specified nicknames or channels. + -colors: Also log the color codes of the messages. + + The filename of the log and the levels to match; if no argument is given, + the list of open logs will be displayed. + +%9Description:%9 + + Opens a log file and stores the messages of the given targets into it; the + log files will be locked so multiple clients cannot log to the same file. + + You may use any of the date formats to create a log rotation; we strongly + recommend you to enable autolog if you are interested in keeping logs. + +%9Examples:%9 + + /LOG OPEN -targets mike ~/irclogs/mike.log MSGS + /LOG OPEN -targets #irssi ~/irclogs/liberachat/irssi-%%Y-%%m-%%d + /LOG CLOSE ~/irclogs/liberachat/irssi-%%Y-%%m-%%d + /LOG STOP ~/irclogs/liberachat/irssi-%%Y-%%m-%%d + /LOG START ~/irclogs/liberachat/irssi-%%Y-%%m-%%d + + /SET autolog ON + +%9References:%9 + + https://github.com/irssi/irssi/blob/master/docs/formats.txt + +%9See also:%9 SET LOG, WINDOW LOG + diff --git a/docs/help/in/lusers.in b/docs/help/in/lusers.in new file mode 100644 index 0000000..f9edf53 --- /dev/null +++ b/docs/help/in/lusers.in @@ -0,0 +1,24 @@ + +%9Syntax:%9 + +@SYNTAX:lusers@ + +%9Parameters:%9 + + The server to search on and the remote sever to search on; if no arguments + are given, the active server will be used. + +%9Description:%9 + + Displays the user statistics of the active or remote server. + + The parameters to search on a remote server are no longer supported on most + IRC servers; we no longer provide examples for remote LUSERS to avoid all + confusion. + +%9Examples:%9 + + /LUSERS + +%9See also:%9 LINKS, MAP + diff --git a/docs/help/in/map.in b/docs/help/in/map.in new file mode 100644 index 0000000..9a80698 --- /dev/null +++ b/docs/help/in/map.in @@ -0,0 +1,16 @@ + +%9Syntax:%9 + +@SYNTAX:map@ + +%9Description:%9 + + Displays the network map of an IRC network; this command is usually + reserved for IRC operators and does not work on all servers. + +%9Examples:%9 + + /MAP + +%9See also:%9 DIE, LINKS, LUSERS + diff --git a/docs/help/in/me.in b/docs/help/in/me.in new file mode 100644 index 0000000..0da1e5c --- /dev/null +++ b/docs/help/in/me.in @@ -0,0 +1,21 @@ + +%9Syntax:%9 + +@SYNTAX:me@ + +%9Parameters:%9 + + The message to emote. + +%9Description:%9 + + Sends an action emote to the active nickname or channel. + +%9Examples:%9 + + /ME is hungry! + /ME had an awesome day @ work + /ME is happy it's Friday + +%9See also:%9 ACTION, CTCP + diff --git a/docs/help/in/mircdcc.in b/docs/help/in/mircdcc.in new file mode 100644 index 0000000..ce57a3f --- /dev/null +++ b/docs/help/in/mircdcc.in @@ -0,0 +1,28 @@ + +%9Syntax:%9 + +@SYNTAX:mircdcc@ + +%9Parameters:%9 + + ON: Enables mIRC compatibility mode. + OFF: Disables mIRC compatibility mode. + +%9Description:%9 + + After establishing a DCC CHAT connection that you initiated, you might + encounter some protocol issues if the target is using mIRC. + + If you or your target sees some unexpected output or behavior inside a DCC + CHAT session, use this command to enable mIRC compatibility mode. + + When receiving a connection from an mIRC user, the compatibility mode will + automatically be enabled. + +%9Examples:%9 + + /MIRCDCC ON + /MIRCDCC OFF + +%9See also:%9 ACTION, CTCP, DCC + diff --git a/docs/help/in/mode.in b/docs/help/in/mode.in new file mode 100644 index 0000000..93d051f --- /dev/null +++ b/docs/help/in/mode.in @@ -0,0 +1,77 @@ + +%9Syntax:%9 + +@SYNTAX:mode@ + +%9Parameters:%9 + + The target nickname or channel and the modes with their parameters to set or + remove. + + If the target nickname or channel is omitted, the active nickname or channel + will be used. + +%9Description:%9 + + Modifies the user or channel modes for which you are privileged to modify. + + You can specify multiple modes in one command and prepend them by using the + '+' sign to set or '-' sign to unset; modes that require a parameter will be + retrieved from the argument list. + + Some common channel modes are: + + b <mask>: Adds or removes a ban; a ban will prevent a user who + matches the given mask from joining the channel unless + he or she is invited or in the exempt list. + e <mask>: Adds or removes a ban exception; users who match a mask + on the exempt list are able to join a channel even if + they also match an entry on the ban list. + i: When enabled, users need to be invited into the channel + or have a matching entry in the invite list. + I <mask>: Adds or removes an invite; users who match a mask on + the invite list are able to join even if the channel is + set to invite only. + k <key>: Adds or removes a channel key, aka a password; users + will not be able to join the channel without providing + the key. + l <count>: Adds, removes or updates the maximum amount of users + that may join the channel. + m: When enabled, users who are not opped or voiced cannot + send messages to the channel. + n: When enabled, users who are not on the channel cannot + send messages to it. + p: When enabled, the channel will not be displayed in your + WHOIS output. + s: When enabled, the channel will not be displayed in the + LIST output. + t: When enabled, users who are not opped or voices cannot + modify the channel topic. + o <nickname>: Adds or removes the operator status from a nickname. + v <nickname>: Adds or removes the voice status from a nickname. + + Some common user modes are: + + i: When enabled, other users will not be able to see you + on a WHO output unless they are in the channel + themselves. + w: When enabled, you will receive WALLOP messages from IRC + operators. + s: When enabled, you will receive special notices or debug + messages from the server. + + Many networks have additional user and channel modes; we highly recommend + you to read the documentation of the networks you frequently connect to and + maximize your IRC experience. + +%9Examples:%9 + + /MODE #irssi +o mike + /MODE #irssi -o+iI mike mike!*@*.irssi.org + /MODE +b mike!*@*.irssi.org + /MODE -o mike + /MODE +impsnkl secret_hideout 100 + /MODE mike +iw + +%9See also:%9 BAN, DEOP, DEVOICE, OP, UNBAN, VOICE + diff --git a/docs/help/in/motd.in b/docs/help/in/motd.in new file mode 100644 index 0000000..6e86681 --- /dev/null +++ b/docs/help/in/motd.in @@ -0,0 +1,22 @@ + +%9Syntax:%9 + +@SYNTAX:motd@ + +%9Parameters:%9 + + The server or the server the target nickname is on; if no parameter is + given, the active server will be used. + +%9Description:%9 + + Displays the welcome message of an IRC server. + +%9Examples:%9 + + /MOTD + /MOTD irc.libera.chat + /MOTD bob + +%9See also:%9 ADMIN, INFO, LINKS, MAP + diff --git a/docs/help/in/msg.in b/docs/help/in/msg.in new file mode 100644 index 0000000..6c7dd70 --- /dev/null +++ b/docs/help/in/msg.in @@ -0,0 +1,33 @@ + +%9Syntax:%9 + +@SYNTAX:msg@ + +%9Parameters:%9 + + -<server tag>: The server tag the targets are on. + -channel: Indicates that the target is a channel. + -nick: Indicates that the target is a nickname. + + The target nickname or channel and the message to send. + + The target can be a comma delimited list of targets, ie + nick1,nick2 or #chan1,#chan2 + + Or one of the following special targets: + * : Use the active nickname or channel + , : Last person who sent you a /msg + . : Last person you sent a /msg to + +%9Description:%9 + + Sends a message to a nickname or channel. + +%9Examples:%9 + + /MSG mike Hi, what's up? + /MSG #irssi I am awesome :) + /MSG * Do you want to build a snowman? + +%9See also:%9 ACTION, DCC, JOIN + diff --git a/docs/help/in/names.in b/docs/help/in/names.in new file mode 100644 index 0000000..974b845 --- /dev/null +++ b/docs/help/in/names.in @@ -0,0 +1,27 @@ + +%9Syntax:%9 + +@SYNTAX:names@ + +%9Parameters:%9 + + -count: Displays the amount of users in the channel. + -ops: Displays the channel operators. + -halfops: Displays the channel demi-operators. + -voices: Displays the users who are voiced in a channel. + + The channels to report or ** for all channels you have joined; if no + arguments are given, the users in the active channel will be displayed. + +%9Description:%9 + + Displays the users who are in a channel; you can provide multiple channels + by separating them with a comma. + +%9Examples:%9 + + /NAMES -ops + /NAMES -voices #irssi,#libera + +%9See also:%9 JOIN, PART, WHO, WHOIS + diff --git a/docs/help/in/nctcp.in b/docs/help/in/nctcp.in new file mode 100644 index 0000000..9f51673 --- /dev/null +++ b/docs/help/in/nctcp.in @@ -0,0 +1,21 @@ + +%9Syntax:%9 + +@SYNTAX:nctcp@ + +%9Parameters:%9 + + A target nickname or channel, a command and the data. + +%9Description:%9 + + Sends a CTCP reply to a nickname or channel; you can provide multiple + targets by separating them with a comma. + +%9Examples:%9 + + /NCTCP #irssi VERSION King of the Jungle v1.0 + /NCTCP bob,#libera USERINFO I am bob :p + +%9See also:%9 CTCP + diff --git a/docs/help/in/netsplit.in b/docs/help/in/netsplit.in new file mode 100644 index 0000000..3578816 --- /dev/null +++ b/docs/help/in/netsplit.in @@ -0,0 +1,16 @@ + +%9Syntax:%9 + +@SYNTAX:netsplit@ + +%9Description:%9 + + Displays some information about users who are currently lost in one or + more net splits. + +%9Examples:%9 + + /NETSPLIT + +%9See also:%9 JOIN, LINKS, MAP, PART + diff --git a/docs/help/in/network.in b/docs/help/in/network.in new file mode 100644 index 0000000..788c1c6 --- /dev/null +++ b/docs/help/in/network.in @@ -0,0 +1,70 @@ + +%9Syntax:%9 + +@SYNTAX:network@ + +%9Parameters:%9 + + LIST: Displays the list of configured networks. + ADD: Adds a network to your configuration. + MODIFY: Modifies a network in your configuration. + REMOVE: Removes a network from your configuration. + + -nick: Specifies the nickname to use. + -alternate_nick Specifies the alternate nickname to use. + -user: Specifies the user identity to use. + -realname: Specifies the real name to use. + -host: Specifies the hostname to use. + -usermode: Specifies the user modes to set on yourself. + -autosendcmd: Specifies the commands, separated by the ';' character, + and enclosed within two "'" characters, to perform after + connecting. + (Some characters need to be escaped - see /help eval) + -querychans: Specifies the maximum number of channels to put in one MODE + or WHO command when synchronizing. + -whois: Specifies the maximum number of nicknames in one WHOIS + command. + -msgs: Specifies the maximum number of nicknames in one PRIVMSG + command. + -kicks: Specifies the maximum number of nicknames in one KICK + command. + -modes: Specifies the maximum number of nicknames in one MODE + command. + -cmdspeed: Specifies the minimum amount of time, expressed in + milliseconds, that the client must wait before sending + additional commands to the server. + -cmdmax: Specifies the maximum number of commands to perform before + starting the internal flood protection. + -sasl_mechanism Specifies the mechanism to use for the SASL authentication. + At the moment irssi only supports the 'plain' and the + 'external' mechanisms. + Use '' to disable the authentication. + -sasl_username Specifies the username to use during the SASL authentication. + -sasl_password Specifies the password to use during the SASL authentication. + + + The name of the network to add, edit or remove; if no parameter is given, + the list of networks will be displayed. + +%9Description:%9 + + Displays, adds, modifies or removes the network configuration of IRC + networks. + + When using the ADD parameter on a network that already exists, the + configuration will be merged with each other. + + We recommend using 'WAIT 2000' between the automated commands in order to + prevent you from being kicked from the network due to flooding commands. + +%9Examples:%9 + + /NETWORK ADD -usermode +giw EFnet + /NETWORK ADD -usermode +iw -nick mike -realname 'The one and only mike!' -host staff.irssi.org liberachat + /NETWORK ADD -autosendcmd '^MSG NickServ identify WzerT8zq' liberachat + /NETWORK ADD -autosendcmd '^MSG Q@CServe.quakenet.org AUTH mike WzerT8zq; WAIT 2000; OPER mike WzerT8zq; WAIT 2000; MODE mike +kXP' Quakenet + /NETWORK MODIFY -usermode +gi EFnet + /NETWORK REMOVE liberachat + +%9See also:%9 CHANNEL, CONNECT, SERVER + diff --git a/docs/help/in/nick.in b/docs/help/in/nick.in new file mode 100644 index 0000000..59e15ca --- /dev/null +++ b/docs/help/in/nick.in @@ -0,0 +1,20 @@ + +%9Syntax:%9 + +@SYNTAX:nick@ + +%9Parameters:%9 + + Your new nickname. + +%9Description:%9 + + Changes your nickname on the active server. + +%9Examples:%9 + + /NICK mike + /NICK bob + +%9See also:%9 CONNECT, JOIN, MSG, PART + diff --git a/docs/help/in/notice.in b/docs/help/in/notice.in new file mode 100644 index 0000000..4c8d213 --- /dev/null +++ b/docs/help/in/notice.in @@ -0,0 +1,23 @@ + +%9Syntax:%9 + +@SYNTAX:notice@ + +%9Parameters:%9 + + The targets and the message to notify. + +%9Description:%9 + + Sends a notice to the target nickname or channel; these are often used in + automated bots or scripts. + + You can provide multiple targets by separating them with a comma. + +%9Examples:%9 + + /NOTICE mike You sir, are just awesome! + /NOTICE bob,#irssi Fish go blub :p + +%9See also:%9 CTCP, MSG, NCTCP + diff --git a/docs/help/in/notify.in b/docs/help/in/notify.in new file mode 100644 index 0000000..14253c1 --- /dev/null +++ b/docs/help/in/notify.in @@ -0,0 +1,29 @@ + +%9Syntax:%9 + +@SYNTAX:notify@ + +%9Parameters:%9 + + -away: Notifies you if the target modifies its away status. + -list: Displays the list of notifications. + + The nickname or mask to get a notification for; if no arguments are given, + the current matching notifications will be displayed. + + You may also provide the network that the target must be on. + +%9Description:%9 + + Notifies you when a nickname or users matching a host on the notification + list comes online or offline. + +%9Examples:%9 + + /NOTIFY -list + /NOTIFY -away mike + /NOTIFY bob + /NOTIFY *!*@staff.irssi.org + +%9See also:%9 AWAY, HILIGHT, UNNOTIFY + diff --git a/docs/help/in/op.in b/docs/help/in/op.in new file mode 100644 index 0000000..ff15c52 --- /dev/null +++ b/docs/help/in/op.in @@ -0,0 +1,23 @@ + +%9Syntax:%9 + +@SYNTAX:op@ + +%9Parameters:%9 + + A list of nicknames to op. + +%9Description:%9 + + Grants the channel operator privileges to the given nicknames; you may use + the wildcard character '*' in a nickname. + +%9Examples:%9 + + /OP mike + /OP bob sarah + /OP jo*n + /OP * + +%9See also:%9 DEOP, DEVOICE, KICK, MODE, VOICE + diff --git a/docs/help/in/oper.in b/docs/help/in/oper.in new file mode 100644 index 0000000..b89a65c --- /dev/null +++ b/docs/help/in/oper.in @@ -0,0 +1,21 @@ + +%9Syntax:%9 + +@SYNTAX:oper@ + +%9Parameters:%9 + + The username and password to identify yourself as an IRC operator; if no + password is given, you will be prompted to enter one. + +%9Description:%9 + + Grants you the IRC operator status. + +%9Examples:%9 + + /OPER bob + /OPER mike WzerT8zq + +%9See also:%9 DIE, KILL + diff --git a/docs/help/in/otr.in b/docs/help/in/otr.in new file mode 100644 index 0000000..fcfcd87 --- /dev/null +++ b/docs/help/in/otr.in @@ -0,0 +1,111 @@ + +OTR %|[OPTION] + +Command to control the OTR module. Without an option, /OTR INFO is printed. + +This help contains three sections which are %9options, quickstart and files.%n + +To add the OTR status bar (highly recommended): + +%9/statusbar window add otr%n + +%9Options:%n + +AUTH <secret> + Start or respond to an authentication process. + +AUTHQ <question> <secret> + Start a SMP authentication process. + + Example: %9/otr authq "My question is" "this is the secret"%n + +AUTHABORT + Abort an ongoing authentication process. + +CONTEXTS + List known contexts which basically list the known fingerprints and their + state. + +DEBUG + Turn on debugging. + +DISTRUST <fingerprint> + Distrust a specific fingerprint. This command can be done inside a private + window for which the current fingerprint of the other person will be used + or else set fp to a human readable OTR fingerprint available with the above + contexts command. + + Examples: %9/otr distrust 487FFADA 5073FEDD C5AB5C14 5BB6C1FF 6D40D48A%n + +FINISH + End the OTR session. This MUST be done inside a private conversation + window. + +FORGET <fingerprint> + Forget a specific fingerprint (deleted from the known fingerprints). The + behavior is the same as the distrust command explained above. + +GENKEY <name> + Generate OTR keys for a given account name. This is done automatically + if someone tries to establish a secure session. + + This process is done in a background worker and can take an arbitrary + amount of time. The completion is checked when another irssi event is + caught. + +HELP + Print this help. + +INFO + Display the OTR fingerprint(s) of all your account(s). + +INIT + Initialize an OTR conversation within a private conversation window. + +TRUST <fingerprint> + Trust a specific fingerprint. The behavior is the same as the forget and + distrust commands explained above. + +VERSION + Print the version of the OTR module. + +%9Quickstart:%n + +Start a private conversation with the person you want to initiate a secure +session. Once in the private message window: + +%9/otr init%n + +Key generation should start if no key is found for your account name. Once the +process is done, either type a message which should automatically start the +session or redo the init command. + +Time to authenticate the person. Either use a shared secret exchange through +phone or GPG-signed email or use the socialist millionaire problem mechanism +(SMP) which is basically to ask a question for which the answer can only be +known by the other person. + +%9/otr auth <shared-secret>%n OR %9/otr authq "A question" <shared-secret>%n + +Or to respond to an authentication: + +%9/otr auth <secret>%n + +%9Files:%n + +This otr modules creates a directory in %9$HOME/.irssi/otr%n and creates three +files: + +* %9otr.key%n + Contains your OTR private key(s). NEVER shared this directory with someone + else unless you know what you are doing. + +* %9otr.fp%n + The known fingerprints with their _trust_ status. + +* %9otr.instag + Instance tag of the libotr. This should NEVER be copied to an other + computer. If unsure, just ignore this file. + +For more information on OTR, see https://otr.cypherpunks.ca/ + diff --git a/docs/help/in/part.in b/docs/help/in/part.in new file mode 100644 index 0000000..f89769c --- /dev/null +++ b/docs/help/in/part.in @@ -0,0 +1,20 @@ + +%9Syntax:%9 + +@SYNTAX:part@ + +%9Parameters:%9 + + The channels, separated by a comma, to leave and the message to advertise. + +%9Description:%9 + + Leaves the given channels. + +%9Examples:%9 + + /PART #irssi + /PART #libera,#irssi + +%9See also:%9 JOIN, KICK + diff --git a/docs/help/in/ping.in b/docs/help/in/ping.in new file mode 100644 index 0000000..11e618d --- /dev/null +++ b/docs/help/in/ping.in @@ -0,0 +1,22 @@ + +%9Syntax:%9 + +@SYNTAX:ping@ + +%9Parameters:%9 + + The nickname or channel to ping, you can use the asterisk '*' character to + ping every user on a channel. + +%9Description:%9 + + Sends a CTCP PING request to a nickname or a channel; this is used to find + out the latency on the network. + +%9Examples:%9 + + /PING bob + /PING #irssi + +%9See also:%9 CTCP, MSG + diff --git a/docs/help/in/query.in b/docs/help/in/query.in new file mode 100644 index 0000000..a34f85e --- /dev/null +++ b/docs/help/in/query.in @@ -0,0 +1,24 @@ + +%9Syntax:%9 + +@SYNTAX:query@ + +%9Parameters:%9 + + -window: Uses the active window instead of opening a new one. + -<server tag>: The server tag the target nickname is on. + + The nickname to query and the message. + +%9Description:%9 + + Starts a private conversation with a nickname. + +%9Examples:%9 + + /QUERY mike + /QUERY -liberachat bob + /QUERY -liberachat -window sarah + +%9See also:%9 MSG, UNQUERY, WINDOW + diff --git a/docs/help/in/quit.in b/docs/help/in/quit.in new file mode 100644 index 0000000..1b9ca26 --- /dev/null +++ b/docs/help/in/quit.in @@ -0,0 +1,21 @@ + +%9Syntax:%9 + +@SYNTAX:quit@ + +%9Parameters:%9 + + The message to advertise. + +%9Description:%9 + + Terminates the application and advertises the given message on all the + networks you are connected to. + +%9Examples:%9 + + /QUIT + /QUIT <@cartman> Screw you guys, I'm going home! + +%9See also:%9 DISCONNECT + diff --git a/docs/help/in/quote.in b/docs/help/in/quote.in new file mode 100644 index 0000000..5b483a8 --- /dev/null +++ b/docs/help/in/quote.in @@ -0,0 +1,20 @@ + +%9Syntax:%9 + +@SYNTAX:quote@ + +%9Parameters:%9 + + The text to send to the IRC server. + +%9Description:%9 + + Sends raw data to the server without any parsing. + +%9Examples:%9 + + /QUOTE PRIVMSG mike :Hey, this works! + /QUOTE OPERWALL :Meow! + +%9See also:%9 CONNECT, DISCONNECT, JOIN, MSG, PART + diff --git a/docs/help/in/rawlog.in b/docs/help/in/rawlog.in new file mode 100644 index 0000000..1c2dafe --- /dev/null +++ b/docs/help/in/rawlog.in @@ -0,0 +1,26 @@ + +%9Syntax:%9 + +@SYNTAX:rawlog@ + +%9Parameters:%9 + + SAVE: Saves the raw server buffer into a file. + OPEN: Opens a log file and start logging all raw data. + CLOSE: Closes the log file + + The filename to store the raw data into. + +%9Description:%9 + + Saves all the raw data that is received from and transmitted to the active + server into a log file. + +%9Examples:%9 + + /RAWLOG SAVE ~/server.log + /RAWLOG OPEN ~/debug.log + /RAWLOG CLOSE + +%9See also:%9 LOG + diff --git a/docs/help/in/recode.in b/docs/help/in/recode.in new file mode 100644 index 0000000..760c66c --- /dev/null +++ b/docs/help/in/recode.in @@ -0,0 +1,39 @@ + +%9Syntax:%9 + +@SYNTAX:recode@ + +%9Parameters:%9 + + ADD: Adds an entry into the conversion database. + REMOVE: Removes an entry from the conversion database. + + The network tag and channel or nickname to add or remove; if no target is + given, the active nickname or channel will be used. + +%9Description:%9 + + Recodes the data transmitted to and received from nicknames and channels + into a specific charset. + + To get a list of supported charsets on your system, you can generally use + the 'iconv -l' command. + +%9Examples:%9 + + /RECODE + /RECODE ADD liberachat/mike utf-8 + /RECODE ADD #korea euc-kr + /RECODE REMOVE #korea + +%9Special Examples:%9 + + /SET term_charset utf-8 + /SET recode_fallback ISO-8859-15 + /SET recode_out_default_charset ISO-8859-15 + + /TOGGLE recode_transliterate + /TOGGLE recode_autodetect_utf8 + +%9See also:%9 CONNECT, MSG, NETWORK, SERVER + diff --git a/docs/help/in/reconnect.in b/docs/help/in/reconnect.in new file mode 100644 index 0000000..87beb95 --- /dev/null +++ b/docs/help/in/reconnect.in @@ -0,0 +1,22 @@ + +%9Syntax:%9 + +@SYNTAX:reconnect@ + +%9Parameters:%9 + + The network tag and message to advertise; if no arguments are given, the + active server and default message will be used. + +%9Description:%9 + + Disconnect and reconnect from a network. + +%9Examples:%9 + + /RECONNECT + /RECONNECT liberachat + /RECONNECT EFnet BRB :) + +%9See also:%9 CONNECT, DISCONNECT, NETWORK, RMRECONNS, SERVER + diff --git a/docs/help/in/rehash.in b/docs/help/in/rehash.in new file mode 100644 index 0000000..a7e774e --- /dev/null +++ b/docs/help/in/rehash.in @@ -0,0 +1,21 @@ + +%9Syntax:%9 + +@SYNTAX:rehash@ + +%9Parameters:%9 + + The raw parameters to send to the server, if no arguments are given, none + will be sent to the server. + +%9Description:%9 + + Reloads the configuration of the IRC server you are are connected to; this + command is restricted to IRC operators. + +%9Examples:%9 + + /REHASH + +%9See also:%9 DIE, KILL, OPER + diff --git a/docs/help/in/reload.in b/docs/help/in/reload.in new file mode 100644 index 0000000..80cfcc4 --- /dev/null +++ b/docs/help/in/reload.in @@ -0,0 +1,21 @@ + +%9Syntax:%9 + +@SYNTAX:reload@ + +%9Parameters:%9 + + The filename of any Irssi configuration; if no parameter is given, the + active configuration file will be used. + +%9Description:%9 + + Reloads the Irssi configuration file. + +%9Examples:%9 + + /RELOAD + /RELOAD ~/test.irssi.conf + +%9See also:%9 SAVE + diff --git a/docs/help/in/restart.in b/docs/help/in/restart.in new file mode 100644 index 0000000..6677b79 --- /dev/null +++ b/docs/help/in/restart.in @@ -0,0 +1,16 @@ + +%9Syntax:%9 + +@SYNTAX:restart@ + +%9Description:%9 + + Restarts the active IRC server; this command is restricted to IRC + administrators. + +%9Examples:%9 + + /RESTART + +%9See also:%9 DIE, KILL, OPER, REHASH + diff --git a/docs/help/in/rmreconns.in b/docs/help/in/rmreconns.in new file mode 100644 index 0000000..4295d4a --- /dev/null +++ b/docs/help/in/rmreconns.in @@ -0,0 +1,15 @@ + +%9Syntax:%9 + +@SYNTAX:rmreconns@ + +%9Description:%9 + + Removes all active and pending reconnections. + +%9Examples:%9 + + /RMRECONNS + +%9See also:%9 CONNECT, DISCONNECT, NETWORK, SERVER + diff --git a/docs/help/in/rmrejoins.in b/docs/help/in/rmrejoins.in new file mode 100644 index 0000000..bfc4f86 --- /dev/null +++ b/docs/help/in/rmrejoins.in @@ -0,0 +1,15 @@ + +%9Syntax:%9 + +@SYNTAX:rmrejoins@ + +%9Description:%9 + + Removes all active and pending join requests. + +%9Examples:%9 + + /RMREJOINS + +%9See also:%9 JOIN, PART + diff --git a/docs/help/in/save.in b/docs/help/in/save.in new file mode 100644 index 0000000..0978597 --- /dev/null +++ b/docs/help/in/save.in @@ -0,0 +1,24 @@ + +%9Syntax:%9 + +@SYNTAX:save@ + +%9Parameters:%9 + + -formats: Saves all the formats into the theme file. + + The file to save the configuration or theme into; if no parameter is given, + the active configuration or theme file will be used. + +%9Description:%9 + + Saves the configuration file. + +%9Examples:%9 + + /SAVE + /SAVE -formats + /SAVE ~/.irssi/config-new + +%9See also:%9 RELOAD, SET + diff --git a/docs/help/in/sconnect.in b/docs/help/in/sconnect.in new file mode 100644 index 0000000..47da885 --- /dev/null +++ b/docs/help/in/sconnect.in @@ -0,0 +1,25 @@ + +%9Syntax:%9 + +@SYNTAX:sconnect@ + +%9Parameters:%9 + + The server to connect to, the connection port and the remote server that + initiates the connection attempt. + + If no remote server is given, the server you are currently connected to will + be used. + +%9Description:%9 + + Connect a server to the IRC network; this command is restricted to IRC + operators. + +%9Examples:%9 + + /SCONNECT ircsource.irssi.org + /SCONNECT ircsource.irssi.org 6667 be.hub + +%9See also:%9 DIE, KILL, OPER, RESTART, SQUIT + diff --git a/docs/help/in/script.in b/docs/help/in/script.in new file mode 100644 index 0000000..e90135a --- /dev/null +++ b/docs/help/in/script.in @@ -0,0 +1,34 @@ + +%9Syntax:%9 + +@SYNTAX:script@ + +%9Parameters:%9 + + LIST: Displays the list of loaded scripts. + EXEC: Executes the given code. + LOAD: Loads the given script into the memory and executes it. + UNLOAD: Unloads the given script from the memory. + RESET: Unloads all the scripts. + -permanent: In combination with EXEC, the code will be loaded into the + memory. + -autorun: When passed to RESET the scripts in the autorun folder are + reloaded. + + If no argument is given, the list of active scripts will be displayed. + +%9Description:%9 + + Interact with the Perl engine to execute scripts. + +%9Examples:%9 + + /SCRIPT + /SCRIPT LIST + /SCRIPT LOAD ~/.irssi/scripts/nickserv.pl + /SCRIPT UNLOAD nickserv + /SCRIPT RESET + /SCRIPT EXEC foreach my $channel (Irssi::channels()) { Irssi::print($channel->{name} . ' @ ' . $channel->{server}->{tag}); } + +%9See also:%9 LOAD, SAVE, UNLOAD + diff --git a/docs/help/in/scrollback.in b/docs/help/in/scrollback.in new file mode 100644 index 0000000..5f59d84 --- /dev/null +++ b/docs/help/in/scrollback.in @@ -0,0 +1,37 @@ + +%9Syntax:%9 + +@SYNTAX:scrollback@ + +%9Parameters:%9 + + CLEAR: Clears the screen and the buffer of all text. + LEVELCLEAR: Clears the screen and the buffer of text matching the given + levels. + GOTO: Go to the given position. + HOME: Go to the start of the buffer. + END: Go to the end of the buffer. + + -all: Applies to all windows instead of only the active one. + -level: The levels, separated by a comma, to match. + + The line number, timestamp to jump to or the window reference number to + clear. + +%9Description:%9 + + Manipulate the text in the window to go to a to the given line number, or + clear the buffers. + + The timestamp format is format is '[dd[.mm] | -<days ago>] hh:mi[:ss]'. + +%9Examples:%9 + + /SCROLLBACK CLEAR + /SCROLLBACK LEVELCLEAR -level NOTICES + /SCROLLBACK GOTO 100 + /SCROLLBACK HOME + /SCROLLBACK END + +%9See also:%9 CLEAR, WINDOW + diff --git a/docs/help/in/server.in b/docs/help/in/server.in new file mode 100644 index 0000000..84b5ad7 --- /dev/null +++ b/docs/help/in/server.in @@ -0,0 +1,78 @@ + +%9Syntax:%9 + +@SYNTAX:server@ + +%9Parameters:%9 + + LIST: Displays the list of servers you have configured. + CONNECT: Connects to the given server. + ADD: Adds a server to your configuration. + MODIFY: Modifies a server in your configuration. + REMOVE: Removes a server from your configuration. + PURGE: Purges the commands queued to be sent to the server. + + -!: Doesn't autojoin the channels. + -4: Connects using IPv4. + -6: Connects using IPv6. + -tls: Connects using TLS encryption. + -notls: Connect without TLS encrption. + -tls_cert: The TLS client certificate file. + -tls_pkey: The TLS client private key, if not included in the + certificate file. + -tls_pass: The password for the TLS client private key or certificate. + -tls_verify: Verifies the TLS certificate of the server. + -notls_verify: Doesn't verify the TLS certificate of the server. + -tls_cafile: The file with the list of CA certificates. + -tls_capath: The directory which contains the CA certificates. + -tls_ciphers: TLS cipher suite preference lists. + -tls_pinned_cert: Pinned x509 certificate fingerprint. + -tls_pinned_pubkey: Pinned public key fingerprint. + -auto: Automatically connects to the server on startup. + -noauto: Doesn't connect to the server on startup. + -cap: Enable CAPREQ for server. + -nocap: Disable CAPREQ for server. + -network: The network the server belongs to. + -host: The hostname you would like to connect from. + -cmdspeed: Specifies the minimum amount of time, expressed in + milliseconds, that the client must wait before sending + additional commands to the server. + -cmdmax: Specifies the maximum number of commands to perform + before starting the internal flood protection. + -port: Specifies the port to connect to the server. + -noproxy: Ignores the global proxy configuration. + -rawlog: Immediately open rawlog after connecting. + -noautosendcmd: Doesn't execute autosendcmd. + + The server, port and network to add, modify or remove; if no argument is + given, the list of servers you are connected to will be returned. + +%9Description:%9 + + Displays, adds, modifies or removes the network configuration of IRC + servers. + + When using the ADD parameter on a server that already exists, the + configuration will be merged with each other. + + When using the CONNECT parameter, it will connect to the specified + server; the server in the active window will be disconnected + unless you prepend the server with the '+' character. + + Specify '-' as password to remove a server password + +%9Examples:%9 + + /SERVER + /SERVER CONNECT irc.libera.chat + /SERVER CONNECT +irc.libera.chat + /SERVER ADD -network liberachat -noautosendcmd irc.libera.chat + /SERVER ADD -! -auto -host staff.irssi.org -4 -network liberachat -noproxy irc.libera.chat 6667 + /SERVER MODIFY -network liberachat -noauto irc.libera.chat + /SERVER MODIFY -network liberachat irc.libera.chat 6697 - + /SERVER REMOVE irc.libera.chat 6667 liberachat + /SERVER PURGE + /SERVER PURGE irc.libera.chat + +%9See also:%9 CHANNEL, CONNECT, DISCONNECT, NETWORK, RECONNECT, RMRECONNS + diff --git a/docs/help/in/servlist.in b/docs/help/in/servlist.in new file mode 100644 index 0000000..0a0d025 --- /dev/null +++ b/docs/help/in/servlist.in @@ -0,0 +1,23 @@ + +%9Syntax:%9 + +@SYNTAX:servlist@ + +%9Parameters:%9 + + <mask> limits the output to the services which names matches + the mask. + <type> limits the output to the services of the specified type. + +%9Description:%9 + + List the network services currently present on the + IRC network. + +%9Examples:%9 + + /SERVLIST *@javairc.* + /SERVLIST * 0xD000 + +%9See also:%9 SQUERY + diff --git a/docs/help/in/set.in b/docs/help/in/set.in new file mode 100644 index 0000000..097ace7 --- /dev/null +++ b/docs/help/in/set.in @@ -0,0 +1,35 @@ + +%9Syntax:%9 + +@SYNTAX:set@ + +%9Parameters:%9 + + -clear: Removes the setting's value from the configuration. + -default: Restore the setting to its default value. + -section: Print settings under the specified section + + The setting and the value; if no value is given, the list of settings that + matched will be returned. If no arguments are given, all the settings will + be displayed. + +%9Description:%9 + + Modifies the value of a setting; boolean settings accept only ON, OFF and + TOGGLE. + + Please remember that you need to use the SAVE command to store the changes + into your configuration. + +%9Examples:%9 + + /SET + /SET nick mike + /SET -clear nick + /SET log_timestamp %%H:%%H:%%S + /SET -default log_timestamp + /SET -section lookandfeel + /SET close + +%9See also:%9 SAVE, TOGGLE + diff --git a/docs/help/in/silence.in b/docs/help/in/silence.in new file mode 100644 index 0000000..cc3c62d --- /dev/null +++ b/docs/help/in/silence.in @@ -0,0 +1,29 @@ + +%9Syntax:%9 + +@SYNTAX:silence@ + +%9Parameters:%9 + + The nickname or hostname to silence; you must prepend it by the '+' or '-' + character to indicate whether the entry should be added or removed. + + If no arguments are given, the list of silence entries will be displayed. + +%9Description:%9 + + Manages the server side ignore list; users or hostnames that match an entry + on the list are not able to send you any messages or invites. + + This command does not work on all IRC networks. + +%9Examples:%9 + + /SILENCE + /SILENCE +mike + /SILENCE -mike + /SILENCE +*!*@*.irssi.org + /SILENCE -*!*@*.irssi.org + +%9See also:%9 ACCEPT, IGNORE + diff --git a/docs/help/in/squery.in b/docs/help/in/squery.in new file mode 100644 index 0000000..59ee800 --- /dev/null +++ b/docs/help/in/squery.in @@ -0,0 +1,16 @@ + +%9Syntax:%9 + +@SYNTAX:squery@ + +%9Parameters:%9 + + <service> - Service nickname or full hostmask of service to query. + <message> - Message to send to the service. + +%9Description:%9 + + /SQUERY sends a query to the specified service. + +%9See also:%9 SERVLIST, LIST, MSG + diff --git a/docs/help/in/squit.in b/docs/help/in/squit.in new file mode 100644 index 0000000..b45a308 --- /dev/null +++ b/docs/help/in/squit.in @@ -0,0 +1,20 @@ + +%9Syntax:%9 + +@SYNTAX:squit@ + +%9Parameters:%9 + + The server and the disconnect reason. + +%9Description:%9 + + Disconnects a server from the IRC network; this command is restricted to + IRC operators. + +%9Examples:%9 + + /SQUIT ircsource.irssi.org I'm fixing a desync! + +%9See also:%9 DIE, OPER, SCONNECT + diff --git a/docs/help/in/stats.in b/docs/help/in/stats.in new file mode 100644 index 0000000..80f1670 --- /dev/null +++ b/docs/help/in/stats.in @@ -0,0 +1,43 @@ + +%9Syntax:%9 + +@SYNTAX:stats@ + +%9Parameters:%9 + + The statistic identifier and the remote server; if no remote server is + given, the active server will be used. + +%9Description:%9 + + Displays statistics from the IRC server; some statistics require you to have + IRC operators privileges and might differ between IRC networks. + + Common statistics: + + C: Displays the servers the server may connect to. + H: Displays hub server the server may connect to. + K: Displays the permanent blacklist of hostnames which are prohibited + from connecting to the server. + k: Displays the temporary blacklist of hostname which are prohibited + from connecting to the server. + I: Displays the list of hostnames which are allowed to connect to the + server. + L: Displays the list of connected users and servers. + M: Displays the list of commands and how many times they have been + issued. + O: Displays the list of hostnames and users which are allowed to + become IRC operators. + P: Displays the ports the server is listening on. + p: Displays the IRC operators and their idle time. + u: Displays the uptime of the server. + Y: Displays the list of connection groups users are placed into. + ?: Displays information about the utilized bandwidth. + +%9Examples:%9 + + /STATS p + /STATS I ircsource.irssi.org + +%9See also:%9 MOTD, OPER + diff --git a/docs/help/in/statusbar.in b/docs/help/in/statusbar.in new file mode 100644 index 0000000..ac57ca5 --- /dev/null +++ b/docs/help/in/statusbar.in @@ -0,0 +1,65 @@ + +%9Syntax:%9 + +@SYNTAX:statusbar@ + +%9Parameters:%9 + + ADD: Adds a statusbar to the list of statusbars. + MODIFY: Modifies the configuration of a statusbar. + RESET: Restores the default statusbar configuration. + ADDITEM: Adds an item to the specified statusbar. It can be set to + appear before/after another item and left/right aligned + on the screen. + MODIFYITEM: Changes an item position inside a bar. + REMOVEITEM: Removes an item from the specified statusbar. + INFO: List the current details and items of the specified + statusbar. + + -disable: Removes a statusbar from the list. + -type: Sets the type of statusbar, for each split window or only + once at the root (very top or bottom) of the screen. + -placement: Sets the placement of the statusbar, either at the top or + the bottom of the screen or split window. + -position: Sets the position of the statusbar. Represented as a + number, with smaller numbers implying a position further + to the top. + -visible: Sets the visibility of the statusbar. If set to always, + it is visible on all split windows, otherwise if set to + inactive or active then it is only visible on inactive or + active split windows, respectively. + -before: This item is added before the other item. + -after: This item is added after the other item. + -priority: When the statusbar items overflow, the item with the + lowest priority is removed or truncated first. + Priority can be negative, in which case it'll have to be + quoted (e.g. -priority "-1") + -alignment: Display the item on the right side. + + Where statusbar refers to the name of the statusbar; if no + argument is given, or `LIST` is given, the entire list of + statusbars along with a quick overview of their properties will be + displayed. + +%9Description:%9 + + Allows adjustment of the attributes and items of a statusbar, as well + as where it is located and whether or not it is currently visible. + +%9Examples:%9 + + /STATUSBAR + /STATUSBAR INFO window + /STATUSBAR REMOVEITEM time window + /STATUSBAR ADDITEM time window + /STATUSBAR RESET window + /STATUSBAR MODIFY -disable topic + /STATUSBAR MODIFY -nodisable topic + +%9Remarks:%9 + + Statusbar syntax was changed in Irssi 1.2. The old syntax is still + accepted for backward compatibility, but no longer documented. + +%9See also:%9 WINDOW + diff --git a/docs/help/in/time.in b/docs/help/in/time.in new file mode 100644 index 0000000..90dd4ac --- /dev/null +++ b/docs/help/in/time.in @@ -0,0 +1,23 @@ + +%9Syntax:%9 + +@SYNTAX:time@ + +%9Parameters:%9 + + The channel or the nickname; if no argument is given, the active server + will be used. + +%9Description:%9 + + Displays the local time of a server or the server the target user is + connected to. + +%9Examples:%9 + + /TIME + /TIME mike + /TIME ircsource.irssi.org + +%9See also:%9 MAP, TRACE, WHOIS + diff --git a/docs/help/in/toggle.in b/docs/help/in/toggle.in new file mode 100644 index 0000000..f87a646 --- /dev/null +++ b/docs/help/in/toggle.in @@ -0,0 +1,22 @@ + +%9Syntax:%9 + +@SYNTAX:toggle@ + +%9Parameters:%9 + + The setting to modify and the new value; if no value is given, its opposite + will be used. + +%9Description:%9 + + Modifies a setting to its counter value; you can also give ON or OFF as a + value. + +%9Examples:%9 + + /TOGGLE resolve_prefer_ipv6 + /TOGGLE channels_rejoin_unavailable ON + +%9See also:%9 SET + diff --git a/docs/help/in/topic.in b/docs/help/in/topic.in new file mode 100644 index 0000000..68a60cc --- /dev/null +++ b/docs/help/in/topic.in @@ -0,0 +1,25 @@ + +%9Syntax:%9 + +@SYNTAX:topic@ + +%9Parameters:%9 + + -delete: Removes the topic. + + The channel and topic; if no channel is given, the active channel will be + used. If no argument is given, the current topic will be displayed. + +%9Description:%9 + + Displays or modifies the topic of a channel. + +%9Examples:%9 + + /TOPIC + /TOPIC The robots are taking over! + /TOPIC -delete #irssi + /TOPIC #shakespeare /bb|[^b]{2}/ + +%9See also:%9 CHANNEL, DEOP, DEVOICE, JOIN, OP, VOICE + diff --git a/docs/help/in/trace.in b/docs/help/in/trace.in new file mode 100644 index 0000000..f3192f1 --- /dev/null +++ b/docs/help/in/trace.in @@ -0,0 +1,25 @@ + +%9Syntax:%9 + +@SYNTAX:trace@ + +%9Parameters:%9 + + The channel or the nickname; if no argument is given, the active server + will be used. + +%9Description:%9 + + Displays the list of servers and users connects to a server, or a list of + the servers between yourself and the target user. + + This command is usually restricted to IRC operators. + +%9Examples:%9 + + /TRACE + /TRACE mike + /TRACE ircsource.irssi.org + +%9See also:%9 MAP, TIME, WHOIS + diff --git a/docs/help/in/ts.in b/docs/help/in/ts.in new file mode 100644 index 0000000..98861bb --- /dev/null +++ b/docs/help/in/ts.in @@ -0,0 +1,15 @@ + +%9Syntax:%9 + +@SYNTAX:ts@ + +%9Description:%9 + + Displays a list of the channels you are on and their topics. + +%9Examples:%9 + + /TS + +%9See also:%9 JOIN, TOPIC + diff --git a/docs/help/in/unalias.in b/docs/help/in/unalias.in new file mode 100644 index 0000000..d610c3a --- /dev/null +++ b/docs/help/in/unalias.in @@ -0,0 +1,20 @@ + +%9Syntax:%9 + +@SYNTAX:unalias@ + +%9Parameters:%9 + + The name of the alias. + +%9Description:%9 + + Removes an alias. + +%9Examples:%9 + + /UNALIAS BAN + /UNALIAS K + +%9See also:%9 ALIAS + diff --git a/docs/help/in/unban.in b/docs/help/in/unban.in new file mode 100644 index 0000000..2c0c8a5 --- /dev/null +++ b/docs/help/in/unban.in @@ -0,0 +1,45 @@ + +%9Syntax:%9 + +@SYNTAX:unban@ + +%9Parameters:%9 + + -normal: Uses the *!*user@*.domain.tld format. + -user: Uses the *!*user@* format. + -host: Uses the *!*@host.domain.tld format. + -domain: Uses the *!*@*.domain.tld format. + -custom: Uses the custom format. + -first: Removes the first ban from the list. + -last: Removes the last ban from the list. + + A channel and the nicknames, hostnames or ban identifier to unban; if no + channel is given, the active channel will be used. + + If no ban format parameter is given, the value of the ban_type setting will + be used to generate the hostmask to ban. + +%9Description:%9 + + Removes one or more bans from a channel. + +%9Configuring the custom format:%9 + + You must set the custom ban_type to the format you would like to use. For + example, if you set the custom ban_type to 'nick domain', it will generate + a ban based on the nick!*@*.domain.tld format. + +%9Examples:%9 + + /UNBAN mike + /UNBAN -host bob + /UNBAN *!*@*.irssi.org + /UNBAN *!*@*.users.irssi.org *!*@*.staff.irssi.org + /UNBAN -first + /UNBAN 5 + + /SET ban_type custom nick domain + /SET ban_type custom user host + +%9See also:%9 BAN, DEOP, KICKBAN, KNOCKOUT, OP + diff --git a/docs/help/in/unignore.in b/docs/help/in/unignore.in new file mode 100644 index 0000000..a353850 --- /dev/null +++ b/docs/help/in/unignore.in @@ -0,0 +1,20 @@ + +%9Syntax:%9 + +@SYNTAX:unignore@ + +%9Parameters:%9 + + The ignore identifier or pattern to remove. + +%9Description:%9 + + Removes an entry from the ignore list. + +%9Examples:%9 + + /UNIGNORE 5 + /UNIGNORE mike + +%9See also:%9 ACCEPT, IGNORE, SILENCE + diff --git a/docs/help/in/unload.in b/docs/help/in/unload.in new file mode 100644 index 0000000..b804e09 --- /dev/null +++ b/docs/help/in/unload.in @@ -0,0 +1,19 @@ + +%9Syntax:%9 + +@SYNTAX:unload@ + +%9Parameters:%9 + + The name of the module to unload. + +%9Description:%9 + + Removes a module from the memory. + +%9Examples:%9 + + /UNLOAD fish + +%9See also:%9 LOAD, SCRIPT + diff --git a/docs/help/in/unnotify.in b/docs/help/in/unnotify.in new file mode 100644 index 0000000..1dfbb40 --- /dev/null +++ b/docs/help/in/unnotify.in @@ -0,0 +1,20 @@ + +%9Syntax:%9 + +@SYNTAX:unnotify@ + +%9Parameters:%9 + + The notify pattern to remove. + +%9Description:%9 + + Removes an entry from the notify list. + +%9Examples:%9 + + /UNNOTIFY bob + /UNNOTIFY *!*@staff.irssi.org + +%9See also:%9 AWAY, HILIGHT, NOTIFY + diff --git a/docs/help/in/unquery.in b/docs/help/in/unquery.in new file mode 100644 index 0000000..78f52b1 --- /dev/null +++ b/docs/help/in/unquery.in @@ -0,0 +1,21 @@ + +%9Syntax:%9 + +@SYNTAX:unquery@ + +%9Parameters:%9 + + The nickname to close the query for; if no argument is given, the active + query will be used. + +%9Description:%9 + + Closes a query window for a nickname. + +%9Examples:%9 + + /UNQUERY + /UNQUERY mike + +%9See also:%9 MSG, QUERY, WINDOW + diff --git a/docs/help/in/unsilence.in b/docs/help/in/unsilence.in new file mode 100644 index 0000000..1e6d226 --- /dev/null +++ b/docs/help/in/unsilence.in @@ -0,0 +1,21 @@ + +%9Syntax:%9 + +@SYNTAX:unsilence@ + +%9Parameters:%9 + + The silence pattern to remove. + +%9Description:%9 + + Removes an entry from the silence list. This command does not work on all + IRC networks. + +%9Examples:%9 + + /UNSILENCE mike + /UNSILENCE *!*@*.irssi.org + +%9See also:%9 ACCEPT, IGNORE, SILENCE + diff --git a/docs/help/in/upgrade.in b/docs/help/in/upgrade.in new file mode 100644 index 0000000..e182f7e --- /dev/null +++ b/docs/help/in/upgrade.in @@ -0,0 +1,22 @@ + +%9Syntax:%9 + +@SYNTAX:upgrade@ + +%9Parameters:%9 + + The location of the new binary; if no arguments are given, the current + binary file will be used. + +%9Description:%9 + + Upgrades to a new version without disconnecting from non-SSL servers; please + bear in mind that it does not download or compile a new version. + +%9Examples:%9 + + /UPGRADE + /UPGRADE /home/mike/irssi-dev/bin/irssi + +%9See also:%9 CONNECT, DISCONNECT, HELP + diff --git a/docs/help/in/uptime.in b/docs/help/in/uptime.in new file mode 100644 index 0000000..7a2924e --- /dev/null +++ b/docs/help/in/uptime.in @@ -0,0 +1,15 @@ + +%9Syntax:%9 + +@SYNTAX:uptime@ + +%9Description:%9 + + Displays how long Irssi has been running. + +%9Examples:%9 + + /UPTIME + +%9See also:%9 CONNECT, EXIT + diff --git a/docs/help/in/userhost.in b/docs/help/in/userhost.in new file mode 100644 index 0000000..4893649 --- /dev/null +++ b/docs/help/in/userhost.in @@ -0,0 +1,22 @@ + +%9Syntax:%9 + +@SYNTAX:userhost@ + +%9Parameters:%9 + + One or more nicknames separated by space. + +%9Description:%9 + + Displays the user@host for the given nicknames; some common added attributes + are '*' to identify an IRC operator, '-' and '+' to indicate whether the + nickname is AWAY or available. + +%9Examples:%9 + + /USERHOST mike + /USERHOST bob sarah + +%9See also:%9 WHOIS + diff --git a/docs/help/in/ver.in b/docs/help/in/ver.in new file mode 100644 index 0000000..1e1afcc --- /dev/null +++ b/docs/help/in/ver.in @@ -0,0 +1,22 @@ + +%9Syntax:%9 + +@SYNTAX:ver@ + +%9Parameters:%9 + + A nickname, channel or the wildcard character '*'. + +%9Description:%9 + + Send a CTCP VERION request to the target nickname, channel or to all the + users on the channel. + +%9Examples:%9 + + /VER * + /VER #irssi + /VER mike + +%9See also:%9 CTCP + diff --git a/docs/help/in/version.in b/docs/help/in/version.in new file mode 100644 index 0000000..98891ca --- /dev/null +++ b/docs/help/in/version.in @@ -0,0 +1,22 @@ + +%9Syntax:%9 + +@SYNTAX:version@ + +%9Parameters:%9 + + A nickname or server; if no argument is given, the active server will be + used. + +%9Description:%9 + + Displays the version and compatibility parameters of the given server, or + for the server the target nickname is on. + +%9Examples:%9 + + /VERSION mike + /VERSION ircsource.irssi.org + +%9See also:%9 ADMIN, STATS + diff --git a/docs/help/in/voice.in b/docs/help/in/voice.in new file mode 100644 index 0000000..33d1a37 --- /dev/null +++ b/docs/help/in/voice.in @@ -0,0 +1,23 @@ + +%9Syntax:%9 + +@SYNTAX:voice@ + +%9Parameters:%9 + + A list of nicknames to voice. + +%9Description:%9 + + Grants the channel voice privileges to the given nicknames; you may use + the wildcard character '*' in a nickname. + +%9Examples:%9 + + /VOICE mike + /VOICE bob sarah + /VOICE jo*n + /VOICE * + +%9See also:%9 DEOP, DEVOICE, KICK, MODE, OP + diff --git a/docs/help/in/wait.in b/docs/help/in/wait.in new file mode 100644 index 0000000..263b9fb --- /dev/null +++ b/docs/help/in/wait.in @@ -0,0 +1,21 @@ + +%9Syntax:%9 + +@SYNTAX:wait@ + +%9Parameters:%9 + + The amount of milliseconds. + +%9Description:%9 + + Waits the specified amount of milliseconds before sending the next command + to the server. + +%9Examples:%9 + + /WAIT 1000 + /WAIT 5000 + +%9See also:%9 ALIAS + diff --git a/docs/help/in/wall.in b/docs/help/in/wall.in new file mode 100644 index 0000000..bf1fc12 --- /dev/null +++ b/docs/help/in/wall.in @@ -0,0 +1,23 @@ + +%9Syntax:%9 + +@SYNTAX:wall@ + +%9Parameters:%9 + + The channel and the message; if no channel is given, the active channel + will be used. + +%9Description:%9 + + Sends a message to all channel operators. If the server doesn't support + WALLCHOPS or STATUSMSG it will send a notice to each channel operator + individually. + +%9Examples:%9 + + /WALL I'm off for today; take care! :) + /WALL #irssi I'm feeling supercalifragilisticexpialidocious today :D + +%9See also:%9 MSG, NOTICE + diff --git a/docs/help/in/wallops.in b/docs/help/in/wallops.in new file mode 100644 index 0000000..dfc3f5d --- /dev/null +++ b/docs/help/in/wallops.in @@ -0,0 +1,20 @@ + +%9Syntax:%9 + +@SYNTAX:wallops@ + +%9Parameters:%9 + + The message to broadcast. + +%9Description:%9 + + Sends a network wide message to all the users which have the usermode 'w' + enabled; this command is restricted to IRC operators. + +%9Examples:%9 + + /WALLOPS Hi everybody! + +%9See also:%9 OPER, STATS + diff --git a/docs/help/in/who.in b/docs/help/in/who.in new file mode 100644 index 0000000..d265fd2 --- /dev/null +++ b/docs/help/in/who.in @@ -0,0 +1,36 @@ + +%9Syntax:%9 + +@SYNTAX:who@ + +%9Parameters:%9 + + The channel name or output filter; if no arguments are given, the current + channel will be used. + +%9Description:%9 + + Displays information about users in the specified channel. If you specify a + filter, all the users whose nick, userhost or realname matches the filter + will be returned. + + If the channel is secret and you are not on it, you will not receive any + output. + + Common flags: + + H: The user is available. + G: The user is away. + *: The user is an IRC operator. + @: The user is a channel operator. + +: The user is a channel voice. + +%9Examples:%9 + + /WHO + /WHO #irssi + /WHO bob + /WHO sar* + +%9See also:%9 CHANNEL, NAMES, WHOIS + diff --git a/docs/help/in/whois.in b/docs/help/in/whois.in new file mode 100644 index 0000000..b2801c5 --- /dev/null +++ b/docs/help/in/whois.in @@ -0,0 +1,30 @@ + +%9Syntax:%9 + +@SYNTAX:whois@ + +%9Parameters:%9 + + -<server tag>: The server tag the target nickname is on. + + The remote server to query and the nicknames; if no remote server is given, + the server you are connected to will be used. If no nickname is given, you + will query yourself. + +%9Description:%9 + + Displays information about users in the specified channel; you may give the + same nickname as the argument twice to also query the idle time. + + If the nickname is not online, the WHOWAS command will be automatically + performed. + +%9Examples:%9 + + /WHOIS + /WHOIS mike + /WHOIS ircsource.irssi.org bob + /WHOIS sarah sarah + +%9See also:%9 CHANNEL, NAMES, WHO, WHOWAS + diff --git a/docs/help/in/whowas.in b/docs/help/in/whowas.in new file mode 100644 index 0000000..3dec6d2 --- /dev/null +++ b/docs/help/in/whowas.in @@ -0,0 +1,24 @@ + +%9Syntax:%9 + +@SYNTAX:whowas@ + +%9Parameters:%9 + + The nicknames, the maximum amount of results and the remote server. If no + arguments are given, your own nickname will be used. If no remote server is + given, the server you are connected to will be used. + +%9Description:%9 + + Displays historical user information. + +%9Examples:%9 + + /WHOWAS + /WHOWAS mike + /WHOWAS bob 10 + /WHOWAS sarah 5 ircsource.irssi.org + +%9See also:%9 CHANNEL, NAMES, WHO, WHOIS + diff --git a/docs/help/in/window.in b/docs/help/in/window.in new file mode 100644 index 0000000..2566668 --- /dev/null +++ b/docs/help/in/window.in @@ -0,0 +1,78 @@ + +%9Syntax:%9 + +@SYNTAX:window@ + +%9Parameters:%9 + + LOG: %|Turn on or off logging of the active window, optionally specifying the log file to use. + LOGFILE: %|Sets the location of the log file to use for window logging without starting to log. + NEW: %|Creates a new hidden or split window. + CLOSE: %|Closes the current window, the specified one or all windows in the given range. + REFNUM: %|Go to the window with the given number. + GOTO: %|Go to the window with activity, with the given nickname, channel or with the specified number. + NEXT: %|Go to the next window numerically. + LAST: %|Go to the previously active window. + PREVIOUS: %|Go to the previous window numerically. + LEVEL: %|Changes the text levels to display in the window, or query the current level. + IMMORTAL: %|Modifies or queries the window mortality status. Immortal windows have an extra protection against WINDOW CLOSE. + SERVER: %|Change the active server of the window or the server stickyness. If the server is sticky, it cannot be cycled with next_window_item/previous_window_item + ITEM PREV: %|Make the previous item in this window active. + ITEM NEXT: %|Make the next item in this window active. + ITEM GOTO: %|Change to the query with the specified nickname, channel with the given name or window item number. + ITEM MOVE: %|Move the active window item to another window, or move the channel or query item specified by their name to the current window. + NUMBER: %|Change the active window number to the specified number, swapping the window already in that place if required. With -sticky, protect the window number from renumbering done by windows_auto_renumber. (To re-set the sticky attribute, use WINDOW NUMBER again without -sticky.) + NAME: %|Change or clear the window name. Window names must be unique. + HISTORY: %|Set or clear a specific named history to use for this window. All windows with the same named history will share a history. + MOVE PREV: %|Move the window to the place of the numerically previous window. At the first position, move the window to the end and renumber the consecutive block that it was part of. + MOVE NEXT: %|Move the window to the place of the numerically next window. At the last position, move the window to the first position and renumber the consecutive block at first position (if any) + MOVE FIRST: %|Move the window to the first position. Any windows inbetween are moved to their numerically next positions. + MOVE LAST: %|Move the window to the last position. Any windows inbetween are moved to their numerically previous positions. + MOVE: %|Move the window to the specified number or the first number that is in use when moving the window in the direction of the specified position. Any windows inbetween are shifted towards the old position of the window (unused positions remain empty) + LIST: %|List all the windows. + THEME: %|Applies or removes a per-window theme. + GROW: %|Increase the size of the active split window by the specified number of lines. + SHRINK: %|Decrease the size of the active split window by the specified number of lines. + SIZE: %|Set the current split window size to the specified number of lines. + BALANCE: %|Balance the heights of all split windows. + HIDE: %|Hides the current split window, or the split window specified by number or item name. + SHOW: %|Show the window specified by number or item name as a new split windows. It is made sticky when autostick_split_windows is turned on. + UP: %|Set the split window left or above the current one active. At the top, wraps to the bottom. + DOWN: %|Set the split window right or below the current one active. At the bottom, wraps left. + LEFT: %|Go to the previous window numerically that is part of the current sticky group (or not part of any sticky group). + RIGHT: %|Go to the next window numerically that is part of the current sticky group (or not part of any sticky group). + STICK: %|Make the currently active window sticky, or stick the window specified by number to the currently visible split window. Or turn off stickyness of the currently active window or the window specified by number. + HIDELEVEL: %|Changes the levels of text lines that should be hidden from view, or query the current hidden level. + MOVE LEFT: %|Move the window to the numerically previous location inside the current sticky group. + MOVE RIGHT: %|Move the window to the numerically next location inside the current sticky group. + MOVE UP: %|Move the current window to the sticky group of the previous split window. If no sticky group remains, the split window collapses. + MOVE DOWN: %|Move the current window to the sticky group of the next split window. If no sticky group remains, the split window collapses. + + -right: %|Makes the command work on the width instead of height, or create the split window to the right instead of top. + -directional: %|Set the split window in the given direction to the current one active, or move the current window to the sticky group of the split window in the given direction. (If no sticky group remains, the split window collapses.) + + %|Add the required arguments for the given command. Without arguments, the details (size, immortality, levels, server, name and sticky group) of the currently active window are displayed. If used with a number as argument, same as WINDOW REFNUM. + + %|LEVEL and HIDELEVEL modify the currently set level. Without arguments, the current level is displayed. Levels listed starting with `+' are added to the current levels. Levels listed starting with `-' are removed from the current levels. To clear the levels, start the new level setting with `NONE'. Levels listed starting with `^' are either removed or added from the current setting, depending on whether they were previously set or not (since Irssi 1.4.4). Levels listed as is are also added to the current levels. Afterwards, the new level setting is displayed. + +%9Description:%9 + + Manipulates the window layout and positioning attributes. + +%9Examples:%9 + + /WINDOW CLOSE + /WINDOW ITEM MOVE 10 + /WINDOW GOTO 15 + /WINDOW GOTO ACTIVE + /WINDOW GOTO mike + /WINDOW GOTO #irssi + /WINDOW NEW HIDDEN + /WINDOW LOG OFF + /WINDOW LOG ON ~/logs/debug.log + /WINDOW LEVEL -ALL +NOTICES + /WINDOW HIDELEVEL ^JOINS ^PARTS ^QUITS + /WINDOW LOGFILE ~/logs/notices.log + +%9See also:%9 JOIN, LEVELS, LOG, QUERY + diff --git a/docs/help/info b/docs/help/info new file mode 100644 index 0000000..b20694d --- /dev/null +++ b/docs/help/info @@ -0,0 +1,21 @@ + +%9Syntax:%9 + +INFO %|[<server>] + +%9Parameters:%9 + + The server to display the information for; if no argument is given, the + active server will be used. + +%9Description:%9 + + Displays information about the IRC server software. + +%9Examples:%9 + + /INFO + /INFO irc.libera.chat + +%9See also:%9 ADMIN + diff --git a/docs/help/invite b/docs/help/invite new file mode 100644 index 0000000..3c7a628 --- /dev/null +++ b/docs/help/invite @@ -0,0 +1,21 @@ + +%9Syntax:%9 + +INVITE %|<nick> [<channel>] + +%9Parameters:%9 + + The nickname to invite and the channel to invite him or her to; if no + channel is given, the active channel will be used. + +%9Description:%9 + + Invites the specified nick to a channel. + +%9Examples:%9 + + /INVITE mike + /INVITE bob #irssi + +%9See also:%9 MODE, WHOIS + diff --git a/docs/help/irssiproxy b/docs/help/irssiproxy new file mode 100644 index 0000000..38ec89a --- /dev/null +++ b/docs/help/irssiproxy @@ -0,0 +1,15 @@ + +IRSSIPROXY STATUS%| +IRSSIPROXY + +%9Description:%9 + + Displays the list of clients connected to irssiproxy. + +%9Examples:%9 + + /IRSSIPROXY + /IRSSIPROXY STATUS + +%9See also:%9 LOAD PROXY, SET irssiproxy + diff --git a/docs/help/ison b/docs/help/ison new file mode 100644 index 0000000..bd445bc --- /dev/null +++ b/docs/help/ison @@ -0,0 +1,20 @@ + +%9Syntax:%9 + +ISON %|<nicks> + +%9Parameters:%9 + + The nicknames, separated by space, to check. + +%9Description:%9 + + Displays whether the specified nicknames are online. + +%9Examples:%9 + + /ISON mike + /ISON sarah bob + +%9See also:%9 NOTIFY, WHOWAS, WHOIS + diff --git a/docs/help/join b/docs/help/join new file mode 100644 index 0000000..65f6038 --- /dev/null +++ b/docs/help/join @@ -0,0 +1,26 @@ + +%9Syntax:%9 + +JOIN %|[-window] [-invite] [-<server tag>] <channels> [<keys>] + +%9Parameters:%9 + + -window Joins a channel in the active window. + -invite Joins the channel you were last invited to. + -<server tag> The server tag on which you want to join the channel. + + The channel names, separated by a comma, to join and the channel key. + +%9Description:%9 + + Joins the given channels. + +%9Examples:%9 + + /JOIN #irssi + /JOIN #basementcat secret_lair + /JOIN -invite + /JOIN -liberachat #github,#libera,#irssi + +%9See also:%9 KICK, PART + diff --git a/docs/help/kick b/docs/help/kick new file mode 100644 index 0000000..0b882cf --- /dev/null +++ b/docs/help/kick @@ -0,0 +1,24 @@ + +%9Syntax:%9 + +KICK %|[<channel>] <nicks> [<reason>] + +%9Parameters:%9 + + The channel and the nicknames, separated by a comma, to kick from the + channel and the reason thereof; if no channel is given, the active channel + will be used. + +%9Description:%9 + + Removes the given nicknames from the specified channel; this command is + typically used to remove troublemakers, flooders or people otherwise making + a nuisance of themselves. + +%9Examples:%9 + + /KICK mike Please... chill down! + /KICK #irssi bob,sarah Stop flooding! + +%9See also:%9 BAN, KICKBAN, KNOCKOUT + diff --git a/docs/help/kickban b/docs/help/kickban new file mode 100644 index 0000000..96c5161 --- /dev/null +++ b/docs/help/kickban @@ -0,0 +1,22 @@ + +%9Syntax:%9 + +KICKBAN %|[<channel>] <nicks> <reason> + +%9Parameters:%9 + + The channel and the nicknames, separated by a comma, to kick and ban from + the channel and the reason thereof; if no channel is given, the active + channel will be used. + +%9Description:%9 + + Removes and then bans the given nicknames from the specified channel. + +%9Examples:%9 + + /KICKBAN mike Please... chill down! + /KICKBAN #irssi bob,sarah You guys broke the rules for the last time. + +%9See also:%9 BAN, KICK, KNOCKOUT + diff --git a/docs/help/kill b/docs/help/kill new file mode 100644 index 0000000..340c9ca --- /dev/null +++ b/docs/help/kill @@ -0,0 +1,24 @@ + +%9Syntax:%9 + +KILL %|<nick> <reason> + +%9Parameters:%9 + + The nickname to remove from the network and the reason thereof. + +%9Description:%9 + + Terminates a nickname's connection from the network; this command is + reserved for IRC operators. + + You should not use this command for personal vendettas or for trolling; + these practices are generally frowned upon. + +%9Examples:%9 + + /KILL mike Get off my lawn + /KILL bob Stop breaking the network rules! + +%9See also:%9 DIE, OPER, WALLOPS + diff --git a/docs/help/knock b/docs/help/knock new file mode 100644 index 0000000..b861f4e --- /dev/null +++ b/docs/help/knock @@ -0,0 +1,30 @@ + +%9Syntax:%9 + +KNOCK %|<channel> + +%9Parameters:%9 + + The channel you wish to get invited to. + +%9Description:%9 + + Sends an invitation request to the channel operators of the target channel; + this command may not work on all IRC servers. + + The following conditions must be met: + + * You are not banned from the channel. + * The channel is not private. + * You may not be already in the channel. + * The channel must be invite only, have a key or has exceeded its user + limit. + +%9Examples:%9 + + /KNOCK #irssi + /KNOCK #libera + /KNOCK #github + +%9See also:%9 INVITE, JOIN + diff --git a/docs/help/knockout b/docs/help/knockout new file mode 100644 index 0000000..2aed4e0 --- /dev/null +++ b/docs/help/knockout @@ -0,0 +1,26 @@ + +%9Syntax:%9 + +KNOCKOUT %|[<time>] <nicks> <reason> + +%9Parameters:%9 + + The time, expressed in seconds, the nicknames, separated by a comma, and the + reason thereof; if no time is provided, the ban will be lifted after 5 + minutes. + +%9Description:%9 + + Removes and then bans the given nicknames from the active channel; the ban + will be automatically lifted after the specified time. + + The ban will not be lifted if you leave the channel or disconnect from the + network. + +%9Examples:%9 + + /KNOCKOUT 3600 mike Your connection is unstable. + /KNOCKOUT bob,sarah Chill down a bit. + +%9See also:%9 BAN, KICK, KICKBAN + diff --git a/docs/help/lastlog b/docs/help/lastlog new file mode 100644 index 0000000..6e8a6ec --- /dev/null +++ b/docs/help/lastlog @@ -0,0 +1,43 @@ + +%9Syntax:%9 + +LASTLOG %|[-] [-file <filename>] [-window <ref#|name>] [-new | -away] [-<level> -<level...>] [-clear] [-count] [-case] [-date] [-regexp | -word] [-before [<#>]] [-after [<#>]] [-<# before+after>] [<pattern>] [<count> [<start>]] + +%9Parameters:%9 + + -: Doesn't print the 'Lastlog:' and 'End of Lastlog' messages. + -file: Output the lastlog to a file instead of the active window. + -window: Specifies the window to check. + -new: Only displays results since the previous lastlog. + -away: Only displays results since you previous away status. + -<level>: Specifies the levels to check (e.g. -joins -quits -hilight) + -clear: Removes the previous results from the active window. + -count: Displays how many lines match. + -case: Performs a case-sensitive matching. + -date: Prepends each row with the message's date + -regexp: The given text pattern is a regular expression. + -word: The text must match full words. + -force: Forces to display the lastlog, even if it exceeds 1000 lines. + -after: Include this many lines of content after the match. + -before: Include this many lines of content before the match. + -<#>: Include this many lines of content around the match. + <count>: Display a maximum number of `count' lines. + <start>: Skip the last `start' lines. + + The pattern to search for and the maximum of lines to display; if no + parameter is given, the entire window buffer will be displayed. + +%9Description:%9 + + Searches the active window for a pattern and displays the result. + +%9Examples:%9 + + /LASTLOG holiday + /LASTLOG 'is on vacation' 10 + /LASTLOG -force -file ~/mike.log 'mike' + /LASTLOG -hilight + /LASTLOG -5 searchterm + +%9See also:%9 HILIGHT, SCROLLBACK + diff --git a/docs/help/layout b/docs/help/layout new file mode 100644 index 0000000..477fdc4 --- /dev/null +++ b/docs/help/layout @@ -0,0 +1,29 @@ + +%9Syntax:%9 + +LAYOUT SAVE%| +LAYOUT RESET + +%9Parameters:%9 + + SAVE: Saves your layout to the configuration. + RESET: Removes the saved layout from the configuration. + +%9Description:%9 + + Saves the layout of your window configuration; the next time you connect + to the server, you will join the channels in the same window as before. + + This method enables you to keep the same window layout when you start Irssi + the next time. + + You will need to use the SAVE command to confirm and commit the changes + into the configuration file. + +%9Examples:%9 + + /LAYOUT SAVE + /LAYOUT RESET + +%9See also:%9 SAVE, WINDOW + diff --git a/docs/help/levels b/docs/help/levels new file mode 100644 index 0000000..b6eb9fb --- /dev/null +++ b/docs/help/levels @@ -0,0 +1,42 @@ + +%9Description:%9 + + These are the message levels that are used throughout Irssi; they describe + what kind of message is displayed. + + These are the common levels you can use: + + ACTIONS Actions by a nickname. + CLIENTCRAP Irssi's internal messages. + CLIENTERROR Irssi's internal error messages. + CLIENTNOTICE Irssi's internal notices. + CRAP Can be almost anything. + CTCPS CTCP messages. + DCC DCC protocol related messages. + DCCMSGS DCC chat messages. + INVITES An invite is received. + JOINS A nickname joins a channel. + KICKS A nickname gets kicked from a channel. + MODES A channel mode is modified. + MSGS Private messages. + NICKS A nickname changes to another nickname. + NOTICES Notices sent from a nickname. + PARTS A nickname leaves a channel. + PUBLIC Public messages in a channel. + QUITS A nickname disconnects from IRC. + SNOTES Notices sent from a server. + TOPICS A channel topic is modified. + WALLOPS A wallop is received. + + These are the special levels you can use: + + HILIGHT The text is highlighted. + NEVER Never ignores or logs the message. + HIDDEN Hides the message when window HIDELEVEL includes HIDDEN. + NO_ACT Doesn't trigger any activity in the statusbar. + NOHILIGHT The text is not highlighted. + Suppresses hilights when used with /ignore. + + When using levels from Irssi scripts, you need to prepend the level with + 'MSGLEVEL_'; for example 'CRAP' becomes 'MSGLEVEL_CRAP'. + diff --git a/docs/help/links b/docs/help/links new file mode 100644 index 0000000..fdcf9df --- /dev/null +++ b/docs/help/links @@ -0,0 +1,22 @@ + +%9Syntax:%9 + +LINKS %|[[<server>] <mask>] + +%9Parameters:%9 + + The server to search on and the string to match on; if no arguments are + given, the list of links of the active server will be displayed. + +%9Description:%9 + + Displays the links between an IRC server and its connections. + +%9Examples:%9 + + /LINKS + /LINKS ircsource.irssi.org + /LINKS ircsource.irssi.org *.hub + +%9See also:%9 LUSERS, MAP + diff --git a/docs/help/list b/docs/help/list new file mode 100644 index 0000000..cabd022 --- /dev/null +++ b/docs/help/list @@ -0,0 +1,38 @@ + +%9Syntax:%9 + +LIST %|[-yes] [<channel>] + +%9Parameters:%9 + + -yes: Confirms that you want to receive a large amount of data. + + If the exact name of a channel is given, the only information about this + channel is requested; otherwise, a list of all channels will be displayed. + +%9Description:%9 + + Displays the channel names that match your request; requesting all channels + may cause the server to disconnect you for flooding. + +%9Examples:%9 + + /LIST + /LIST -yes + /LIST #ubuntu + /LIST #*ubuntu*,>1 + +%9Remarks:%9 + + Not all networks support server-side filtering. Some provide a network + service or service bot instead; on IRCnet, you may use the List service: + + /SQUERY Alis HELP + + Other networks with service bots (like ChanServ) may also provide a list + service bot (confirm with /WHOIS ALIS): + + /MSG Alis HELP + +%9See also:%9 STATS, SQUERY, WHOIS + diff --git a/docs/help/load b/docs/help/load new file mode 100644 index 0000000..9cdde01 --- /dev/null +++ b/docs/help/load @@ -0,0 +1,23 @@ + +%9Syntax:%9 + +LOAD %|[-silent] <module> [<submodule>] + +%9Parameters:%9 + + The name of the module and submodule to load. + +%9Description:%9 + + Loads a plugin; if the full path isn't given, it will attempt to load from + common directories in your installation path. + + To load a perl script, you must use the SCRIPT command. + +%9Examples:%9 + + /LOAD fish + /LOAD ~/irssi-fish/libfish.so + +%9See also:%9 SCRIPT, UNLOAD + diff --git a/docs/help/log b/docs/help/log new file mode 100644 index 0000000..f76ea30 --- /dev/null +++ b/docs/help/log @@ -0,0 +1,51 @@ + +%9Syntax:%9 + +LOG OPEN %|[-noopen] [-autoopen] [-window] [-<server tag>] [-targets <targets>] [-colors] <fname> [<levels>] +LOG CLOSE %|<id>|<file> +LOG START %|<id>|<file> +LOG STOP %|<id>|<file> + +%9Parameters:%9 + + OPEN: Opens a log file. + CLOSE: Closes a log file. + START: Starts logging a log entry. + STOP: Stops logging a log entry. + + -noopen: Saves the entry in the configuration, but doesn't actually + start logging. + -autoopen: Automatically opens the log at startup. + -window: Displays the output to the active window, or the window + specified in the targets parameter. + -<server tag>: The server tag the targets must be on. + -targets: Logs the specified nicknames or channels. + -colors: Also log the color codes of the messages. + + The filename of the log and the levels to match; if no argument is given, + the list of open logs will be displayed. + +%9Description:%9 + + Opens a log file and stores the messages of the given targets into it; the + log files will be locked so multiple clients cannot log to the same file. + + You may use any of the date formats to create a log rotation; we strongly + recommend you to enable autolog if you are interested in keeping logs. + +%9Examples:%9 + + /LOG OPEN -targets mike ~/irclogs/mike.log MSGS + /LOG OPEN -targets #irssi ~/irclogs/liberachat/irssi-%%Y-%%m-%%d + /LOG CLOSE ~/irclogs/liberachat/irssi-%%Y-%%m-%%d + /LOG STOP ~/irclogs/liberachat/irssi-%%Y-%%m-%%d + /LOG START ~/irclogs/liberachat/irssi-%%Y-%%m-%%d + + /SET autolog ON + +%9References:%9 + + https://github.com/irssi/irssi/blob/master/docs/formats.txt + +%9See also:%9 SET LOG, WINDOW LOG + diff --git a/docs/help/lusers b/docs/help/lusers new file mode 100644 index 0000000..5c94060 --- /dev/null +++ b/docs/help/lusers @@ -0,0 +1,24 @@ + +%9Syntax:%9 + +LUSERS %|[<server mask> [<remote server>]] + +%9Parameters:%9 + + The server to search on and the remote sever to search on; if no arguments + are given, the active server will be used. + +%9Description:%9 + + Displays the user statistics of the active or remote server. + + The parameters to search on a remote server are no longer supported on most + IRC servers; we no longer provide examples for remote LUSERS to avoid all + confusion. + +%9Examples:%9 + + /LUSERS + +%9See also:%9 LINKS, MAP + diff --git a/docs/help/map b/docs/help/map new file mode 100644 index 0000000..e6ea4eb --- /dev/null +++ b/docs/help/map @@ -0,0 +1,16 @@ + +%9Syntax:%9 + +MAP + +%9Description:%9 + + Displays the network map of an IRC network; this command is usually + reserved for IRC operators and does not work on all servers. + +%9Examples:%9 + + /MAP + +%9See also:%9 DIE, LINKS, LUSERS + diff --git a/docs/help/me b/docs/help/me new file mode 100644 index 0000000..52158a5 --- /dev/null +++ b/docs/help/me @@ -0,0 +1,21 @@ + +%9Syntax:%9 + +ME %|<message> + +%9Parameters:%9 + + The message to emote. + +%9Description:%9 + + Sends an action emote to the active nickname or channel. + +%9Examples:%9 + + /ME is hungry! + /ME had an awesome day @ work + /ME is happy it's Friday + +%9See also:%9 ACTION, CTCP + diff --git a/docs/help/meson.build b/docs/help/meson.build new file mode 100644 index 0000000..7fe95d4 --- /dev/null +++ b/docs/help/meson.build @@ -0,0 +1,121 @@ +install_data( + files( + 'accept', + 'action', + 'admin', + 'alias', + 'away', + 'ban', + 'beep', + 'bind', + 'cat', + 'cd', + 'channel', + 'clear', + 'completion', + 'connect', + 'ctcp', + 'cycle', + 'dcc', + 'dehilight', + 'deop', + 'devoice', + 'die', + 'disconnect', + 'echo', + 'eval', + 'exec', + 'flushbuffer', + 'format', + 'hash', + 'help', + 'hilight', + 'ignore', + 'info', + 'invite', + 'irssiproxy', + 'ison', + 'join', + 'kick', + 'kickban', + 'kill', + 'knock', + 'knockout', + 'lastlog', + 'layout', + 'levels', + 'links', + 'list', + 'load', + 'log', + 'lusers', + 'map', + 'me', + 'mircdcc', + 'mode', + 'motd', + 'msg', + 'names', + 'nctcp', + 'netsplit', + 'network', + 'nick', + 'notice', + 'notify', + 'op', + 'oper', + 'otr', + 'part', + 'ping', + 'query', + 'quit', + 'quote', + 'rawlog', + 'recode', + 'reconnect', + 'rehash', + 'reload', + 'restart', + 'rmreconns', + 'rmrejoins', + 'save', + 'sconnect', + 'script', + 'scrollback', + 'server', + 'servlist', + 'set', + 'silence', + 'squery', + 'squit', + 'stats', + 'statusbar', + 'time', + 'toggle', + 'topic', + 'trace', + 'ts', + 'unalias', + 'unban', + 'unignore', + 'unload', + 'unnotify', + 'unquery', + 'unsilence', + 'upgrade', + 'uptime', + 'userhost', + 'ver', + 'version', + 'voice', + 'wait', + 'wall', + 'wallops', + 'who', + 'whois', + 'whowas', + 'window', + ), + install_dir : helpdir) + +# subdir('in') diff --git a/docs/help/mircdcc b/docs/help/mircdcc new file mode 100644 index 0000000..7449e76 --- /dev/null +++ b/docs/help/mircdcc @@ -0,0 +1,28 @@ + +%9Syntax:%9 + +MIRCDCC ON%||OFF + +%9Parameters:%9 + + ON: Enables mIRC compatibility mode. + OFF: Disables mIRC compatibility mode. + +%9Description:%9 + + After establishing a DCC CHAT connection that you initiated, you might + encounter some protocol issues if the target is using mIRC. + + If you or your target sees some unexpected output or behavior inside a DCC + CHAT session, use this command to enable mIRC compatibility mode. + + When receiving a connection from an mIRC user, the compatibility mode will + automatically be enabled. + +%9Examples:%9 + + /MIRCDCC ON + /MIRCDCC OFF + +%9See also:%9 ACTION, CTCP, DCC + diff --git a/docs/help/mode b/docs/help/mode new file mode 100644 index 0000000..ed47ed7 --- /dev/null +++ b/docs/help/mode @@ -0,0 +1,77 @@ + +%9Syntax:%9 + +MODE %|<your nick>|<channel> [<mode> [<mode parameters>]] + +%9Parameters:%9 + + The target nickname or channel and the modes with their parameters to set or + remove. + + If the target nickname or channel is omitted, the active nickname or channel + will be used. + +%9Description:%9 + + Modifies the user or channel modes for which you are privileged to modify. + + You can specify multiple modes in one command and prepend them by using the + '+' sign to set or '-' sign to unset; modes that require a parameter will be + retrieved from the argument list. + + Some common channel modes are: + + b <mask>: Adds or removes a ban; a ban will prevent a user who + matches the given mask from joining the channel unless + he or she is invited or in the exempt list. + e <mask>: Adds or removes a ban exception; users who match a mask + on the exempt list are able to join a channel even if + they also match an entry on the ban list. + i: When enabled, users need to be invited into the channel + or have a matching entry in the invite list. + I <mask>: Adds or removes an invite; users who match a mask on + the invite list are able to join even if the channel is + set to invite only. + k <key>: Adds or removes a channel key, aka a password; users + will not be able to join the channel without providing + the key. + l <count>: Adds, removes or updates the maximum amount of users + that may join the channel. + m: When enabled, users who are not opped or voiced cannot + send messages to the channel. + n: When enabled, users who are not on the channel cannot + send messages to it. + p: When enabled, the channel will not be displayed in your + WHOIS output. + s: When enabled, the channel will not be displayed in the + LIST output. + t: When enabled, users who are not opped or voices cannot + modify the channel topic. + o <nickname>: Adds or removes the operator status from a nickname. + v <nickname>: Adds or removes the voice status from a nickname. + + Some common user modes are: + + i: When enabled, other users will not be able to see you + on a WHO output unless they are in the channel + themselves. + w: When enabled, you will receive WALLOP messages from IRC + operators. + s: When enabled, you will receive special notices or debug + messages from the server. + + Many networks have additional user and channel modes; we highly recommend + you to read the documentation of the networks you frequently connect to and + maximize your IRC experience. + +%9Examples:%9 + + /MODE #irssi +o mike + /MODE #irssi -o+iI mike mike!*@*.irssi.org + /MODE +b mike!*@*.irssi.org + /MODE -o mike + /MODE +impsnkl secret_hideout 100 + /MODE mike +iw + +%9See also:%9 BAN, DEOP, DEVOICE, OP, UNBAN, VOICE + diff --git a/docs/help/motd b/docs/help/motd new file mode 100644 index 0000000..650bbf6 --- /dev/null +++ b/docs/help/motd @@ -0,0 +1,22 @@ + +%9Syntax:%9 + +MOTD %|[<server>|<nick>] + +%9Parameters:%9 + + The server or the server the target nickname is on; if no parameter is + given, the active server will be used. + +%9Description:%9 + + Displays the welcome message of an IRC server. + +%9Examples:%9 + + /MOTD + /MOTD irc.libera.chat + /MOTD bob + +%9See also:%9 ADMIN, INFO, LINKS, MAP + diff --git a/docs/help/msg b/docs/help/msg new file mode 100644 index 0000000..b8587c6 --- /dev/null +++ b/docs/help/msg @@ -0,0 +1,33 @@ + +%9Syntax:%9 + +MSG %|[-<server tag>] [-channel | -nick] *|<targets> <message> + +%9Parameters:%9 + + -<server tag>: The server tag the targets are on. + -channel: Indicates that the target is a channel. + -nick: Indicates that the target is a nickname. + + The target nickname or channel and the message to send. + + The target can be a comma delimited list of targets, ie + nick1,nick2 or #chan1,#chan2 + + Or one of the following special targets: + * : Use the active nickname or channel + , : Last person who sent you a /msg + . : Last person you sent a /msg to + +%9Description:%9 + + Sends a message to a nickname or channel. + +%9Examples:%9 + + /MSG mike Hi, what's up? + /MSG #irssi I am awesome :) + /MSG * Do you want to build a snowman? + +%9See also:%9 ACTION, DCC, JOIN + diff --git a/docs/help/names b/docs/help/names new file mode 100644 index 0000000..6cb295c --- /dev/null +++ b/docs/help/names @@ -0,0 +1,27 @@ + +%9Syntax:%9 + +NAMES %|[-count | -ops -halfops -voices -normal] [<channels> | **] + +%9Parameters:%9 + + -count: Displays the amount of users in the channel. + -ops: Displays the channel operators. + -halfops: Displays the channel demi-operators. + -voices: Displays the users who are voiced in a channel. + + The channels to report or ** for all channels you have joined; if no + arguments are given, the users in the active channel will be displayed. + +%9Description:%9 + + Displays the users who are in a channel; you can provide multiple channels + by separating them with a comma. + +%9Examples:%9 + + /NAMES -ops + /NAMES -voices #irssi,#libera + +%9See also:%9 JOIN, PART, WHO, WHOIS + diff --git a/docs/help/nctcp b/docs/help/nctcp new file mode 100644 index 0000000..e0c94a1 --- /dev/null +++ b/docs/help/nctcp @@ -0,0 +1,21 @@ + +%9Syntax:%9 + +NCTCP %|<targets> <ctcp command> [<ctcp data>] + +%9Parameters:%9 + + A target nickname or channel, a command and the data. + +%9Description:%9 + + Sends a CTCP reply to a nickname or channel; you can provide multiple + targets by separating them with a comma. + +%9Examples:%9 + + /NCTCP #irssi VERSION King of the Jungle v1.0 + /NCTCP bob,#libera USERINFO I am bob :p + +%9See also:%9 CTCP + diff --git a/docs/help/netsplit b/docs/help/netsplit new file mode 100644 index 0000000..e253f23 --- /dev/null +++ b/docs/help/netsplit @@ -0,0 +1,16 @@ + +%9Syntax:%9 + +NETSPLIT + +%9Description:%9 + + Displays some information about users who are currently lost in one or + more net splits. + +%9Examples:%9 + + /NETSPLIT + +%9See also:%9 JOIN, LINKS, MAP, PART + diff --git a/docs/help/network b/docs/help/network new file mode 100644 index 0000000..7d33400 --- /dev/null +++ b/docs/help/network @@ -0,0 +1,71 @@ + +%9Syntax:%9 + +NETWORK ADD%||MODIFY [-nick <nick>] [-alternate_nick <nick>] [-user <user>] [-realname <name>] [-host <host>] [-usermode <mode>] [-autosendcmd <cmd>] [-querychans <count>] [-whois <count>] [-msgs <count>] [-kicks <count>] [-modes <count>] [-cmdspeed <ms>] [-cmdmax <count>] [-sasl_mechanism <mechanism>] [-sasl_username <username>] [-sasl_password <password>] <name> +NETWORK REMOVE %|<network> + +%9Parameters:%9 + + LIST: Displays the list of configured networks. + ADD: Adds a network to your configuration. + MODIFY: Modifies a network in your configuration. + REMOVE: Removes a network from your configuration. + + -nick: Specifies the nickname to use. + -alternate_nick Specifies the alternate nickname to use. + -user: Specifies the user identity to use. + -realname: Specifies the real name to use. + -host: Specifies the hostname to use. + -usermode: Specifies the user modes to set on yourself. + -autosendcmd: Specifies the commands, separated by the ';' character, + and enclosed within two "'" characters, to perform after + connecting. + (Some characters need to be escaped - see /help eval) + -querychans: Specifies the maximum number of channels to put in one MODE + or WHO command when synchronizing. + -whois: Specifies the maximum number of nicknames in one WHOIS + command. + -msgs: Specifies the maximum number of nicknames in one PRIVMSG + command. + -kicks: Specifies the maximum number of nicknames in one KICK + command. + -modes: Specifies the maximum number of nicknames in one MODE + command. + -cmdspeed: Specifies the minimum amount of time, expressed in + milliseconds, that the client must wait before sending + additional commands to the server. + -cmdmax: Specifies the maximum number of commands to perform before + starting the internal flood protection. + -sasl_mechanism Specifies the mechanism to use for the SASL authentication. + At the moment irssi only supports the 'plain' and the + 'external' mechanisms. + Use '' to disable the authentication. + -sasl_username Specifies the username to use during the SASL authentication. + -sasl_password Specifies the password to use during the SASL authentication. + + + The name of the network to add, edit or remove; if no parameter is given, + the list of networks will be displayed. + +%9Description:%9 + + Displays, adds, modifies or removes the network configuration of IRC + networks. + + When using the ADD parameter on a network that already exists, the + configuration will be merged with each other. + + We recommend using 'WAIT 2000' between the automated commands in order to + prevent you from being kicked from the network due to flooding commands. + +%9Examples:%9 + + /NETWORK ADD -usermode +giw EFnet + /NETWORK ADD -usermode +iw -nick mike -realname 'The one and only mike!' -host staff.irssi.org liberachat + /NETWORK ADD -autosendcmd '^MSG NickServ identify WzerT8zq' liberachat + /NETWORK ADD -autosendcmd '^MSG Q@CServe.quakenet.org AUTH mike WzerT8zq; WAIT 2000; OPER mike WzerT8zq; WAIT 2000; MODE mike +kXP' Quakenet + /NETWORK MODIFY -usermode +gi EFnet + /NETWORK REMOVE liberachat + +%9See also:%9 CHANNEL, CONNECT, SERVER + diff --git a/docs/help/nick b/docs/help/nick new file mode 100644 index 0000000..a55a3dd --- /dev/null +++ b/docs/help/nick @@ -0,0 +1,20 @@ + +%9Syntax:%9 + +NICK %|<new nick> + +%9Parameters:%9 + + Your new nickname. + +%9Description:%9 + + Changes your nickname on the active server. + +%9Examples:%9 + + /NICK mike + /NICK bob + +%9See also:%9 CONNECT, JOIN, MSG, PART + diff --git a/docs/help/notice b/docs/help/notice new file mode 100644 index 0000000..67c4dd9 --- /dev/null +++ b/docs/help/notice @@ -0,0 +1,23 @@ + +%9Syntax:%9 + +NOTICE %|<targets> <message> + +%9Parameters:%9 + + The targets and the message to notify. + +%9Description:%9 + + Sends a notice to the target nickname or channel; these are often used in + automated bots or scripts. + + You can provide multiple targets by separating them with a comma. + +%9Examples:%9 + + /NOTICE mike You sir, are just awesome! + /NOTICE bob,#irssi Fish go blub :p + +%9See also:%9 CTCP, MSG, NCTCP + diff --git a/docs/help/notify b/docs/help/notify new file mode 100644 index 0000000..51f9c85 --- /dev/null +++ b/docs/help/notify @@ -0,0 +1,29 @@ + +%9Syntax:%9 + +NOTIFY %|[-away] <mask> [<ircnets>] + +%9Parameters:%9 + + -away: Notifies you if the target modifies its away status. + -list: Displays the list of notifications. + + The nickname or mask to get a notification for; if no arguments are given, + the current matching notifications will be displayed. + + You may also provide the network that the target must be on. + +%9Description:%9 + + Notifies you when a nickname or users matching a host on the notification + list comes online or offline. + +%9Examples:%9 + + /NOTIFY -list + /NOTIFY -away mike + /NOTIFY bob + /NOTIFY *!*@staff.irssi.org + +%9See also:%9 AWAY, HILIGHT, UNNOTIFY + diff --git a/docs/help/op b/docs/help/op new file mode 100644 index 0000000..ed0198c --- /dev/null +++ b/docs/help/op @@ -0,0 +1,23 @@ + +%9Syntax:%9 + +OP %|<nicks> + +%9Parameters:%9 + + A list of nicknames to op. + +%9Description:%9 + + Grants the channel operator privileges to the given nicknames; you may use + the wildcard character '*' in a nickname. + +%9Examples:%9 + + /OP mike + /OP bob sarah + /OP jo*n + /OP * + +%9See also:%9 DEOP, DEVOICE, KICK, MODE, VOICE + diff --git a/docs/help/oper b/docs/help/oper new file mode 100644 index 0000000..0bbd031 --- /dev/null +++ b/docs/help/oper @@ -0,0 +1,21 @@ + +%9Syntax:%9 + +OPER %|[<nick> [<password>]] + +%9Parameters:%9 + + The username and password to identify yourself as an IRC operator; if no + password is given, you will be prompted to enter one. + +%9Description:%9 + + Grants you the IRC operator status. + +%9Examples:%9 + + /OPER bob + /OPER mike WzerT8zq + +%9See also:%9 DIE, KILL + diff --git a/docs/help/otr b/docs/help/otr new file mode 100644 index 0000000..ddad457 --- /dev/null +++ b/docs/help/otr @@ -0,0 +1,104 @@ + +OTR %|[OPTION] + +Command to control the OTR module. Without an option, /OTR INFO is printed. + +This help contains three sections which are %9options, quickstart and files.%n + +To add the OTR status bar (highly recommended): + +%9/statusbar window add otr%n + +%9Options:%n + +AUTH <secret> + Start or respond to an authentication process. + +AUTHQ <question> <secret> + Start a SMP authentication process. + + Example: %9/otr authq "My question is" "this is the secret"%n + +AUTHABORT + Abort an ongoing authentication process. + +CONTEXTS + List known contexts which basically list the known fingerprints and their + state. + +DEBUG + Turn on debugging. + +DISTRUST <fingerprint> + Distrust a specific fingerprint. This command can be done inside a private + window for which the current fingerprint of the other person will be used + or else set fp to a human readable OTR fingerprint available with the above + contexts command. + + Examples: %9/otr distrust 487FFADA 5073FEDD C5AB5C14 5BB6C1FF 6D40D48A%n + +FINISH + End the OTR session. This MUST be done inside a private conversation + window. + +FORGET <fingerprint> + Forget a specific fingerprint (deleted from the known fingerprints). The + behavior is the same as the distrust command explained above. + +GENKEY <name> + Generate OTR keys for a given account name. This is done automatically + if someone tries to establish a secure session. + + This process is done in a background worker and can take an arbitrary + amount of time. The completion is checked when another irssi event is + caught. + +HELP + Print this help. + +INFO + Display the OTR fingerprint(s) of all your account(s). + +INIT + Initialize an OTR conversation within a private conversation window. + +TRUST <fingerprint> + Trust a specific fingerprint. The behavior is the same as the forget and + distrust commands explained above. + +VERSION + Print the version of the OTR module. + +%9Quickstart:%n + +Start a private conversation with the person you want to initiate a secure session. Once in the private message window: + +%9/otr init%n + +Key generation should start if no key is found for your account name. Once the process is done, either type a message which should automatically start the session or redo the init command. + +Time to authenticate the person. Either use a shared secret exchange through phone or GPG-signed email or use the socialist millionaire problem mechanism (SMP) which is basically to ask a question for which the answer can only be known by the other person. + +%9/otr auth <shared-secret>%n OR %9/otr authq "A question" <shared-secret>%n + +Or to respond to an authentication: + +%9/otr auth <secret>%n + +%9Files:%n + +This otr modules creates a directory in %9$HOME/.irssi/otr%n and creates three files: + +* %9otr.key%n + Contains your OTR private key(s). NEVER shared this directory with someone + else unless you know what you are doing. + +* %9otr.fp%n + The known fingerprints with their _trust_ status. + +* %9otr.instag + Instance tag of the libotr. This should NEVER be copied to an other + computer. If unsure, just ignore this file. + +For more information on OTR, see https://otr.cypherpunks.ca/ + diff --git a/docs/help/part b/docs/help/part new file mode 100644 index 0000000..5f7e54b --- /dev/null +++ b/docs/help/part @@ -0,0 +1,20 @@ + +%9Syntax:%9 + +PART %|[<channels>] [<message>] + +%9Parameters:%9 + + The channels, separated by a comma, to leave and the message to advertise. + +%9Description:%9 + + Leaves the given channels. + +%9Examples:%9 + + /PART #irssi + /PART #libera,#irssi + +%9See also:%9 JOIN, KICK + diff --git a/docs/help/ping b/docs/help/ping new file mode 100644 index 0000000..1ac5c59 --- /dev/null +++ b/docs/help/ping @@ -0,0 +1,22 @@ + +%9Syntax:%9 + +PING %|[<nick> | <channel> | *] + +%9Parameters:%9 + + The nickname or channel to ping, you can use the asterisk '*' character to + ping every user on a channel. + +%9Description:%9 + + Sends a CTCP PING request to a nickname or a channel; this is used to find + out the latency on the network. + +%9Examples:%9 + + /PING bob + /PING #irssi + +%9See also:%9 CTCP, MSG + diff --git a/docs/help/query b/docs/help/query new file mode 100644 index 0000000..536b97c --- /dev/null +++ b/docs/help/query @@ -0,0 +1,24 @@ + +%9Syntax:%9 + +QUERY %|[-window] [-<server tag>] <nick> [<message>] + +%9Parameters:%9 + + -window: Uses the active window instead of opening a new one. + -<server tag>: The server tag the target nickname is on. + + The nickname to query and the message. + +%9Description:%9 + + Starts a private conversation with a nickname. + +%9Examples:%9 + + /QUERY mike + /QUERY -liberachat bob + /QUERY -liberachat -window sarah + +%9See also:%9 MSG, UNQUERY, WINDOW + diff --git a/docs/help/quit b/docs/help/quit new file mode 100644 index 0000000..9110990 --- /dev/null +++ b/docs/help/quit @@ -0,0 +1,21 @@ + +%9Syntax:%9 + +QUIT %|[<message>] + +%9Parameters:%9 + + The message to advertise. + +%9Description:%9 + + Terminates the application and advertises the given message on all the + networks you are connected to. + +%9Examples:%9 + + /QUIT + /QUIT <@cartman> Screw you guys, I'm going home! + +%9See also:%9 DISCONNECT + diff --git a/docs/help/quote b/docs/help/quote new file mode 100644 index 0000000..918ac7c --- /dev/null +++ b/docs/help/quote @@ -0,0 +1,20 @@ + +%9Syntax:%9 + +QUOTE %|<data> + +%9Parameters:%9 + + The text to send to the IRC server. + +%9Description:%9 + + Sends raw data to the server without any parsing. + +%9Examples:%9 + + /QUOTE PRIVMSG mike :Hey, this works! + /QUOTE OPERWALL :Meow! + +%9See also:%9 CONNECT, DISCONNECT, JOIN, MSG, PART + diff --git a/docs/help/rawlog b/docs/help/rawlog new file mode 100644 index 0000000..ef3dac5 --- /dev/null +++ b/docs/help/rawlog @@ -0,0 +1,28 @@ + +%9Syntax:%9 + +RAWLOG SAVE %|<file> +RAWLOG OPEN %|<file> +RAWLOG CLOSE + +%9Parameters:%9 + + SAVE: Saves the raw server buffer into a file. + OPEN: Opens a log file and start logging all raw data. + CLOSE: Closes the log file + + The filename to store the raw data into. + +%9Description:%9 + + Saves all the raw data that is received from and transmitted to the active + server into a log file. + +%9Examples:%9 + + /RAWLOG SAVE ~/server.log + /RAWLOG OPEN ~/debug.log + /RAWLOG CLOSE + +%9See also:%9 LOG + diff --git a/docs/help/recode b/docs/help/recode new file mode 100644 index 0000000..c55c142 --- /dev/null +++ b/docs/help/recode @@ -0,0 +1,41 @@ + +%9Syntax:%9 + +RECODE%| +RECODE ADD %|[[<tag>/]<target>] <charset> +RECODE REMOVE %|[<target>] + +%9Parameters:%9 + + ADD: Adds an entry into the conversion database. + REMOVE: Removes an entry from the conversion database. + + The network tag and channel or nickname to add or remove; if no target is + given, the active nickname or channel will be used. + +%9Description:%9 + + Recodes the data transmitted to and received from nicknames and channels + into a specific charset. + + To get a list of supported charsets on your system, you can generally use + the 'iconv -l' command. + +%9Examples:%9 + + /RECODE + /RECODE ADD liberachat/mike utf-8 + /RECODE ADD #korea euc-kr + /RECODE REMOVE #korea + +%9Special Examples:%9 + + /SET term_charset utf-8 + /SET recode_fallback ISO-8859-15 + /SET recode_out_default_charset ISO-8859-15 + + /TOGGLE recode_transliterate + /TOGGLE recode_autodetect_utf8 + +%9See also:%9 CONNECT, MSG, NETWORK, SERVER + diff --git a/docs/help/reconnect b/docs/help/reconnect new file mode 100644 index 0000000..9d9f738 --- /dev/null +++ b/docs/help/reconnect @@ -0,0 +1,22 @@ + +%9Syntax:%9 + +RECONNECT %|<tag> [<quit message>] + +%9Parameters:%9 + + The network tag and message to advertise; if no arguments are given, the + active server and default message will be used. + +%9Description:%9 + + Disconnect and reconnect from a network. + +%9Examples:%9 + + /RECONNECT + /RECONNECT liberachat + /RECONNECT EFnet BRB :) + +%9See also:%9 CONNECT, DISCONNECT, NETWORK, RMRECONNS, SERVER + diff --git a/docs/help/rehash b/docs/help/rehash new file mode 100644 index 0000000..5803203 --- /dev/null +++ b/docs/help/rehash @@ -0,0 +1,21 @@ + +%9Syntax:%9 + +REHASH %|[<option>] + +%9Parameters:%9 + + The raw parameters to send to the server, if no arguments are given, none + will be sent to the server. + +%9Description:%9 + + Reloads the configuration of the IRC server you are are connected to; this + command is restricted to IRC operators. + +%9Examples:%9 + + /REHASH + +%9See also:%9 DIE, KILL, OPER + diff --git a/docs/help/reload b/docs/help/reload new file mode 100644 index 0000000..dd8815c --- /dev/null +++ b/docs/help/reload @@ -0,0 +1,21 @@ + +%9Syntax:%9 + +RELOAD %|[<file>] + +%9Parameters:%9 + + The filename of any Irssi configuration; if no parameter is given, the + active configuration file will be used. + +%9Description:%9 + + Reloads the Irssi configuration file. + +%9Examples:%9 + + /RELOAD + /RELOAD ~/test.irssi.conf + +%9See also:%9 SAVE + diff --git a/docs/help/restart b/docs/help/restart new file mode 100644 index 0000000..4fac06a --- /dev/null +++ b/docs/help/restart @@ -0,0 +1,16 @@ + +%9Syntax:%9 + +RESTART + +%9Description:%9 + + Restarts the active IRC server; this command is restricted to IRC + administrators. + +%9Examples:%9 + + /RESTART + +%9See also:%9 DIE, KILL, OPER, REHASH + diff --git a/docs/help/rmreconns b/docs/help/rmreconns new file mode 100644 index 0000000..6d0974c --- /dev/null +++ b/docs/help/rmreconns @@ -0,0 +1,15 @@ + +%9Syntax:%9 + +RMRECONNS + +%9Description:%9 + + Removes all active and pending reconnections. + +%9Examples:%9 + + /RMRECONNS + +%9See also:%9 CONNECT, DISCONNECT, NETWORK, SERVER + diff --git a/docs/help/rmrejoins b/docs/help/rmrejoins new file mode 100644 index 0000000..b82e458 --- /dev/null +++ b/docs/help/rmrejoins @@ -0,0 +1,14 @@ + +%9Syntax:%9 + + +%9Description:%9 + + Removes all active and pending join requests. + +%9Examples:%9 + + /RMREJOINS + +%9See also:%9 JOIN, PART + diff --git a/docs/help/save b/docs/help/save new file mode 100644 index 0000000..b22c4d1 --- /dev/null +++ b/docs/help/save @@ -0,0 +1,24 @@ + +%9Syntax:%9 + +SAVE %|[<file>] + +%9Parameters:%9 + + -formats: Saves all the formats into the theme file. + + The file to save the configuration or theme into; if no parameter is given, + the active configuration or theme file will be used. + +%9Description:%9 + + Saves the configuration file. + +%9Examples:%9 + + /SAVE + /SAVE -formats + /SAVE ~/.irssi/config-new + +%9See also:%9 RELOAD, SET + diff --git a/docs/help/sconnect b/docs/help/sconnect new file mode 100644 index 0000000..12c46c4 --- /dev/null +++ b/docs/help/sconnect @@ -0,0 +1,25 @@ + +%9Syntax:%9 + +SCONNECT %|<new server> [[<port>] <existing server>] + +%9Parameters:%9 + + The server to connect to, the connection port and the remote server that + initiates the connection attempt. + + If no remote server is given, the server you are currently connected to will + be used. + +%9Description:%9 + + Connect a server to the IRC network; this command is restricted to IRC + operators. + +%9Examples:%9 + + /SCONNECT ircsource.irssi.org + /SCONNECT ircsource.irssi.org 6667 be.hub + +%9See also:%9 DIE, KILL, OPER, RESTART, SQUIT + diff --git a/docs/help/script b/docs/help/script new file mode 100644 index 0000000..1c562df --- /dev/null +++ b/docs/help/script @@ -0,0 +1,33 @@ + +%9Syntax:%9 + + +%9Parameters:%9 + + LIST: Displays the list of loaded scripts. + EXEC: Executes the given code. + LOAD: Loads the given script into the memory and executes it. + UNLOAD: Unloads the given script from the memory. + RESET: Unloads all the scripts. + -permanent: In combination with EXEC, the code will be loaded into the + memory. + -autorun: When passed to RESET the scripts in the autorun folder are + reloaded. + + If no argument is given, the list of active scripts will be displayed. + +%9Description:%9 + + Interact with the Perl engine to execute scripts. + +%9Examples:%9 + + /SCRIPT + /SCRIPT LIST + /SCRIPT LOAD ~/.irssi/scripts/nickserv.pl + /SCRIPT UNLOAD nickserv + /SCRIPT RESET + /SCRIPT EXEC foreach my $channel (Irssi::channels()) { Irssi::print($channel->{name} . ' @ ' . $channel->{server}->{tag}); } + +%9See also:%9 LOAD, SAVE, UNLOAD + diff --git a/docs/help/scrollback b/docs/help/scrollback new file mode 100644 index 0000000..daf6332 --- /dev/null +++ b/docs/help/scrollback @@ -0,0 +1,42 @@ + +%9Syntax:%9 + +SCROLLBACK CLEAR %|[-all] [<refnum>] +SCROLLBACK LEVELCLEAR %|[-all] [-level <level>] [<refnum>] +SCROLLBACK GOTO %|<+|-linecount>|<linenum>|<timestamp> +SCROLLBACK HOME%| +SCROLLBACK END%| +SCROLLBACK REDRAW + +%9Parameters:%9 + + CLEAR: Clears the screen and the buffer of all text. + LEVELCLEAR: Clears the screen and the buffer of text matching the given + levels. + GOTO: Go to the given position. + HOME: Go to the start of the buffer. + END: Go to the end of the buffer. + + -all: Applies to all windows instead of only the active one. + -level: The levels, separated by a comma, to match. + + The line number, timestamp to jump to or the window reference number to + clear. + +%9Description:%9 + + Manipulate the text in the window to go to a to the given line number, or + clear the buffers. + + The timestamp format is format is '[dd[.mm] | -<days ago>] hh:mi[:ss]'. + +%9Examples:%9 + + /SCROLLBACK CLEAR + /SCROLLBACK LEVELCLEAR -level NOTICES + /SCROLLBACK GOTO 100 + /SCROLLBACK HOME + /SCROLLBACK END + +%9See also:%9 CLEAR, WINDOW + diff --git a/docs/help/server b/docs/help/server new file mode 100644 index 0000000..4a9e5ae --- /dev/null +++ b/docs/help/server @@ -0,0 +1,82 @@ + +%9Syntax:%9 + +SERVER CONNECT %|[-4 | -6] [-tls | -notls] [-tls_cert <cert>] [-tls_pkey <pkey>] [-tls_pass <password>] [-tls_verify | -notls_verify] [-tls_cafile <cafile>] [-tls_capath <capath>] [-tls_ciphers <list>] [-tls_pinned_cert <fingerprint>] [-tls_pinned_pubkey <fingerprint>] [-!] [-noautosendcmd] [-nocap] [-noproxy] [-network <network>] [-host <hostname>] [-rawlog <file>] [+]<address>|<chatnet> [<port> [<password> [<nick>]]] +SERVER REMOVE %|<address> [<port>] [<network>] +SERVER ADD%||MODIFY [-4 | -6] [-cap | -nocap] [-tls_cert <cert>] [-tls_pkey <pkey>] [-tls_pass <password>] [-tls_verify] [-tls_cafile <cafile>] [-tls_capath <capath>] [-tls_ciphers <list>] [-tls | -notls] [-starttls | -nostarttls | -disallow_starttls | -nodisallow_starttls] [-auto | -noauto] [-network <network>] [-host <hostname>] [-cmdspeed <ms>] [-cmdmax <count>] [-port <port>] <address> [<port> [<password>]] +SERVER LIST%| +SERVER PURGE %|[<target>] + +%9Parameters:%9 + + LIST: Displays the list of servers you have configured. + CONNECT: Connects to the given server. + ADD: Adds a server to your configuration. + MODIFY: Modifies a server in your configuration. + REMOVE: Removes a server from your configuration. + PURGE: Purges the commands queued to be sent to the server. + + -!: Doesn't autojoin the channels. + -4: Connects using IPv4. + -6: Connects using IPv6. + -tls: Connects using TLS encryption. + -notls: Connect without TLS encrption. + -tls_cert: The TLS client certificate file. + -tls_pkey: The TLS client private key, if not included in the + certificate file. + -tls_pass: The password for the TLS client private key or certificate. + -tls_verify: Verifies the TLS certificate of the server. + -notls_verify: Doesn't verify the TLS certificate of the server. + -tls_cafile: The file with the list of CA certificates. + -tls_capath: The directory which contains the CA certificates. + -tls_ciphers: TLS cipher suite preference lists. + -tls_pinned_cert: Pinned x509 certificate fingerprint. + -tls_pinned_pubkey: Pinned public key fingerprint. + -auto: Automatically connects to the server on startup. + -noauto: Doesn't connect to the server on startup. + -cap: Enable CAPREQ for server. + -nocap: Disable CAPREQ for server. + -network: The network the server belongs to. + -host: The hostname you would like to connect from. + -cmdspeed: Specifies the minimum amount of time, expressed in + milliseconds, that the client must wait before sending + additional commands to the server. + -cmdmax: Specifies the maximum number of commands to perform + before starting the internal flood protection. + -port: Specifies the port to connect to the server. + -noproxy: Ignores the global proxy configuration. + -rawlog: Immediately open rawlog after connecting. + -noautosendcmd: Doesn't execute autosendcmd. + + The server, port and network to add, modify or remove; if no argument is + given, the list of servers you are connected to will be returned. + +%9Description:%9 + + Displays, adds, modifies or removes the network configuration of IRC + servers. + + When using the ADD parameter on a server that already exists, the + configuration will be merged with each other. + + When using the CONNECT parameter, it will connect to the specified + server; the server in the active window will be disconnected + unless you prepend the server with the '+' character. + + Specify '-' as password to remove a server password + +%9Examples:%9 + + /SERVER + /SERVER CONNECT irc.libera.chat + /SERVER CONNECT +irc.libera.chat + /SERVER ADD -network liberachat -noautosendcmd irc.libera.chat + /SERVER ADD -! -auto -host staff.irssi.org -4 -network liberachat -noproxy irc.libera.chat 6667 + /SERVER MODIFY -network liberachat -noauto irc.libera.chat + /SERVER MODIFY -network liberachat irc.libera.chat 6697 - + /SERVER REMOVE irc.libera.chat 6667 liberachat + /SERVER PURGE + /SERVER PURGE irc.libera.chat + +%9See also:%9 CHANNEL, CONNECT, DISCONNECT, NETWORK, RECONNECT, RMRECONNS + diff --git a/docs/help/servlist b/docs/help/servlist new file mode 100644 index 0000000..a02d229 --- /dev/null +++ b/docs/help/servlist @@ -0,0 +1,23 @@ + +%9Syntax:%9 + +SERVLIST %|[<mask> [<type>]] + +%9Parameters:%9 + + <mask> limits the output to the services which names matches + the mask. + <type> limits the output to the services of the specified type. + +%9Description:%9 + + List the network services currently present on the + IRC network. + +%9Examples:%9 + + /SERVLIST *@javairc.* + /SERVLIST * 0xD000 + +%9See also:%9 SQUERY + diff --git a/docs/help/set b/docs/help/set new file mode 100644 index 0000000..cd0ca51 --- /dev/null +++ b/docs/help/set @@ -0,0 +1,35 @@ + +%9Syntax:%9 + +SET %|[-clear | -default | -section] [<key> [<value>]] + +%9Parameters:%9 + + -clear: Removes the setting's value from the configuration. + -default: Restore the setting to its default value. + -section: Print settings under the specified section + + The setting and the value; if no value is given, the list of settings that + matched will be returned. If no arguments are given, all the settings will + be displayed. + +%9Description:%9 + + Modifies the value of a setting; boolean settings accept only ON, OFF and + TOGGLE. + + Please remember that you need to use the SAVE command to store the changes + into your configuration. + +%9Examples:%9 + + /SET + /SET nick mike + /SET -clear nick + /SET log_timestamp %%H:%%H:%%S + /SET -default log_timestamp + /SET -section lookandfeel + /SET close + +%9See also:%9 SAVE, TOGGLE + diff --git a/docs/help/silence b/docs/help/silence new file mode 100644 index 0000000..bdacb06 --- /dev/null +++ b/docs/help/silence @@ -0,0 +1,30 @@ + +%9Syntax:%9 + +SILENCE %|[[+|-]<nick!user@host>] +SILENCE %|[<nick>] + +%9Parameters:%9 + + The nickname or hostname to silence; you must prepend it by the '+' or '-' + character to indicate whether the entry should be added or removed. + + If no arguments are given, the list of silence entries will be displayed. + +%9Description:%9 + + Manages the server side ignore list; users or hostnames that match an entry + on the list are not able to send you any messages or invites. + + This command does not work on all IRC networks. + +%9Examples:%9 + + /SILENCE + /SILENCE +mike + /SILENCE -mike + /SILENCE +*!*@*.irssi.org + /SILENCE -*!*@*.irssi.org + +%9See also:%9 ACCEPT, IGNORE + diff --git a/docs/help/squery b/docs/help/squery new file mode 100644 index 0000000..bb5498e --- /dev/null +++ b/docs/help/squery @@ -0,0 +1,16 @@ + +%9Syntax:%9 + +SQUERY %|<service> [<message>] + +%9Parameters:%9 + + <service> - Service nickname or full hostmask of service to query. + <message> - Message to send to the service. + +%9Description:%9 + + /SQUERY sends a query to the specified service. + +%9See also:%9 SERVLIST, LIST, MSG + diff --git a/docs/help/squit b/docs/help/squit new file mode 100644 index 0000000..d414ee3 --- /dev/null +++ b/docs/help/squit @@ -0,0 +1,20 @@ + +%9Syntax:%9 + +SQUIT %|<server>|<mask> <reason> + +%9Parameters:%9 + + The server and the disconnect reason. + +%9Description:%9 + + Disconnects a server from the IRC network; this command is restricted to + IRC operators. + +%9Examples:%9 + + /SQUIT ircsource.irssi.org I'm fixing a desync! + +%9See also:%9 DIE, OPER, SCONNECT + diff --git a/docs/help/stats b/docs/help/stats new file mode 100644 index 0000000..027bb3a --- /dev/null +++ b/docs/help/stats @@ -0,0 +1,43 @@ + +%9Syntax:%9 + +STATS %|<type> [<server>] + +%9Parameters:%9 + + The statistic identifier and the remote server; if no remote server is + given, the active server will be used. + +%9Description:%9 + + Displays statistics from the IRC server; some statistics require you to have + IRC operators privileges and might differ between IRC networks. + + Common statistics: + + C: Displays the servers the server may connect to. + H: Displays hub server the server may connect to. + K: Displays the permanent blacklist of hostnames which are prohibited + from connecting to the server. + k: Displays the temporary blacklist of hostname which are prohibited + from connecting to the server. + I: Displays the list of hostnames which are allowed to connect to the + server. + L: Displays the list of connected users and servers. + M: Displays the list of commands and how many times they have been + issued. + O: Displays the list of hostnames and users which are allowed to + become IRC operators. + P: Displays the ports the server is listening on. + p: Displays the IRC operators and their idle time. + u: Displays the uptime of the server. + Y: Displays the list of connection groups users are placed into. + ?: Displays information about the utilized bandwidth. + +%9Examples:%9 + + /STATS p + /STATS I ircsource.irssi.org + +%9See also:%9 MOTD, OPER + diff --git a/docs/help/statusbar b/docs/help/statusbar new file mode 100644 index 0000000..8a4711b --- /dev/null +++ b/docs/help/statusbar @@ -0,0 +1,69 @@ + +%9Syntax:%9 + +STATUSBAR ADD%||MODIFY [-disable | -nodisable] [-type window|root] [-placement top|bottom] [-position #] [-visible always|active|inactive] <statusbar> +STATUSBAR RESET %|<statusbar> +STATUSBAR ADDITEM%||MODIFYITEM [-before | -after <item>] [-priority #] [-alignment left|right] <item> <statusbar> +STATUSBAR REMOVEITEM %|<item> <statusbar> +STATUSBAR INFO %|<statusbar> + +%9Parameters:%9 + + ADD: Adds a statusbar to the list of statusbars. + MODIFY: Modifies the configuration of a statusbar. + RESET: Restores the default statusbar configuration. + ADDITEM: Adds an item to the specified statusbar. It can be set to + appear before/after another item and left/right aligned + on the screen. + MODIFYITEM: Changes an item position inside a bar. + REMOVEITEM: Removes an item from the specified statusbar. + INFO: List the current details and items of the specified + statusbar. + + -disable: Removes a statusbar from the list. + -type: Sets the type of statusbar, for each split window or only + once at the root (very top or bottom) of the screen. + -placement: Sets the placement of the statusbar, either at the top or + the bottom of the screen or split window. + -position: Sets the position of the statusbar. Represented as a + number, with smaller numbers implying a position further + to the top. + -visible: Sets the visibility of the statusbar. If set to always, + it is visible on all split windows, otherwise if set to + inactive or active then it is only visible on inactive or + active split windows, respectively. + -before: This item is added before the other item. + -after: This item is added after the other item. + -priority: When the statusbar items overflow, the item with the + lowest priority is removed or truncated first. + Priority can be negative, in which case it'll have to be + quoted (e.g. -priority "-1") + -alignment: Display the item on the right side. + + Where statusbar refers to the name of the statusbar; if no + argument is given, or `LIST` is given, the entire list of + statusbars along with a quick overview of their properties will be + displayed. + +%9Description:%9 + + Allows adjustment of the attributes and items of a statusbar, as well + as where it is located and whether or not it is currently visible. + +%9Examples:%9 + + /STATUSBAR + /STATUSBAR INFO window + /STATUSBAR REMOVEITEM time window + /STATUSBAR ADDITEM time window + /STATUSBAR RESET window + /STATUSBAR MODIFY -disable topic + /STATUSBAR MODIFY -nodisable topic + +%9Remarks:%9 + + Statusbar syntax was changed in Irssi 1.2. The old syntax is still + accepted for backward compatibility, but no longer documented. + +%9See also:%9 WINDOW + diff --git a/docs/help/time b/docs/help/time new file mode 100644 index 0000000..25c488b --- /dev/null +++ b/docs/help/time @@ -0,0 +1,23 @@ + +%9Syntax:%9 + +TIME %|[<server>|<nick>] + +%9Parameters:%9 + + The channel or the nickname; if no argument is given, the active server + will be used. + +%9Description:%9 + + Displays the local time of a server or the server the target user is + connected to. + +%9Examples:%9 + + /TIME + /TIME mike + /TIME ircsource.irssi.org + +%9See also:%9 MAP, TRACE, WHOIS + diff --git a/docs/help/toggle b/docs/help/toggle new file mode 100644 index 0000000..e6a1e3a --- /dev/null +++ b/docs/help/toggle @@ -0,0 +1,22 @@ + +%9Syntax:%9 + +TOGGLE %|<key> [on|off|toggle] + +%9Parameters:%9 + + The setting to modify and the new value; if no value is given, its opposite + will be used. + +%9Description:%9 + + Modifies a setting to its counter value; you can also give ON or OFF as a + value. + +%9Examples:%9 + + /TOGGLE resolve_prefer_ipv6 + /TOGGLE channels_rejoin_unavailable ON + +%9See also:%9 SET + diff --git a/docs/help/topic b/docs/help/topic new file mode 100644 index 0000000..a75933e --- /dev/null +++ b/docs/help/topic @@ -0,0 +1,25 @@ + +%9Syntax:%9 + +TOPIC %|[-delete] [<channel>] [<topic>] + +%9Parameters:%9 + + -delete: Removes the topic. + + The channel and topic; if no channel is given, the active channel will be + used. If no argument is given, the current topic will be displayed. + +%9Description:%9 + + Displays or modifies the topic of a channel. + +%9Examples:%9 + + /TOPIC + /TOPIC The robots are taking over! + /TOPIC -delete #irssi + /TOPIC #shakespeare /bb|[^b]{2}/ + +%9See also:%9 CHANNEL, DEOP, DEVOICE, JOIN, OP, VOICE + diff --git a/docs/help/trace b/docs/help/trace new file mode 100644 index 0000000..c4f42fa --- /dev/null +++ b/docs/help/trace @@ -0,0 +1,25 @@ + +%9Syntax:%9 + +TRACE %|[<server>|<nick>] + +%9Parameters:%9 + + The channel or the nickname; if no argument is given, the active server + will be used. + +%9Description:%9 + + Displays the list of servers and users connects to a server, or a list of + the servers between yourself and the target user. + + This command is usually restricted to IRC operators. + +%9Examples:%9 + + /TRACE + /TRACE mike + /TRACE ircsource.irssi.org + +%9See also:%9 MAP, TIME, WHOIS + diff --git a/docs/help/ts b/docs/help/ts new file mode 100644 index 0000000..80ca17c --- /dev/null +++ b/docs/help/ts @@ -0,0 +1,15 @@ + +%9Syntax:%9 + +TS + +%9Description:%9 + + Displays a list of the channels you are on and their topics. + +%9Examples:%9 + + /TS + +%9See also:%9 JOIN, TOPIC + diff --git a/docs/help/unalias b/docs/help/unalias new file mode 100644 index 0000000..f2dde72 --- /dev/null +++ b/docs/help/unalias @@ -0,0 +1,20 @@ + +%9Syntax:%9 + +UNALIAS %|<alias> + +%9Parameters:%9 + + The name of the alias. + +%9Description:%9 + + Removes an alias. + +%9Examples:%9 + + /UNALIAS BAN + /UNALIAS K + +%9See also:%9 ALIAS + diff --git a/docs/help/unban b/docs/help/unban new file mode 100644 index 0000000..19abff1 --- /dev/null +++ b/docs/help/unban @@ -0,0 +1,45 @@ + +%9Syntax:%9 + +UNBAN %|-first | -last | <id> | <masks> + +%9Parameters:%9 + + -normal: Uses the *!*user@*.domain.tld format. + -user: Uses the *!*user@* format. + -host: Uses the *!*@host.domain.tld format. + -domain: Uses the *!*@*.domain.tld format. + -custom: Uses the custom format. + -first: Removes the first ban from the list. + -last: Removes the last ban from the list. + + A channel and the nicknames, hostnames or ban identifier to unban; if no + channel is given, the active channel will be used. + + If no ban format parameter is given, the value of the ban_type setting will + be used to generate the hostmask to ban. + +%9Description:%9 + + Removes one or more bans from a channel. + +%9Configuring the custom format:%9 + + You must set the custom ban_type to the format you would like to use. For + example, if you set the custom ban_type to 'nick domain', it will generate + a ban based on the nick!*@*.domain.tld format. + +%9Examples:%9 + + /UNBAN mike + /UNBAN -host bob + /UNBAN *!*@*.irssi.org + /UNBAN *!*@*.users.irssi.org *!*@*.staff.irssi.org + /UNBAN -first + /UNBAN 5 + + /SET ban_type custom nick domain + /SET ban_type custom user host + +%9See also:%9 BAN, DEOP, KICKBAN, KNOCKOUT, OP + diff --git a/docs/help/unignore b/docs/help/unignore new file mode 100644 index 0000000..070900e --- /dev/null +++ b/docs/help/unignore @@ -0,0 +1,20 @@ + +%9Syntax:%9 + +UNIGNORE %|<id>|<mask> + +%9Parameters:%9 + + The ignore identifier or pattern to remove. + +%9Description:%9 + + Removes an entry from the ignore list. + +%9Examples:%9 + + /UNIGNORE 5 + /UNIGNORE mike + +%9See also:%9 ACCEPT, IGNORE, SILENCE + diff --git a/docs/help/unload b/docs/help/unload new file mode 100644 index 0000000..fc1aaee --- /dev/null +++ b/docs/help/unload @@ -0,0 +1,19 @@ + +%9Syntax:%9 + +UNLOAD %|<module> [<submodule>] + +%9Parameters:%9 + + The name of the module to unload. + +%9Description:%9 + + Removes a module from the memory. + +%9Examples:%9 + + /UNLOAD fish + +%9See also:%9 LOAD, SCRIPT + diff --git a/docs/help/unnotify b/docs/help/unnotify new file mode 100644 index 0000000..6df266c --- /dev/null +++ b/docs/help/unnotify @@ -0,0 +1,20 @@ + +%9Syntax:%9 + +UNNOTIFY %|<mask> + +%9Parameters:%9 + + The notify pattern to remove. + +%9Description:%9 + + Removes an entry from the notify list. + +%9Examples:%9 + + /UNNOTIFY bob + /UNNOTIFY *!*@staff.irssi.org + +%9See also:%9 AWAY, HILIGHT, NOTIFY + diff --git a/docs/help/unquery b/docs/help/unquery new file mode 100644 index 0000000..8bb0483 --- /dev/null +++ b/docs/help/unquery @@ -0,0 +1,21 @@ + +%9Syntax:%9 + +UNQUERY %|[<nick>] + +%9Parameters:%9 + + The nickname to close the query for; if no argument is given, the active + query will be used. + +%9Description:%9 + + Closes a query window for a nickname. + +%9Examples:%9 + + /UNQUERY + /UNQUERY mike + +%9See also:%9 MSG, QUERY, WINDOW + diff --git a/docs/help/unsilence b/docs/help/unsilence new file mode 100644 index 0000000..f8e2252 --- /dev/null +++ b/docs/help/unsilence @@ -0,0 +1,21 @@ + +%9Syntax:%9 + +UNSILENCE %|<nick!user@host> + +%9Parameters:%9 + + The silence pattern to remove. + +%9Description:%9 + + Removes an entry from the silence list. This command does not work on all + IRC networks. + +%9Examples:%9 + + /UNSILENCE mike + /UNSILENCE *!*@*.irssi.org + +%9See also:%9 ACCEPT, IGNORE, SILENCE + diff --git a/docs/help/upgrade b/docs/help/upgrade new file mode 100644 index 0000000..b113af5 --- /dev/null +++ b/docs/help/upgrade @@ -0,0 +1,22 @@ + +%9Syntax:%9 + +UPGRADE %|[<irssi binary path>] + +%9Parameters:%9 + + The location of the new binary; if no arguments are given, the current + binary file will be used. + +%9Description:%9 + + Upgrades to a new version without disconnecting from non-SSL servers; please + bear in mind that it does not download or compile a new version. + +%9Examples:%9 + + /UPGRADE + /UPGRADE /home/mike/irssi-dev/bin/irssi + +%9See also:%9 CONNECT, DISCONNECT, HELP + diff --git a/docs/help/uptime b/docs/help/uptime new file mode 100644 index 0000000..3e62767 --- /dev/null +++ b/docs/help/uptime @@ -0,0 +1,15 @@ + +%9Syntax:%9 + +UPTIME + +%9Description:%9 + + Displays how long Irssi has been running. + +%9Examples:%9 + + /UPTIME + +%9See also:%9 CONNECT, EXIT + diff --git a/docs/help/userhost b/docs/help/userhost new file mode 100644 index 0000000..7c7e914 --- /dev/null +++ b/docs/help/userhost @@ -0,0 +1,22 @@ + +%9Syntax:%9 + +USERHOST %|<nicks> + +%9Parameters:%9 + + One or more nicknames separated by space. + +%9Description:%9 + + Displays the user@host for the given nicknames; some common added attributes + are '*' to identify an IRC operator, '-' and '+' to indicate whether the + nickname is AWAY or available. + +%9Examples:%9 + + /USERHOST mike + /USERHOST bob sarah + +%9See also:%9 WHOIS + diff --git a/docs/help/ver b/docs/help/ver new file mode 100644 index 0000000..8464dfb --- /dev/null +++ b/docs/help/ver @@ -0,0 +1,22 @@ + +%9Syntax:%9 + +VER %|[<nick> | <channel> | *] + +%9Parameters:%9 + + A nickname, channel or the wildcard character '*'. + +%9Description:%9 + + Send a CTCP VERION request to the target nickname, channel or to all the + users on the channel. + +%9Examples:%9 + + /VER * + /VER #irssi + /VER mike + +%9See also:%9 CTCP + diff --git a/docs/help/version b/docs/help/version new file mode 100644 index 0000000..7e67385 --- /dev/null +++ b/docs/help/version @@ -0,0 +1,23 @@ + +%9Syntax:%9 + +VERSION%| +VERSION %|[<server>|<nick>] + +%9Parameters:%9 + + A nickname or server; if no argument is given, the active server will be + used. + +%9Description:%9 + + Displays the version and compatibility parameters of the given server, or + for the server the target nickname is on. + +%9Examples:%9 + + /VERSION mike + /VERSION ircsource.irssi.org + +%9See also:%9 ADMIN, STATS + diff --git a/docs/help/voice b/docs/help/voice new file mode 100644 index 0000000..481686e --- /dev/null +++ b/docs/help/voice @@ -0,0 +1,23 @@ + +%9Syntax:%9 + +VOICE %|<nicks> + +%9Parameters:%9 + + A list of nicknames to voice. + +%9Description:%9 + + Grants the channel voice privileges to the given nicknames; you may use + the wildcard character '*' in a nickname. + +%9Examples:%9 + + /VOICE mike + /VOICE bob sarah + /VOICE jo*n + /VOICE * + +%9See also:%9 DEOP, DEVOICE, KICK, MODE, OP + diff --git a/docs/help/wait b/docs/help/wait new file mode 100644 index 0000000..a19db97 --- /dev/null +++ b/docs/help/wait @@ -0,0 +1,21 @@ + +%9Syntax:%9 + +WAIT %|[-<server tag>] <milliseconds> + +%9Parameters:%9 + + The amount of milliseconds. + +%9Description:%9 + + Waits the specified amount of milliseconds before sending the next command + to the server. + +%9Examples:%9 + + /WAIT 1000 + /WAIT 5000 + +%9See also:%9 ALIAS + diff --git a/docs/help/wall b/docs/help/wall new file mode 100644 index 0000000..f1f2da1 --- /dev/null +++ b/docs/help/wall @@ -0,0 +1,23 @@ + +%9Syntax:%9 + +WALL %|[<channel>] <message> + +%9Parameters:%9 + + The channel and the message; if no channel is given, the active channel + will be used. + +%9Description:%9 + + Sends a message to all channel operators. If the server doesn't support + WALLCHOPS or STATUSMSG it will send a notice to each channel operator + individually. + +%9Examples:%9 + + /WALL I'm off for today; take care! :) + /WALL #irssi I'm feeling supercalifragilisticexpialidocious today :D + +%9See also:%9 MSG, NOTICE + diff --git a/docs/help/wallops b/docs/help/wallops new file mode 100644 index 0000000..b9c8752 --- /dev/null +++ b/docs/help/wallops @@ -0,0 +1,20 @@ + +%9Syntax:%9 + +WALLOPS %|<message> + +%9Parameters:%9 + + The message to broadcast. + +%9Description:%9 + + Sends a network wide message to all the users which have the usermode 'w' + enabled; this command is restricted to IRC operators. + +%9Examples:%9 + + /WALLOPS Hi everybody! + +%9See also:%9 OPER, STATS + diff --git a/docs/help/who b/docs/help/who new file mode 100644 index 0000000..0b0b412 --- /dev/null +++ b/docs/help/who @@ -0,0 +1,36 @@ + +%9Syntax:%9 + +WHO %|[<nicks> | <channels> | **] + +%9Parameters:%9 + + The channel name or output filter; if no arguments are given, the current + channel will be used. + +%9Description:%9 + + Displays information about users in the specified channel. If you specify a + filter, all the users whose nick, userhost or realname matches the filter + will be returned. + + If the channel is secret and you are not on it, you will not receive any + output. + + Common flags: + + H: The user is available. + G: The user is away. + *: The user is an IRC operator. + @: The user is a channel operator. + +: The user is a channel voice. + +%9Examples:%9 + + /WHO + /WHO #irssi + /WHO bob + /WHO sar* + +%9See also:%9 CHANNEL, NAMES, WHOIS + diff --git a/docs/help/whois b/docs/help/whois new file mode 100644 index 0000000..40bbaa3 --- /dev/null +++ b/docs/help/whois @@ -0,0 +1,30 @@ + +%9Syntax:%9 + +WHOIS %|[-<server tag>] [<server>] [<nicks>] + +%9Parameters:%9 + + -<server tag>: The server tag the target nickname is on. + + The remote server to query and the nicknames; if no remote server is given, + the server you are connected to will be used. If no nickname is given, you + will query yourself. + +%9Description:%9 + + Displays information about users in the specified channel; you may give the + same nickname as the argument twice to also query the idle time. + + If the nickname is not online, the WHOWAS command will be automatically + performed. + +%9Examples:%9 + + /WHOIS + /WHOIS mike + /WHOIS ircsource.irssi.org bob + /WHOIS sarah sarah + +%9See also:%9 CHANNEL, NAMES, WHO, WHOWAS + diff --git a/docs/help/whowas b/docs/help/whowas new file mode 100644 index 0000000..0fbc545 --- /dev/null +++ b/docs/help/whowas @@ -0,0 +1,24 @@ + +%9Syntax:%9 + +WHOWAS %|[<nicks> [<count> [server]]] + +%9Parameters:%9 + + The nicknames, the maximum amount of results and the remote server. If no + arguments are given, your own nickname will be used. If no remote server is + given, the server you are connected to will be used. + +%9Description:%9 + + Displays historical user information. + +%9Examples:%9 + + /WHOWAS + /WHOWAS mike + /WHOWAS bob 10 + /WHOWAS sarah 5 ircsource.irssi.org + +%9See also:%9 CHANNEL, NAMES, WHO, WHOIS + diff --git a/docs/help/window b/docs/help/window new file mode 100644 index 0000000..424be94 --- /dev/null +++ b/docs/help/window @@ -0,0 +1,119 @@ + +%9Syntax:%9 + +WINDOW LOG %|on|off|toggle [<filename>] +WINDOW LOGFILE %|<file> +WINDOW NEW %|[HIDDEN|SPLIT|-right SPLIT] +WINDOW CLOSE %|[<first> [<last>]] +WINDOW REFNUM %|<number> +WINDOW GOTO %|active|<number>|<name> +WINDOW NEXT%| +WINDOW LAST%| +WINDOW PREVIOUS%| +WINDOW LEVEL %|[<levels>] +WINDOW IMMORTAL %|on|off|toggle +WINDOW SERVER %|[-sticky | -unsticky] <tag> +WINDOW ITEM PREV%| +WINDOW ITEM NEXT%| +WINDOW ITEM GOTO %|<number>|<name> +WINDOW ITEM MOVE %|<number>|<name> +WINDOW NUMBER %|[-sticky] <number> +WINDOW NAME %|<name> +WINDOW HISTORY %|[-clear] <name> +WINDOW MOVE PREV%| +WINDOW MOVE NEXT%| +WINDOW MOVE FIRST%| +WINDOW MOVE LAST%| +WINDOW MOVE %|<number>|<direction> +WINDOW LIST%| +WINDOW THEME %|[-delete] [<name>] +WINDOW HIDE %|[<number>|<name>] +WINDOW SHOW %|[-right] <number>|<name> +WINDOW GROW %|[-right] [<lines>|<columns>] +WINDOW SHRINK %|[-right] [<lines>|<columns>] +WINDOW SIZE %|[-right] <lines>|<columns> +WINDOW BALANCE %|[-right] +WINDOW UP %|[-directional] +WINDOW DOWN %|[-directional] +WINDOW LEFT %|[-directional] +WINDOW RIGHT %|[-directional] +WINDOW STICK %|[<ref#>] [ON|OFF] +WINDOW MOVE LEFT %|[-directional] +WINDOW MOVE RIGHT %|[-directional] +WINDOW MOVE UP %|[-directional] +WINDOW MOVE DOWN %|[-directional] +WINDOW HIDELEVEL %|[<levels>] + +%9Parameters:%9 + + LOG: %|Turn on or off logging of the active window, optionally specifying the log file to use. + LOGFILE: %|Sets the location of the log file to use for window logging without starting to log. + NEW: %|Creates a new hidden or split window. + CLOSE: %|Closes the current window, the specified one or all windows in the given range. + REFNUM: %|Go to the window with the given number. + GOTO: %|Go to the window with activity, with the given nickname, channel or with the specified number. + NEXT: %|Go to the next window numerically. + LAST: %|Go to the previously active window. + PREVIOUS: %|Go to the previous window numerically. + LEVEL: %|Changes the text levels to display in the window, or query the current level. + IMMORTAL: %|Modifies or queries the window mortality status. Immortal windows have an extra protection against WINDOW CLOSE. + SERVER: %|Change the active server of the window or the server stickyness. If the server is sticky, it cannot be cycled with next_window_item/previous_window_item + ITEM PREV: %|Make the previous item in this window active. + ITEM NEXT: %|Make the next item in this window active. + ITEM GOTO: %|Change to the query with the specified nickname, channel with the given name or window item number. + ITEM MOVE: %|Move the active window item to another window, or move the channel or query item specified by their name to the current window. + NUMBER: %|Change the active window number to the specified number, swapping the window already in that place if required. With -sticky, protect the window number from renumbering done by windows_auto_renumber. (To re-set the sticky attribute, use WINDOW NUMBER again without -sticky.) + NAME: %|Change or clear the window name. Window names must be unique. + HISTORY: %|Set or clear a specific named history to use for this window. All windows with the same named history will share a history. + MOVE PREV: %|Move the window to the place of the numerically previous window. At the first position, move the window to the end and renumber the consecutive block that it was part of. + MOVE NEXT: %|Move the window to the place of the numerically next window. At the last position, move the window to the first position and renumber the consecutive block at first position (if any) + MOVE FIRST: %|Move the window to the first position. Any windows inbetween are moved to their numerically next positions. + MOVE LAST: %|Move the window to the last position. Any windows inbetween are moved to their numerically previous positions. + MOVE: %|Move the window to the specified number or the first number that is in use when moving the window in the direction of the specified position. Any windows inbetween are shifted towards the old position of the window (unused positions remain empty) + LIST: %|List all the windows. + THEME: %|Applies or removes a per-window theme. + GROW: %|Increase the size of the active split window by the specified number of lines. + SHRINK: %|Decrease the size of the active split window by the specified number of lines. + SIZE: %|Set the current split window size to the specified number of lines. + BALANCE: %|Balance the heights of all split windows. + HIDE: %|Hides the current split window, or the split window specified by number or item name. + SHOW: %|Show the window specified by number or item name as a new split windows. It is made sticky when autostick_split_windows is turned on. + UP: %|Set the split window left or above the current one active. At the top, wraps to the bottom. + DOWN: %|Set the split window right or below the current one active. At the bottom, wraps left. + LEFT: %|Go to the previous window numerically that is part of the current sticky group (or not part of any sticky group). + RIGHT: %|Go to the next window numerically that is part of the current sticky group (or not part of any sticky group). + STICK: %|Make the currently active window sticky, or stick the window specified by number to the currently visible split window. Or turn off stickyness of the currently active window or the window specified by number. + HIDELEVEL: %|Changes the levels of text lines that should be hidden from view, or query the current hidden level. + MOVE LEFT: %|Move the window to the numerically previous location inside the current sticky group. + MOVE RIGHT: %|Move the window to the numerically next location inside the current sticky group. + MOVE UP: %|Move the current window to the sticky group of the previous split window. If no sticky group remains, the split window collapses. + MOVE DOWN: %|Move the current window to the sticky group of the next split window. If no sticky group remains, the split window collapses. + + -right: %|Makes the command work on the width instead of height, or create the split window to the right instead of top. + -directional: %|Set the split window in the given direction to the current one active, or move the current window to the sticky group of the split window in the given direction. (If no sticky group remains, the split window collapses.) + + %|Add the required arguments for the given command. Without arguments, the details (size, immortality, levels, server, name and sticky group) of the currently active window are displayed. If used with a number as argument, same as WINDOW REFNUM. + + %|LEVEL and HIDELEVEL modify the currently set level. Without arguments, the current level is displayed. Levels listed starting with `+' are added to the current levels. Levels listed starting with `-' are removed from the current levels. To clear the levels, start the new level setting with `NONE'. Levels listed starting with `^' are either removed or added from the current setting, depending on whether they were previously set or not (since Irssi 1.4.4). Levels listed as is are also added to the current levels. Afterwards, the new level setting is displayed. + +%9Description:%9 + + Manipulates the window layout and positioning attributes. + +%9Examples:%9 + + /WINDOW CLOSE + /WINDOW ITEM MOVE 10 + /WINDOW GOTO 15 + /WINDOW GOTO ACTIVE + /WINDOW GOTO mike + /WINDOW GOTO #irssi + /WINDOW NEW HIDDEN + /WINDOW LOG OFF + /WINDOW LOG ON ~/logs/debug.log + /WINDOW LEVEL -ALL +NOTICES + /WINDOW HIDELEVEL ^JOINS ^PARTS ^QUITS + /WINDOW LOGFILE ~/logs/notices.log + +%9See also:%9 JOIN, LEVELS, LOG, QUERY + |