diff options
Diffstat (limited to 'documentation')
22 files changed, 1573 insertions, 0 deletions
diff --git a/documentation/help/bind.markdown b/documentation/help/bind.markdown index ba0d6a1..fea92a1 100644 --- a/documentation/help/bind.markdown +++ b/documentation/help/bind.markdown @@ -13,6 +13,8 @@ Please submit changes to {% endcomment %} [Help index](/documentation/help) +[ v1.1 ] - [ [v1.2](/documentation/help/bind_(1.2)) ] + ### 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> diff --git a/documentation/help/bind_(1.2).markdown b/documentation/help/bind_(1.2).markdown new file mode 100644 index 0000000..e49d2b2 --- /dev/null +++ b/documentation/help/bind_(1.2).markdown @@ -0,0 +1,56 @@ +--- +layout: page +title: "Help: bind (1.2)" +--- + +{% 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/index_(1.2)) + +[ [v1.1](/documentation/help/bind) ] - [ v1.2 ] + +### 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 class="syn">-reset</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. | +| `-reset`: | Reset a key to its default 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/index.markdown b/documentation/help/index.markdown index 55e86c2..81dcead 100644 --- a/documentation/help/index.markdown +++ b/documentation/help/index.markdown @@ -5,6 +5,8 @@ title: Help These are the `/help` pages of the Irssi on-line help. +[ [v1.0](/documentation/help/index_(1.0)) ] - [ v1.1 ] - [ [v1.2](/documentation/help/index_(1.2)) ] + <div markdown="1" class="helpindex"> * [accept](accept) diff --git a/documentation/help/index_(1.0).markdown b/documentation/help/index_(1.0).markdown new file mode 100644 index 0000000..ead7560 --- /dev/null +++ b/documentation/help/index_(1.0).markdown @@ -0,0 +1,319 @@ +--- +layout: page +title: Help (1.0) +--- + +These are the `/help` pages of the Irssi on-line help. + +[ v1.0 ] - [ [v1.1](/documentation/help) ] - [ [v1.2](/documentation/help/index_(1.2)) ] + +<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_(1.0)) +* [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_(1.0)) +* [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_(1.0)) + + +### Connection + +<div markdown="1" class="helpindex"> + +* [connect](../connect) +* [disconnect](../disconnect) +* [network](../network_(1.0)) +* [quit](../quit) +* [rawlog](../rawlog) +* [reconnect](../reconnect) +* [rmreconns](../rmreconns) +* [server](../server_(1.0)) + + +</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_(1.0)) +* [unquery](../unquery) + + +</div> + + +### Window Commands + +<div markdown="1" class="helpindex"> + +* [clear](../clear) +* [lastlog](../lastlog) +* [layout](../layout) +* [scrollback](../scrollback) +* [window](../window_(1.0)) + + +</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_(1.0)) + + +</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_(1.0)) +* [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/index_(1.2).markdown b/documentation/help/index_(1.2).markdown new file mode 100644 index 0000000..6d97b8b --- /dev/null +++ b/documentation/help/index_(1.2).markdown @@ -0,0 +1,319 @@ +--- +layout: page +title: Help (1.2) +--- + +These are the `/help` pages of the Irssi on-line help. + +[ [v1.0](/documentation/help/index_(1.0)) ] - [ [v1.1](/documentation/help) ] - [ v1.2 ] + +<div markdown="1" class="helpindex"> + +* [accept](../accept) +* [action](../action) +* [admin](../admin) +* [alias](../alias) +* [away](../away) +* [ban](../ban) +* [beep](../beep) +* [bind](../bind_(1.2)) +* [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_(1.2)) + + +### 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_(1.2)) + + +</div> + + +### Settings + +<div markdown="1" class="helpindex"> + +* [alias](../alias) +* [bind](../bind_(1.2)) +* [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_(1.2)) + + +</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/network.markdown b/documentation/help/network.markdown index 7ff8bff..44dda98 100644 --- a/documentation/help/network.markdown +++ b/documentation/help/network.markdown @@ -13,6 +13,8 @@ Please submit changes to {% endcomment %} [Help index](/documentation/help) +[ [v1.0](/documentation/help/network_(1.0)) ] - [ v1.1 ] + ### 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> diff --git a/documentation/help/network_(1.0).markdown b/documentation/help/network_(1.0).markdown new file mode 100644 index 0000000..2d725dd --- /dev/null +++ b/documentation/help/network_(1.0).markdown @@ -0,0 +1,81 @@ +--- +layout: page +title: "Help: network (1.0)" +--- + +{% 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/index_(1.0)) + +[ v1.0 ] - [ [v1.1](/documentation/help/network) ] + +### 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">-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. | +| `-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/server.markdown b/documentation/help/server.markdown index 4a1e819..e565227 100644 --- a/documentation/help/server.markdown +++ b/documentation/help/server.markdown @@ -16,6 +16,8 @@ Please submit changes to {% endcomment %} [Help index](/documentation/help) +[ [v1.0](/documentation/help/server_(1.0)) ] - [ v1.1 ] + ### 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> diff --git a/documentation/help/server_(1.0).markdown b/documentation/help/server_(1.0).markdown new file mode 100644 index 0000000..aabf4f2 --- /dev/null +++ b/documentation/help/server_(1.0).markdown @@ -0,0 +1,108 @@ +--- +layout: page +title: "Help: server (1.0)" +--- + +{% 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/index_(1.0)) + +[ v1.0 ] - [ [v1.1](/documentation/help/server) ] + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:6ch"><code><span class="synB">SERVER</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">-!</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 chat.freenode.net + /SERVER +chat.freenode.net + /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/window.markdown b/documentation/help/window.markdown index cb74092..173fdbc 100644 --- a/documentation/help/window.markdown +++ b/documentation/help/window.markdown @@ -15,6 +15,9 @@ Please submit changes to {% endcomment %} [Help index](/documentation/help) + +[ [v1.0](/documentation/help/window_(1.0)) ] - [ v1.1 ] - [ [v1.2](/documentation/help/window_(1.2)) ] + ### Subcommands diff --git a/documentation/help/window_(1.0).markdown b/documentation/help/window_(1.0).markdown new file mode 100644 index 0000000..8fe93f9 --- /dev/null +++ b/documentation/help/window_(1.0).markdown @@ -0,0 +1,156 @@ +--- +layout: page +title: "Help: window (1.0)" +--- + +{% 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 + + +{% endcomment %} +[Help index](/documentation/help/index_(1.0)) + +[ v1.0 ] - [ [v1.1](/documentation/help/window) ] - [ [v1.2](/documentation/help/window_(1.2)) ] + +### Subcommands + + +#### [window/split window creation](/documentation/help/window_creation) + +<div markdown="1" class="helpindex"> + +* window new +* window close +* window list +* window hide +* window show + +</div> + +#### [window changing](/documentation/help/window_changing) + +<div markdown="1" class="helpindex"> + +* window refnum +* window goto +* window next +* window last +* window previous +* window left +* window right + +</div> + +#### [window attribute manipulation](/documentation/help/window_properties_(1.0)) + +<div markdown="1" class="helpindex"> + +* window level +* window immortal +* window server +* window number +* window name +* window history +* window theme +* window stick + +</div> + +#### [window items](/documentation/help/window_items) + +<div markdown="1" class="helpindex"> + +* window item prev +* window item next +* window item goto +* window item move + +</div> + +#### [window moving/number changing](/documentation/help/window_moving) + +<div markdown="1" class="helpindex"> + +* window number +* window move prev +* window move next +* window move first +* window move last +* window move +* window move left +* window move right + +</div> + +#### [split window resizing](/documentation/help/window_resizing) + +<div markdown="1" class="helpindex"> + +* window grow +* window shrink +* window size +* window balance + +</div> + +#### [split window navigation](/documentation/help/window_navigation) + +<div markdown="1" class="helpindex"> + +* window up +* window down + +</div> + +#### [split window moving](/documentation/help/window_split_moving) + +<div markdown="1" class="helpindex"> + +* window stick +* window move up +* window move down + +</div> + +#### [logging](/documentation/help/window_logging) + +<div markdown="1" class="helpindex"> + +* window log +* window logfile + +</div> + + + +### Parameters ### + + + 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/help/window_(1.2).markdown b/documentation/help/window_(1.2).markdown new file mode 100644 index 0000000..c560d8b --- /dev/null +++ b/documentation/help/window_(1.2).markdown @@ -0,0 +1,169 @@ +--- +layout: page +title: "Help: window (1.2)" +--- + +{% 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/index_(1.2)) + +[ [v1.0](/documentation/help/window_(1.0)) ] - [ [v1.1](/documentation/help/window) ] - [ v1.2 ] + +### Subcommands + + +#### [window/split window creation](/documentation/help/window_creation_(1.2)) + +<div markdown="1" class="helpindex"> + +* window new +* window close +* window list +* window hide +* window show +* window rshow + +</div> + +#### [window changing](/documentation/help/window_changing) + +<div markdown="1" class="helpindex"> + +* window refnum +* window goto +* window next +* window last +* window previous +* window left +* window right + +</div> + +#### [window attribute manipulation](/documentation/help/window_properties) + +<div markdown="1" class="helpindex"> + +* window level +* window immortal +* window server +* window number +* window name +* window history +* window theme +* window stick +* window hidelevel + +</div> + +#### [window items](/documentation/help/window_items) + +<div markdown="1" class="helpindex"> + +* window item prev +* window item next +* window item goto +* window item move + +</div> + +#### [window moving/number changing](/documentation/help/window_moving) + +<div markdown="1" class="helpindex"> + +* window number +* window move prev +* window move next +* window move first +* window move last +* window move +* window move left +* window move right + +</div> + +#### [split window resizing](/documentation/help/window_resizing_(1.2)) + +<div markdown="1" class="helpindex"> + +* window grow +* window shrink +* window size +* window balance +* window rgrow +* window rshrink +* window rsize +* window rbalance + +</div> + +#### [split window navigation](/documentation/help/window_navigation_(1.2)) + +<div markdown="1" class="helpindex"> + +* window up +* window dup +* window dleft +* window down +* window ddown +* window dright + +</div> + +#### [split window moving](/documentation/help/window_split_moving_(1.2)) + +<div markdown="1" class="helpindex"> + +* window stick +* window move dleft +* window move dright +* window move up +* window move down + +</div> + +#### [logging](/documentation/help/window_logging) + +<div markdown="1" class="helpindex"> + +* window log +* window logfile + +</div> + + + +### Parameters ### + + + 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/help/window_creation.markdown b/documentation/help/window_creation.markdown index b4773fb..6612f86 100644 --- a/documentation/help/window_creation.markdown +++ b/documentation/help/window_creation.markdown @@ -18,6 +18,8 @@ Please submit changes to [Window subcommands index](/documentation/help/window) +[ v1.1 ] - [ [v1.2](/documentation/help/window_creation_(1.2)) ] + ### Syntax ### <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></code></pre></div> diff --git a/documentation/help/window_creation_(1.2).markdown b/documentation/help/window_creation_(1.2).markdown new file mode 100644 index 0000000..55b892a --- /dev/null +++ b/documentation/help/window_creation_(1.2).markdown @@ -0,0 +1,68 @@ +--- +layout: page +title: "Help: window/split window creation (1.2)" +--- + +{% 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/index_(1.2)) + +[Window subcommands index](/documentation/help/window_(1.2)) + +[ [v1.1](/documentation/help/window_creation) ] - [ v1.2 ] + +### Syntax ### + +<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:10ch"><code><span class="synB">WINDOW</span> <span class="synB">LIST</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> + + + +### Parameters ### + + +| `NEW`: | Creates a new hidden or split window. | +| `CLOSE`: | Closes the current window, the specified one or all windows in the given range. | +| `LIST`: | List all the windows. | +| `HIDE`: | Hides the current split window, or the split window specified by number or item name. | +| `SHOW`: | Show the window specified by number or item name as a new split windows. It is made sticky when autostick_split_windows is turned on. | +| `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. | +{:.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 NEW HIDDEN + +### See also ### +[JOIN](/documentation/help/join), [LEVELS](/documentation/help/levels), [LOG](/documentation/help/log), [QUERY](/documentation/help/query) + diff --git a/documentation/help/window_navigation.markdown b/documentation/help/window_navigation.markdown index 3149997..fe08149 100644 --- a/documentation/help/window_navigation.markdown +++ b/documentation/help/window_navigation.markdown @@ -18,6 +18,8 @@ Please submit changes to [Window subcommands index](/documentation/help/window) +[ v1.1 ] - [ [v1.2](/documentation/help/window_navigation_(1.2)) ] + ### Syntax ### <div class="highlight irssisyntax"><pre style="\-\-cmdlen:8ch"><code><span class="synB">WINDOW</span> <span class="synB">UP</span></code></pre></div> diff --git a/documentation/help/window_navigation_(1.2).markdown b/documentation/help/window_navigation_(1.2).markdown new file mode 100644 index 0000000..e07aff0 --- /dev/null +++ b/documentation/help/window_navigation_(1.2).markdown @@ -0,0 +1,66 @@ +--- +layout: page +title: "Help: window: split window navigation (1.2)" +--- + +{% 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/index_(1.2)) + +[Window subcommands index](/documentation/help/window_(1.2)) + +[ [v1.1](/documentation/help/window_navigation) ] - [ v1.2 ] + +### Syntax ### + +<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> + + + +### Parameters ### + + +| `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. | +{:.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 ### + + +### See also ### +[JOIN](/documentation/help/join), [LEVELS](/documentation/help/levels), [LOG](/documentation/help/log), [QUERY](/documentation/help/query) + diff --git a/documentation/help/window_properties.markdown b/documentation/help/window_properties.markdown index a023e97..013fd38 100644 --- a/documentation/help/window_properties.markdown +++ b/documentation/help/window_properties.markdown @@ -18,6 +18,8 @@ Please submit changes to [Window subcommands index](/documentation/help/window) +[ [v1.0](/documentation/help/window_navigation_(1.0)) ] - [ v1.1 ] + ### Syntax ### <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> diff --git a/documentation/help/window_properties_(1.0).markdown b/documentation/help/window_properties_(1.0).markdown new file mode 100644 index 0000000..f5be01f --- /dev/null +++ b/documentation/help/window_properties_(1.0).markdown @@ -0,0 +1,74 @@ +--- +layout: page +title: "Help: window attribute manipulation (1.0)" +--- + +{% 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 + + +{% endcomment %} +[Help index](/documentation/help/index_(1.0)) + +[Window subcommands index](/documentation/help/window_(1.0)) + +[ v1.0 ] - [ [v1.1](/documentation/help/window_properties) ] + +### Syntax ### + +<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: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: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: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> + + + +### Parameters ### + + +| `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 | +| `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. | +| `THEME`: | Applies or removes a per-window theme. | +| `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. | +{:.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 LEVEL -ALL +NOTICES + +### See also ### +[JOIN](/documentation/help/join), [LEVELS](/documentation/help/levels), [LOG](/documentation/help/log), [QUERY](/documentation/help/query) + diff --git a/documentation/help/window_resizing.markdown b/documentation/help/window_resizing.markdown index a8d70da..6551c8d 100644 --- a/documentation/help/window_resizing.markdown +++ b/documentation/help/window_resizing.markdown @@ -18,6 +18,8 @@ Please submit changes to [Window subcommands index](/documentation/help/window) +[ v1.1 ] - [ [v1.2](/documentation/help/window_resizing_(1.2)) ] + ### Syntax ### <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> diff --git a/documentation/help/window_resizing_(1.2).markdown b/documentation/help/window_resizing_(1.2).markdown new file mode 100644 index 0000000..55e025f --- /dev/null +++ b/documentation/help/window_resizing_(1.2).markdown @@ -0,0 +1,74 @@ +--- +layout: page +title: "Help: window: split window resizing (1.2)" +--- + +{% 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/index_(1.2)) + +[Window subcommands index](/documentation/help/window_(1.2)) + +[ [v1.1](/documentation/help/window_resizing) ] - [ v1.2 ] + +### Syntax ### + +<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: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> + + + +### Parameters ### + + +| `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. | +{:.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 ### + + +### See also ### +[JOIN](/documentation/help/join), [LEVELS](/documentation/help/levels), [LOG](/documentation/help/log), [QUERY](/documentation/help/query) + diff --git a/documentation/help/window_split_moving.markdown b/documentation/help/window_split_moving.markdown index 90c9d70..bbbe745 100644 --- a/documentation/help/window_split_moving.markdown +++ b/documentation/help/window_split_moving.markdown @@ -18,6 +18,8 @@ Please submit changes to [Window subcommands index](/documentation/help/window) +[ v1.1 ] - [ [v1.2](/documentation/help/window_split_moving_(1.2)) ] + ### Syntax ### <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> diff --git a/documentation/help/window_split_moving_(1.2).markdown b/documentation/help/window_split_moving_(1.2).markdown new file mode 100644 index 0000000..8deff44 --- /dev/null +++ b/documentation/help/window_split_moving_(1.2).markdown @@ -0,0 +1,62 @@ +--- +layout: page +title: "Help: window: split window moving (1.2)" +--- + +{% 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/index_(1.2)) + +[Window subcommands index](/documentation/help/window_(1.2)) + +[ [v1.1](/documentation/help/window_split_moving) ] - [ v1.2 ] + +### Syntax ### + +<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: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> + + + +### Parameters ### + + +| `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 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 ### + + +### See also ### +[JOIN](/documentation/help/join), [LEVELS](/documentation/help/levels), [LOG](/documentation/help/log), [QUERY](/documentation/help/query) + |