summaryrefslogtreecommitdiff
path: root/doc/en/autogen
diff options
context:
space:
mode:
authorSebastien Helleu <flashcode@flashtux.org>2012-07-27 17:54:08 +0200
committerSebastien Helleu <flashcode@flashtux.org>2012-07-27 17:54:08 +0200
commit782e01f17798478322f7634c43d35653e92c2b2a (patch)
tree9babde108b57ca7a5b1014e4b5e2f357805ab8a4 /doc/en/autogen
parent32b8f345673f5eb736a27090e98de808f6e7fda2 (diff)
downloadweechat-782e01f17798478322f7634c43d35653e92c2b2a.zip
relay: add support of SSL (for irc and weechat protocols), new option relay.network.ssl_cert_key (task #12044)
Diffstat (limited to 'doc/en/autogen')
-rw-r--r--doc/en/autogen/user/irc_options.txt4
-rw-r--r--doc/en/autogen/user/relay_commands.txt9
-rw-r--r--doc/en/autogen/user/relay_options.txt16
-rw-r--r--doc/en/autogen/user/xfer_options.txt6
4 files changed, 26 insertions, 9 deletions
diff --git a/doc/en/autogen/user/irc_options.txt b/doc/en/autogen/user/irc_options.txt
index bef128d0b..f12df01a0 100644
--- a/doc/en/autogen/user/irc_options.txt
+++ b/doc/en/autogen/user/irc_options.txt
@@ -509,7 +509,7 @@
** values: on, off (default value: `off`)
* [[option_irc.server_default.ssl_cert]] *irc.server_default.ssl_cert*
-** description: `ssl certificate file used to automatically identify your nick ("%h" will be replaced by WeeChat home, "~/.weechat" by default)`
+** description: `SSL certificate file used to automatically identify your nick ("%h" will be replaced by WeeChat home, "~/.weechat" by default)`
** type: string
** values: any string (default value: `""`)
@@ -524,7 +524,7 @@
** values: any string (default value: `"NORMAL"`)
* [[option_irc.server_default.ssl_verify]] *irc.server_default.ssl_verify*
-** description: `check that the ssl connection is fully trusted`
+** description: `check that the SSL connection is fully trusted`
** type: boolean
** values: on, off (default value: `on`)
diff --git a/doc/en/autogen/user/relay_commands.txt b/doc/en/autogen/user/relay_commands.txt
index 94b7b6a1e..ff8cdef5c 100644
--- a/doc/en/autogen/user/relay_commands.txt
+++ b/doc/en/autogen/user/relay_commands.txt
@@ -5,6 +5,7 @@
add <protocol.name> <port>
del <protocol.name>
raw
+ sslcertkey
list: list relay clients (only active relays)
listfull: list relay clients (verbose, all relays)
@@ -14,15 +15,21 @@
protocol.name: protocol and name to relay:
- protocol "irc": name is the server to share
- protocol "weechat" (name is not used)
+ Note: the protocol can be prefixed by "ssl." to enable SSL
port: port used for relay
raw: open buffer with raw Relay data
+ sslcertkey: set SSL certificate/key using path in option relay.network.ssl_cert_key
Without argument, this command opens buffer with list of relay clients.
Examples:
irc proxy, for server "freenode":
/relay add irc.freenode 8000
+ irc proxy, for server "freenode", with SSL:
+ /relay add ssl.irc.freenode 8001
weechat protocol:
- /relay add weechat 8001
+ /relay add weechat 9000
+ weechat protocol with SSL:
+ /relay add ssl.weechat 9001
........................................
diff --git a/doc/en/autogen/user/relay_options.txt b/doc/en/autogen/user/relay_options.txt
index a3cf672c9..60383fc62 100644
--- a/doc/en/autogen/user/relay_options.txt
+++ b/doc/en/autogen/user/relay_options.txt
@@ -1,3 +1,8 @@
+* [[option_relay.color.client]] *relay.color.client*
+** description: `text color for client description`
+** type: color
+** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: `cyan`)
+
* [[option_relay.color.status_active]] *relay.color.status_active*
** description: `text color for "connected" status`
** type: color
@@ -24,17 +29,17 @@
** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: `brown`)
* [[option_relay.color.text]] *relay.color.text*
-** description: `text color`
+** description: `text color in relay buffer`
** type: color
** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: `default`)
* [[option_relay.color.text_bg]] *relay.color.text_bg*
-** description: `background color`
+** description: `background color in relay buffer`
** type: color
** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: `default`)
* [[option_relay.color.text_selected]] *relay.color.text_selected*
-** description: `text color of selected client line`
+** description: `text color of selected line in relay buffer`
** type: color
** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: `white`)
@@ -73,3 +78,8 @@
** type: string
** values: any string (default value: `""`)
+* [[option_relay.network.ssl_cert_key]] *relay.network.ssl_cert_key*
+** description: `file with SSL certificate and private key (for serving clients with SSL)`
+** type: string
+** values: any string (default value: `"%h/ssl/relay.pem"`)
+
diff --git a/doc/en/autogen/user/xfer_options.txt b/doc/en/autogen/user/xfer_options.txt
index c92550512..12c35b67d 100644
--- a/doc/en/autogen/user/xfer_options.txt
+++ b/doc/en/autogen/user/xfer_options.txt
@@ -29,17 +29,17 @@
** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: `lightcyan`)
* [[option_xfer.color.text]] *xfer.color.text*
-** description: `text color`
+** description: `text color in xfer buffer`
** type: color
** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: `default`)
* [[option_xfer.color.text_bg]] *xfer.color.text_bg*
-** description: `background color`
+** description: `background color in xfer buffer`
** type: color
** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: `default`)
* [[option_xfer.color.text_selected]] *xfer.color.text_selected*
-** description: `text color of selected xfer line`
+** description: `text color of selected line in xfer buffer`
** type: color
** values: a WeeChat color name (default, black, (dark)gray, white, (light)red, (light)green, brown, yellow, (light)blue, (light)magenta, (light)cyan), a terminal color number or an alias; attributes are allowed before color (for text color only, not background): "*" for bold, "!" for reverse, "_" for underline (default value: `white`)