doc: add a chapter about WeeChat files and directories in user's guide

6 files changed, 373 insertions, 0 deletions

diff --git a/doc/de/weechat_user.de.adoc b/doc/de/weechat_user.de.adoc
index a73c969a1..6f76ff325 100644
--- a/doc/de/weechat_user.de.adoc
+++ b/doc/de/weechat_user.de.adoc
@@ -476,6 +476,68 @@ Die Einstellungen für WeeChat können an die eigenen Bedürfnisse angepasst wer
 Veränderungen an der Konfigurationsdatei mit dem internen Befehl `/set` durchführt werden. (siehe
 <<weechat_commands,WeeChat Befehle>>).
 
+[[files_and_directories]]
+=== Files and directories
+
+WeeChat writes configuration files and other data in directory `~/.weechat`
+by default.
+
+The directories are:
+
+[width="100%",cols="1m,3",options="header"]
+|===
+| Path/file         | Description
+| ~/.weechat/       | WeeChat home directory (can be changed, see <<running_weechat,Running WeeChat>>)
+|    logs/          | Log files (one file per buffer)
+|    python/        | Python scripts
+|       autoload/   | Python scripts auto-loaded on startup ^(1)^
+|    perl/          | Perl scripts
+|       autoload/   | Perl scripts auto-loaded on startup ^(1)^
+|    ruby/          | Ruby scripts
+|       autoload/   | Ruby scripts auto-loaded on startup ^(1)^
+|    lua/           | Lua scripts
+|       autoload/   | Lua scripts auto-loaded on startup ^(1)^
+|    tcl/           | Tcl scripts
+|       autoload/   | Tcl scripts auto-loaded on startup ^(1)^
+|    guile/         | Guile scripts
+|       autoload/   | Guile scripts auto-loaded on startup ^(1)^
+|    javascript/    | Javascript scripts
+|       autoload/   | Javascript scripts auto-loaded on startup ^(1)^
+|===
+
+[NOTE]
+^(1)^ This directory often contains only symbolic links to scripts in parent directory.
+
+The files in home directory are:
+
+[width="100%",cols="1m,3,6",options="header"]
+|===
+| File         | Description                             | Sensitive data
+| weechat.conf | Main WeeChat configuration file         | Possible (example: list of channels in a saved buffers layout)
+| sec.conf     | Configuration file with secured data    | *Yes, highly sensitive*: this file must never be shared with anyone
+| plugins.conf | Plugins configuration file              | Possible, depends on plugins/scripts
+| alias.conf   | Configuration file for _alias_ plugin   | Possible, depends on aliases
+| aspell.conf  | Configuration file for _aspell_ plugin  | No
+| charset.conf | Configuration file for _charset_ plugin | No
+| exec.conf    | Configuration file for _exec_ plugin    | No
+| irc.conf     | Configuration file for _irc_ plugin     | *Yes*: it can contain passwords for servers, nickserv and channels (if not stored in `sec.conf`)
+| logger.conf  | Configuration file for _logger_ plugin  | No
+| relay.conf   | Configuration file for _relay_ plugin   | No
+| script.conf  | Configuration file for _script_ plugin  | No
+| trigger.conf | Configuration file for _trigger_ plugin | Possible, depends on triggers
+| xfer.conf    | Configuration file for _xfer_ plugin    | No
+| weechat.log  | WeeChat log file                        | No
+|===
+
+[IMPORTANT]
+It is *not recommended* to edit configuration files by hand because WeeChat
+may write them at any time (for example on <<command_weechat_quit,/quit>>)
+and after any change you must run the command <<command_weechat_reload,/reload>>
+(with the risk of loosing other changes that were not yet saved with
+<<command_weechat_save,/save>>). +
+You can use the command <<command_weechat_set,/set>>, which checks the value
+and applies immediately the changes.
+
 [[screen_layout]]
 === Screen layout
 
diff --git a/doc/en/weechat_user.en.adoc b/doc/en/weechat_user.en.adoc
index ba02a1f7d..f070ed1e5 100644
--- a/doc/en/weechat_user.en.adoc
+++ b/doc/en/weechat_user.en.adoc
@@ -469,6 +469,68 @@ You can edit this file at your convenience to configure WeeChat or you can set
 parameters with `/set` command in WeeChat (see
 <<weechat_commands,WeeChat commands>>).
 
+[[files_and_directories]]
+=== Files and directories
+
+WeeChat writes configuration files and other data in directory `~/.weechat`
+by default.
+
+The directories are:
+
+[width="100%",cols="1m,3",options="header"]
+|===
+| Path/file         | Description
+| ~/.weechat/       | WeeChat home directory (can be changed, see <<running_weechat,Running WeeChat>>)
+|    logs/          | Log files (one file per buffer)
+|    python/        | Python scripts
+|       autoload/   | Python scripts auto-loaded on startup ^(1)^
+|    perl/          | Perl scripts
+|       autoload/   | Perl scripts auto-loaded on startup ^(1)^
+|    ruby/          | Ruby scripts
+|       autoload/   | Ruby scripts auto-loaded on startup ^(1)^
+|    lua/           | Lua scripts
+|       autoload/   | Lua scripts auto-loaded on startup ^(1)^
+|    tcl/           | Tcl scripts
+|       autoload/   | Tcl scripts auto-loaded on startup ^(1)^
+|    guile/         | Guile scripts
+|       autoload/   | Guile scripts auto-loaded on startup ^(1)^
+|    javascript/    | Javascript scripts
+|       autoload/   | Javascript scripts auto-loaded on startup ^(1)^
+|===
+
+[NOTE]
+^(1)^ This directory often contains only symbolic links to scripts in parent directory.
+
+The files in home directory are:
+
+[width="100%",cols="1m,3,6",options="header"]
+|===
+| File         | Description                             | Sensitive data
+| weechat.conf | Main WeeChat configuration file         | Possible (example: list of channels in a saved buffers layout)
+| sec.conf     | Configuration file with secured data    | *Yes, highly sensitive*: this file must never be shared with anyone
+| plugins.conf | Plugins configuration file              | Possible, depends on plugins/scripts
+| alias.conf   | Configuration file for _alias_ plugin   | Possible, depends on aliases
+| aspell.conf  | Configuration file for _aspell_ plugin  | No
+| charset.conf | Configuration file for _charset_ plugin | No
+| exec.conf    | Configuration file for _exec_ plugin    | No
+| irc.conf     | Configuration file for _irc_ plugin     | *Yes*: it can contain passwords for servers, nickserv and channels (if not stored in `sec.conf`)
+| logger.conf  | Configuration file for _logger_ plugin  | No
+| relay.conf   | Configuration file for _relay_ plugin   | No
+| script.conf  | Configuration file for _script_ plugin  | No
+| trigger.conf | Configuration file for _trigger_ plugin | Possible, depends on triggers
+| xfer.conf    | Configuration file for _xfer_ plugin    | No
+| weechat.log  | WeeChat log file                        | No
+|===
+
+[IMPORTANT]
+It is *not recommended* to edit configuration files by hand because WeeChat
+may write them at any time (for example on <<command_weechat_quit,/quit>>)
+and after any change you must run the command <<command_weechat_reload,/reload>>
+(with the risk of loosing other changes that were not yet saved with
+<<command_weechat_save,/save>>). +
+You can use the command <<command_weechat_set,/set>>, which checks the value
+and applies immediately the changes.
+
 [[screen_layout]]
 === Screen layout
 
diff --git a/doc/fr/weechat_user.fr.adoc b/doc/fr/weechat_user.fr.adoc
index 5f106bae8..a98949965 100644
--- a/doc/fr/weechat_user.fr.adoc
+++ b/doc/fr/weechat_user.fr.adoc
@@ -478,6 +478,69 @@ Vous pouvez éditer ce fichier pour configurer WeeChat à votre convenance ou
 vous pouvez modifier les paramètres dans WeeChat avec la commande `/set`
 (voir <<weechat_commands,commandes WeeChat>>).
 
+[[files_and_directories]]
+=== Fichiers et répertoires
+
+WeeChat écrit ses fichiers de configuration et les autres données dans
+`~/.weechat` par défaut.
+
+Les répertoires sont :
+
+[width="100%",cols="1m,3",options="header"]
+|===
+| Chemin/fichier    | Description
+| ~/.weechat/       | Répertoire principal de WeeChat (peut être changé, voir <<running_weechat,Lancer WeeChat>>)
+|    logs/          | Fichiers de log (un fichier par tampon)
+|    python/        | Scripts Python
+|       autoload/   | Scripts Python chargés automatiquement au démarrage ^(1)^
+|    perl/          | Perl scripts
+|       autoload/   | Scripts Perl chargés automatiquement au démarrage ^(1)^
+|    ruby/          | Ruby scripts
+|       autoload/   | Scripts Ruby chargés automatiquement au démarrage ^(1)^
+|    lua/           | Lua scripts
+|       autoload/   | Scripts Lua chargés automatiquement au démarrage ^(1)^
+|    tcl/           | Tcl scripts
+|       autoload/   | Scripts Tcl chargés automatiquement au démarrage ^(1)^
+|    guile/         | Guile scripts
+|       autoload/   | Scripts Guile chargés automatiquement au démarrage ^(1)^
+|    javascript/    | Javascript scripts
+|       autoload/   | Scripts Javascript chargés automatiquement au démarrage ^(1)^
+|===
+
+[NOTE]
+^(1)^ Ce répertoire contient souvent seulement des liens symboliques vers les
+scripts dans le répertoire parent.
+
+Les fichiers dans le répertoire principal sont :
+
+[width="100%",cols="1m,3,6",options="header"]
+|===
+| Fichier      | Description                                          | Données sensibles
+| weechat.conf | Fichier de configuration principal de WeeChat        | Possible (par exemple : liste des canaux sauvés dans la disposition des tampons)
+| sec.conf     | Fichier de configuration avec les données sécurisées | *Oui, très sensibles*: ce fichier ne doit jamais être partagé avec quiconque
+| plugins.conf | Fichier de configuration des extensions              | Possible, cela dépend des extensions/scripts
+| alias.conf   | Fichier de configuration de l'extension _alias_      | Possible, cela dépend des alias
+| aspell.conf  | Fichier de configuration de l'extension _aspell_     | Non
+| charset.conf | Fichier de configuration de l'extension _charset_    | No,
+| exec.conf    | Fichier de configuration de l'extension _exec_       | No,
+| irc.conf     | Fichier de configuration de l'extension _irc_        | *Oui*: il peut contenir des mots de passes pour les serveurs, nickserv et les canaux (si non stockés dans `sec.conf`)
+| logger.conf  | Fichier de configuration de l'extension _logger_     | Non
+| relay.conf   | Fichier de configuration de l'extension _relay_      | Non
+| script.conf  | Fichier de configuration de l'extension _script_     | Non
+| trigger.conf | Fichier de configuration de l'extension _trigger_    | Possible, cela dépend des triggers
+| xfer.conf    | Fichier de configuration de l'extension _xfer_       | Non
+| weechat.log  | Fichier de log WeeChat                               | Non
+|===
+
+[IMPORTANT]
+Il n'est *pas recommandé* de modifier les fichiers de configuration à la main
+car WeeChat peut les écrire à tout moment (par exemple sur
+<<command_weechat_quit,/quit>>) et après chaque changement vous devez lancer la
+commande <<command_weechat_reload,/reload>> (avec le risque de perdre d'autres
+changements qui n'auraient pas été sauvés avec <<command_weechat_save,/save>>). +
+Vous pouvez utiliser la commande <<command_weechat_set,/set>>, qui vérifie la
+valeur et applique les changements immédiatement.
+
 [[screen_layout]]
 === Organisation de l'écran
 
diff --git a/doc/it/weechat_user.it.adoc b/doc/it/weechat_user.it.adoc
index f5bbbfda4..524a7da03 100644
--- a/doc/it/weechat_user.it.adoc
+++ b/doc/it/weechat_user.it.adoc
@@ -505,6 +505,68 @@ _~/.weechat/weechat.conf_.
 proprie esigenze, oppure impostando i parametri con il comando `/set`
 all'interno di WeeChat (consultare <<weechat_commands,comandi di WeeChat>>).
 
+[[files_and_directories]]
+=== Files and directories
+
+WeeChat writes configuration files and other data in directory `~/.weechat`
+by default.
+
+The directories are:
+
+[width="100%",cols="1m,3",options="header"]
+|===
+| Path/file         | Description
+| ~/.weechat/       | WeeChat home directory (can be changed, see <<running_weechat,Running WeeChat>>)
+|    logs/          | Log files (one file per buffer)
+|    python/        | Python scripts
+|       autoload/   | Python scripts auto-loaded on startup ^(1)^
+|    perl/          | Perl scripts
+|       autoload/   | Perl scripts auto-loaded on startup ^(1)^
+|    ruby/          | Ruby scripts
+|       autoload/   | Ruby scripts auto-loaded on startup ^(1)^
+|    lua/           | Lua scripts
+|       autoload/   | Lua scripts auto-loaded on startup ^(1)^
+|    tcl/           | Tcl scripts
+|       autoload/   | Tcl scripts auto-loaded on startup ^(1)^
+|    guile/         | Guile scripts
+|       autoload/   | Guile scripts auto-loaded on startup ^(1)^
+|    javascript/    | Javascript scripts
+|       autoload/   | Javascript scripts auto-loaded on startup ^(1)^
+|===
+
+[NOTE]
+^(1)^ This directory often contains only symbolic links to scripts in parent directory.
+
+The files in home directory are:
+
+[width="100%",cols="1m,3,6",options="header"]
+|===
+| File         | Description                             | Sensitive data
+| weechat.conf | Main WeeChat configuration file         | Possible (example: list of channels in a saved buffers layout)
+| sec.conf     | Configuration file with secured data    | *Yes, highly sensitive*: this file must never be shared with anyone
+| plugins.conf | Plugins configuration file              | Possible, depends on plugins/scripts
+| alias.conf   | Configuration file for _alias_ plugin   | Possible, depends on aliases
+| aspell.conf  | Configuration file for _aspell_ plugin  | No
+| charset.conf | Configuration file for _charset_ plugin | No
+| exec.conf    | Configuration file for _exec_ plugin    | No
+| irc.conf     | Configuration file for _irc_ plugin     | *Yes*: it can contain passwords for servers, nickserv and channels (if not stored in `sec.conf`)
+| logger.conf  | Configuration file for _logger_ plugin  | No
+| relay.conf   | Configuration file for _relay_ plugin   | No
+| script.conf  | Configuration file for _script_ plugin  | No
+| trigger.conf | Configuration file for _trigger_ plugin | Possible, depends on triggers
+| xfer.conf    | Configuration file for _xfer_ plugin    | No
+| weechat.log  | WeeChat log file                        | No
+|===
+
+[IMPORTANT]
+It is *not recommended* to edit configuration files by hand because WeeChat
+may write them at any time (for example on <<command_weechat_quit,/quit>>)
+and after any change you must run the command <<command_weechat_reload,/reload>>
+(with the risk of loosing other changes that were not yet saved with
+<<command_weechat_save,/save>>). +
+You can use the command <<command_weechat_set,/set>>, which checks the value
+and applies immediately the changes.
+
 [[screen_layout]]
 === Layout dello schermo
 
diff --git a/doc/ja/weechat_user.ja.adoc b/doc/ja/weechat_user.ja.adoc
index eb5cb0e11..6b5b881cc 100644
--- a/doc/ja/weechat_user.ja.adoc
+++ b/doc/ja/weechat_user.ja.adoc
@@ -472,6 +472,68 @@ WeeChat を設定するにはこのファイルを編集するか、WeeChat
 内で `/set` コマンドにパラメータを付けて設定します
 (<<weechat_commands,WeeChat コマンド>>を参照)。
 
+[[files_and_directories]]
+=== Files and directories
+
+WeeChat writes configuration files and other data in directory `~/.weechat`
+by default.
+
+The directories are:
+
+[width="100%",cols="1m,3",options="header"]
+|===
+| Path/file         | Description
+| ~/.weechat/       | WeeChat home directory (can be changed, see <<running_weechat,Running WeeChat>>)
+|    logs/          | Log files (one file per buffer)
+|    python/        | Python scripts
+|       autoload/   | Python scripts auto-loaded on startup ^(1)^
+|    perl/          | Perl scripts
+|       autoload/   | Perl scripts auto-loaded on startup ^(1)^
+|    ruby/          | Ruby scripts
+|       autoload/   | Ruby scripts auto-loaded on startup ^(1)^
+|    lua/           | Lua scripts
+|       autoload/   | Lua scripts auto-loaded on startup ^(1)^
+|    tcl/           | Tcl scripts
+|       autoload/   | Tcl scripts auto-loaded on startup ^(1)^
+|    guile/         | Guile scripts
+|       autoload/   | Guile scripts auto-loaded on startup ^(1)^
+|    javascript/    | Javascript scripts
+|       autoload/   | Javascript scripts auto-loaded on startup ^(1)^
+|===
+
+[NOTE]
+^(1)^ This directory often contains only symbolic links to scripts in parent directory.
+
+The files in home directory are:
+
+[width="100%",cols="1m,3,6",options="header"]
+|===
+| File         | Description                             | Sensitive data
+| weechat.conf | Main WeeChat configuration file         | Possible (example: list of channels in a saved buffers layout)
+| sec.conf     | Configuration file with secured data    | *Yes, highly sensitive*: this file must never be shared with anyone
+| plugins.conf | Plugins configuration file              | Possible, depends on plugins/scripts
+| alias.conf   | Configuration file for _alias_ plugin   | Possible, depends on aliases
+| aspell.conf  | Configuration file for _aspell_ plugin  | No
+| charset.conf | Configuration file for _charset_ plugin | No
+| exec.conf    | Configuration file for _exec_ plugin    | No
+| irc.conf     | Configuration file for _irc_ plugin     | *Yes*: it can contain passwords for servers, nickserv and channels (if not stored in `sec.conf`)
+| logger.conf  | Configuration file for _logger_ plugin  | No
+| relay.conf   | Configuration file for _relay_ plugin   | No
+| script.conf  | Configuration file for _script_ plugin  | No
+| trigger.conf | Configuration file for _trigger_ plugin | Possible, depends on triggers
+| xfer.conf    | Configuration file for _xfer_ plugin    | No
+| weechat.log  | WeeChat log file                        | No
+|===
+
+[IMPORTANT]
+It is *not recommended* to edit configuration files by hand because WeeChat
+may write them at any time (for example on <<command_weechat_quit,/quit>>)
+and after any change you must run the command <<command_weechat_reload,/reload>>
+(with the risk of loosing other changes that were not yet saved with
+<<command_weechat_save,/save>>). +
+You can use the command <<command_weechat_set,/set>>, which checks the value
+and applies immediately the changes.
+
 [[screen_layout]]
 === 画面レイアウト
 
diff --git a/doc/pl/weechat_user.pl.adoc b/doc/pl/weechat_user.pl.adoc
index b82107254..f10f5410e 100644
--- a/doc/pl/weechat_user.pl.adoc
+++ b/doc/pl/weechat_user.pl.adoc
@@ -476,6 +476,68 @@ Możesz edytować ten plik wedle upodobań, żeby skonfigurować WeeChat, lub mo
 ustawić parametry za pomocą komendy `/set` z poziomu WeeChat (zobacz
 <<weechat_commands,Komendy WeeChat>>).
 
+[[files_and_directories]]
+=== Files and directories
+
+WeeChat writes configuration files and other data in directory `~/.weechat`
+by default.
+
+The directories are:
+
+[width="100%",cols="1m,3",options="header"]
+|===
+| Path/file         | Description
+| ~/.weechat/       | WeeChat home directory (can be changed, see <<running_weechat,Running WeeChat>>)
+|    logs/          | Log files (one file per buffer)
+|    python/        | Python scripts
+|       autoload/   | Python scripts auto-loaded on startup ^(1)^
+|    perl/          | Perl scripts
+|       autoload/   | Perl scripts auto-loaded on startup ^(1)^
+|    ruby/          | Ruby scripts
+|       autoload/   | Ruby scripts auto-loaded on startup ^(1)^
+|    lua/           | Lua scripts
+|       autoload/   | Lua scripts auto-loaded on startup ^(1)^
+|    tcl/           | Tcl scripts
+|       autoload/   | Tcl scripts auto-loaded on startup ^(1)^
+|    guile/         | Guile scripts
+|       autoload/   | Guile scripts auto-loaded on startup ^(1)^
+|    javascript/    | Javascript scripts
+|       autoload/   | Javascript scripts auto-loaded on startup ^(1)^
+|===
+
+[NOTE]
+^(1)^ This directory often contains only symbolic links to scripts in parent directory.
+
+The files in home directory are:
+
+[width="100%",cols="1m,3,6",options="header"]
+|===
+| File         | Description                             | Sensitive data
+| weechat.conf | Main WeeChat configuration file         | Possible (example: list of channels in a saved buffers layout)
+| sec.conf     | Configuration file with secured data    | *Yes, highly sensitive*: this file must never be shared with anyone
+| plugins.conf | Plugins configuration file              | Possible, depends on plugins/scripts
+| alias.conf   | Configuration file for _alias_ plugin   | Possible, depends on aliases
+| aspell.conf  | Configuration file for _aspell_ plugin  | No
+| charset.conf | Configuration file for _charset_ plugin | No
+| exec.conf    | Configuration file for _exec_ plugin    | No
+| irc.conf     | Configuration file for _irc_ plugin     | *Yes*: it can contain passwords for servers, nickserv and channels (if not stored in `sec.conf`)
+| logger.conf  | Configuration file for _logger_ plugin  | No
+| relay.conf   | Configuration file for _relay_ plugin   | No
+| script.conf  | Configuration file for _script_ plugin  | No
+| trigger.conf | Configuration file for _trigger_ plugin | Possible, depends on triggers
+| xfer.conf    | Configuration file for _xfer_ plugin    | No
+| weechat.log  | WeeChat log file                        | No
+|===
+
+[IMPORTANT]
+It is *not recommended* to edit configuration files by hand because WeeChat
+may write them at any time (for example on <<command_weechat_quit,/quit>>)
+and after any change you must run the command <<command_weechat_reload,/reload>>
+(with the risk of loosing other changes that were not yet saved with
+<<command_weechat_save,/save>>). +
+You can use the command <<command_weechat_set,/set>>, which checks the value
+and applies immediately the changes.
+
 [[screen_layout]]
 === Układ ekranu