diff options
author | Sébastien Helleu <flashcode@flashtux.org> | 2014-05-25 12:25:58 +0200 |
---|---|---|
committer | Sébastien Helleu <flashcode@flashtux.org> | 2014-05-25 12:47:24 +0200 |
commit | dc0229617ada67fd02815bbc94b245871248b9db (patch) | |
tree | 0af7418d7f3ebf8082408fa2ee9e73f5a572360f /doc/en/autogen/user/sec_options.asciidoc | |
parent | 76a066c9cca620e1204815f63abbfa8b09f162c6 (diff) | |
download | weechat-dc0229617ada67fd02815bbc94b245871248b9db.zip |
doc: use .asciidoc extension instead of .txt for doc files
Diffstat (limited to 'doc/en/autogen/user/sec_options.asciidoc')
-rw-r--r-- | doc/en/autogen/user/sec_options.asciidoc | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/en/autogen/user/sec_options.asciidoc b/doc/en/autogen/user/sec_options.asciidoc new file mode 100644 index 000000000..623b13153 --- /dev/null +++ b/doc/en/autogen/user/sec_options.asciidoc @@ -0,0 +1,20 @@ +* [[option_sec.crypt.cipher]] *sec.crypt.cipher* +** description: `cipher used to crypt data (the number after algorithm is the size of the key in bits)` +** type: integer +** values: aes128, aes192, aes256 (default value: `aes256`) + +* [[option_sec.crypt.hash_algo]] *sec.crypt.hash_algo* +** description: `hash algorithm used to check the decrypted data` +** type: integer +** values: sha224, sha256, sha384, sha512 (default value: `sha256`) + +* [[option_sec.crypt.passphrase_file]] *sec.crypt.passphrase_file* +** description: `path to a file containing the passphrase to encrypt/decrypt secured data; this option is used only when reading file sec.conf; only first line of file is used; this file is used only if the environment variable "WEECHAT_PASSPHRASE" is not set (the environment variable has higher priority); security note: it is recommended to keep this file readable only by you and store it outside WeeChat home (for example in your home); example: "~/.weechat-passphrase"` +** type: string +** values: any string (default value: `""`) + +* [[option_sec.crypt.salt]] *sec.crypt.salt* +** description: `use salt when generating key used in encryption (recommended for maximum security); when enabled, the content of crypted data in file sec.conf will be different on each write of the file; if you put the file sec.conf in a version control system, then you can turn off this option to have always same content in file` +** type: boolean +** values: on, off (default value: `on`) + |