diff options
| -rw-r--r-- | _tools/help2md.pl | 9 | ||||
| -rw-r--r-- | _tools/help2md.yml | 3 | ||||
| -rw-r--r-- | documentation/help/index.markdown | 7 | ||||
| -rw-r--r-- | documentation/help/index_(1.0).markdown | 7 | ||||
| -rw-r--r-- | documentation/help/index_(1.2).markdown | 13 | ||||
| -rw-r--r-- | documentation/help/network_(1.0).markdown | 2 | ||||
| -rw-r--r-- | documentation/help/otr.markdown | 119 | ||||
| -rw-r--r-- | documentation/help/server_(1.0).markdown | 2 | ||||
| -rw-r--r-- | documentation/help/statusbar.markdown | 2 | ||||
| -rw-r--r-- | documentation/help/statusbar_(1.2).markdown | 85 |
10 files changed, 244 insertions, 5 deletions
diff --git a/_tools/help2md.pl b/_tools/help2md.pl index 8dcd8e1..8d8cdda 100644 --- a/_tools/help2md.pl +++ b/_tools/help2md.pl @@ -72,7 +72,7 @@ sub _get_mv { $multiver_links = join ' - ', map { my $link; my $name = "v$_"; - my @latest = grep { version->parse("v$_") <= version->parse("v$ver") } @multiver; + my @latest = ($default_ver, (grep { version->parse("v$_") <= version->parse("v$ver") } @multiver)); if (version->parse("v$_") == version->parse("v".$latest[-1])) { $link = "[ $name ]"; } @@ -165,6 +165,13 @@ title: Help$ver_suffix_title_main --- These are the `/help` pages of the Irssi on-line help. +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/tree/master/docs/help/in +- https://github.com/irssi/irssi.github.io/blob/master/_tools/help2md.yml + +{% endcomment %} $multiver_links_main <div markdown="1" class="helpindex"> diff --git a/_tools/help2md.yml b/_tools/help2md.yml index f595112..1ad1f52 100644 --- a/_tools/help2md.yml +++ b/_tools/help2md.yml @@ -81,6 +81,9 @@ multiversion_pages: - page: window_split_moving versions: - 1.2 + - page: statusbar + versions: + - 1.2 - page: window versions: - 1.0 diff --git a/documentation/help/index.markdown b/documentation/help/index.markdown index 81dcead..56acffd 100644 --- a/documentation/help/index.markdown +++ b/documentation/help/index.markdown @@ -4,6 +4,13 @@ title: Help --- These are the `/help` pages of the Irssi on-line help. +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/tree/master/docs/help/in +- https://github.com/irssi/irssi.github.io/blob/master/_tools/help2md.yml + +{% endcomment %} [ [v1.0](/documentation/help/index_(1.0)) ] - [ v1.1 ] - [ [v1.2](/documentation/help/index_(1.2)) ] diff --git a/documentation/help/index_(1.0).markdown b/documentation/help/index_(1.0).markdown index ead7560..1b06c37 100644 --- a/documentation/help/index_(1.0).markdown +++ b/documentation/help/index_(1.0).markdown @@ -4,6 +4,13 @@ title: Help (1.0) --- These are the `/help` pages of the Irssi on-line help. +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/tree/master/docs/help/in +- https://github.com/irssi/irssi.github.io/blob/master/_tools/help2md.yml + +{% endcomment %} [ v1.0 ] - [ [v1.1](/documentation/help) ] - [ [v1.2](/documentation/help/index_(1.2)) ] diff --git a/documentation/help/index_(1.2).markdown b/documentation/help/index_(1.2).markdown index 6d97b8b..9097a1a 100644 --- a/documentation/help/index_(1.2).markdown +++ b/documentation/help/index_(1.2).markdown @@ -4,6 +4,13 @@ title: Help (1.2) --- These are the `/help` pages of the Irssi on-line help. +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/tree/master/docs/help/in +- https://github.com/irssi/irssi.github.io/blob/master/_tools/help2md.yml + +{% endcomment %} [ [v1.0](/documentation/help/index_(1.0)) ] - [ [v1.1](/documentation/help) ] - [ v1.2 ] @@ -73,6 +80,7 @@ These are the `/help` pages of the Irssi on-line help. * [notify](../notify) * [op](../op) * [oper](../oper) +* [otr](../otr) * [part](../part) * [ping](../ping) * [query](../query) @@ -97,7 +105,7 @@ These are the `/help` pages of the Irssi on-line help. * [squery](../squery) * [squit](../squit) * [stats](../stats) -* [statusbar](../statusbar) +* [statusbar](../statusbar_(1.2)) * [time](../time) * [toggle](../toggle) * [topic](../topic) @@ -193,7 +201,7 @@ These are the `/help` pages of the Irssi on-line help. * [reload](../reload) * [save](../save) * [set](../set) -* [statusbar](../statusbar) +* [statusbar](../statusbar_(1.2)) * [toggle](../toggle) * [unalias](../unalias) * [unignore](../unignore) @@ -312,6 +320,7 @@ These are the `/help` pages of the Irssi on-line help. * [flushbuffer](../flushbuffer) * [levels](../levels) +* [otr](../otr) * [rmrejoins](../rmrejoins) * [script](../script) diff --git a/documentation/help/network_(1.0).markdown b/documentation/help/network_(1.0).markdown index 2d725dd..f323b8e 100644 --- a/documentation/help/network_(1.0).markdown +++ b/documentation/help/network_(1.0).markdown @@ -77,5 +77,5 @@ prevent you from being kicked from the network due to flooding commands. /NETWORK REMOVE Freenode ### See also ### -[CHANNEL](/documentation/help/channel), [CONNECT](/documentation/help/connect), [SERVER](/documentation/help/server) +[CHANNEL](/documentation/help/channel), [CONNECT](/documentation/help/connect), [SERVER](/documentation/help/server_(1.0)) diff --git a/documentation/help/otr.markdown b/documentation/help/otr.markdown new file mode 100644 index 0000000..0861900 --- /dev/null +++ b/documentation/help/otr.markdown @@ -0,0 +1,119 @@ +--- +layout: page +title: "Help: otr" +--- + +{% comment %} + +Please submit changes to +- https://github.com/irssi/irssi/blob/master/docs/help/in/otr.in + + +{% endcomment %} +[Help index](/documentation/help) + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:3ch"><code><span class="synB">OTR</span> <span class="syn10">[<span class="syn">OPTION</span>]</span></code></pre></div> + + + +Command to control the OTR module. Without an option, /OTR INFO is printed. + +This help contains three sections which are <strong>options, quickstart and files.</strong> + +To add the OTR status bar (highly recommended): + +<strong>/statusbar window add otr</strong> + +<strong>Options:</strong> + +AUTH <secret> +Start or respond to an authentication process. + +AUTHQ <question> <secret> +Start a SMP authentication process. + +Example: <strong>/otr authq "My question is" "this is the secret"</strong> + +AUTHABORT +Abort an ongoing authentication process. + +CONTEXTS +List known contexts which basically list the known fingerprints and their +state. + +DEBUG +Turn on debugging. + +DISTRUST <fingerprint> +Distrust a specific fingerprint. This command can be done inside a private +window for which the current fingerprint of the other person will be used +or else set fp to a human readable OTR fingerprint available with the above +contexts command. + +Examples: <strong>/otr distrust 487FFADA 5073FEDD C5AB5C14 5BB6C1FF 6D40D48A</strong> + +FINISH +End the OTR session. This MUST be done inside a private conversation +window. + +FORGET <fingerprint> +Forget a specific fingerprint (deleted from the known fingerprints). The +behavior is the same as the distrust command explained above. + +GENKEY <name> +Generate OTR keys for a given account name. This is done automatically +if someone tries to establish a secure session. + +This process is done in a background worker and can take an arbitrary +amount of time. The completion is checked when another irssi event is +catched. + +HELP +Print this help. + +INFO +Display the OTR fingerprint(s) of all your account(s). + +INIT +Initialize an OTR conversation within a private conversation window. + +TRUST <fingerprint> +Trust a specific fingerprint. The behavior is the same as the forget and +distrust commands explained above. + +VERSION +Print the version of the OTR module. + +<strong>Quickstart:</strong> + +Start a private conversation with the person you want to initiate a secure session. Once in the private message window: + +<strong>/otr init</strong> + +Key generation should start if no key is found for your account name. Once the process is done, either type a message which should automatically start the session or redo the init command. + +Time to authenticate the person. Either use a shared secret exchange through phone or GPG-signed email or use the socialist millionaire problem mechanism (SMP) which is basically to ask a question for which the answer can only be known by the other person. + +<strong>/otr auth <shared-secret>%n OR %9/otr authq "A question" <shared-secret></strong> + +Or to respond to an authentication: + +<strong>/otr auth <secret></strong> + +<strong>Files:</strong> + +This otr modules creates a directory in <strong>$HOME/.irssi/otr</strong> and creates three files: + +* <strong>otr.key</strong> +Contains your OTR private key(s). NEVER shared this directory with someone +else unless you know what you are doing. + +* <strong>otr.fp</strong> +The known fingerprints with their _trust_ status. + +* %9otr.instag +Instance tag of the libotr. This should NEVER be copied to an other +computer. If unsure, just ignore this file. + +For more information on OTR, see https://otr.cypherpunks.ca/ + diff --git a/documentation/help/server_(1.0).markdown b/documentation/help/server_(1.0).markdown index aabf4f2..87940d2 100644 --- a/documentation/help/server_(1.0).markdown +++ b/documentation/help/server_(1.0).markdown @@ -104,5 +104,5 @@ method is applicable to the CONNECT parameter. /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) +[CHANNEL](/documentation/help/channel), [CONNECT](/documentation/help/connect), [DISCONNECT](/documentation/help/disconnect), [NETWORK](/documentation/help/network_(1.0)), [RECONNECT](/documentation/help/reconnect), [RMRECONNS](/documentation/help/rmreconns) diff --git a/documentation/help/statusbar.markdown b/documentation/help/statusbar.markdown index 0a6bd5e..76ffc8e 100644 --- a/documentation/help/statusbar.markdown +++ b/documentation/help/statusbar.markdown @@ -13,6 +13,8 @@ Please submit changes to {% endcomment %} [Help index](/documentation/help) +[ v1.1 ] - [ [v1.2](/documentation/help/statusbar_(1.2)) ] + ### 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> diff --git a/documentation/help/statusbar_(1.2).markdown b/documentation/help/statusbar_(1.2).markdown new file mode 100644 index 0000000..9a83e66 --- /dev/null +++ b/documentation/help/statusbar_(1.2).markdown @@ -0,0 +1,85 @@ +--- +layout: page +title: "Help: statusbar (1.2)" +--- + +{% 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/index_(1.2)) + +[ [v1.1](/documentation/help/statusbar) ] - [ v1.2 ] + +### Syntax ### + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:12ch"><code><span class="synB">STATUSBAR</span> <span class="synB">ADD</span>|<span class="synB">MODIFY</span> <span class="syn10">[<span class="syn">-disable</span> | <span class="syn">-nodisable</span>]</span> <span class="syn10">[<span class="syn">-type</span> <span class="syn">window</span>|<span class="syn">root</span>]</span> <span class="syn10">[<span class="syn">-placement</span> <span class="syn">top</span>|<span class="syn">bottom</span>]</span> <span class="syn10">[<span class="syn">-position</span> <span class="syn">#</span>]</span> <span class="syn10">[<span class="syn">-visible</span> <span class="syn">always</span>|<span class="syn">active</span>|<span class="syn">inactive</span>]</span> <span class="synB05"><statusbar></span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:15ch"><code><span class="synB">STATUSBAR</span> <span class="synB">RESET</span> <span class="synB05"><statusbar></span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:16ch"><code><span class="synB">STATUSBAR</span> <span class="synB">ADDITEM</span>|<span class="synB">MODIFYITEM</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> <span class="synB05"><statusbar></span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:20ch"><code><span class="synB">STATUSBAR</span> <span class="synB">REMOVEITEM</span> <span class="synB05"><item></span> <span class="synB05"><statusbar></span></code></pre></div> + + +<div class="highlight irssisyntax"><pre style="\-\-cmdlen:14ch"><code><span class="synB">STATUSBAR</span> <span class="synB">INFO</span> <span class="synB05"><statusbar></span></code></pre></div> + + + +### Parameters ### + + +| `ADD`: | Adds a statusbar to the list of statusbars. | +| `MODIFY`: | Modifies the configuration of a statusbar. | +| `RESET`: | Restores the default statusbar configuration. | +| `ADDITEM`: | Adds an item to the specified statusbar. It can be set to appear before/after another item and left/right aligned to a specified position on the screen. | +| `MODIFYITEM`: | Changes an item position inside a bar. | +| `REMOVEITEM`: | Removes an item from the specified statusbar. | +| `INFO`: | List the current details and items of the specified statusbar. | +{:.table.kv} + + +| `-disable`: | Removes a statusbar from the list. | +| `-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. | +| `-before`: | This item is added before the other item. | +| `-after`: | This item is added after the other item. | +| `-priority`: | When the statusbar items overflow, the item with the lowest priority is removed first | +| `-alignment`: | Display the item on the right side. | +{:.table.kv} + +Where statusbar 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 INFO window + /STATUSBAR REMOVEITEM time window + /STATUSBAR ADDITEM time window + /STATUSBAR RESET window + /STATUSBAR MODIFY -disable topic + /STATUSBAR MODIFY -nodisable topic + +### Remarks ### + +Statusbar syntax was changed in Irssi 1.2. The old syntax is still +accepted for backward compatibility, but no longer documented. + +### See also ### +[WINDOW](/documentation/help/window_(1.2)) + |