diff options
121 files changed, 6137 insertions, 5 deletions
@@ -1 +1,2 @@ _site +.jekyll-metadata diff --git a/_includes/relnews.markdown b/_includes/relnews.markdown index 899cb65..2d70afb 100644 --- a/_includes/relnews.markdown +++ b/_includes/relnews.markdown @@ -257,10 +257,10 @@ The Irssi team released this <abbr class="timeago" title="2017-01-03">2017-01-03 - Fix potential crash if scripts insert undef values into the completion list ([#413](https://github.com/irssi/irssi/issues/413)). - Paste warning is now also shown on pasting overlong lines. By Manish Goregaokar ([#426](https://github.com/irssi/irssi/issues/426)). - autolog_ignore_targets and activity_hide_targets learn a new syntax - tag/** and ** to ignore whole networks or everything. By Jari Matilainen (vague666, [#437](https://github.com/irssi/irssi/issues/437)) + tag/* and * to ignore whole networks or everything. By Jari Matilainen (vague666, [#437](https://github.com/irssi/irssi/issues/437)) - /hilight got a -matchcase flag to hilight case sensitively. By Thibault B (isundil, [#421](https://github.com/irssi/irssi/issues/421), [#476](https://github.com/irssi/irssi/issues/476)). - Always build irssi with TLS support. -- Rename SSL to TLS in the code and add -tls_** versions of the -ssl_** options to /CONNECT and /SERVER, but make sure the -ssl_* options continue to work. +- Rename SSL to TLS in the code and add -tls_* versions of the -ssl_* options to /CONNECT and /SERVER, but make sure the -ssl_* options continue to work. - Use TLS for Freenode, EFnet, EsperNet, OFTC, Rizon, and IRC6 in the default configuration. - Display TLS connection information upon connect. You can disable this by setting tls_verbose_connect to FALSE. - Add -tls_pinned_cert and -tls_pinned_pubkey for x509 and public key pinning. @@ -1117,7 +1117,7 @@ Timo Sirainen released this <abbr class="timeago" title="2001-03-04">2001-03-04< - /LASTLOG: added -case option for case-sensitive matching. -force option is now required to print lastlogs longer than 1000 lines. - /BANTYPE -> /SET ban_type. /BAN: -type option added to override default ban type. -- /NAMES: -ops -halfops -voices -normal options added. /NAMES without parameters now prints nicklist in active channel, /NAMES **** shows all nicks in all channels. +- /NAMES: -ops -halfops -voices -normal options added. /NAMES without parameters now prints nicklist in active channel, /NAMES ** shows all nicks in all channels. - delete_next_word key implemented, patch by Tinuk - /SET beep_when_window_active - works with /SET beep_msg_level, should we beep when the msg is printed to active window. If msg is printed to some other window it always beeps. - /JOIN #channel and /QUERY nick won't anymore automatically move channel/query to active window but send a notice to user how to move it. This was confusing people who did it accidentally. diff --git a/_tools/help2md.pl b/_tools/help2md.pl new file mode 100644 index 0000000..1b36fe9 --- /dev/null +++ b/_tools/help2md.pl @@ -0,0 +1,320 @@ +use strict; +use warnings; + +my @categories = ( + ['Connection' => [qr/fe-irc-server/, qr/fe-ircnet/, qr/core\/servers/, qr/core\/chat-commands/, qr/fe-server/, qr/rawlog/], [qw[MSG FOREACH]] ], + ['Core Commands' => [qr/core\/chat-commands/, qr/fe-channels/, qr/fe-queries/] ], + ['Window Commands' => [qr/textbuffer-commands/, qr/mainwindows/, qr/window-commands/, qr/lastlog/] ], + ['Settings' => [qr/fe-settings/, qr/themes/, qr/keyboard/, qr/statusbar-config/, qr/session/, qr/fe-recode/, qr/window-commands/, qr/completion/, qr/hilight-text/, qr/fe-ignore/, qr/fe-log/], [qw[FOREACH]] ], + ['Misc' => [qr/fe-modules/, qr/fe-help/, qr/fe-exec/, qr/fe-core-commands/, qr/core\/commands/] ], + ['IRC Commands' => [qr/irc-commands/, qr/fe-netsplit/, qr/dcc/, qr/notify-commands/, qr/irc\/core/] ], + ['IRC Proxy' => [qr/irc\/proxy/] ], + ['Other pages'] + ); + +sub _to_ic { + my ($cc, $cg, $type, $on) = @_; + my $col = @$cg >= 3 ? $cg->[$type] : + @$cg == 2 && $type > 0 ? $cg->[$type - 1] : + @$cg == 1 && $type == 1 ? $cg->[0] : + ''; + my $str = ''; + if ($col =~ s/[*]//) { + $str .= "B"; + } + if ($col =~ s/[_]//) { + $str .= "U"; + } + if (length $col) { + if ($on) { + push @$cc, $col; + } + else { + pop @$cc; + $col = @$cc ? $cc->[-1] : ''; + } + $str .= "$col"; + } + if ($on) { + "<span class=\"syn$str\">" + } + else { + "</span>" + } +} + +sub _html { + $_[0] =~ s/</</gr +} + +sub _add_syn_colors { + my $text = shift; + my $cc = pop // []; + my $cgroup = shift // []; + my @next_level = @_; + $text =~ s{ + (,?\s*|\|) | + (< .*? >) | + ((?<!^) [[] (?: [^][]++ | (?R) )* []]) | + ([^][\s,|><]+) + }{ +# defined $1 ? _popcol($cc, $1) : + defined $1 ? $1 : + length $2 ? _to_ic($cc,$cgroup,1,1)._html($2)._to_ic($cc,$cgroup,1,0) : + length $3 ? _to_ic($cc,$cgroup,2,1)._add_syn_colors($3, @next_level, [@$cc])._to_ic($cc,$cgroup,2,0) : + length $4 ? _to_ic($cc,$cgroup,0,1)._html($4)._to_ic($cc,$cgroup,0,0) : "" + }gexr; +} + +sub finish_table { + my ($out, $state) = @_; + if ($state->{WORD}) { + #$PARAM_WORD =~ s/</</g; + push @{$state->{table}}, "| $state->{WORD} | @{$state->{INFO}} |\n"; + } elsif (@{$state->{table}||[]}) { + print $out @{$state->{table}}, "{:.table.kv}\n\n"; + @{$state->{table}} = (); + } + $state->{WORD} = ''; + $state->{INFO} = []; +} + +sub main { + my $dir = shift; + my $out = shift; + unless ($dir && $out) { + die "syntax: $0 <path> <outpath>\n"; + } + + system("cd \Q$dir\E; perl utils/syntax.pl"); + + chomp (my @files = `find \Q$dir\E/docs/help -type f`); + @files = grep !/Makefile/, @files; + + s{^\Q$dir\E/docs/help(?:/|$)}{} for @files; + + @files = grep !m{^in(?:/|$)}, @files; + @files = grep /./, @files; + + unless (@files) { + die "No help found in $dir/docs/help\n"; + } + + chomp(my @syntaxes = `cd \Q$dir\E; find . -name \*.c -exec grep -Hn SYNTAX {} +`); + my %cmd; + for my $l (@syntaxes) { + my @fields = split ":", $l; + my @command = split " ", $fields[3]; + my $srcfile = $fields[0]; + $srcfile =~ s/^\.\///; + $cmd{ $command[0] }{ $srcfile } = 1; + } + + @files = sort @files; + + system("mkdir -p \Q$out\E/documentation/help"); + open my $index, '>', "$out/documentation/help/index.markdown"; + print $index '--- +layout: page +title: Help +--- + +These are the `/help` pages of the Irssi on-line help. + +<div markdown="1" class="helpindex"> + +'; + + my %table_state; + for (@files) { + print $index "* [$_]($_)\n"; + open my $syn, '>', "$out/documentation/help/$_.markdown"; + print $syn qq'--- +layout: page +title: "Help: $_" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/$_.in +'; + if ($cmd{"\U$_"}) { + for (sort keys %{$cmd{"\U$_"}}) { + print $syn "- https://github.com/irssi/irssi/blob/master/$_\n"; + } + } + print $syn qq' + +{% endcomment %} +[Help index](/documentation/help) +'; + open my $sin, '<', "$dir/docs/help/$_"; + chomp (my @tx = <$sin>); + my @otx = @tx; + my $in = 'syn'; + for (@tx) { + if (/^%9Syntax:/) { + $in = 'syn'; + } + elsif (/^%9Parameters:/) { + $in = 'param'; + } + elsif (/^%9References:/) { + finish_table($syn, \%table_state); + $in = 'refs'; + } + elsif (/^%9/) { + finish_table($syn, \%table_state); + $in = ''; + } + s/^%9(.*):%9$/### $1 ###/; + if (/^%9(See also):%9 (.*)$/i) { + my $res = "### $1 ### +"; + my @see_also = split " ", $2; + s/,$// for @see_also; + for (@see_also) { + $_ = "[$_](/documentation/help/\L$_\E)"; + } + $_ = $res . join ", ", @see_also; + } + s/^ ([[:alpha:]] ?[[:lower:]].*)$/$1/ || + s/^ ([* ] [[:alpha:]] ?[[:lower:]].*)$/$1/; + + my $cmdlen = -1 + index $_, '%|'; + if ($in eq 'syn' && (s/%\|// || /^[[:upper:]]+$/)) { + $_ = qq'<div class="highlight irssisyntax"><pre style="--cmdlen:${cmdlen}ch"><code>'._add_syn_colors($_, ["*", "*05", "10"], ["09", "14"], ["*", "13", "13"], ["14"], []) . "</code></pre></div>\n\n"; + } + elsif ($in eq 'param' + || /^ .............? / + || /^ .. /) { + if (/^\s{8}\s+(\S.*)$/) { + # continuation + $_ = $1; + s/%\|//; + } + elsif (/^\s+\S/) { + my ($word, $rest); + if (-1 != index $_, '%|') { + ($word, $rest) = split /%\|/, $_, 2; + } + elsif (-1 != index $_, ':') { + ($word, $rest) = split /:/, $_, 2; + $word .= ':'; + } + elsif (/^\s+(\S+)\s{2,}(.*)$/) { + ($word, $rest) = ($1, $2); + } + elsif (/^\s+(-?<[^>]+>)\s+(.*)$/) { + ($word, $rest) = ($1, $2); + } else { + finish_table($syn, \%table_state); + } + if ($word) { + $word =~ s/^\s+//; + $word =~ s/\s+$//; + } + if ($word) { + $word = "`$word`"; + $word =~ s/:`/`:/; + $_ = $rest; + finish_table($syn, \%table_state); + $table_state{WORD} = $word; + } + else { + finish_table($syn, \%table_state); + s/%\|//; + } + } + else { + finish_table($syn, \%table_state); + } + } + else { + finish_table($syn, \%table_state); + s/</</g; + } + + unless (/^ {4}/ && $in ne 'param') { + # disable markdown smartypants on command line flags + s/(?:\W|^)\K-(-\w+)/\\-\\$1/g; + + # disable markdown floats on alternations + s/(\[[^]]+\])/$1 =~ s:\|:\\|:gr/ge + unless $in eq 'syn'; + s/(\w)\|(\w)/$1\\|$2/g; + #s/>\|</>\\|</g + # if $in eq 'syn'; + + # disable markdown italics on host masks + s/\*([!@].*?)\*/\\*$1\\*/g; + + # disable markdown __ bold + s/__/\\_\\_/g; + s/``((?:[^`']|`[^`]|'[^'])*)''/``$1``/g; + s/`([^`']*)'/`$1`/g; + + # simple bold -> markdown bold + s/(?<!\\)\*(\S.*?)(?<!\\)\*/**$1**/g; + + } + + if ($in eq 'refs') { + s{(\w+://\S+)}{[$1]($1)}g; + $_ .= "\n"; + } + + # irssi escapes + s/%%/%/g; + + if ($table_state{WORD}) { + # delay printing to finish_table() + push @{$table_state{INFO}}, $_; + } + else { + print $syn "$_\n"; + } + } + #print $syn "```\n",(join "\n", @otx),"\n```\n"; + } + my %seen; + for my $cat (@categories) { + print $index qq' + +### $cat->[0] + +<div markdown="1" class="helpindex"> + +'; + + for (@files) { + my $cmd = "\U$_"; + my $srcf = $cmd{$cmd}; + if ($cat->[2] && grep { $cmd eq $_ } @{$cat->[2]}) { + next; + } + my $found; + if ($cat->[1]) { + for my $sea (@{$cat->[1]}) { + $found = grep { $_ =~ $sea } keys %$srcf; + last if $found; + } + } + else { + $found = !$seen{$_}; + } + next unless $found; + $seen{$_} = 1; + print $index "* [$_]($_)\n"; + } + print $index ' + +</div> +'; + } +} + +main(@ARGV); + +#print "$_\n" for @files; diff --git a/_tools/news2md.pl b/_tools/news2md.pl index 4028b80..3b2622d 100644 --- a/_tools/news2md.pl +++ b/_tools/news2md.pl @@ -260,7 +260,7 @@ sub finish_S { s/`([^`']*)'/`$1`/g for @lines; # simple bold -> markdown bold - s/(?<!\\)\*(.*?)(?<!\\)\*/**$1**/g for @lines; + s/(?<!\\)\*(\S.*?)(?<!\\)\*/**$1**/g for @lines; # stop mentions if ($ENV{GITHUB}) { diff --git a/assets/css/style.css b/assets/css/style.css index d06e271..9d49512 100644 --- a/assets/css/style.css +++ b/assets/css/style.css @@ -400,6 +400,7 @@ blockquote { .container.wrc > div > ol, .container.wrc > div > p, .container.wrc > div > ul, +.container.wrc > div > .table, .container.wrc > dl, .container.wrc > ol, .container.wrc > p, @@ -418,6 +419,7 @@ blockquote { } .container.wrc > div > .wide, +.container.wrc > div > .table.wide, .container.wrc > .wide { max-width: 100%; } @@ -537,3 +539,69 @@ div.toprule { padding-right: 15px; margin-top: 4px; } + +.syn { color: #2e3440; /* body color */ } +.synB { font-weight: bold; } +.synB05 { font-weight: bold; color: #bf616a; } +.syn13 { color: #b48ead; } +.syn14 { color: #4c566a; } +.syn10 { color: #3e6766; } +.syn09 { color: #719453; } + +.helpindex { + width: 100%; +} +.helpindex > ul { + column-gap: 3; +} +.helpindex > ul > li { + display: inline-block; + padding: 5px 15px; + min-width: 10em; + width: auto; +} + +div.irssisyntax { + --cmdlen: 0ch; +} +div.irssisyntax pre { + word-break: inherit; + word-wrap: inherit; + padding-left: 9.5px; + padding-left: calc(9.5px + 1ch + var(--cmdlen)); + text-indent: calc(0px - 1ch - var(--cmdlen)); +} + +table.kv > tbody > tr > td:first-child { + white-space: nowrap; +} +@media (min-width: 384px) { + .helpindex > ul { + column-count: 2; + } +} +@media (min-width: 480px) { + .helpindex > ul { + column-count: 3; + } +} +@media (min-width: 640px) { + .helpindex > ul { + column-count: 4; + } +} +@media (min-width: 768px) { + .helpindex > ul { + column-count: 5; + } +} +@media (min-width: 992px) { + .helpindex > ul { + column-count: 6; + } +} +@media (min-width: 1200px) { + .helpindex > ul { + column-count: 7; + } +} diff --git a/documentation/help/accept.markdown b/documentation/help/accept.markdown new file mode 100644 index 0000000..0b4bde8 --- /dev/null +++ b/documentation/help/accept.markdown @@ -0,0 +1,47 @@ +--- +layout: page +title: "Help: accept" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/accept.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:6ch"><code><span class="synB">ACCEPT</span> <span class="syn10">[<span class="syn14">[<span class="synB">-</span>]</span><span class="syn">nick</span>,<span class="syn">...</span>]</span></code></pre></div> + + + +### Parameters ### + +A comma-separated list of nicknames to add or remove; if no argument is +given, your accept list will be displayed. + +### Description ### + +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. + +### Examples ### + + /ACCEPT mike,bob,-john,-sarah + /ACCEPT sarah,-bob + +### See also ### +[IGNORE](/documentation/help/ignore), [SILENCE](/documentation/help/silence) + diff --git a/documentation/help/action.markdown b/documentation/help/action.markdown new file mode 100644 index 0000000..0da874b --- /dev/null +++ b/documentation/help/action.markdown @@ -0,0 +1,42 @@ +--- +layout: page +title: "Help: action" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/action.in +- https://github.com/irssi/irssi/blob/master/src/fe-common/irc/fe-irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:6ch"><code><span class="synB">ACTION</span> <span class="syn10">[<span class="syn">-</span><span class="syn09"><server tag></span>]</span> <span class="synB05"><target></span> <span class="synB05"><message></span></code></pre></div> + + + +### Parameters ### + + +| `-<server tag>`: | The server tag you want to send the action emote to. | +{:.table.kv} + +A target nickname or channel and the message to emote. + +### Description ### + +Sends an action emote to a nickname or a channel. + +### Examples ### + + /ACTION #irssi is hungry! + /ACTION mike had an awesome day @ work + /ACTION -efnet #irssi is happy it's Friday + +### See also ### +[ME](/documentation/help/me) + diff --git a/documentation/help/admin.markdown b/documentation/help/admin.markdown new file mode 100644 index 0000000..3e0c9f3 --- /dev/null +++ b/documentation/help/admin.markdown @@ -0,0 +1,39 @@ +--- +layout: page +title: "Help: admin" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/admin.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:5ch"><code><span class="synB">ADMIN</span> <span class="syn10">[<span class="syn09"><server></span>|<span class="syn09"><nickname></span>]</span></code></pre></div> + + + +### Parameters ### + +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. + +### Description ### + +Displays the administrative details of a server. + +### Examples ### + + /ADMIN + /ADMIN orwell.freenode.net + /ADMIN mike + +### See also ### +[INFO](/documentation/help/info) + diff --git a/documentation/help/alias.markdown b/documentation/help/alias.markdown new file mode 100644 index 0000000..7072c81 --- /dev/null +++ b/documentation/help/alias.markdown @@ -0,0 +1,58 @@ +--- +layout: page +title: "Help: alias" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/alias.in +- https://github.com/irssi/irssi/blob/master/src/fe-common/core/fe-settings.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:5ch"><code><span class="synB">ALIAS</span> <span class="syn10">[<span class="syn14">[<span class="synB">-</span>]</span><span class="syn09"><alias></span> <span class="syn14">[<span class="syn13"><command></span>]</span>]</span></code></pre></div> + + + +### Parameters ### + +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. + +### Description ### + +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. + +### Examples ### + + /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 + +### References ### + + + +[https://github.com/irssi/irssi/blob/master/docs/special_vars.txt](https://github.com/irssi/irssi/blob/master/docs/special_vars.txt) + + + +### See also ### +[BIND](/documentation/help/bind), [UNALIAS](/documentation/help/unalias) + diff --git a/documentation/help/away.markdown b/documentation/help/away.markdown new file mode 100644 index 0000000..49160e6 --- /dev/null +++ b/documentation/help/away.markdown @@ -0,0 +1,52 @@ +--- +layout: page +title: "Help: away" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/away.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:4ch"><code><span class="synB">AWAY</span> <span class="syn10">[<span class="syn">-one</span> | <span class="syn">-all</span>]</span> <span class="syn10">[<span class="syn09"><reason></span>]</span></code></pre></div> + + + +### Parameters ### + + +| `-one`: | Marks yourself as away on the active server. | +| `-all`: | Marks yourself as away on all the servers you are connected to. | +{:.table.kv} + + Your away message; if no argument is given, your away status will be removed. + +### Description ### + +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. + +### Examples ### + + /AWAY + /AWAY I'm getting some food. + /AWAY zZzZ + /AWAY -one Feeding the cat! + +### See also ### +[DISCONNECT](/documentation/help/disconnect) + diff --git a/documentation/help/ban.markdown b/documentation/help/ban.markdown new file mode 100644 index 0000000..e70e704 --- /dev/null +++ b/documentation/help/ban.markdown @@ -0,0 +1,65 @@ +--- +layout: page +title: "Help: ban" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/ban.in +- https://github.com/irssi/irssi/blob/master/src/fe-common/irc/fe-irc-commands.c +- https://github.com/irssi/irssi/blob/master/src/irc/core/bans.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:3ch"><code><span class="synB">BAN</span> <span class="syn10">[<span class="syn09"><channel></span>]</span> <span class="syn10">[<span class="syn09"><nicks></span>]</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:3ch"><code><span class="synB">BAN</span> <span class="syn10">[<span class="syn">-normal</span> | <span class="syn">-user</span> | <span class="syn">-host</span> | <span class="syn">-domain</span> | <span class="syn">-custom</span> <span class="syn09"><type></span>]</span> <span class="synB05"><nicks/masks></span></code></pre></div> + + + +### Parameters ### + + +| `-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. | +{:.table.kv} + +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. + +### Description ### + +Adds one or more bans to a channel. + +### Configuring the custom format ### + +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. + +### Examples ### + + /BAN + /BAN mike + /BAN -host bob + /BAN *!*@*.irssi.org + /BAN -domain sarah + + /SET ban_type custom nick domain + /SET ban_type custom user host + +### See also ### +[DEOP](/documentation/help/deop), [KICKBAN](/documentation/help/kickban), [KNOCKOUT](/documentation/help/knockout), [OP](/documentation/help/op), [UNBAN](/documentation/help/unban) + diff --git a/documentation/help/beep.markdown b/documentation/help/beep.markdown new file mode 100644 index 0000000..9a6670e --- /dev/null +++ b/documentation/help/beep.markdown @@ -0,0 +1,32 @@ +--- +layout: page +title: "Help: beep" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/beep.in +- https://github.com/irssi/irssi/blob/master/src/fe-common/core/fe-core-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:-2ch"><code><span class="synB">BEEP</span></code></pre></div> + + + +### Description ### + +Outputs the bell-character, usually causing your terminal to beep. + +### Examples ### + + /BEEP + +### See also ### +[CLEAR](/documentation/help/clear) + diff --git a/documentation/help/bind.markdown b/documentation/help/bind.markdown new file mode 100644 index 0000000..ba0d6a1 --- /dev/null +++ b/documentation/help/bind.markdown @@ -0,0 +1,53 @@ +--- +layout: page +title: "Help: bind" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/bind.in +- https://github.com/irssi/irssi/blob/master/src/fe-common/core/keyboard.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:4ch"><code><span class="synB">BIND</span> <span class="syn10">[<span class="syn">-list</span>]</span> <span class="syn10">[<span class="syn">-delete</span>]</span> <span class="syn10">[<span class="syn09"><key></span> <span class="syn14">[<span class="syn13"><command></span> <span class="syn13">[<span class="syn14"><data></span>]</span>]</span>]</span></code></pre></div> + + + +### Parameters ### + + +| `-list`: | Displays a list of all the bindable commands. | +| `-delete`: | Removes the binding, | +{:.table.kv} + +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. + +### Examples ### + + /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 + +### See also ### +[ALIAS](/documentation/help/alias) + diff --git a/documentation/help/cat.markdown b/documentation/help/cat.markdown new file mode 100644 index 0000000..baf42d6 --- /dev/null +++ b/documentation/help/cat.markdown @@ -0,0 +1,38 @@ +--- +layout: page +title: "Help: cat" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/cat.in +- https://github.com/irssi/irssi/blob/master/src/fe-common/core/fe-core-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:3ch"><code><span class="synB">CAT</span> <span class="synB05"><file></span></code></pre></div> + + + +### Parameters ### + +The file to display. + +### Description ### + +Displays the contents of the specified file into the active window. + +### Examples ### + + /CAT /etc/network/interfaces + /CAT /home/mike/resume.txt + /CAT contact_details.txt + +### See also ### +[CD](/documentation/help/cd), [EXEC](/documentation/help/exec) + diff --git a/documentation/help/cd.markdown b/documentation/help/cd.markdown new file mode 100644 index 0000000..76d9a72 --- /dev/null +++ b/documentation/help/cd.markdown @@ -0,0 +1,38 @@ +--- +layout: page +title: "Help: cd" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/cd.in +- https://github.com/irssi/irssi/blob/master/src/core/commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:2ch"><code><span class="synB">CD</span> <span class="synB05"><directory></span></code></pre></div> + + + +### Parameters ### + +The directory to change into. + +### Description ### + +Changes the current active directory. + +### Examples ### + + /CD /home/public_ftp + /CD /home/mike + /CD /var/log + +### See also ### +[CAT](/documentation/help/cat) + diff --git a/documentation/help/channel.markdown b/documentation/help/channel.markdown new file mode 100644 index 0000000..f98b2f2 --- /dev/null +++ b/documentation/help/channel.markdown @@ -0,0 +1,75 @@ +--- +layout: page +title: "Help: channel" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/channel.in +- https://github.com/irssi/irssi/blob/master/src/fe-common/core/fe-channels.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:11ch"><code><span class="synB">CHANNEL</span> <span class="synB">LIST</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:10ch"><code><span class="synB">CHANNEL</span> <span class="synB">ADD</span>|<span class="synB">MODIFY</span> <span class="syn10">[<span class="syn">-auto</span> | <span class="syn">-noauto</span>]</span> <span class="syn10">[<span class="syn">-bots</span> <span class="syn09"><masks></span>]</span> <span class="syn10">[<span class="syn">-botcmd</span> <span class="syn09"><command></span>]</span> <span class="synB05"><channel></span> <span class="synB05"><network></span> <span class="syn10">[<span class="syn09"><password></span>]</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:14ch"><code><span class="synB">CHANNEL</span> <span class="synB">REMOVE</span> <span class="synB05"><channel></span> <span class="synB05"><network></span></code></pre></div> + + + +### Parameters ### + + +| `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. | +{:.table.kv} + + +| `-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. | +{:.table.kv} + +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. + +### Description ### + +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. + +### Examples ### + + /CHANNEL + /CHANNEL LIST + /CHANNEL ADD -auto #irssi Freenode + /CHANNEL ADD -auto #basementcat Quakenet secret_lair + /CHANNEL ADD -auto -bots '*!@*.irssi.org *!bot@irssi.org' -botcmd 'msg $0 op WzerTrzq' #hideout Freenode + /CHANNEL ADD -auto -bots 'Q!TheQBot@CServe.quakenet.org' -botcmd '^MSG Q op #irssi' #irssi Quakenet + /CHANNEL MODIFY -noauto #irssi Freenode + /CHANNEL REMOVE #hideout Freenode + +### Special Example ### + + /ADDALLCHANS + +### See also ### +[JOIN](/documentation/help/join), [TS](/documentation/help/ts) + diff --git a/documentation/help/clear.markdown b/documentation/help/clear.markdown new file mode 100644 index 0000000..a0beca0 --- /dev/null +++ b/documentation/help/clear.markdown @@ -0,0 +1,38 @@ +--- +layout: page +title: "Help: clear" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/clear.in +- https://github.com/irssi/irssi/blob/master/src/fe-text/textbuffer-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:5ch"><code><span class="synB">CLEAR</span> <span class="syn10">[<span class="syn">-all</span>]</span> <span class="syn10">[<span class="syn09"><refnum></span>]</span></code></pre></div> + + + +### Parameters ### + + +| `-all`: | Clear all the windows | +{:.table.kv} + +The window number to clear; if no argument is given, the active window +will be used. + +### Description ### + +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. + +### See also ### +[REDRAW](/documentation/help/redraw), [SCROLLBACK](/documentation/help/scrollback), [CLEAR](/documentation/help/clear) + diff --git a/documentation/help/completion.markdown b/documentation/help/completion.markdown new file mode 100644 index 0000000..7743b0e --- /dev/null +++ b/documentation/help/completion.markdown @@ -0,0 +1,53 @@ +--- +layout: page +title: "Help: completion" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/completion.in +- https://github.com/irssi/irssi/blob/master/src/fe-common/core/completion.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:10ch"><code><span class="synB">COMPLETION</span> <span class="syn10">[<span class="syn">-auto</span>]</span> <span class="syn10">[<span class="syn">-delete</span>]</span> <span class="synB05"><key></span> <span class="synB05"><value></span></code></pre></div> + + + +### Parameters ### + + +| `-auto`: | Inserts the completion without pressing a word completion character. | +| `-delete`: | Removes the completion from the configuration. | +{:.table.kv} + +A key and the value to use as a replacement. If no argument is given, the +list of completions will be displayed. + +### Description ### + +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. + +### Examples ### + + /COMPLETION w/h without + /COMPLETION -auto anywya anyway + /COMPLETION -delete 'anywya' + /COMPLETION -delete without + +### See also ### +[BIND](/documentation/help/bind) + diff --git a/documentation/help/connect.markdown b/documentation/help/connect.markdown new file mode 100644 index 0000000..b99d4e9 --- /dev/null +++ b/documentation/help/connect.markdown @@ -0,0 +1,62 @@ +--- +layout: page +title: "Help: connect" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/connect.in +- https://github.com/irssi/irssi/blob/master/src/core/chat-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:7ch"><code><span class="synB">CONNECT</span> <span class="syn10">[<span class="syn">-4</span> | <span class="syn">-6</span>]</span> <span class="syn10">[<span class="syn">-tls</span>]</span> <span class="syn10">[<span class="syn">-tls_cert</span> <span class="syn09"><cert></span>]</span> <span class="syn10">[<span class="syn">-tls_pkey</span> <span class="syn09"><pkey></span>]</span> <span class="syn10">[<span class="syn">-tls_pass</span> <span class="syn09"><password></span>]</span> <span class="syn10">[<span class="syn">-tls_verify</span>]</span> <span class="syn10">[<span class="syn">-tls_cafile</span> <span class="syn09"><cafile></span>]</span> <span class="syn10">[<span class="syn">-tls_capath</span> <span class="syn09"><capath></span>]</span> <span class="syn10">[<span class="syn">-tls_ciphers</span> <span class="syn09"><list></span>]</span> <span class="syn10">[<span class="syn">-tls_pinned_cert</span> <span class="syn09"><fingerprint></span>]</span> <span class="syn10">[<span class="syn">-tls_pinned_pubkey</span> <span class="syn09"><fingerprint></span>]</span> <span class="syn10">[<span class="syn">-!</span>]</span> <span class="syn10">[<span class="syn">-noautosendcmd</span>]</span> <span class="syn10">[<span class="syn">-noproxy</span>]</span> <span class="syn10">[<span class="syn">-network</span> <span class="syn09"><network></span>]</span> <span class="syn10">[<span class="syn">-host</span> <span class="syn09"><hostname></span>]</span> <span class="syn10">[<span class="syn">-rawlog</span> <span class="syn09"><file></span>]</span> <span class="synB05"><address></span>|<span class="synB05"><chatnet></span> <span class="syn10">[<span class="syn09"><port></span> <span class="syn14">[<span class="syn13"><password></span> <span class="syn13">[<span class="syn14"><nick></span>]</span>]</span>]</span></code></pre></div> + + + +### Parameters ### + + +| `-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. | +| `-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. | +{:.table.kv} + +A network or server to connect to; you can optionally specify a custom port, +password and nickname. + +### Description ### + +Opens a new connection to the specified network or server; existing +connections are kept. + +### Examples ### + + /CONNECT Freenode + /CONNECT -6 Freenode + /CONNECT -4 -! -host staff.irssi.org -network Freenode orwell.freenode.net + /CONNECT irc.irssi.org 6667 WzerT8zq mike + +### See also ### +[DISCONNECT](/documentation/help/disconnect), [RMRECONNS](/documentation/help/rmreconns), [SERVER](/documentation/help/server) + diff --git a/documentation/help/ctcp.markdown b/documentation/help/ctcp.markdown new file mode 100644 index 0000000..ddf5ff6 --- /dev/null +++ b/documentation/help/ctcp.markdown @@ -0,0 +1,40 @@ +--- +layout: page +title: "Help: ctcp" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/ctcp.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:4ch"><code><span class="synB">CTCP</span> <span class="synB05"><targets></span> <span class="synB05"><ctcp command></span> <span class="syn10">[<span class="syn09"><ctcp data></span>]</span></code></pre></div> + + + +### Parameters ### + +A target nickname or channel and a command. + +### Description ### + +Sends a CTCP request towards the given target nickname or channel. + +### Examples ### + + /CTCP mike PING + /CTCP #irssi VERSION + /CTCP bob USERINFO + /CTCP sarah CLIENTINFO + /CTCP john TIME + +### See also ### +[ACTION](/documentation/help/action), [ME](/documentation/help/me) + diff --git a/documentation/help/cycle.markdown b/documentation/help/cycle.markdown new file mode 100644 index 0000000..913276b --- /dev/null +++ b/documentation/help/cycle.markdown @@ -0,0 +1,39 @@ +--- +layout: page +title: "Help: cycle" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/cycle.in +- https://github.com/irssi/irssi/blob/master/src/fe-common/core/fe-channels.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:5ch"><code><span class="synB">CYCLE</span> <span class="syn10">[<span class="syn09"><channel></span>]</span> <span class="syn10">[<span class="syn09"><message></span>]</span></code></pre></div> + + + +### Parameters ### + +A channel and the message. If no argument is given, the active channel +will be used. + +### Description ### + +Leaves and rejoins a channel. + +### Examples ### + + /CYCLE + /CYCLE #irssi + /CYCLE #irssi BRB :) + +### See also ### +[JOIN](/documentation/help/join), [PART](/documentation/help/part) + diff --git a/documentation/help/dcc.markdown b/documentation/help/dcc.markdown new file mode 100644 index 0000000..f62f9d2 --- /dev/null +++ b/documentation/help/dcc.markdown @@ -0,0 +1,79 @@ +--- +layout: page +title: "Help: dcc" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/dcc.in +- https://github.com/irssi/irssi/blob/master/src/irc/dcc/dcc-chat.c +- https://github.com/irssi/irssi/blob/master/src/irc/dcc/dcc-get.c +- https://github.com/irssi/irssi/blob/master/src/irc/dcc/dcc-resume.c +- https://github.com/irssi/irssi/blob/master/src/irc/dcc/dcc-server.c +- https://github.com/irssi/irssi/blob/master/src/irc/dcc/dcc.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:8ch"><code><span class="synB">DCC</span> <span class="synB">CHAT</span> <span class="syn10">[<span class="syn">-passive</span>]</span> <span class="syn10">[<span class="syn09"><nick></span>]</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:7ch"><code><span class="synB">DCC</span> <span class="synB">GET</span> <span class="syn10">[<span class="syn09"><nick></span> <span class="syn14">[<span class="syn13"><file></span>]</span>]</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:10ch"><code><span class="synB">DCC</span> <span class="synB">RESUME</span> <span class="syn10">[<span class="syn09"><nick></span> <span class="syn14">[<span class="syn13"><file></span>]</span>]</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:10ch"><code><span class="synB">DCC</span> <span class="synB">SERVER</span> <span class="syn10">[<span class="syn">+</span>|<span class="syn">-scf</span>]</span> <span class="syn10">[<span class="syn">port</span>]</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:9ch"><code><span class="synB">DCC</span> <span class="synB">CLOSE</span> <span class="synB05"><type></span> <span class="synB05"><nick></span> <span class="syn10">[<span class="syn09"><file></span>]</span></code></pre></div> + + + +### Parameters ### + + +| `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. | +{:.table.kv} + + +| `-passive`: | Uses the passive DCC protocol. | +| `-scf`: | Use any combination of the flags to indicate: 's' - send 'c' - chat 'f' - fserver | +{:.table.kv} + +The nickname of the person to chat with, or the name of the file to +transfer. + +### Description ### + +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'. + +### Examples ### + + /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" + +### See also ### +[CD](/documentation/help/cd) + diff --git a/documentation/help/dehilight.markdown b/documentation/help/dehilight.markdown new file mode 100644 index 0000000..18237a8 --- /dev/null +++ b/documentation/help/dehilight.markdown @@ -0,0 +1,37 @@ +--- +layout: page +title: "Help: dehilight" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/dehilight.in +- https://github.com/irssi/irssi/blob/master/src/fe-common/core/hilight-text.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:9ch"><code><span class="synB">DEHILIGHT</span> <span class="synB05"><id></span>|<span class="synB05"><mask></span></code></pre></div> + + + +### Parameters ### + +The id or mask of the highlight to remove. + +### Description ### + +Removes the specified highlight from the configuration. + +### Examples ### + + /DEHILIGHT 1 + /DEHILIGHT 31 + +### See also ### +[HILIGHT](/documentation/help/hilight) + diff --git a/documentation/help/deop.markdown b/documentation/help/deop.markdown new file mode 100644 index 0000000..b8a6a3d --- /dev/null +++ b/documentation/help/deop.markdown @@ -0,0 +1,40 @@ +--- +layout: page +title: "Help: deop" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/deop.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/modes.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:4ch"><code><span class="synB">DEOP</span> <span class="synB05"><nicks></span></code></pre></div> + + + +### Parameters ### + +A list of nicknames to deop. + +### Description ### + +Removes the channel operator privileges from the given nicknames; you may +use the wildcard character '*' in a nickname. + +### Examples ### + + /DEOP mike + /DEOP bob sarah + /DEOP jo*n + /DEOP * + +### See also ### +[DEVOICE](/documentation/help/devoice), [MODE](/documentation/help/mode), [OP](/documentation/help/op), [VOICE](/documentation/help/voice) + diff --git a/documentation/help/devoice.markdown b/documentation/help/devoice.markdown new file mode 100644 index 0000000..a70275e --- /dev/null +++ b/documentation/help/devoice.markdown @@ -0,0 +1,43 @@ +--- +layout: page +title: "Help: devoice" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/devoice.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/modes.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:7ch"><code><span class="synB">DEVOICE</span> <span class="synB05"><nicks></span></code></pre></div> + + + +### Parameters ### + +A list of nicknames to devoice. + +### Description ### + +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. + +### Examples ### + + /DEVOICE mike + /DEVOICE bob sarah + /DEVOICE jo*n + /DEVOICE * + +### See also ### +[DEOP](/documentation/help/deop), [MODE](/documentation/help/mode), [OP](/documentation/help/op), [VOICE](/documentation/help/voice) + diff --git a/documentation/help/die.markdown b/documentation/help/die.markdown new file mode 100644 index 0000000..bb5351a --- /dev/null +++ b/documentation/help/die.markdown @@ -0,0 +1,32 @@ +--- +layout: page +title: "Help: die" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/die.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:-2ch"><code><span class="synB">DIE</span></code></pre></div> + + + +### Description ### + +Terminates the IRC server; this command is reserved for IRC operators. + +### Examples ### + + /DIE + +### See also ### +[KILL](/documentation/help/kill), [OPER](/documentation/help/oper), [WALLOPS](/documentation/help/wallops) + diff --git a/documentation/help/disconnect.markdown b/documentation/help/disconnect.markdown new file mode 100644 index 0000000..568ffed --- /dev/null +++ b/documentation/help/disconnect.markdown @@ -0,0 +1,43 @@ +--- +layout: page +title: "Help: disconnect" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/disconnect.in +- https://github.com/irssi/irssi/blob/master/src/core/chat-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:10ch"><code><span class="synB">DISCONNECT</span> <span class="synB">*</span>|<span class="synB05"><tag></span> <span class="syn10">[<span class="syn09"><message></span>]</span></code></pre></div> + + + +### Parameters ### + +The network to disconnect from and the message to advertise; if no +parameters are given, the active server will be used. + +### Description ### + +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. + +### Examples ### + + /DISCONNECT Freenode I'm off for today, take care! + /DISCONNECT * Vacation time :D + /DISCONNECT + +### See also ### +[CONNECT](/documentation/help/connect), [SERVER](/documentation/help/server) + diff --git a/documentation/help/echo.markdown b/documentation/help/echo.markdown new file mode 100644 index 0000000..5b9d048 --- /dev/null +++ b/documentation/help/echo.markdown @@ -0,0 +1,44 @@ +--- +layout: page +title: "Help: echo" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/echo.in +- https://github.com/irssi/irssi/blob/master/src/fe-common/core/fe-core-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:4ch"><code><span class="synB">ECHO</span> <span class="syn10">[<span class="syn">-current</span>]</span> <span class="syn10">[<span class="syn">-window</span> <span class="syn09"><name></span>]</span> <span class="syn10">[<span class="syn">-level</span> <span class="syn09"><level></span>]</span> <span class="synB05"><text></span></code></pre></div> + + + +### Parameters ### + + +| `-current`: | Displays the output in the active window. | +| `-window`: | Displays the output in the target window. | +| `-level`: | Displays the output with a given message level. | +{:.table.kv} + +The text output; if no target is given, the active window will be used. + +### Description ### + +Displays the given text. + +### Examples ### + + /ECHO 1 + 1 = 2 :D + /ECHO -current Testing the ECHO command + /ECHO -window #irssi Special variables such as ${N} will not be expanded. + +### See also ### +[CAT](/documentation/help/cat), [EVAL](/documentation/help/eval), [EXEC](/documentation/help/exec), [LEVELS](/documentation/help/levels) + diff --git a/documentation/help/eval.markdown b/documentation/help/eval.markdown new file mode 100644 index 0000000..79a9fa7 --- /dev/null +++ b/documentation/help/eval.markdown @@ -0,0 +1,46 @@ +--- +layout: page +title: "Help: eval" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/eval.in +- https://github.com/irssi/irssi/blob/master/src/core/commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:4ch"><code><span class="synB">EVAL</span> <span class="synB05"><command(s)></span></code></pre></div> + + + +### Parameters ### + +The commands to evaluate. + +### Description ### + +Evaluates the given commands and executes them; you can use internal +variables and separate multiple commands by using the ';' character. + +### Examples ### + + /EVAL echo I am connected to ${S} on ${chatnet} as ${N} + /EVAL echo My user privileges are +${usermode}; echo Let's party! + +### References ### + + + +[https://github.com/irssi/irssi/blob/master/docs/special_vars.txt](https://github.com/irssi/irssi/blob/master/docs/special_vars.txt) + + + +### See also ### +[CAT](/documentation/help/cat), [CD](/documentation/help/cd), [ECHO](/documentation/help/echo), [EXEC](/documentation/help/exec) + diff --git a/documentation/help/exec.markdown b/documentation/help/exec.markdown new file mode 100644 index 0000000..fa8ac4a --- /dev/null +++ b/documentation/help/exec.markdown @@ -0,0 +1,74 @@ +--- +layout: page +title: "Help: exec" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/exec.in +- https://github.com/irssi/irssi/blob/master/src/fe-common/core/fe-exec.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:4ch"><code><span class="synB">EXEC</span> <span class="syn10">[<span class="syn">-</span>]</span> <span class="syn10">[<span class="syn">-nosh</span>]</span> <span class="syn10">[<span class="syn">-out</span> | <span class="syn">-msg</span> <span class="syn09"><target></span> | <span class="syn">-notice</span> <span class="syn09"><target></span>]</span> <span class="syn10">[<span class="syn">-name</span> <span class="syn09"><name></span>]</span> <span class="synB05"><cmd line></span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:4ch"><code><span class="synB">EXEC</span> <span class="synB">-out</span> | <span class="synB">-window</span> | <span class="synB">-msg</span> <span class="synB05"><target></span> | <span class="synB">-notice</span> <span class="synB05"><target></span> | <span class="synB">-close</span> | <span class="synB">-</span><span class="synB05"><signal></span> <span class="synB">%</span><span class="synB05"><id></span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:4ch"><code><span class="synB">EXEC</span> <span class="synB">-in</span> <span class="synB">%</span><span class="synB05"><id></span> <span class="synB05"><text to send to process></span></code></pre></div> + + + +### Parameters ### + + +| `-`: | 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. | +{:.table.kv} + +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. + +### Description ### + +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. + +### Examples ### + + /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 + +### See also ### +[CAT](/documentation/help/cat), [CD](/documentation/help/cd), [ECHO](/documentation/help/echo), [EVAL](/documentation/help/eval) + diff --git a/documentation/help/flushbuffer.markdown b/documentation/help/flushbuffer.markdown new file mode 100644 index 0000000..7223fa7 --- /dev/null +++ b/documentation/help/flushbuffer.markdown @@ -0,0 +1,32 @@ +--- +layout: page +title: "Help: flushbuffer" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/flushbuffer.in + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + + +### Description ### + +Forces an immediate flush of the buffers if the related settings are +enabled. + +### Examples ### + + /FLUSHBUFFER + + /SET write_buffer_size + /SET write_buffer_timeout + +### See also ### +[REDRAW](/documentation/help/redraw), [SCROLLBACK](/documentation/help/scrollback) + diff --git a/documentation/help/format.markdown b/documentation/help/format.markdown new file mode 100644 index 0000000..bab8b30 --- /dev/null +++ b/documentation/help/format.markdown @@ -0,0 +1,44 @@ +--- +layout: page +title: "Help: format" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/format.in +- https://github.com/irssi/irssi/blob/master/src/fe-common/core/themes.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:6ch"><code><span class="synB">FORMAT</span> <span class="syn10">[<span class="syn">-delete</span> | <span class="syn">-reset</span>]</span> <span class="syn10">[<span class="syn09"><module></span>]</span> <span class="syn10">[<span class="syn09"><key></span> <span class="syn14">[<span class="syn13"><value></span>]</span>]</span></code></pre></div> + + + +### Parameters ### + + +| `-reset`: | Restores the original value. | +| `-delete`: | Removes the format from the configuration. | +{:.table.kv} + +The module name, the format name and the value; if no arguments are given, +the list of formats are displayed. + +### Description ### + +Allows you to reconfigure the way messages are displayed. + +### Examples ### + + /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 + +### See also ### +[RELOAD](/documentation/help/reload), [SAVE](/documentation/help/save), [SET](/documentation/help/set) + diff --git a/documentation/help/hash.markdown b/documentation/help/hash.markdown new file mode 100644 index 0000000..f534729 --- /dev/null +++ b/documentation/help/hash.markdown @@ -0,0 +1,44 @@ +--- +layout: page +title: "Help: hash" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/hash.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:-2ch"><code><span class="synB">HASH</span></code></pre></div> + + + +### Description ### + +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. + +### Examples ### + + /HASH + +### References ### + + + +[https://irssi.org](https://irssi.org) + +[https://github.com/irssi](https://github.com/irssi) + + + +### See also ### +[DIE](/documentation/help/die), [KILL](/documentation/help/kill), [OPER](/documentation/help/oper) + diff --git a/documentation/help/help.markdown b/documentation/help/help.markdown new file mode 100644 index 0000000..f0a11dc --- /dev/null +++ b/documentation/help/help.markdown @@ -0,0 +1,49 @@ +--- +layout: page +title: "Help: help" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/help.in +- https://github.com/irssi/irssi/blob/master/src/fe-common/core/fe-help.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:4ch"><code><span class="synB">HELP</span> <span class="syn10">[<span class="syn09"><command></span>]</span></code></pre></div> + + + +### Parameters ### + +The command to display the documentation for; if no argument is given, the +list of commands will be displayed. + +### Description ### + +Displays the documentation for the given command. + +### Examples ### + + /HELP + /HELP AWAY + /HELP CONNECT + +### References ### + + + +[https://irssi.org](https://irssi.org) + +[https://github.com/irssi](https://github.com/irssi) + + + +### See also ### +[CONNECT](/documentation/help/connect), [MSG](/documentation/help/msg), [NETWORK](/documentation/help/network), [SERVER](/documentation/help/server) + diff --git a/documentation/help/hilight.markdown b/documentation/help/hilight.markdown new file mode 100644 index 0000000..bf3217c --- /dev/null +++ b/documentation/help/hilight.markdown @@ -0,0 +1,66 @@ +--- +layout: page +title: "Help: hilight" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/hilight.in +- https://github.com/irssi/irssi/blob/master/src/fe-common/core/hilight-text.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:7ch"><code><span class="synB">HILIGHT</span> <span class="syn10">[<span class="syn">-nick</span> | <span class="syn">-word</span> | <span class="syn">-line</span>]</span> <span class="syn10">[<span class="syn">-mask</span> | <span class="syn">-full</span> | <span class="syn">-matchcase</span> | <span class="syn">-regexp</span>]</span> <span class="syn10">[<span class="syn">-color</span> <span class="syn09"><color></span>]</span> <span class="syn10">[<span class="syn">-actcolor</span> <span class="syn09"><color></span>]</span> <span class="syn10">[<span class="syn">-level</span> <span class="syn09"><level></span>]</span> <span class="syn10">[<span class="syn">-network</span> <span class="syn09"><network></span>]</span> <span class="syn10">[<span class="syn">-channels</span> <span class="syn09"><channels></span>]</span> <span class="synB05"><text></span></code></pre></div> + + + +### Parameters ### + + +| `-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 the 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. | +{:.table.kv} + +The text to highlight on; if no argument is given, the list of highlights +will be displayed. + +### Description ### + +Highlights the keyword or pattern to make sure that you don't miss any +important messages. + +### Examples ### + + /HILIGHT + /HILIGHT mike + /HILIGHT -regexp mi+ke+ + /HILIGHT -mask -color %G bob!*@*.irssi.org + /HILIGHT -full -color %G -actcolor %Y redbull + +### References ### + + + +[https://github.com/irssi/irssi/blob/master/docs/formats.txt](https://github.com/irssi/irssi/blob/master/docs/formats.txt) + + + +### See also ### +[DEHILIGHT](/documentation/help/dehilight), [LEVELS](/documentation/help/levels) + diff --git a/documentation/help/ignore.markdown b/documentation/help/ignore.markdown new file mode 100644 index 0000000..2c488b3 --- /dev/null +++ b/documentation/help/ignore.markdown @@ -0,0 +1,67 @@ +--- +layout: page +title: "Help: ignore" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/ignore.in +- https://github.com/irssi/irssi/blob/master/src/fe-common/core/fe-ignore.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:6ch"><code><span class="synB">IGNORE</span> <span class="syn10">[<span class="syn">-regexp</span> | <span class="syn">-full</span>]</span> <span class="syn10">[<span class="syn">-pattern</span> <span class="syn09"><pattern></span>]</span> <span class="syn10">[<span class="syn">-except</span>]</span> <span class="syn10">[<span class="syn">-replies</span>]</span> <span class="syn10">[<span class="syn">-network</span> <span class="syn09"><network></span>]</span> <span class="syn10">[<span class="syn">-channels</span> <span class="syn09"><channel></span>]</span> <span class="syn10">[<span class="syn">-time</span> <span class="syn09"><secs></span>]</span> <span class="synB05"><mask></span> <span class="syn10">[<span class="syn09"><levels></span>]</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:6ch"><code><span class="synB">IGNORE</span> <span class="syn10">[<span class="syn">-regexp</span> | <span class="syn">-full</span>]</span> <span class="syn10">[<span class="syn">-pattern</span> <span class="syn09"><pattern></span>]</span> <span class="syn10">[<span class="syn">-except</span>]</span> <span class="syn10">[<span class="syn">-replies</span>]</span> <span class="syn10">[<span class="syn">-network</span> <span class="syn09"><network></span>]</span> <span class="syn10">[<span class="syn">-time</span> <span class="syn09"><secs></span>]</span> <span class="synB05"><channels></span> <span class="syn10">[<span class="syn09"><levels></span>]</span></code></pre></div> + + + +### Parameters ### + + +| `-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. | +{:.table.kv} + +The mask, channels and levels to ignore; if no argument is provided, the +list of ignores will be displayed. + +### Description ### + +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. + +### Examples ### + + /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 *zzz* NICKS + /IGNORE *afk* NICKS + /IGNORE *away* NICKS + /IGNORE #irssi NO_ACT JOINS PARTS QUITS + /IGNORE mike NO_ACT -MSGS + /IGNORE -regexp -pattern + +### See also ### +[ACCEPT](/documentation/help/accept), [SILENCE](/documentation/help/silence), [UNIGNORE](/documentation/help/unignore) + diff --git a/documentation/help/index.markdown b/documentation/help/index.markdown new file mode 100644 index 0000000..55e86c2 --- /dev/null +++ b/documentation/help/index.markdown @@ -0,0 +1,317 @@ +--- +layout: page +title: Help +--- + +These are the `/help` pages of the Irssi on-line help. + +<div markdown="1" class="helpindex"> + +* [accept](accept) +* [action](action) +* [admin](admin) +* [alias](alias) +* [away](away) +* [ban](ban) +* [beep](beep) +* [bind](bind) +* [cat](cat) +* [cd](cd) +* [channel](channel) +* [clear](clear) +* [completion](completion) +* [connect](connect) +* [ctcp](ctcp) +* [cycle](cycle) +* [dcc](dcc) +* [dehilight](dehilight) +* [deop](deop) +* [devoice](devoice) +* [die](die) +* [disconnect](disconnect) +* [echo](echo) +* [eval](eval) +* [exec](exec) +* [flushbuffer](flushbuffer) +* [format](format) +* [hash](hash) +* [help](help) +* [hilight](hilight) +* [ignore](ignore) +* [info](info) +* [invite](invite) +* [irssiproxy](irssiproxy) +* [ison](ison) +* [join](join) +* [kick](kick) +* [kickban](kickban) +* [kill](kill) +* [knock](knock) +* [knockout](knockout) +* [lastlog](lastlog) +* [layout](layout) +* [levels](levels) +* [links](links) +* [list](list) +* [load](load) +* [log](log) +* [lusers](lusers) +* [map](map) +* [me](me) +* [mircdcc](mircdcc) +* [mode](mode) +* [motd](motd) +* [msg](msg) +* [names](names) +* [nctcp](nctcp) +* [netsplit](netsplit) +* [network](network) +* [nick](nick) +* [notice](notice) +* [notify](notify) +* [op](op) +* [oper](oper) +* [part](part) +* [ping](ping) +* [query](query) +* [quit](quit) +* [quote](quote) +* [rawlog](rawlog) +* [recode](recode) +* [reconnect](reconnect) +* [rehash](rehash) +* [reload](reload) +* [restart](restart) +* [rmreconns](rmreconns) +* [rmrejoins](rmrejoins) +* [save](save) +* [sconnect](sconnect) +* [script](script) +* [scrollback](scrollback) +* [server](server) +* [servlist](servlist) +* [set](set) +* [silence](silence) +* [squery](squery) +* [squit](squit) +* [stats](stats) +* [statusbar](statusbar) +* [time](time) +* [toggle](toggle) +* [topic](topic) +* [trace](trace) +* [ts](ts) +* [unalias](unalias) +* [unban](unban) +* [unignore](unignore) +* [unload](unload) +* [unnotify](unnotify) +* [unquery](unquery) +* [unsilence](unsilence) +* [upgrade](upgrade) +* [uptime](uptime) +* [userhost](userhost) +* [ver](ver) +* [version](version) +* [voice](voice) +* [wait](wait) +* [wall](wall) +* [wallops](wallops) +* [who](who) +* [whois](whois) +* [whowas](whowas) +* [window](window) + + +### Connection + +<div markdown="1" class="helpindex"> + +* [connect](connect) +* [disconnect](disconnect) +* [network](network) +* [quit](quit) +* [rawlog](rawlog) +* [reconnect](reconnect) +* [rmreconns](rmreconns) +* [server](server) + + +</div> + + +### Core Commands + +<div markdown="1" class="helpindex"> + +* [channel](channel) +* [connect](connect) +* [cycle](cycle) +* [disconnect](disconnect) +* [join](join) +* [msg](msg) +* [names](names) +* [query](query) +* [quit](quit) +* [server](server) +* [unquery](unquery) + + +</div> + + +### Window Commands + +<div markdown="1" class="helpindex"> + +* [clear](clear) +* [lastlog](lastlog) +* [layout](layout) +* [scrollback](scrollback) +* [window](window) + + +</div> + + +### Settings + +<div markdown="1" class="helpindex"> + +* [alias](alias) +* [bind](bind) +* [completion](completion) +* [dehilight](dehilight) +* [format](format) +* [hilight](hilight) +* [ignore](ignore) +* [layout](layout) +* [log](log) +* [recode](recode) +* [reload](reload) +* [save](save) +* [set](set) +* [statusbar](statusbar) +* [toggle](toggle) +* [unalias](unalias) +* [unignore](unignore) +* [upgrade](upgrade) +* [window](window) + + +</div> + + +### Misc + +<div markdown="1" class="helpindex"> + +* [beep](beep) +* [cat](cat) +* [cd](cd) +* [echo](echo) +* [eval](eval) +* [exec](exec) +* [help](help) +* [load](load) +* [unload](unload) +* [uptime](uptime) +* [version](version) + + +</div> + + +### IRC Commands + +<div markdown="1" class="helpindex"> + +* [accept](accept) +* [action](action) +* [admin](admin) +* [away](away) +* [ban](ban) +* [ctcp](ctcp) +* [dcc](dcc) +* [deop](deop) +* [devoice](devoice) +* [die](die) +* [hash](hash) +* [info](info) +* [invite](invite) +* [ison](ison) +* [kick](kick) +* [kickban](kickban) +* [kill](kill) +* [knock](knock) +* [knockout](knockout) +* [links](links) +* [list](list) +* [lusers](lusers) +* [map](map) +* [me](me) +* [mircdcc](mircdcc) +* [mode](mode) +* [motd](motd) +* [nctcp](nctcp) +* [netsplit](netsplit) +* [nick](nick) +* [notice](notice) +* [notify](notify) +* [op](op) +* [oper](oper) +* [part](part) +* [ping](ping) +* [quote](quote) +* [rehash](rehash) +* [restart](restart) +* [sconnect](sconnect) +* [server](server) +* [servlist](servlist) +* [silence](silence) +* [squery](squery) +* [squit](squit) +* [stats](stats) +* [time](time) +* [topic](topic) +* [trace](trace) +* [ts](ts) +* [unban](unban) +* [unnotify](unnotify) +* [unsilence](unsilence) +* [userhost](userhost) +* [ver](ver) +* [version](version) +* [voice](voice) +* [wait](wait) +* [wall](wall) +* [wallops](wallops) +* [who](who) +* [whois](whois) +* [whowas](whowas) + + +</div> + + +### IRC Proxy + +<div markdown="1" class="helpindex"> + +* [irssiproxy](irssiproxy) + + +</div> + + +### Other pages + +<div markdown="1" class="helpindex"> + +* [flushbuffer](flushbuffer) +* [levels](levels) +* [rmrejoins](rmrejoins) +* [script](script) + + +</div> diff --git a/documentation/help/info.markdown b/documentation/help/info.markdown new file mode 100644 index 0000000..c988509 --- /dev/null +++ b/documentation/help/info.markdown @@ -0,0 +1,38 @@ +--- +layout: page +title: "Help: info" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/info.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:4ch"><code><span class="synB">INFO</span> <span class="syn10">[<span class="syn09"><server></span>]</span></code></pre></div> + + + +### Parameters ### + +The server to display the information for; if no argument is given, the +active server will be used. + +### Description ### + +Displays information about the IRC server software. + +### Examples ### + + /INFO + /INFO orwell.freenode.net + +### See also ### +[ADMIN](/documentation/help/admin) + diff --git a/documentation/help/invite.markdown b/documentation/help/invite.markdown new file mode 100644 index 0000000..df3c542 --- /dev/null +++ b/documentation/help/invite.markdown @@ -0,0 +1,38 @@ +--- +layout: page +title: "Help: invite" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/invite.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:6ch"><code><span class="synB">INVITE</span> <span class="synB05"><nick></span> <span class="syn10">[<span class="syn09"><channel></span>]</span></code></pre></div> + + + +### Parameters ### + +The nickname to invite and the channel to invite him or her to; if no +channel is given, the active channel will be used. + +### Description ### + +Invites the specified nick to a channel. + +### Examples ### + + /INVITE mike + /INVITE bob #irssi + +### See also ### +[MODE](/documentation/help/mode), [WHOIS](/documentation/help/whois) + diff --git a/documentation/help/irssiproxy.markdown b/documentation/help/irssiproxy.markdown new file mode 100644 index 0000000..5f63b79 --- /dev/null +++ b/documentation/help/irssiproxy.markdown @@ -0,0 +1,34 @@ +--- +layout: page +title: "Help: irssiproxy" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/irssiproxy.in +- https://github.com/irssi/irssi/blob/master/src/irc/proxy/proxy.c + + +{% endcomment %} +[Help index](/documentation/help) + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:16ch"><code><span class="synB">IRSSIPROXY</span> <span class="synB">STATUS</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:-2ch"><code><span class="synB">IRSSIPROXY</span></code></pre></div> + + + +### Description ### + +Displays the list of clients connected to irssiproxy. + +### Examples ### + + /IRSSIPROXY + /IRSSIPROXY STATUS + +### See also ### +[LOAD](/documentation/help/load), [PROXY](/documentation/help/proxy), [SET](/documentation/help/set), [irssiproxy](/documentation/help/irssiproxy) + diff --git a/documentation/help/ison.markdown b/documentation/help/ison.markdown new file mode 100644 index 0000000..7b5019b --- /dev/null +++ b/documentation/help/ison.markdown @@ -0,0 +1,37 @@ +--- +layout: page +title: "Help: ison" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/ison.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:4ch"><code><span class="synB">ISON</span> <span class="synB05"><nicks></span></code></pre></div> + + + +### Parameters ### + +The nicknames, separated by space, to check. + +### Description ### + +Displays whether the specified nicknames are online. + +### Examples ### + + /ISON mike + /ISON sarah bob + +### See also ### +[NOTIFY](/documentation/help/notify), [WHOWAS](/documentation/help/whowas), [WHOIS](/documentation/help/whois) + diff --git a/documentation/help/join.markdown b/documentation/help/join.markdown new file mode 100644 index 0000000..139de70 --- /dev/null +++ b/documentation/help/join.markdown @@ -0,0 +1,45 @@ +--- +layout: page +title: "Help: join" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/join.in +- https://github.com/irssi/irssi/blob/master/src/fe-common/core/fe-channels.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:4ch"><code><span class="synB">JOIN</span> <span class="syn10">[<span class="syn">-window</span>]</span> <span class="syn10">[<span class="syn">-invite</span>]</span> <span class="syn10">[<span class="syn">-</span><span class="syn09"><server tag></span>]</span> <span class="synB05"><channels></span> <span class="syn10">[<span class="syn09"><keys></span>]</span></code></pre></div> + + + +### Parameters ### + + +| `-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. | +{:.table.kv} + +The channel names, separated by a comma, to join and the channel key. + +### Description ### + +Joins the given channels. + +### Examples ### + + /JOIN #irssi + /JOIN #basementcat secret_lair + /JOIN -invite + /JOIN -freenode #github,#freenode,#irssi + +### See also ### +[KICK](/documentation/help/kick), [PART](/documentation/help/part) + diff --git a/documentation/help/kick.markdown b/documentation/help/kick.markdown new file mode 100644 index 0000000..40741a3 --- /dev/null +++ b/documentation/help/kick.markdown @@ -0,0 +1,41 @@ +--- +layout: page +title: "Help: kick" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/kick.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:4ch"><code><span class="synB">KICK</span> <span class="syn10">[<span class="syn09"><channel></span>]</span> <span class="synB05"><nicks></span> <span class="syn10">[<span class="syn09"><reason></span>]</span></code></pre></div> + + + +### Parameters ### + +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. + +### Description ### + +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. + +### Examples ### + + /KICK mike Please... chill down! + /KICK #irssi bob,sarah Stop flooding! + +### See also ### +[BAN](/documentation/help/ban), [KICKBAN](/documentation/help/kickban), [KNOCKOUT](/documentation/help/knockout) + diff --git a/documentation/help/kickban.markdown b/documentation/help/kickban.markdown new file mode 100644 index 0000000..1da2232 --- /dev/null +++ b/documentation/help/kickban.markdown @@ -0,0 +1,39 @@ +--- +layout: page +title: "Help: kickban" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/kickban.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:7ch"><code><span class="synB">KICKBAN</span> <span class="syn10">[<span class="syn09"><channel></span>]</span> <span class="synB05"><nicks></span> <span class="synB05"><reason></span></code></pre></div> + + + +### Parameters ### + +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. + +### Description ### + +Removes and then bans the given nicknames from the specified channel. + +### Examples ### + + /KICKBAN mike Please... chill down! + /KICKBAN #irssi bob,sarah You guys broke the rules for the last time. + +### See also ### +[BAN](/documentation/help/ban), [KICK](/documentation/help/kick), [KNOCKOUT](/documentation/help/knockout) + diff --git a/documentation/help/kill.markdown b/documentation/help/kill.markdown new file mode 100644 index 0000000..52dd1e9 --- /dev/null +++ b/documentation/help/kill.markdown @@ -0,0 +1,41 @@ +--- +layout: page +title: "Help: kill" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/kill.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:4ch"><code><span class="synB">KILL</span> <span class="synB05"><nick></span> <span class="synB05"><reason></span></code></pre></div> + + + +### Parameters ### + +The nickname to remove from the network and the reason thereof. + +### Description ### + +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. + +### Examples ### + + /KILL mike Get off my lawn + /KILL bob Stop breaking the network rules! + +### See also ### +[DIE](/documentation/help/die), [OPER](/documentation/help/oper), [WALLOPS](/documentation/help/wallops) + diff --git a/documentation/help/knock.markdown b/documentation/help/knock.markdown new file mode 100644 index 0000000..b192013 --- /dev/null +++ b/documentation/help/knock.markdown @@ -0,0 +1,47 @@ +--- +layout: page +title: "Help: knock" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/knock.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:5ch"><code><span class="synB">KNOCK</span> <span class="synB05"><channel></span></code></pre></div> + + + +### Parameters ### + +The channel you wish to get invited to. + +### Description ### + +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. + +### Examples ### + + /KNOCK #irssi + /KNOCK #freenode + /KNOCK #github + +### See also ### +[INVITE](/documentation/help/invite), [JOIN](/documentation/help/join) + diff --git a/documentation/help/knockout.markdown b/documentation/help/knockout.markdown new file mode 100644 index 0000000..31d390f --- /dev/null +++ b/documentation/help/knockout.markdown @@ -0,0 +1,43 @@ +--- +layout: page +title: "Help: knockout" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/knockout.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:8ch"><code><span class="synB">KNOCKOUT</span> <span class="syn10">[<span class="syn09"><time></span>]</span> <span class="synB05"><nicks></span> <span class="synB05"><reason></span></code></pre></div> + + + +### Parameters ### + +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. + +### Description ### + +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. + +### Examples ### + + /KNOCKOUT 3600 mike Your connection is unstable. + /KNOCKOUT bob,sarah Chill down a bit. + +### See also ### +[BAN](/documentation/help/ban), [KICK](/documentation/help/kick), [KICKBAN](/documentation/help/kickban) + diff --git a/documentation/help/lastlog.markdown b/documentation/help/lastlog.markdown new file mode 100644 index 0000000..f1061e9 --- /dev/null +++ b/documentation/help/lastlog.markdown @@ -0,0 +1,62 @@ +--- +layout: page +title: "Help: lastlog" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/lastlog.in +- https://github.com/irssi/irssi/blob/master/src/fe-text/lastlog.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:7ch"><code><span class="synB">LASTLOG</span> <span class="syn10">[<span class="syn">-</span>]</span> <span class="syn10">[<span class="syn">-file</span> <span class="syn09"><filename></span>]</span> <span class="syn10">[<span class="syn">-window</span> <span class="syn09"><ref#|name></span>]</span> <span class="syn10">[<span class="syn">-new</span> | <span class="syn">-away</span>]</span> <span class="syn10">[<span class="syn">-</span><span class="syn09"><level></span> <span class="syn">-</span><span class="syn09"><level...></span>]</span> <span class="syn10">[<span class="syn">-clear</span>]</span> <span class="syn10">[<span class="syn">-count</span>]</span> <span class="syn10">[<span class="syn">-case</span>]</span> <span class="syn10">[<span class="syn">-date</span>]</span> <span class="syn10">[<span class="syn">-regexp</span> | <span class="syn">-word</span>]</span> <span class="syn10">[<span class="syn">-before</span> <span class="syn14">[<span class="syn13"><#></span>]</span>]</span> <span class="syn10">[<span class="syn">-after</span> <span class="syn14">[<span class="syn13"><#></span>]</span>]</span> <span class="syn10">[<span class="syn">-</span><span class="syn09"><# before+after></span>]</span> <span class="syn10">[<span class="syn09"><pattern></span>]</span> <span class="syn10">[<span class="syn09"><count></span> <span class="syn14">[<span class="syn13"><start></span>]</span>]</span></code></pre></div> + + + +### Parameters ### + + +| `-`: | 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. | +{:.table.kv} + +The pattern to search for and the maximum of lines to display; if no +parameter is given, the entire window buffer will be displayed. + +### Description ### + +Searches the active window for a pattern and displays the result. + +### Examples ### + + /LASTLOG holiday + /LASTLOG 'is on vacation' 10 + /LASTLOG -force -file ~/mike.log 'mike' + /LASTLOG -hilight + /LASTLOG -5 searchterm + +### See also ### +[HILIGHT](/documentation/help/hilight), [SCROLLBACK](/documentation/help/scrollback) + diff --git a/documentation/help/layout.markdown b/documentation/help/layout.markdown new file mode 100644 index 0000000..dce926e --- /dev/null +++ b/documentation/help/layout.markdown @@ -0,0 +1,48 @@ +--- +layout: page +title: "Help: layout" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/layout.in +- https://github.com/irssi/irssi/blob/master/src/fe-common/core/window-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:10ch"><code><span class="synB">LAYOUT</span> <span class="synB">SAVE</span></code></pre></div> + + +LAYOUT RESET + +### Parameters ### + + +| `SAVE`: | Saves your layout to the configuration. | +| `RESET`: | Removes the saved layout from the configuration. | +{:.table.kv} + +### Description ### + +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. + +### Examples ### + + /LAYOUT SAVE + /LAYOUT RESET + +### See also ### +[SAVE](/documentation/help/save), [WINDOW](/documentation/help/window) + diff --git a/documentation/help/levels.markdown b/documentation/help/levels.markdown new file mode 100644 index 0000000..46097d2 --- /dev/null +++ b/documentation/help/levels.markdown @@ -0,0 +1,57 @@ +--- +layout: page +title: "Help: levels" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/levels.in + + +{% endcomment %} +[Help index](/documentation/help) + +### Description ### + +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. | +{:.table.kv} + +These are the special levels you can use: + + +| `HILIGHT` | The text is highlighted. | +| `NEVER` | Never ignores or logs the message. | +| `NO_ACT` | Doesn't trigger any activity in the statusbar. | +| `NOHILIGHT` | The text is not highlighted. | +{:.table.kv} + +When using levels from Irssi scripts, you need to prepend the level with + 'MSGLEVEL_'; for example 'CRAP' becomes 'MSGLEVEL_CRAP'. + diff --git a/documentation/help/links.markdown b/documentation/help/links.markdown new file mode 100644 index 0000000..0f1adb4 --- /dev/null +++ b/documentation/help/links.markdown @@ -0,0 +1,39 @@ +--- +layout: page +title: "Help: links" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/links.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:5ch"><code><span class="synB">LINKS</span> <span class="syn10">[<span class="syn14">[<span class="syn13"><server></span>]</span> <span class="syn09"><mask></span>]</span></code></pre></div> + + + +### Parameters ### + +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. + +### Description ### + +Displays the links between an IRC server and its connections. + +### Examples ### + + /LINKS + /LINKS ircsource.irssi.org + /LINKS ircsource.irssi.org *.hub + +### See also ### +[LUSERS](/documentation/help/lusers), [MAP](/documentation/help/map) + diff --git a/documentation/help/list.markdown b/documentation/help/list.markdown new file mode 100644 index 0000000..d559f1d --- /dev/null +++ b/documentation/help/list.markdown @@ -0,0 +1,57 @@ +--- +layout: page +title: "Help: list" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/list.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:4ch"><code><span class="synB">LIST</span> <span class="syn10">[<span class="syn">-yes</span>]</span> <span class="syn10">[<span class="syn09"><channel></span>]</span></code></pre></div> + + + +### Parameters ### + + +| `-yes`: | Confirms that you want to receive a large amount of data. | +{:.table.kv} + +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. + +### Description ### + +Displays the channel names that match your request; requesting all channels +may cause the server to disconnect you for flooding. + +### Examples ### + + /LIST + /LIST -yes + /LIST #ubuntu + /LIST #*ubuntu*,>1 + +### Remarks ### + +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 + +### See also ### +[STATS](/documentation/help/stats), [SQUERY](/documentation/help/squery), [WHOIS](/documentation/help/whois) + diff --git a/documentation/help/load.markdown b/documentation/help/load.markdown new file mode 100644 index 0000000..44d3b90 --- /dev/null +++ b/documentation/help/load.markdown @@ -0,0 +1,40 @@ +--- +layout: page +title: "Help: load" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/load.in +- https://github.com/irssi/irssi/blob/master/src/fe-common/core/fe-modules.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:4ch"><code><span class="synB">LOAD</span> <span class="synB05"><module></span> <span class="syn10">[<span class="syn09"><submodule></span>]</span></code></pre></div> + + + +### Parameters ### + +The name of the module and submodule to load. + +### Description ### + +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. + +### Examples ### + + /LOAD fish + /LOAD ~/irssi-fish/libfish.so + +### See also ### +[SCRIPT](/documentation/help/script), [UNLOAD](/documentation/help/unload) + diff --git a/documentation/help/log.markdown b/documentation/help/log.markdown new file mode 100644 index 0000000..c43d3ad --- /dev/null +++ b/documentation/help/log.markdown @@ -0,0 +1,80 @@ +--- +layout: page +title: "Help: log" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/log.in +- https://github.com/irssi/irssi/blob/master/src/fe-common/core/fe-log.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:8ch"><code><span class="synB">LOG</span> <span class="synB">OPEN</span> <span class="syn10">[<span class="syn">-noopen</span>]</span> <span class="syn10">[<span class="syn">-autoopen</span>]</span> <span class="syn10">[<span class="syn">-window</span>]</span> <span class="syn10">[<span class="syn">-</span><span class="syn09"><server tag></span>]</span> <span class="syn10">[<span class="syn">-targets</span> <span class="syn09"><targets></span>]</span> <span class="syn10">[<span class="syn">-colors</span>]</span> <span class="synB05"><fname></span> <span class="syn10">[<span class="syn09"><levels></span>]</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:9ch"><code><span class="synB">LOG</span> <span class="synB">CLOSE</span> <span class="synB05"><id></span>|<span class="synB05"><file></span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:9ch"><code><span class="synB">LOG</span> <span class="synB">START</span> <span class="synB05"><id></span>|<span class="synB05"><file></span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:8ch"><code><span class="synB">LOG</span> <span class="synB">STOP</span> <span class="synB05"><id></span>|<span class="synB05"><file></span></code></pre></div> + + + +### Parameters ### + + +| `OPEN`: | Opens a log file. | +| `CLOSE`: | Closes a log file. | +| `START`: | Starts logging a log entry. | +| `STOP`: | Stops logging a log entry. | +{:.table.kv} + + +| `-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. | +{:.table.kv} + +The filename of the log and the levels to match; if no argument is given, +the list of open logs will be displayed. + +### Description ### + +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. + +### Examples ### + + /LOG OPEN -targets mike ~/irclogs/mike.log MSGS + /LOG OPEN -targets #irssi-freenode ~/irclogs/freenode/irssi-%Y-%m-%d + /LOG CLOSE ~/irclogs/freenode/irssi-%Y-%m-%d + /LOG STOP ~/irclogs/freenode/irssi-%Y-%m-%d + /LOG START ~/irclogs/freenode/irssi-%Y-%m-%d + + /SET autolog ON + +### References ### + + + +[https://github.com/irssi/irssi/blob/master/docs/formats.txt](https://github.com/irssi/irssi/blob/master/docs/formats.txt) + + + +### See also ### +[SET](/documentation/help/set), [LOG](/documentation/help/log), [WINDOW](/documentation/help/window), [LOG](/documentation/help/log) + diff --git a/documentation/help/lusers.markdown b/documentation/help/lusers.markdown new file mode 100644 index 0000000..8397b11 --- /dev/null +++ b/documentation/help/lusers.markdown @@ -0,0 +1,41 @@ +--- +layout: page +title: "Help: lusers" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/lusers.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:6ch"><code><span class="synB">LUSERS</span> <span class="syn10">[<span class="syn09"><server mask></span> <span class="syn14">[<span class="syn13"><remote server></span>]</span>]</span></code></pre></div> + + + +### Parameters ### + +The server to search on and the remote sever to search on; if no arguments +are given, the active server will be used. + +### Description ### + +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. + +### Examples ### + + /LUSERS + +### See also ### +[LINKS](/documentation/help/links), [MAP](/documentation/help/map) + diff --git a/documentation/help/map.markdown b/documentation/help/map.markdown new file mode 100644 index 0000000..e96433f --- /dev/null +++ b/documentation/help/map.markdown @@ -0,0 +1,33 @@ +--- +layout: page +title: "Help: map" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/map.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:-2ch"><code><span class="synB">MAP</span></code></pre></div> + + + +### Description ### + +Displays the network map of an IRC network; this command is usually +reserved for IRC operators and does not work on all servers. + +### Examples ### + + /MAP + +### See also ### +[DIE](/documentation/help/die), [LINKS](/documentation/help/links), [LUSERS](/documentation/help/lusers) + diff --git a/documentation/help/me.markdown b/documentation/help/me.markdown new file mode 100644 index 0000000..66d0a02 --- /dev/null +++ b/documentation/help/me.markdown @@ -0,0 +1,38 @@ +--- +layout: page +title: "Help: me" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/me.in +- https://github.com/irssi/irssi/blob/master/src/fe-common/irc/fe-irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:2ch"><code><span class="synB">ME</span> <span class="synB05"><message></span></code></pre></div> + + + +### Parameters ### + +The message to emote. + +### Description ### + +Sends an action emote to the active nickname or channel. + +### Examples ### + + /ME is hungry! + /ME had an awesome day @ work + /ME is happy it's Friday + +### See also ### +[ACTION](/documentation/help/action), [CTCP](/documentation/help/ctcp) + diff --git a/documentation/help/mircdcc.markdown b/documentation/help/mircdcc.markdown new file mode 100644 index 0000000..25e7cf8 --- /dev/null +++ b/documentation/help/mircdcc.markdown @@ -0,0 +1,47 @@ +--- +layout: page +title: "Help: mircdcc" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/mircdcc.in +- https://github.com/irssi/irssi/blob/master/src/irc/dcc/dcc-chat.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:9ch"><code><span class="synB">MIRCDCC</span> <span class="synB">ON</span>|<span class="synB">OFF</span></code></pre></div> + + + +### Parameters ### + + +| `ON`: | Enables mIRC compatibility mode. | +| `OFF`: | Disables mIRC compatibility mode. | +{:.table.kv} + +### Description ### + +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. + +### Examples ### + + /MIRCDCC ON + /MIRCDCC OFF + +### See also ### +[ACTION](/documentation/help/action), [CTCP](/documentation/help/ctcp), [DCC](/documentation/help/dcc) + diff --git a/documentation/help/mode.markdown b/documentation/help/mode.markdown new file mode 100644 index 0000000..fb40ea0 --- /dev/null +++ b/documentation/help/mode.markdown @@ -0,0 +1,79 @@ +--- +layout: page +title: "Help: mode" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/mode.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/modes.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:4ch"><code><span class="synB">MODE</span> <span class="synB05"><your nick></span>|<span class="synB05"><channel></span> <span class="syn10">[<span class="syn09"><mode></span> <span class="syn14">[<span class="syn13"><mode parameters></span>]</span>]</span></code></pre></div> + + + +### Parameters ### + +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. + +### Description ### + +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. | +{:.table.kv} + +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. | +{:.table.kv} + +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. + +### Examples ### + + /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 + +### See also ### +[BAN](/documentation/help/ban), [DEOP](/documentation/help/deop), [DEVOICE](/documentation/help/devoice), [OP](/documentation/help/op), [UNBAN](/documentation/help/unban), [VOICE](/documentation/help/voice) + diff --git a/documentation/help/motd.markdown b/documentation/help/motd.markdown new file mode 100644 index 0000000..8ccf493 --- /dev/null +++ b/documentation/help/motd.markdown @@ -0,0 +1,39 @@ +--- +layout: page +title: "Help: motd" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/motd.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:4ch"><code><span class="synB">MOTD</span> <span class="syn10">[<span class="syn09"><server></span>|<span class="syn09"><nick></span>]</span></code></pre></div> + + + +### Parameters ### + +The server or the server the target nickname is on; if no parameter is +given, the active server will be used. + +### Description ### + +Displays the welcome message of an IRC server. + +### Examples ### + + /MOTD + /MOTD orwel.freenode.org + /MOTD bob + +### See also ### +[ADMIN](/documentation/help/admin), [INFO](/documentation/help/info), [LINKS](/documentation/help/links), [MAP](/documentation/help/map) + diff --git a/documentation/help/msg.markdown b/documentation/help/msg.markdown new file mode 100644 index 0000000..807e4fb --- /dev/null +++ b/documentation/help/msg.markdown @@ -0,0 +1,47 @@ +--- +layout: page +title: "Help: msg" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/msg.in +- https://github.com/irssi/irssi/blob/master/src/core/chat-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:3ch"><code><span class="synB">MSG</span> <span class="syn10">[<span class="syn">-</span><span class="syn09"><server tag></span>]</span> <span class="syn10">[<span class="syn">-channel</span> | <span class="syn">-nick</span>]</span> <span class="synB">*</span>|<span class="synB05"><targets></span> <span class="synB05"><message></span></code></pre></div> + + + +### Parameters ### + + +| `-<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. | +{:.table.kv} + +The target nickname or channel and the message to send. + +Use the wildcard character '*' if you want to use the active nickname or +channel. + +### Description ### + +Sends a message to a nickname or channel. + +### Examples ### + + /MSG mike Hi, what's up? + /MSG #irssi I am awesome :) + /MSG * Do you want to build a snowman? + +### See also ### +[ACTION](/documentation/help/action), [DCC](/documentation/help/dcc), [JOIN](/documentation/help/join) + diff --git a/documentation/help/names.markdown b/documentation/help/names.markdown new file mode 100644 index 0000000..07bdfe7 --- /dev/null +++ b/documentation/help/names.markdown @@ -0,0 +1,46 @@ +--- +layout: page +title: "Help: names" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/names.in +- https://github.com/irssi/irssi/blob/master/src/fe-common/core/fe-channels.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:5ch"><code><span class="synB">NAMES</span> <span class="syn10">[<span class="syn">-count</span> | <span class="syn">-ops</span> <span class="syn">-halfops</span> <span class="syn">-voices</span> <span class="syn">-normal</span>]</span> <span class="syn10">[<span class="syn09"><channels></span> | <span class="syn">**</span>]</span></code></pre></div> + + + +### Parameters ### + + +| `-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. | +{:.table.kv} + +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. + +### Description ### + +Displays the users who are in a channel; you can provide multiple channels +by separating them with a comma. + +### Examples ### + + /NAMES -ops + /NAMES -voices #irssi,#freenode + +### See also ### +[JOIN](/documentation/help/join), [PART](/documentation/help/part), [WHO](/documentation/help/who), [WHOIS](/documentation/help/whois) + diff --git a/documentation/help/nctcp.markdown b/documentation/help/nctcp.markdown new file mode 100644 index 0000000..585a2c3 --- /dev/null +++ b/documentation/help/nctcp.markdown @@ -0,0 +1,38 @@ +--- +layout: page +title: "Help: nctcp" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/nctcp.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:5ch"><code><span class="synB">NCTCP</span> <span class="synB05"><targets></span> <span class="synB05"><ctcp command></span> <span class="syn10">[<span class="syn09"><ctcp data></span>]</span></code></pre></div> + + + +### Parameters ### + +A target nickname or channel, a command and the data. + +### Description ### + +Sends a CTCP reply to a nickname or channel; you can provide multiple +targets by separating them with a comma. + +### Examples ### + + /NCTCP #irssi VERSION King of the Jungle v1.0 + /NCTCP bob,#freenode USERINFO I am bob :p + +### See also ### +[CTCP](/documentation/help/ctcp) + diff --git a/documentation/help/netsplit.markdown b/documentation/help/netsplit.markdown new file mode 100644 index 0000000..fe680f7 --- /dev/null +++ b/documentation/help/netsplit.markdown @@ -0,0 +1,33 @@ +--- +layout: page +title: "Help: netsplit" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/netsplit.in +- https://github.com/irssi/irssi/blob/master/src/fe-common/irc/fe-netsplit.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:-2ch"><code><span class="synB">NETSPLIT</span></code></pre></div> + + + +### Description ### + +Displays some information about users who are currently lost in one or +more net splits. + +### Examples ### + + /NETSPLIT + +### See also ### +[JOIN](/documentation/help/join), [LINKS](/documentation/help/links), [MAP](/documentation/help/map), [PART](/documentation/help/part) + diff --git a/documentation/help/network.markdown b/documentation/help/network.markdown new file mode 100644 index 0000000..7ff8bff --- /dev/null +++ b/documentation/help/network.markdown @@ -0,0 +1,80 @@ +--- +layout: page +title: "Help: network" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/network.in +- https://github.com/irssi/irssi/blob/master/src/fe-common/irc/fe-ircnet.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:10ch"><code><span class="synB">NETWORK</span> <span class="synB">ADD</span>|<span class="synB">MODIFY</span> <span class="syn10">[<span class="syn">-nick</span> <span class="syn09"><nick></span>]</span> <span class="syn10">[<span class="syn">-alternate_nick</span> <span class="syn09"><nick></span>]</span> <span class="syn10">[<span class="syn">-user</span> <span class="syn09"><user></span>]</span> <span class="syn10">[<span class="syn">-realname</span> <span class="syn09"><name></span>]</span> <span class="syn10">[<span class="syn">-host</span> <span class="syn09"><host></span>]</span> <span class="syn10">[<span class="syn">-usermode</span> <span class="syn09"><mode></span>]</span> <span class="syn10">[<span class="syn">-autosendcmd</span> <span class="syn09"><cmd></span>]</span> <span class="syn10">[<span class="syn">-querychans</span> <span class="syn09"><count></span>]</span> <span class="syn10">[<span class="syn">-whois</span> <span class="syn09"><count></span>]</span> <span class="syn10">[<span class="syn">-msgs</span> <span class="syn09"><count></span>]</span> <span class="syn10">[<span class="syn">-kicks</span> <span class="syn09"><count></span>]</span> <span class="syn10">[<span class="syn">-modes</span> <span class="syn09"><count></span>]</span> <span class="syn10">[<span class="syn">-cmdspeed</span> <span class="syn09"><ms></span>]</span> <span class="syn10">[<span class="syn">-cmdmax</span> <span class="syn09"><count></span>]</span> <span class="syn10">[<span class="syn">-sasl_mechanism</span> <span class="syn09"><mechanism></span>]</span> <span class="syn10">[<span class="syn">-sasl_username</span> <span class="syn09"><username></span>]</span> <span class="syn10">[<span class="syn">-sasl_password</span> <span class="syn09"><password></span>]</span> <span class="synB05"><name></span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:14ch"><code><span class="synB">NETWORK</span> <span class="synB">REMOVE</span> <span class="synB05"><network></span></code></pre></div> + + + +### Parameters ### + + +| `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. | +{:.table.kv} + + +| `-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. | +| `-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. | +{:.table.kv} + + +The name of the network to add, edit or remove; if no parameter is given, +the list of networks will be displayed. + +### Description ### + +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. + +### Examples ### + + /NETWORK ADD -usermode +giw EFnet + /NETWORK ADD -usermode +iw -nick mike -realname 'The one and only mike!' -host staff.irssi.org Freenode + /NETWORK ADD -autosendcmd '^MSG NickServ identify WzerT8zq' Freenode + /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 Freenode + +### See also ### +[CHANNEL](/documentation/help/channel), [CONNECT](/documentation/help/connect), [SERVER](/documentation/help/server) + diff --git a/documentation/help/nick.markdown b/documentation/help/nick.markdown new file mode 100644 index 0000000..c5f5fe4 --- /dev/null +++ b/documentation/help/nick.markdown @@ -0,0 +1,37 @@ +--- +layout: page +title: "Help: nick" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/nick.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:4ch"><code><span class="synB">NICK</span> <span class="synB05"><new nick></span></code></pre></div> + + + +### Parameters ### + +Your new nickname. + +### Description ### + +Changes your nickname on the active server. + +### Examples ### + + /NICK mike + /NICK bob + +### See also ### +[CONNECT](/documentation/help/connect), [JOIN](/documentation/help/join), [MSG](/documentation/help/msg), [PART](/documentation/help/part) + diff --git a/documentation/help/notice.markdown b/documentation/help/notice.markdown new file mode 100644 index 0000000..e1378d1 --- /dev/null +++ b/documentation/help/notice.markdown @@ -0,0 +1,40 @@ +--- +layout: page +title: "Help: notice" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/notice.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:6ch"><code><span class="synB">NOTICE</span> <span class="synB05"><targets></span> <span class="synB05"><message></span></code></pre></div> + + + +### Parameters ### + +The targets and the message to notify. + +### Description ### + +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. + +### Examples ### + + /NOTICE mike You sir, are just awesome! + /NOTICE bob,#irssi Fish go blub :p + +### See also ### +[CTCP](/documentation/help/ctcp), [MSG](/documentation/help/msg), [NCTCP](/documentation/help/nctcp) + diff --git a/documentation/help/notify.markdown b/documentation/help/notify.markdown new file mode 100644 index 0000000..7446389 --- /dev/null +++ b/documentation/help/notify.markdown @@ -0,0 +1,48 @@ +--- +layout: page +title: "Help: notify" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/notify.in +- https://github.com/irssi/irssi/blob/master/src/irc/notifylist/notify-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:6ch"><code><span class="synB">NOTIFY</span> <span class="syn10">[<span class="syn">-away</span>]</span> <span class="synB05"><mask></span> <span class="syn10">[<span class="syn09"><ircnets></span>]</span></code></pre></div> + + + +### Parameters ### + + +| `-away`: | Notifies you if the target modifies its away status. | +| `-list`: | Displays the list of notifications. | +{:.table.kv} + +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. + +### Description ### + +Notifies you when a nickname or users matching a host on the notification +list comes online or offline. + +### Examples ### + + /NOTIFY -list + /NOTIFY -away mike + /NOTIFY bob + /NOTIFY *!*@staff.irssi.org + +### See also ### +[AWAY](/documentation/help/away), [HILIGHT](/documentation/help/hilight), [UNNOTIFY](/documentation/help/unnotify) + diff --git a/documentation/help/op.markdown b/documentation/help/op.markdown new file mode 100644 index 0000000..169ae00 --- /dev/null +++ b/documentation/help/op.markdown @@ -0,0 +1,40 @@ +--- +layout: page +title: "Help: op" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/op.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/modes.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:2ch"><code><span class="synB">OP</span> <span class="synB05"><nicks></span></code></pre></div> + + + +### Parameters ### + +A list of nicknames to op. + +### Description ### + +Grants the channel operator privileges to the given nicknames; you may use +the wildcard character '*' in a nickname. + +### Examples ### + + /OP mike + /OP bob sarah + /OP jo*n + /OP * + +### See also ### +[DEOP](/documentation/help/deop), [DEVOICE](/documentation/help/devoice), [KICK](/documentation/help/kick), [MODE](/documentation/help/mode), [VOICE](/documentation/help/voice) + diff --git a/documentation/help/oper.markdown b/documentation/help/oper.markdown new file mode 100644 index 0000000..bcabc61 --- /dev/null +++ b/documentation/help/oper.markdown @@ -0,0 +1,38 @@ +--- +layout: page +title: "Help: oper" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/oper.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:4ch"><code><span class="synB">OPER</span> <span class="syn10">[<span class="syn09"><nick></span> <span class="syn14">[<span class="syn13"><password></span>]</span>]</span></code></pre></div> + + + +### Parameters ### + +The username and password to identify yourself as an IRC operator; if no +password is given, you will be prompted to enter one. + +### Description ### + +Grants you the IRC operator status. + +### Examples ### + + /OPER bob + /OPER mike WzerT8zq + +### See also ### +[DIE](/documentation/help/die), [KILL](/documentation/help/kill) + diff --git a/documentation/help/part.markdown b/documentation/help/part.markdown new file mode 100644 index 0000000..8824ff1 --- /dev/null +++ b/documentation/help/part.markdown @@ -0,0 +1,37 @@ +--- +layout: page +title: "Help: part" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/part.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:4ch"><code><span class="synB">PART</span> <span class="syn10">[<span class="syn09"><channels></span>]</span> <span class="syn10">[<span class="syn09"><message></span>]</span></code></pre></div> + + + +### Parameters ### + +The channels, separated by a comma, to leave and the message to advertise. + +### Description ### + +Leaves the given channels. + +### Examples ### + + /PART #irssi + /PART #freenode,#irssi + +### See also ### +[JOIN](/documentation/help/join), [KICK](/documentation/help/kick) + diff --git a/documentation/help/ping.markdown b/documentation/help/ping.markdown new file mode 100644 index 0000000..8622df8 --- /dev/null +++ b/documentation/help/ping.markdown @@ -0,0 +1,39 @@ +--- +layout: page +title: "Help: ping" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/ping.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:4ch"><code><span class="synB">PING</span> <span class="syn10">[<span class="syn09"><nick></span> | <span class="syn09"><channel></span> | <span class="syn">*</span>]</span></code></pre></div> + + + +### Parameters ### + +The nickname or channel to ping, you can use the asterisk '*' character to +ping every user on a channel. + +### Description ### + +Sends a CTCP PING request to a nickname or a channel; this is used to find +out the latency on the network. + +### Examples ### + + /PING bob + /PING #irssi + +### See also ### +[CTCP](/documentation/help/ctcp), [MSG](/documentation/help/msg) + diff --git a/documentation/help/query.markdown b/documentation/help/query.markdown new file mode 100644 index 0000000..ca4408a --- /dev/null +++ b/documentation/help/query.markdown @@ -0,0 +1,43 @@ +--- +layout: page +title: "Help: query" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/query.in +- https://github.com/irssi/irssi/blob/master/src/fe-common/core/fe-queries.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:5ch"><code><span class="synB">QUERY</span> <span class="syn10">[<span class="syn">-window</span>]</span> <span class="syn10">[<span class="syn">-</span><span class="syn09"><server tag></span>]</span> <span class="synB05"><nick></span> <span class="syn10">[<span class="syn09"><message></span>]</span></code></pre></div> + + + +### Parameters ### + + +| `-window`: | Uses the active window instead of opening a new one. | +| `-<server tag>`: | The server tag the target nickname is on. | +{:.table.kv} + +The nickname to query and the message. + +### Description ### + +Starts a private conversation with a nickname. + +### Examples ### + + /QUERY mike + /QUERY -freenode bob + /QUERY -freenode -window sarah + +### See also ### +[MSG](/documentation/help/msg), [UNQUERY](/documentation/help/unquery), [WINDOW](/documentation/help/window) + diff --git a/documentation/help/quit.markdown b/documentation/help/quit.markdown new file mode 100644 index 0000000..5de8006 --- /dev/null +++ b/documentation/help/quit.markdown @@ -0,0 +1,38 @@ +--- +layout: page +title: "Help: quit" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/quit.in +- https://github.com/irssi/irssi/blob/master/src/core/chat-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:4ch"><code><span class="synB">QUIT</span> <span class="syn10">[<span class="syn09"><message></span>]</span></code></pre></div> + + + +### Parameters ### + +The message to advertise. + +### Description ### + +Terminates the application and advertises the given message on all the +networks you are connected to. + +### Examples ### + + /QUIT + /QUIT <@cartman> Screw you guys, I'm going home! + +### See also ### +[DISCONNECT](/documentation/help/disconnect) + diff --git a/documentation/help/quote.markdown b/documentation/help/quote.markdown new file mode 100644 index 0000000..40ce2d2 --- /dev/null +++ b/documentation/help/quote.markdown @@ -0,0 +1,37 @@ +--- +layout: page +title: "Help: quote" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/quote.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:5ch"><code><span class="synB">QUOTE</span> <span class="synB05"><data></span></code></pre></div> + + + +### Parameters ### + +The text to send to the IRC server. + +### Description ### + +Sends raw data to the server without any parsing. + +### Examples ### + + /QUOTE PRIVMSG mike :Hey, this works! + /QUOTE OPERWALL :Meow! + +### See also ### +[CONNECT](/documentation/help/connect), [DISCONNECT](/documentation/help/disconnect), [JOIN](/documentation/help/join), [MSG](/documentation/help/msg), [PART](/documentation/help/part) + diff --git a/documentation/help/rawlog.markdown b/documentation/help/rawlog.markdown new file mode 100644 index 0000000..c78d85a --- /dev/null +++ b/documentation/help/rawlog.markdown @@ -0,0 +1,49 @@ +--- +layout: page +title: "Help: rawlog" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/rawlog.in +- https://github.com/irssi/irssi/blob/master/src/core/rawlog.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:11ch"><code><span class="synB">RAWLOG</span> <span class="synB">SAVE</span> <span class="synB05"><file></span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:11ch"><code><span class="synB">RAWLOG</span> <span class="synB">OPEN</span> <span class="synB05"><file></span></code></pre></div> + + +RAWLOG CLOSE + +### Parameters ### + + +| `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 | +{:.table.kv} + +The filename to store the raw data into. + +### Description ### + +Saves all the raw data that is received from and transmitted to the active +server into a log file. + +### Examples ### + + /RAWLOG SAVE ~/server.log + /RAWLOG OPEN ~/debug.log + /RAWLOG CLOSE + +### See also ### +[LOG](/documentation/help/log) + diff --git a/documentation/help/recode.markdown b/documentation/help/recode.markdown new file mode 100644 index 0000000..6076833 --- /dev/null +++ b/documentation/help/recode.markdown @@ -0,0 +1,64 @@ +--- +layout: page +title: "Help: recode" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/recode.in +- https://github.com/irssi/irssi/blob/master/src/fe-common/core/fe-recode.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:5ch"><code><span class="synB">RECODE</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:10ch"><code><span class="synB">RECODE</span> <span class="synB">ADD</span> <span class="syn10">[<span class="syn14">[<span class="syn13"><tag></span><span class="synB">/</span>]</span><span class="syn09"><target></span>]</span> <span class="synB05"><charset></span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:13ch"><code><span class="synB">RECODE</span> <span class="synB">REMOVE</span> <span class="syn10">[<span class="syn09"><target></span>]</span></code></pre></div> + + + +### Parameters ### + + +| `ADD`: | Adds an entry into the conversion database. | +| `REMOVE`: | Removes an entry from the conversion database. | +{:.table.kv} + +The network tag and channel or nickname to add or remove; if no target is +given, the active nickname or channel will be used. + +### Description ### + +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. + +### Examples ### + + /RECODE + /RECODE ADD Freenode/mike utf-8 + /RECODE ADD #korea euc-kr + /RECODE REMOVE #korea + +### Special Examples ### + + /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 + +### See also ### +[CONNECT](/documentation/help/connect), [MSG](/documentation/help/msg), [NETWORK](/documentation/help/network), [SERVER](/documentation/help/server) + diff --git a/documentation/help/reconnect.markdown b/documentation/help/reconnect.markdown new file mode 100644 index 0000000..18c3143 --- /dev/null +++ b/documentation/help/reconnect.markdown @@ -0,0 +1,39 @@ +--- +layout: page +title: "Help: reconnect" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/reconnect.in +- https://github.com/irssi/irssi/blob/master/src/core/servers-reconnect.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:9ch"><code><span class="synB">RECONNECT</span> <span class="synB05"><tag></span> <span class="syn10">[<span class="syn09"><quit message></span>]</span></code></pre></div> + + + +### Parameters ### + +The network tag and message to advertise; if no arguments are given, the +active server and default message will be used. + +### Description ### + +Disconnect and reconnect from a network. + +### Examples ### + + /RECONNECT + /RECONNECT Freenode + /RECONNECT EFnet BRB :) + +### See also ### +[CONNECT](/documentation/help/connect), [DISCONNECT](/documentation/help/disconnect), [NETWORK](/documentation/help/network), [RMRECONNS](/documentation/help/rmreconns), [SERVER](/documentation/help/server) + diff --git a/documentation/help/rehash.markdown b/documentation/help/rehash.markdown new file mode 100644 index 0000000..340b9dc --- /dev/null +++ b/documentation/help/rehash.markdown @@ -0,0 +1,38 @@ +--- +layout: page +title: "Help: rehash" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/rehash.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:6ch"><code><span class="synB">REHASH</span> <span class="syn10">[<span class="syn09"><option></span>]</span></code></pre></div> + + + +### Parameters ### + +The raw parameters to send to the server, if no arguments are given, none +will be sent to the server. + +### Description ### + +Reloads the configuration of the IRC server you are are connected to; this +command is restricted to IRC operators. + +### Examples ### + + /REHASH + +### See also ### +[DIE](/documentation/help/die), [KILL](/documentation/help/kill), [OPER](/documentation/help/oper) + diff --git a/documentation/help/reload.markdown b/documentation/help/reload.markdown new file mode 100644 index 0000000..2163e4b --- /dev/null +++ b/documentation/help/reload.markdown @@ -0,0 +1,38 @@ +--- +layout: page +title: "Help: reload" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/reload.in +- https://github.com/irssi/irssi/blob/master/src/fe-common/core/fe-settings.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:6ch"><code><span class="synB">RELOAD</span> <span class="syn10">[<span class="syn09"><file></span>]</span></code></pre></div> + + + +### Parameters ### + +The filename of any Irssi configuration; if no parameter is given, the +active configuration file will be used. + +### Description ### + +Reloads the Irssi configuration file. + +### Examples ### + + /RELOAD + /RELOAD ~/test.irssi.conf + +### See also ### +[SAVE](/documentation/help/save) + diff --git a/documentation/help/restart.markdown b/documentation/help/restart.markdown new file mode 100644 index 0000000..4ab462f --- /dev/null +++ b/documentation/help/restart.markdown @@ -0,0 +1,33 @@ +--- +layout: page +title: "Help: restart" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/restart.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:-2ch"><code><span class="synB">RESTART</span></code></pre></div> + + + +### Description ### + +Restarts the active IRC server; this command is restricted to IRC +administrators. + +### Examples ### + + /RESTART + +### See also ### +[DIE](/documentation/help/die), [KILL](/documentation/help/kill), [OPER](/documentation/help/oper), [REHASH](/documentation/help/rehash) + diff --git a/documentation/help/rmreconns.markdown b/documentation/help/rmreconns.markdown new file mode 100644 index 0000000..bcf4dad --- /dev/null +++ b/documentation/help/rmreconns.markdown @@ -0,0 +1,32 @@ +--- +layout: page +title: "Help: rmreconns" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/rmreconns.in +- https://github.com/irssi/irssi/blob/master/src/core/servers-reconnect.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:-2ch"><code><span class="synB">RMRECONNS</span></code></pre></div> + + + +### Description ### + +Removes all active and pending reconnections. + +### Examples ### + + /RMRECONNS + +### See also ### +[CONNECT](/documentation/help/connect), [DISCONNECT](/documentation/help/disconnect), [NETWORK](/documentation/help/network), [SERVER](/documentation/help/server) + diff --git a/documentation/help/rmrejoins.markdown b/documentation/help/rmrejoins.markdown new file mode 100644 index 0000000..c459e70 --- /dev/null +++ b/documentation/help/rmrejoins.markdown @@ -0,0 +1,28 @@ +--- +layout: page +title: "Help: rmrejoins" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/rmrejoins.in + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + + +### Description ### + +Removes all active and pending join requests. + +### Examples ### + + /RMREJOINS + +### See also ### +[JOIN](/documentation/help/join), [PART](/documentation/help/part) + diff --git a/documentation/help/save.markdown b/documentation/help/save.markdown new file mode 100644 index 0000000..125119a --- /dev/null +++ b/documentation/help/save.markdown @@ -0,0 +1,43 @@ +--- +layout: page +title: "Help: save" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/save.in +- https://github.com/irssi/irssi/blob/master/src/fe-common/core/fe-settings.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:4ch"><code><span class="synB">SAVE</span> <span class="syn10">[<span class="syn09"><file></span>]</span></code></pre></div> + + + +### Parameters ### + + +| `-formats`: | Saves all the formats into the theme file. | +{:.table.kv} + +The file to save the configuration or theme into; if no parameter is given, +the active configuration or theme file will be used. + +### Description ### + +Saves the configuration file. + +### Examples ### + + /SAVE + /SAVE -formats + /SAVE ~/.irssi/config-new + +### See also ### +[RELOAD](/documentation/help/reload), [SET](/documentation/help/set) + diff --git a/documentation/help/sconnect.markdown b/documentation/help/sconnect.markdown new file mode 100644 index 0000000..f700482 --- /dev/null +++ b/documentation/help/sconnect.markdown @@ -0,0 +1,42 @@ +--- +layout: page +title: "Help: sconnect" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/sconnect.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:8ch"><code><span class="synB">SCONNECT</span> <span class="synB05"><new server></span> <span class="syn10">[<span class="syn14">[<span class="syn13"><port></span>]</span> <span class="syn09"><existing server></span>]</span></code></pre></div> + + + +### Parameters ### + +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. + +### Description ### + +Connect a server to the IRC network; this command is restricted to IRC +operators. + +### Examples ### + + /SCONNECT ircsource.irssi.org + /SCONNECT ircsource.irssi.org 6667 be.hub + +### See also ### +[DIE](/documentation/help/die), [KILL](/documentation/help/kill), [OPER](/documentation/help/oper), [RESTART](/documentation/help/restart), [SQUIT](/documentation/help/squit) + diff --git a/documentation/help/script.markdown b/documentation/help/script.markdown new file mode 100644 index 0000000..5ff17e1 --- /dev/null +++ b/documentation/help/script.markdown @@ -0,0 +1,47 @@ +--- +layout: page +title: "Help: script" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/script.in + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + + +### Parameters ### + + +| `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. | +{:.table.kv} + +If no argument is given, the list of active scripts will be displayed. + +### Description ### + +Interact with the Perl engine to execute scripts. + +### Examples ### + + /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}); } + +### See also ### +[LOAD](/documentation/help/load), [SAVE](/documentation/help/save), [UNLOAD](/documentation/help/unload) + diff --git a/documentation/help/scrollback.markdown b/documentation/help/scrollback.markdown new file mode 100644 index 0000000..56f58d6 --- /dev/null +++ b/documentation/help/scrollback.markdown @@ -0,0 +1,67 @@ +--- +layout: page +title: "Help: scrollback" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/scrollback.in +- https://github.com/irssi/irssi/blob/master/src/fe-text/textbuffer-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:16ch"><code><span class="synB">SCROLLBACK</span> <span class="synB">CLEAR</span> <span class="syn10">[<span class="syn">-all</span>]</span> <span class="syn10">[<span class="syn09"><refnum></span>]</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:21ch"><code><span class="synB">SCROLLBACK</span> <span class="synB">LEVELCLEAR</span> <span class="syn10">[<span class="syn">-all</span>]</span> <span class="syn10">[<span class="syn">-level</span> <span class="syn09"><level></span>]</span> <span class="syn10">[<span class="syn09"><refnum></span>]</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:15ch"><code><span class="synB">SCROLLBACK</span> <span class="synB">GOTO</span> <span class="synB05"><+|-linecount></span>|<span class="synB05"><linenum></span>|<span class="synB05"><timestamp></span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:14ch"><code><span class="synB">SCROLLBACK</span> <span class="synB">HOME</span></code></pre></div> + + +SCROLLBACK END + +### Parameters ### + + +| `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. | +{:.table.kv} + + +| `-all`: | Applies to all windows instead of only the active one. | +| `-level`: | The levels, separated by a comma, to match. | +{:.table.kv} + +The line number, timestamp to jump to or the window reference number to +clear. + +### Description ### + +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]'. + +### Examples ### + + /SCROLLBACK CLEAR + /SCROLLBACK LEVELCLEAR -level NOTICES + /SCROLLBACK GOTO 100 + /SCROLLBACK HOME + /SCROLLBACK END + +### See also ### +[CLEAR](/documentation/help/clear), [WINDOW](/documentation/help/window) + diff --git a/documentation/help/server.markdown b/documentation/help/server.markdown new file mode 100644 index 0000000..4a1e819 --- /dev/null +++ b/documentation/help/server.markdown @@ -0,0 +1,104 @@ +--- +layout: page +title: "Help: server" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/server.in +- https://github.com/irssi/irssi/blob/master/src/core/chat-commands.c +- https://github.com/irssi/irssi/blob/master/src/fe-common/core/fe-server.c +- https://github.com/irssi/irssi/blob/master/src/fe-common/irc/fe-irc-server.c +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:14ch"><code><span class="synB">SERVER</span> <span class="synB">CONNECT</span> <span class="syn10">[<span class="syn">-4</span> | <span class="syn">-6</span>]</span> <span class="syn10">[<span class="syn">-tls</span>]</span> <span class="syn10">[<span class="syn">-tls_cert</span> <span class="syn09"><cert></span>]</span> <span class="syn10">[<span class="syn">-tls_pkey</span> <span class="syn09"><pkey></span>]</span> <span class="syn10">[<span class="syn">-tls_pass</span> <span class="syn09"><password></span>]</span> <span class="syn10">[<span class="syn">-tls_verify</span>]</span> <span class="syn10">[<span class="syn">-tls_cafile</span> <span class="syn09"><cafile></span>]</span> <span class="syn10">[<span class="syn">-tls_capath</span> <span class="syn09"><capath></span>]</span> <span class="syn10">[<span class="syn">-tls_ciphers</span> <span class="syn09"><list></span>]</span> <span class="syn10">[<span class="syn">-tls_pinned_cert</span> <span class="syn09"><fingerprint></span>]</span> <span class="syn10">[<span class="syn">-tls_pinned_pubkey</span> <span class="syn09"><fingerprint></span>]</span> <span class="syn10">[<span class="syn">-!</span>]</span> <span class="syn10">[<span class="syn">-noautosendcmd</span>]</span> <span class="syn10">[<span class="syn">-noproxy</span>]</span> <span class="syn10">[<span class="syn">-network</span> <span class="syn09"><network></span>]</span> <span class="syn10">[<span class="syn">-host</span> <span class="syn09"><hostname></span>]</span> <span class="syn10">[<span class="syn">-rawlog</span> <span class="syn09"><file></span>]</span> <span class="syn10">[<span class="syn">+</span>]</span><span class="synB05"><address></span>|<span class="synB05"><chatnet></span> <span class="syn10">[<span class="syn09"><port></span> <span class="syn14">[<span class="syn13"><password></span> <span class="syn13">[<span class="syn14"><nick></span>]</span>]</span>]</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:13ch"><code><span class="synB">SERVER</span> <span class="synB">REMOVE</span> <span class="synB05"><address></span> <span class="syn10">[<span class="syn09"><port></span>]</span> <span class="syn10">[<span class="syn09"><network></span>]</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:9ch"><code><span class="synB">SERVER</span> <span class="synB">ADD</span>|<span class="synB">MODIFY</span> <span class="syn10">[<span class="syn">-4</span> | <span class="syn">-6</span>]</span> <span class="syn10">[<span class="syn">-ssl</span>]</span> <span class="syn10">[<span class="syn">-ssl_cert</span> <span class="syn09"><cert></span>]</span> <span class="syn10">[<span class="syn">-ssl_pkey</span> <span class="syn09"><pkey></span>]</span> <span class="syn10">[<span class="syn">-ssl_pass</span> <span class="syn09"><password></span>]</span> <span class="syn10">[<span class="syn">-ssl_verify</span>]</span> <span class="syn10">[<span class="syn">-ssl_cafile</span> <span class="syn09"><cafile></span>]</span> <span class="syn10">[<span class="syn">-ssl_capath</span> <span class="syn09"><capath></span>]</span> <span class="syn10">[<span class="syn">-ssl_ciphers</span> <span class="syn09"><list></span>]</span> <span class="syn10">[<span class="syn">-auto</span> | <span class="syn">-noauto</span>]</span> <span class="syn10">[<span class="syn">-network</span> <span class="syn09"><network></span>]</span> <span class="syn10">[<span class="syn">-host</span> <span class="syn09"><hostname></span>]</span> <span class="syn10">[<span class="syn">-cmdspeed</span> <span class="syn09"><ms></span>]</span> <span class="syn10">[<span class="syn">-cmdmax</span> <span class="syn09"><count></span>]</span> <span class="syn10">[<span class="syn">-port</span> <span class="syn09"><port></span>]</span> <span class="synB05"><address></span> <span class="syn10">[<span class="syn09"><port></span> <span class="syn14">[<span class="syn13"><password></span>]</span>]</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:10ch"><code><span class="synB">SERVER</span> <span class="synB">LIST</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:12ch"><code><span class="synB">SERVER</span> <span class="synB">PURGE</span> <span class="syn10">[<span class="syn09"><target></span>]</span></code></pre></div> + + + +### Parameters ### + + +| `LIST`: | Displays the list of servers you are connected to. | +| `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. | +{:.table.kv} + + +| `-!`: | Doesn't autojoin the channels. | +| `-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. | +| `-auto`: | Automatically connects to the server on startup. | +| `-noauto`: | Doesn't connect to the server on startup. | +| `-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. | +{:.table.kv} + +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. + +### Description ### + +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 command without any of the given parameters, it will +connect to the specified server; the server in the active window will be +disconnected unless you prepend the server with the '+' character; the same +method is applicable to the CONNECT parameter. + +### Examples ### + + /SERVER + /SERVER CONNECT chat.freenode.net + /SERVER CONNECT +chat.freenode.net + /SERVER ADD -network Freenode -noautosendcmd orwell.freenode.net + /SERVER ADD -! -auto -host staff.irssi.org -4 -network Freenode -noproxy orwell.freenode.net 6667 + /SERVER MODIFY -network Freenode -noauto orwell.freenode.net + /SERVER REMOVE orwell.freenode.net 6667 Freenode + /SERVER PURGE + /SERVER PURGE orwell.freenode.net + +### See also ### +[CHANNEL](/documentation/help/channel), [CONNECT](/documentation/help/connect), [DISCONNECT](/documentation/help/disconnect), [NETWORK](/documentation/help/network), [RECONNECT](/documentation/help/reconnect), [RMRECONNS](/documentation/help/rmreconns) + diff --git a/documentation/help/servlist.markdown b/documentation/help/servlist.markdown new file mode 100644 index 0000000..812ccf8 --- /dev/null +++ b/documentation/help/servlist.markdown @@ -0,0 +1,41 @@ +--- +layout: page +title: "Help: servlist" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/servlist.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:8ch"><code><span class="synB">SERVLIST</span> <span class="syn10">[<span class="syn09"><mask></span> <span class="syn14">[<span class="syn13"><type></span>]</span>]</span></code></pre></div> + + + +### Parameters ### + + +| `<mask>` | limits the output to the services which names matches the mask. | +| `<type>` | limits the output to the services of the specified type. | +{:.table.kv} + +### Description ### + +List the network services currently present on the + IRC network. + +### Examples ### + + /SERVLIST *@javairc.* + /SERVLIST * 0xD000 + +### See also ### +[SQUERY](/documentation/help/squery) + diff --git a/documentation/help/set.markdown b/documentation/help/set.markdown new file mode 100644 index 0000000..3f6d11c --- /dev/null +++ b/documentation/help/set.markdown @@ -0,0 +1,52 @@ +--- +layout: page +title: "Help: set" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/set.in +- https://github.com/irssi/irssi/blob/master/src/fe-common/core/fe-settings.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:3ch"><code><span class="synB">SET</span> <span class="syn10">[<span class="syn">-clear</span> | <span class="syn">-default</span>]</span> <span class="syn10">[<span class="syn09"><key></span> <span class="syn14">[<span class="syn13"><value></span>]</span>]</span></code></pre></div> + + + +### Parameters ### + + +| `-clear`: | Removes the setting's value from the configuration. | +| `-default`: | Restore the setting to its default value. | +{:.table.kv} + +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. + +### Description ### + +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. + +### Examples ### + + /SET + /SET nick mike + /SET -clear nick + /SET log_timestamp %H:%H:%S + /SET -default log_timestamp + /SET close + +### See also ### +[SAVE](/documentation/help/save), [TOGGLE](/documentation/help/toggle) + diff --git a/documentation/help/silence.markdown b/documentation/help/silence.markdown new file mode 100644 index 0000000..293c51c --- /dev/null +++ b/documentation/help/silence.markdown @@ -0,0 +1,49 @@ +--- +layout: page +title: "Help: silence" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/silence.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:7ch"><code><span class="synB">SILENCE</span> <span class="syn10">[<span class="syn14">[<span class="synB">+</span>|<span class="synB">-</span>]</span><span class="syn09"><nick!user@host></span>]</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:7ch"><code><span class="synB">SILENCE</span> <span class="syn10">[<span class="syn09"><nick></span>]</span></code></pre></div> + + + +### Parameters ### + +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. + +### Description ### + +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. + +### Examples ### + + /SILENCE + /SILENCE +mike + /SILENCE -mike + /SILENCE +*!*@*.irssi.org + /SILENCE -*!*@*.irssi.org + +### See also ### +[ACCEPT](/documentation/help/accept), [IGNORE](/documentation/help/ignore) + diff --git a/documentation/help/squery.markdown b/documentation/help/squery.markdown new file mode 100644 index 0000000..9da09cc --- /dev/null +++ b/documentation/help/squery.markdown @@ -0,0 +1,35 @@ +--- +layout: page +title: "Help: squery" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/squery.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:6ch"><code><span class="synB">SQUERY</span> <span class="synB05"><service></span> <span class="syn10">[<span class="syn09"><message></span>]</span></code></pre></div> + + + +### Parameters ### + + +| `<service>` | - Service nickname or full hostmask of service to query. | +| `<message>` | - Message to send to the service. | +{:.table.kv} + +### Description ### + + /SQUERY sends a query to the specified service. + +### See also ### +[SERVLIST](/documentation/help/servlist), [LIST](/documentation/help/list), [MSG](/documentation/help/msg) + diff --git a/documentation/help/squit.markdown b/documentation/help/squit.markdown new file mode 100644 index 0000000..563e57f --- /dev/null +++ b/documentation/help/squit.markdown @@ -0,0 +1,37 @@ +--- +layout: page +title: "Help: squit" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/squit.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:5ch"><code><span class="synB">SQUIT</span> <span class="synB05"><server></span>|<span class="synB05"><mask></span> <span class="synB05"><reason></span></code></pre></div> + + + +### Parameters ### + +The server and the disconnect reason. + +### Description ### + +Disconnects a server from the IRC network; this command is restricted to + IRC operators. + +### Examples ### + + /SQUIT ircsource.irssi.org I'm fixing a desync! + +### See also ### +[DIE](/documentation/help/die), [OPER](/documentation/help/oper), [SCONNECT](/documentation/help/sconnect) + diff --git a/documentation/help/stats.markdown b/documentation/help/stats.markdown new file mode 100644 index 0000000..cf337d2 --- /dev/null +++ b/documentation/help/stats.markdown @@ -0,0 +1,57 @@ +--- +layout: page +title: "Help: stats" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/stats.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:5ch"><code><span class="synB">STATS</span> <span class="synB05"><type></span> <span class="syn10">[<span class="syn09"><server></span>]</span></code></pre></div> + + + +### Parameters ### + +The statistic identifier and the remote server; if no remote server is +given, the active server will be used. + +### Description ### + +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. | +{:.table.kv} + +### Examples ### + + /STATS p + /STATS I ircsource.irssi.org + +### See also ### +[MOTD](/documentation/help/motd), [OPER](/documentation/help/oper) + diff --git a/documentation/help/statusbar.markdown b/documentation/help/statusbar.markdown new file mode 100644 index 0000000..0a6bd5e --- /dev/null +++ b/documentation/help/statusbar.markdown @@ -0,0 +1,80 @@ +--- +layout: page +title: "Help: statusbar" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/statusbar.in +- https://github.com/irssi/irssi/blob/master/src/fe-text/statusbar-config.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:9ch"><code><span class="synB">STATUSBAR</span> <span class="synB05"><name></span> <span class="synB">ENABLE</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:9ch"><code><span class="synB">STATUSBAR</span> <span class="synB05"><name></span> <span class="synB">DISABLE</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:9ch"><code><span class="synB">STATUSBAR</span> <span class="synB05"><name></span> <span class="synB">RESET</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:9ch"><code><span class="synB">STATUSBAR</span> <span class="synB05"><name></span> <span class="synB">TYPE</span> <span class="synB">window</span>|<span class="synB">root</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:9ch"><code><span class="synB">STATUSBAR</span> <span class="synB05"><name></span> <span class="synB">PLACEMENT</span> <span class="synB">top</span>|<span class="synB">bottom</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:9ch"><code><span class="synB">STATUSBAR</span> <span class="synB05"><name></span> <span class="synB">POSITION</span> <span class="synB05"><num></span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:9ch"><code><span class="synB">STATUSBAR</span> <span class="synB05"><name></span> <span class="synB">VISIBLE</span> <span class="synB">always</span>|<span class="synB">active</span>|<span class="synB">inactive</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:9ch"><code><span class="synB">STATUSBAR</span> <span class="synB05"><name></span> <span class="synB">ADD</span> <span class="syn10">[<span class="syn">-before</span> | <span class="syn">-after</span> <span class="syn09"><item></span>]</span> <span class="syn10">[<span class="syn">-priority</span> <span class="syn">#</span>]</span> <span class="syn10">[<span class="syn">-alignment</span> <span class="syn">left</span>|<span class="syn">right</span>]</span> <span class="synB05"><item></span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:9ch"><code><span class="synB">STATUSBAR</span> <span class="synB05"><name></span> <span class="synB">REMOVE</span> <span class="synB05"><item></span></code></pre></div> + + + +### Parameters ### + + +| `ENABLE`: | Adds a statusbar to the list of statusbars. | +| `DISABLE`: | Removes a statusbar from the list. Note that for built-in statusbars they can be enabled again should the user wish to add back the default statusbars. | +| `RESET`: | Restores the default statusbar configuration. | +| `TYPE`: | Sets the type of statusbar, for each split window or only for the current root screen. | +| `PLACEMENT`: | Sets the placement of the statusbar, either at the top or the bottom of the screen. | +| `POSITION`: | Sets the position of the statusbar. Represented as a number, with 0 implying the first position. | +| `VISIBLE`: | Sets the visibility of the statusbar or item. If set to always it is visible on all screens, otherwise if set to inactive or active then it is only visible on inactive or active screens, respectively. | +| `ADD`: | Adds an item to the specified statusbar. It can be set to appear before/after another item and left/right aligned to a specified position on the screen. | +| `REMOVE`: | Removes an item from the specified statusbar. | +{:.table.kv} + +Where name refers to the name of the statusbar; if no argument is +given, the entire list of statusbars will be displayed. + +### Description ### + +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. + +### Examples ### + + /STATUSBAR + /STATUSBAR window + /STATUSBAR window REMOVE time + /STATUSBAR window ADD time + /STATUSBAR window RESET + /STATUSBAR topic DISABLE + /STATUSBAR topic ENABLE + +### See also ### +[WINDOW](/documentation/help/window) + diff --git a/documentation/help/time.markdown b/documentation/help/time.markdown new file mode 100644 index 0000000..9775fef --- /dev/null +++ b/documentation/help/time.markdown @@ -0,0 +1,40 @@ +--- +layout: page +title: "Help: time" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/time.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:4ch"><code><span class="synB">TIME</span> <span class="syn10">[<span class="syn09"><server></span>|<span class="syn09"><nick></span>]</span></code></pre></div> + + + +### Parameters ### + +The channel or the nickname; if no argument is given, the active server +will be used. + +### Description ### + +Displays the local time of a server or the server the target user is +connected to. + +### Examples ### + + /TIME + /TIME mike + /TIME ircsource.irssi.org + +### See also ### +[MAP](/documentation/help/map), [TRACE](/documentation/help/trace), [WHOIS](/documentation/help/whois) + diff --git a/documentation/help/toggle.markdown b/documentation/help/toggle.markdown new file mode 100644 index 0000000..3bfed9b --- /dev/null +++ b/documentation/help/toggle.markdown @@ -0,0 +1,39 @@ +--- +layout: page +title: "Help: toggle" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/toggle.in +- https://github.com/irssi/irssi/blob/master/src/fe-common/core/fe-settings.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:6ch"><code><span class="synB">TOGGLE</span> <span class="synB05"><key></span> <span class="syn10">[<span class="syn">on</span>|<span class="syn">off</span>|<span class="syn">toggle</span>]</span></code></pre></div> + + + +### Parameters ### + + The setting to modify and the new value; if no value is given, its opposite + will be used. + +### Description ### + +Modifies a setting to its counter value; you can also give ON or OFF as a +value. + +### Examples ### + + /TOGGLE resolve_prefer_ipv6 + /TOGGLE channels_rejoin_unavailable ON + +### See also ### +[SET](/documentation/help/set) + diff --git a/documentation/help/topic.markdown b/documentation/help/topic.markdown new file mode 100644 index 0000000..3e2e281 --- /dev/null +++ b/documentation/help/topic.markdown @@ -0,0 +1,44 @@ +--- +layout: page +title: "Help: topic" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/topic.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:5ch"><code><span class="synB">TOPIC</span> <span class="syn10">[<span class="syn">-delete</span>]</span> <span class="syn10">[<span class="syn09"><channel></span>]</span> <span class="syn10">[<span class="syn09"><topic></span>]</span></code></pre></div> + + + +### Parameters ### + + +| `-delete`: | Removes the topic. | +{:.table.kv} + +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. + +### Description ### + +Displays or modifies the topic of a channel. + +### Examples ### + + /TOPIC + /TOPIC The robots are taking over! + /TOPIC -delete #irssi + /TOPIC #shakespeare /bb|[^b]{2}/ + +### See also ### +[CHANNEL](/documentation/help/channel), [DEOP](/documentation/help/deop), [DEVOICE](/documentation/help/devoice), [JOIN](/documentation/help/join), [OP](/documentation/help/op), [VOICE](/documentation/help/voice) + diff --git a/documentation/help/trace.markdown b/documentation/help/trace.markdown new file mode 100644 index 0000000..ea00d55 --- /dev/null +++ b/documentation/help/trace.markdown @@ -0,0 +1,42 @@ +--- +layout: page +title: "Help: trace" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/trace.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:5ch"><code><span class="synB">TRACE</span> <span class="syn10">[<span class="syn09"><server></span>|<span class="syn09"><nick></span>]</span></code></pre></div> + + + +### Parameters ### + +The channel or the nickname; if no argument is given, the active server +will be used. + +### Description ### + +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. + +### Examples ### + + /TRACE + /TRACE mike + /TRACE ircsource.irssi.org + +### See also ### +[MAP](/documentation/help/map), [TIME](/documentation/help/time), [WHOIS](/documentation/help/whois) + diff --git a/documentation/help/ts.markdown b/documentation/help/ts.markdown new file mode 100644 index 0000000..73424fa --- /dev/null +++ b/documentation/help/ts.markdown @@ -0,0 +1,32 @@ +--- +layout: page +title: "Help: ts" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/ts.in +- https://github.com/irssi/irssi/blob/master/src/fe-common/irc/fe-irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:-2ch"><code><span class="synB">TS</span></code></pre></div> + + + +### Description ### + +Displays a list of the channels you are on and their topics. + +### Examples ### + + /TS + +### See also ### +[JOIN](/documentation/help/join), [TOPIC](/documentation/help/topic) + diff --git a/documentation/help/unalias.markdown b/documentation/help/unalias.markdown new file mode 100644 index 0000000..fe72ff6 --- /dev/null +++ b/documentation/help/unalias.markdown @@ -0,0 +1,37 @@ +--- +layout: page +title: "Help: unalias" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/unalias.in +- https://github.com/irssi/irssi/blob/master/src/fe-common/core/fe-settings.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:7ch"><code><span class="synB">UNALIAS</span> <span class="synB05"><alias></span></code></pre></div> + + + +### Parameters ### + +The name of the alias. + +### Description ### + +Removes an alias. + +### Examples ### + + /UNALIAS BAN + /UNALIAS K + +### See also ### +[ALIAS](/documentation/help/alias) + diff --git a/documentation/help/unban.markdown b/documentation/help/unban.markdown new file mode 100644 index 0000000..8be7436 --- /dev/null +++ b/documentation/help/unban.markdown @@ -0,0 +1,64 @@ +--- +layout: page +title: "Help: unban" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/unban.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/bans.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:5ch"><code><span class="synB">UNBAN</span> <span class="synB">-first</span> | <span class="synB">-last</span> | <span class="synB05"><id></span> | <span class="synB05"><masks></span></code></pre></div> + + + +### Parameters ### + + +| `-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. | +{:.table.kv} + +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. + +### Description ### + +Removes one or more bans from a channel. + +### Configuring the custom format ### + +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. + +### Examples ### + + /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 + +### See also ### +[BAN](/documentation/help/ban), [DEOP](/documentation/help/deop), [KICKBAN](/documentation/help/kickban), [KNOCKOUT](/documentation/help/knockout), [OP](/documentation/help/op) + diff --git a/documentation/help/unignore.markdown b/documentation/help/unignore.markdown new file mode 100644 index 0000000..711a27e --- /dev/null +++ b/documentation/help/unignore.markdown @@ -0,0 +1,37 @@ +--- +layout: page +title: "Help: unignore" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/unignore.in +- https://github.com/irssi/irssi/blob/master/src/fe-common/core/fe-ignore.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:8ch"><code><span class="synB">UNIGNORE</span> <span class="synB05"><id></span>|<span class="synB05"><mask></span></code></pre></div> + + + +### Parameters ### + +The ignore identifier or pattern to remove. + +### Description ### + +Removes an entry from the ignore list. + +### Examples ### + + /UNIGNORE 5 + /UNIGNORE mike + +### See also ### +[ACCEPT](/documentation/help/accept), [IGNORE](/documentation/help/ignore), [SILENCE](/documentation/help/silence) + diff --git a/documentation/help/unload.markdown b/documentation/help/unload.markdown new file mode 100644 index 0000000..35924fa --- /dev/null +++ b/documentation/help/unload.markdown @@ -0,0 +1,36 @@ +--- +layout: page +title: "Help: unload" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/unload.in +- https://github.com/irssi/irssi/blob/master/src/fe-common/core/fe-modules.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:6ch"><code><span class="synB">UNLOAD</span> <span class="synB05"><module></span> <span class="syn10">[<span class="syn09"><submodule></span>]</span></code></pre></div> + + + +### Parameters ### + +The name of the module to unload. + +### Description ### + +Removes a module from the memory. + +### Examples ### + + /UNLOAD fish + +### See also ### +[LOAD](/documentation/help/load), [SCRIPT](/documentation/help/script) + diff --git a/documentation/help/unnotify.markdown b/documentation/help/unnotify.markdown new file mode 100644 index 0000000..e2e140e --- /dev/null +++ b/documentation/help/unnotify.markdown @@ -0,0 +1,37 @@ +--- +layout: page +title: "Help: unnotify" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/unnotify.in +- https://github.com/irssi/irssi/blob/master/src/irc/notifylist/notify-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:8ch"><code><span class="synB">UNNOTIFY</span> <span class="synB05"><mask></span></code></pre></div> + + + +### Parameters ### + +The notify pattern to remove. + +### Description ### + +Removes an entry from the notify list. + +### Examples ### + + /UNNOTIFY bob + /UNNOTIFY *!*@staff.irssi.org + +### See also ### +[AWAY](/documentation/help/away), [HILIGHT](/documentation/help/hilight), [NOTIFY](/documentation/help/notify) + diff --git a/documentation/help/unquery.markdown b/documentation/help/unquery.markdown new file mode 100644 index 0000000..e44dc4f --- /dev/null +++ b/documentation/help/unquery.markdown @@ -0,0 +1,38 @@ +--- +layout: page +title: "Help: unquery" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/unquery.in +- https://github.com/irssi/irssi/blob/master/src/fe-common/core/fe-queries.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:7ch"><code><span class="synB">UNQUERY</span> <span class="syn10">[<span class="syn09"><nick></span>]</span></code></pre></div> + + + +### Parameters ### + +The nickname to close the query for; if no argument is given, the active +query will be used. + +### Description ### + +Closes a query window for a nickname. + +### Examples ### + + /UNQUERY + /UNQUERY mike + +### See also ### +[MSG](/documentation/help/msg), [QUERY](/documentation/help/query), [WINDOW](/documentation/help/window) + diff --git a/documentation/help/unsilence.markdown b/documentation/help/unsilence.markdown new file mode 100644 index 0000000..3433de6 --- /dev/null +++ b/documentation/help/unsilence.markdown @@ -0,0 +1,38 @@ +--- +layout: page +title: "Help: unsilence" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/unsilence.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:9ch"><code><span class="synB">UNSILENCE</span> <span class="synB05"><nick!user@host></span></code></pre></div> + + + +### Parameters ### + +The silence pattern to remove. + +### Description ### + +Removes an entry from the silence list. This command does not work on all + IRC networks. + +### Examples ### + + /UNSILENCE mike + /UNSILENCE *!*@*.irssi.org + +### See also ### +[ACCEPT](/documentation/help/accept), [IGNORE](/documentation/help/ignore), [SILENCE](/documentation/help/silence) + diff --git a/documentation/help/upgrade.markdown b/documentation/help/upgrade.markdown new file mode 100644 index 0000000..f361349 --- /dev/null +++ b/documentation/help/upgrade.markdown @@ -0,0 +1,39 @@ +--- +layout: page +title: "Help: upgrade" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/upgrade.in +- https://github.com/irssi/irssi/blob/master/src/core/session.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:7ch"><code><span class="synB">UPGRADE</span> <span class="syn10">[<span class="syn09"><irssi binary path></span>]</span></code></pre></div> + + + +### Parameters ### + +The location of the new binary; if no arguments are given, the current +binary file will be used. + +### Description ### + +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. + +### Examples ### + + /UPGRADE + /UPGRADE /home/mike/irssi-dev/bin/irssi + +### See also ### +[CONNECT](/documentation/help/connect), [DISCONNECT](/documentation/help/disconnect), [HELP](/documentation/help/help) + diff --git a/documentation/help/uptime.markdown b/documentation/help/uptime.markdown new file mode 100644 index 0000000..f31e37a --- /dev/null +++ b/documentation/help/uptime.markdown @@ -0,0 +1,32 @@ +--- +layout: page +title: "Help: uptime" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/uptime.in +- https://github.com/irssi/irssi/blob/master/src/fe-common/core/fe-core-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:-2ch"><code><span class="synB">UPTIME</span></code></pre></div> + + + +### Description ### + +Displays how long Irssi has been running. + +### Examples ### + + /UPTIME + +### See also ### +[CONNECT](/documentation/help/connect), [EXIT](/documentation/help/exit) + diff --git a/documentation/help/userhost.markdown b/documentation/help/userhost.markdown new file mode 100644 index 0000000..0100d0b --- /dev/null +++ b/documentation/help/userhost.markdown @@ -0,0 +1,39 @@ +--- +layout: page +title: "Help: userhost" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/userhost.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:8ch"><code><span class="synB">USERHOST</span> <span class="synB05"><nicks></span></code></pre></div> + + + +### Parameters ### + +One or more nicknames separated by space. + +### Description ### + +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. + +### Examples ### + + /USERHOST mike + /USERHOST bob sarah + +### See also ### +[WHOIS](/documentation/help/whois) + diff --git a/documentation/help/ver.markdown b/documentation/help/ver.markdown new file mode 100644 index 0000000..39f57a5 --- /dev/null +++ b/documentation/help/ver.markdown @@ -0,0 +1,39 @@ +--- +layout: page +title: "Help: ver" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/ver.in +- https://github.com/irssi/irssi/blob/master/src/fe-common/irc/fe-irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:3ch"><code><span class="synB">VER</span> <span class="syn10">[<span class="syn09"><nick></span> | <span class="syn09"><channel></span> | <span class="syn">*</span>]</span></code></pre></div> + + + +### Parameters ### + +A nickname, channel or the wildcard character '*'. + +### Description ### + +Send a CTCP VERION request to the target nickname, channel or to all the +users on the channel. + +### Examples ### + + /VER * + /VER #irssi + /VER mike + +### See also ### +[CTCP](/documentation/help/ctcp) + diff --git a/documentation/help/version.markdown b/documentation/help/version.markdown new file mode 100644 index 0000000..5eb44dc --- /dev/null +++ b/documentation/help/version.markdown @@ -0,0 +1,43 @@ +--- +layout: page +title: "Help: version" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/version.in +- https://github.com/irssi/irssi/blob/master/src/fe-common/core/fe-core-commands.c +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:6ch"><code><span class="synB">VERSION</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:7ch"><code><span class="synB">VERSION</span> <span class="syn10">[<span class="syn09"><server></span>|<span class="syn09"><nick></span>]</span></code></pre></div> + + + +### Parameters ### + +A nickname or server; if no argument is given, the active server will be +used. + +### Description ### + +Displays the version and compatibility parameters of the given server, or +for the server the target nickname is on. + +### Examples ### + + /VERSION mike + /VERSION ircsource.irssi.org + +### See also ### +[ADMIN](/documentation/help/admin), [STATS](/documentation/help/stats) + diff --git a/documentation/help/voice.markdown b/documentation/help/voice.markdown new file mode 100644 index 0000000..21cfd04 --- /dev/null +++ b/documentation/help/voice.markdown @@ -0,0 +1,40 @@ +--- +layout: page +title: "Help: voice" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/voice.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/modes.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:5ch"><code><span class="synB">VOICE</span> <span class="synB05"><nicks></span></code></pre></div> + + + +### Parameters ### + +A list of nicknames to voice. + +### Description ### + +Grants the channel voice privileges to the given nicknames; you may use +the wildcard character '*' in a nickname. + +### Examples ### + + /VOICE mike + /VOICE bob sarah + /VOICE jo*n + /VOICE * + +### See also ### +[DEOP](/documentation/help/deop), [DEVOICE](/documentation/help/devoice), [KICK](/documentation/help/kick), [MODE](/documentation/help/mode), [OP](/documentation/help/op) + diff --git a/documentation/help/wait.markdown b/documentation/help/wait.markdown new file mode 100644 index 0000000..0c5f231 --- /dev/null +++ b/documentation/help/wait.markdown @@ -0,0 +1,38 @@ +--- +layout: page +title: "Help: wait" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/wait.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:4ch"><code><span class="synB">WAIT</span> <span class="syn10">[<span class="syn">-</span><span class="syn09"><server tag></span>]</span> <span class="synB05"><milliseconds></span></code></pre></div> + + + +### Parameters ### + +The amount of milliseconds. + +### Description ### + +Waits the specified amount of milliseconds before sending the next command +to the server. + +### Examples ### + + /WAIT 1000 + /WAIT 5000 + +### See also ### +[ALIAS](/documentation/help/alias) + diff --git a/documentation/help/wall.markdown b/documentation/help/wall.markdown new file mode 100644 index 0000000..31ec810 --- /dev/null +++ b/documentation/help/wall.markdown @@ -0,0 +1,40 @@ +--- +layout: page +title: "Help: wall" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/wall.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:4ch"><code><span class="synB">WALL</span> <span class="syn10">[<span class="syn09"><channel></span>]</span> <span class="synB05"><message></span></code></pre></div> + + + +### Parameters ### + +The channel and the message; if no channel is given, the active channel +will be used. + +### Description ### + +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. + +### Examples ### + + /WALL I'm off for today; take care! :) + /WALL #irssi I'm feeling supercalifragilisticexpialidocious today :D + +### See also ### +[MSG](/documentation/help/msg), [NOTICE](/documentation/help/notice) + diff --git a/documentation/help/wallops.markdown b/documentation/help/wallops.markdown new file mode 100644 index 0000000..0c5b943 --- /dev/null +++ b/documentation/help/wallops.markdown @@ -0,0 +1,37 @@ +--- +layout: page +title: "Help: wallops" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/wallops.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:7ch"><code><span class="synB">WALLOPS</span> <span class="synB05"><message></span></code></pre></div> + + + +### Parameters ### + +The message to broadcast. + +### Description ### + +Sends a network wide message to all the users which have the usermode 'w' +enabled; this command is restricted to IRC operators. + +### Examples ### + + /WALLOPS Hi everybody! + +### See also ### +[OPER](/documentation/help/oper), [STATS](/documentation/help/stats) + diff --git a/documentation/help/who.markdown b/documentation/help/who.markdown new file mode 100644 index 0000000..76eeef9 --- /dev/null +++ b/documentation/help/who.markdown @@ -0,0 +1,55 @@ +--- +layout: page +title: "Help: who" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/who.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:3ch"><code><span class="synB">WHO</span> <span class="syn10">[<span class="syn09"><nicks></span> | <span class="syn09"><channels></span> | <span class="syn">**</span>]</span></code></pre></div> + + + +### Parameters ### + +The channel name or output filter; if no arguments are given, the current +channel will be used. + +### Description ### + +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. | +{:.table.kv} + +### Examples ### + + /WHO + /WHO #irssi + /WHO bob + /WHO sar* + +### See also ### +[CHANNEL](/documentation/help/channel), [NAMES](/documentation/help/names), [WHOIS](/documentation/help/whois) + diff --git a/documentation/help/whois.markdown b/documentation/help/whois.markdown new file mode 100644 index 0000000..af0e4ec --- /dev/null +++ b/documentation/help/whois.markdown @@ -0,0 +1,49 @@ +--- +layout: page +title: "Help: whois" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/whois.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:5ch"><code><span class="synB">WHOIS</span> <span class="syn10">[<span class="syn">-</span><span class="syn09"><server tag></span>]</span> <span class="syn10">[<span class="syn09"><server></span>]</span> <span class="syn10">[<span class="syn09"><nicks></span>]</span></code></pre></div> + + + +### Parameters ### + + +| `-<server tag>`: | The server tag the target nickname is on. | +{:.table.kv} + +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. + +### Description ### + +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. + +### Examples ### + + /WHOIS + /WHOIS mike + /WHOIS ircsource.irssi.org bob + /WHOIS sarah sarah + +### See also ### +[CHANNEL](/documentation/help/channel), [NAMES](/documentation/help/names), [WHO](/documentation/help/who), [WHOWAS](/documentation/help/whowas) + diff --git a/documentation/help/whowas.markdown b/documentation/help/whowas.markdown new file mode 100644 index 0000000..152fbd1 --- /dev/null +++ b/documentation/help/whowas.markdown @@ -0,0 +1,41 @@ +--- +layout: page +title: "Help: whowas" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/whowas.in +- https://github.com/irssi/irssi/blob/master/src/irc/core/irc-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:6ch"><code><span class="synB">WHOWAS</span> <span class="syn10">[<span class="syn09"><nicks></span> <span class="syn14">[<span class="syn13"><count></span> <span class="syn13">[<span class="syn">server</span>]</span>]</span>]</span></code></pre></div> + + + +### Parameters ### + +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. + +### Description ### + +Displays historical user information. + +### Examples ### + + /WHOWAS + /WHOWAS mike + /WHOWAS bob 10 + /WHOWAS sarah 5 ircsource.irssi.org + +### See also ### +[CHANNEL](/documentation/help/channel), [NAMES](/documentation/help/names), [WHO](/documentation/help/who), [WHOIS](/documentation/help/whois) + diff --git a/documentation/help/window.markdown b/documentation/help/window.markdown new file mode 100644 index 0000000..19ad37c --- /dev/null +++ b/documentation/help/window.markdown @@ -0,0 +1,260 @@ +--- +layout: page +title: "Help: window" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/window.in +- https://github.com/irssi/irssi/blob/master/src/fe-common/core/fe-log.c +- https://github.com/irssi/irssi/blob/master/src/fe-common/core/window-commands.c +- https://github.com/irssi/irssi/blob/master/src/fe-text/mainwindows.c +- https://github.com/irssi/irssi/blob/master/src/fe-text/textbuffer-commands.c + + +{% endcomment %} +[Help index](/documentation/help) + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:10ch"><code><span class="synB">WINDOW</span> <span class="synB">LOG</span> <span class="synB">on</span>|<span class="synB">off</span>|<span class="synB">toggle</span> <span class="syn10">[<span class="syn09"><filename></span>]</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:14ch"><code><span class="synB">WINDOW</span> <span class="synB">LOGFILE</span> <span class="synB05"><file></span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:10ch"><code><span class="synB">WINDOW</span> <span class="synB">NEW</span> <span class="syn10">[<span class="syn">HIDDEN</span>|<span class="syn">SPLIT</span>|<span class="syn">RSPLIT</span>]</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:12ch"><code><span class="synB">WINDOW</span> <span class="synB">CLOSE</span> <span class="syn10">[<span class="syn09"><first></span> <span class="syn14">[<span class="syn13"><last></span>]</span>]</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:13ch"><code><span class="synB">WINDOW</span> <span class="synB">REFNUM</span> <span class="synB05"><number></span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:11ch"><code><span class="synB">WINDOW</span> <span class="synB">GOTO</span> <span class="synB">active</span>|<span class="synB05"><number></span>|<span class="synB05"><name></span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:10ch"><code><span class="synB">WINDOW</span> <span class="synB">NEXT</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:10ch"><code><span class="synB">WINDOW</span> <span class="synB">LAST</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:14ch"><code><span class="synB">WINDOW</span> <span class="synB">PREVIOUS</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:12ch"><code><span class="synB">WINDOW</span> <span class="synB">LEVEL</span> <span class="syn10">[<span class="syn09"><level></span>]</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:15ch"><code><span class="synB">WINDOW</span> <span class="synB">IMMORTAL</span> <span class="synB">on</span>|<span class="synB">off</span>|<span class="synB">toggle</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:13ch"><code><span class="synB">WINDOW</span> <span class="synB">SERVER</span> <span class="syn10">[<span class="syn">-sticky</span> | <span class="syn">-unsticky</span>]</span> <span class="synB05"><tag></span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:15ch"><code><span class="synB">WINDOW</span> <span class="synB">ITEM</span> <span class="synB">PREV</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:15ch"><code><span class="synB">WINDOW</span> <span class="synB">ITEM</span> <span class="synB">NEXT</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:16ch"><code><span class="synB">WINDOW</span> <span class="synB">ITEM</span> <span class="synB">GOTO</span> <span class="synB05"><number></span>|<span class="synB05"><name></span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:16ch"><code><span class="synB">WINDOW</span> <span class="synB">ITEM</span> <span class="synB">MOVE</span> <span class="synB05"><number></span>|<span class="synB05"><name></span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:13ch"><code><span class="synB">WINDOW</span> <span class="synB">NUMBER</span> <span class="syn10">[<span class="syn">-sticky</span>]</span> <span class="synB05"><number></span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:11ch"><code><span class="synB">WINDOW</span> <span class="synB">NAME</span> <span class="synB05"><name></span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:14ch"><code><span class="synB">WINDOW</span> <span class="synB">HISTORY</span> <span class="syn10">[<span class="syn">-clear</span>]</span> <span class="synB05"><name></span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:15ch"><code><span class="synB">WINDOW</span> <span class="synB">MOVE</span> <span class="synB">PREV</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:15ch"><code><span class="synB">WINDOW</span> <span class="synB">MOVE</span> <span class="synB">NEXT</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:16ch"><code><span class="synB">WINDOW</span> <span class="synB">MOVE</span> <span class="synB">FIRST</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:15ch"><code><span class="synB">WINDOW</span> <span class="synB">MOVE</span> <span class="synB">LAST</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:11ch"><code><span class="synB">WINDOW</span> <span class="synB">MOVE</span> <span class="synB05"><number></span>|<span class="synB05"><direction></span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:10ch"><code><span class="synB">WINDOW</span> <span class="synB">LIST</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:12ch"><code><span class="synB">WINDOW</span> <span class="synB">THEME</span> <span class="syn10">[<span class="syn">-delete</span>]</span> <span class="syn10">[<span class="syn09"><name></span>]</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:11ch"><code><span class="synB">WINDOW</span> <span class="synB">GROW</span> <span class="syn10">[<span class="syn09"><lines></span>]</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:13ch"><code><span class="synB">WINDOW</span> <span class="synB">SHRINK</span> <span class="syn10">[<span class="syn09"><lines></span>]</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:11ch"><code><span class="synB">WINDOW</span> <span class="synB">SIZE</span> <span class="synB05"><lines></span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:13ch"><code><span class="synB">WINDOW</span> <span class="synB">BALANCE</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:11ch"><code><span class="synB">WINDOW</span> <span class="synB">HIDE</span> <span class="syn10">[<span class="syn09"><number></span>|<span class="syn09"><name></span>]</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:11ch"><code><span class="synB">WINDOW</span> <span class="synB">SHOW</span> <span class="synB05"><number></span>|<span class="synB05"><name></span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:12ch"><code><span class="synB">WINDOW</span> <span class="synB">RSHOW</span> <span class="synB05"><number></span>|<span class="synB05"><name></span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:12ch"><code><span class="synB">WINDOW</span> <span class="synB">RGROW</span> <span class="syn10">[<span class="syn09"><columns></span>]</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:14ch"><code><span class="synB">WINDOW</span> <span class="synB">RSHRINK</span> <span class="syn10">[<span class="syn09"><lines></span>]</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:12ch"><code><span class="synB">WINDOW</span> <span class="synB">RSIZE</span> <span class="synB05"><columns></span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:14ch"><code><span class="synB">WINDOW</span> <span class="synB">RBALANCE</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:8ch"><code><span class="synB">WINDOW</span> <span class="synB">UP</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:9ch"><code><span class="synB">WINDOW</span> <span class="synB">DUP</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:11ch"><code><span class="synB">WINDOW</span> <span class="synB">DLEFT</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:10ch"><code><span class="synB">WINDOW</span> <span class="synB">DOWN</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:11ch"><code><span class="synB">WINDOW</span> <span class="synB">DDOWN</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:12ch"><code><span class="synB">WINDOW</span> <span class="synB">DRIGHT</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:10ch"><code><span class="synB">WINDOW</span> <span class="synB">LEFT</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:11ch"><code><span class="synB">WINDOW</span> <span class="synB">RIGHT</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:12ch"><code><span class="synB">WINDOW</span> <span class="synB">STICK</span> <span class="syn10">[<span class="syn09"><ref#></span>]</span> <span class="syn10">[<span class="syn">ON</span>|<span class="syn">OFF</span>]</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:15ch"><code><span class="synB">WINDOW</span> <span class="synB">MOVE</span> <span class="synB">LEFT</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:16ch"><code><span class="synB">WINDOW</span> <span class="synB">MOVE</span> <span class="synB">RIGHT</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:16ch"><code><span class="synB">WINDOW</span> <span class="synB">MOVE</span> <span class="synB">DLEFT</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:17ch"><code><span class="synB">WINDOW</span> <span class="synB">MOVE</span> <span class="synB">DRIGHT</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:13ch"><code><span class="synB">WINDOW</span> <span class="synB">MOVE</span> <span class="synB">UP</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:15ch"><code><span class="synB">WINDOW</span> <span class="synB">MOVE</span> <span class="synB">DOWN</span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:16ch"><code><span class="synB">WINDOW</span> <span class="synB">HIDELEVEL</span> <span class="syn10">[<span class="syn09"><level></span>]</span></code></pre></div> + + + +### Parameters ### + + +| `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 numer of lines. | +| `BALANCE`: | Balance the heights of all split windows. | +| `RGROW`: | Increase the width of the active split window by the specified number of columns. | +| `RSHRINK`: | Decrease the wodth of the active split window by the specified number of columns. | +| `RSIZE`: | Set the current split window width to the specified numer of columns. | +| `RBALANCE`: | Balance the widths of all split windows in this line. | +| `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. | +| `RSHOW`: | Show the window specified by number or item name as a new windows split to the right of the current window. 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 to the top. | +| `DUP`: | Set the split window above the current one active. At the top, wraps to the bottom. | +| `DDOWN`: | Set the split window below the current one active. At the bottom, wraps to the top. | +| `DLEFT`: | Set the split window left to the current one active. At the left, wraps to the right. | +| `DRIGHT`: | Set the split window right to the current one active. At the right, wraps to the 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. | +| `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 split window above. If no sticky group remains, the split window collapses. | +| `MOVE DOWN`: | Move the current window to the sticky group of the split window below. If no sticky group remains, the split window collapses. | +| `MOVE DLEFT`: | Move the current window to the sticky group of the split window to the left. If no sticky group remains, the split window collapses. | +| `MOVE DRIGHT`: | Move the current window to the sticky group of the split window to the right. If no sticky group remains, the split window collapses. | +{:.table.kv} + + 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. + +### Description ### + +Manipulates the window layout and positioning attributes. + +### Examples ### + + /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 LOGFILE ~/logs/notices.log + +### See also ### +[JOIN](/documentation/help/join), [LEVELS](/documentation/help/levels), [LOG](/documentation/help/log), [QUERY](/documentation/help/query) + diff --git a/documentation/index.markdown b/documentation/index.markdown index 34cb822..2e046d9 100644 --- a/documentation/index.markdown +++ b/documentation/index.markdown @@ -9,7 +9,7 @@ categories: [ _nav ] - [Frequently Asked Questions](faq) - [Startup How-To](startup) -- Check the built-in `/HELP`, it has all the details on command syntax +- [Check the built-in `/HELP`](help), it has all the details on command syntax - [Settings](settings) - [Design](//github.com/irssi/irssi/blob/master/docs/design.txt){:rel='external'} - [Manual](//github.com/irssi/irssi/blob/master/docs/manual.txt){:rel='external'}, a bit dated and unfinished |