doc/user: add chapter on log file rotation/compression

diff --git a/doc/de/weechat_user.de.adoc b/doc/de/weechat_user.de.adoc
index 88fd0e7e6f438f10f1d808756d9cf5678803c4f5..df22af286151b2d5c8422884c491886e24ba4ae9 100644 (file)
--- a/doc/de/weechat_user.de.adoc
+++ b/doc/de/weechat_user.de.adoc
@@ -2475,6 +2475,49 @@ Erstellt eine Struktur in folgender Form:
         ...
 ....
 
+// TRANSLATION MISSING
+[[logger_rotation_compression]]
+==== Rotation and compression
+
+It is possible to define a max size for log files, and when it is reached,
+there is automatic rotation of log file.
+
+The rotated log files can be compressed with gzip or
+https://facebook.github.io/zstd/[zstd ^↗^,window=_blank].
+
+[NOTE]
+As the compression of a file can take some time, it is performed in background.
+
+Example with a max size of 2GB and compression with gzip, using good compression
+level (slower than default one):
+
+----
+/set logger.file.rotation_compression_type gzip
+/set logger.file.rotation_compression_level 80
+/set logger.file.rotation_size_max "2g"
+----
+
+If you want to use a decimal number, you can use the unit below and multiply
+by 1000, for example to set max size to 2.5GB:
+
+----
+/set logger.file.rotation_size_max "2500m"
+----
+
+With these settings, you'll end with files like these ones (in this example
+there is rotation only for the log of #weechat channel):
+
+....
+~/.local/share/weechat
+└── logs
+    ├── core.weechat.weechatlog
+    ├── irc.server.libera.weechatlog
+    ├── irc.libera.#weechat.weechatlog
+    ├── irc.libera.#weechat.weechatlog.1.gz
+    ├── irc.libera.#weechat.weechatlog.2.gz
+    └── irc.libera.#weechat.weechatlog.3.gz
+....
+
 [[logger_commands]]
 ==== Befehle
 

diff --git a/doc/en/weechat_user.en.adoc b/doc/en/weechat_user.en.adoc
index a5bab362a59b9884b53fc7cff2a638cec4c7da5e..332f964109442d5c7ed3b8a5bb75cace0d00d8a6 100644 (file)
--- a/doc/en/weechat_user.en.adoc
+++ b/doc/en/weechat_user.en.adoc
@@ -2430,6 +2430,48 @@ You'll have following files:
         ...
 ....
 
+[[logger_rotation_compression]]
+==== Rotation and compression
+
+It is possible to define a max size for log files, and when it is reached,
+there is automatic rotation of log file.
+
+The rotated log files can be compressed with gzip or
+https://facebook.github.io/zstd/[zstd ^↗^,window=_blank].
+
+[NOTE]
+As the compression of a file can take some time, it is performed in background.
+
+Example with a max size of 2GB and compression with gzip, using good compression
+level (slower than default one):
+
+----
+/set logger.file.rotation_compression_type gzip
+/set logger.file.rotation_compression_level 80
+/set logger.file.rotation_size_max "2g"
+----
+
+If you want to use a decimal number, you can use the unit below and multiply
+by 1000, for example to set max size to 2.5GB:
+
+----
+/set logger.file.rotation_size_max "2500m"
+----
+
+With these settings, you'll end with files like these ones (in this example
+there is rotation only for the log of #weechat channel):
+
+....
+~/.local/share/weechat
+└── logs
+    ├── core.weechat.weechatlog
+    ├── irc.server.libera.weechatlog
+    ├── irc.libera.#weechat.weechatlog
+    ├── irc.libera.#weechat.weechatlog.1.gz
+    ├── irc.libera.#weechat.weechatlog.2.gz
+    └── irc.libera.#weechat.weechatlog.3.gz
+....
+
 [[logger_commands]]
 ==== Commands
 

diff --git a/doc/fr/weechat_user.fr.adoc b/doc/fr/weechat_user.fr.adoc
index 03addfbea6719bff1733721db41d0e94f0b43f5b..9737693b34400d5a4a80f88f551a171ed2e04de3 100644 (file)
--- a/doc/fr/weechat_user.fr.adoc
+++ b/doc/fr/weechat_user.fr.adoc
@@ -2499,6 +2499,49 @@ Vous obtiendrez les fichiers suivants :
         ...
 ....
 
+[[logger_rotation_compression]]
+==== Rotation et compression
+
+Il est possible de définir une taille maximale pour les fichiers de logs, et
+lorsqu'elle est atteinte, il y a une rotation automatique du fichier de log.
+
+Les fichiers de logs qui ont tourné peuvent être compressés avec gzip ou
+https://facebook.github.io/zstd/[zstd ^↗^,window=_blank].
+
+[NOTE]
+La compression du fichier pouvant prendre du temps, elle est exécutée en tâche
+de fond.
+
+Exemple avec une taille maximale de 2 Go et la compression avec gzip, en utilisant
+un bon niveau de compression (plus lent que celui par défaut) :
+
+----
+/set logger.file.rotation_compression_type gzip
+/set logger.file.rotation_compression_level 80
+/set logger.file.rotation_size_max "2g"
+----
+
+Si vous voulez utiliser un nombre décimal, vous pouvez utiliser l'unité en
+dessous et multiplier par 1000, par exemple pour une taille maximale de 2,5 Go :
+
+----
+/set logger.file.rotation_size_max "2500m"
+----
+
+Avec cette configuration, vous aurez des fichiers comme ceux-ci (dans cet exemple
+il y a eu une rotation seulement pour le log du canal "#weechat"):
+
+....
+~/.local/share/weechat
+└── logs
+    ├── core.weechat.weechatlog
+    ├── irc.server.libera.weechatlog
+    ├── irc.libera.#weechat.weechatlog
+    ├── irc.libera.#weechat.weechatlog.1.gz
+    ├── irc.libera.#weechat.weechatlog.2.gz
+    └── irc.libera.#weechat.weechatlog.3.gz
+....
+
 [[logger_commands]]
 ==== Commandes
 

diff --git a/doc/it/weechat_user.it.adoc b/doc/it/weechat_user.it.adoc
index 12942dc982b605d28ec442d127eb0684b0e3065d..0c610c15f2801a60cec80cf7fc9d1eceee2abd10 100644 (file)
--- a/doc/it/weechat_user.it.adoc
+++ b/doc/it/weechat_user.it.adoc
@@ -2652,6 +2652,49 @@ Si avranno i seguenti file:
         ...
 ....
 
+// TRANSLATION MISSING
+[[logger_rotation_compression]]
+==== Rotation and compression
+
+It is possible to define a max size for log files, and when it is reached,
+there is automatic rotation of log file.
+
+The rotated log files can be compressed with gzip or
+https://facebook.github.io/zstd/[zstd ^↗^,window=_blank].
+
+[NOTE]
+As the compression of a file can take some time, it is performed in background.
+
+Example with a max size of 2GB and compression with gzip, using good compression
+level (slower than default one):
+
+----
+/set logger.file.rotation_compression_type gzip
+/set logger.file.rotation_compression_level 80
+/set logger.file.rotation_size_max "2g"
+----
+
+If you want to use a decimal number, you can use the unit below and multiply
+by 1000, for example to set max size to 2.5GB:
+
+----
+/set logger.file.rotation_size_max "2500m"
+----
+
+With these settings, you'll end with files like these ones (in this example
+there is rotation only for the log of #weechat channel):
+
+....
+~/.local/share/weechat
+└── logs
+    ├── core.weechat.weechatlog
+    ├── irc.server.libera.weechatlog
+    ├── irc.libera.#weechat.weechatlog
+    ├── irc.libera.#weechat.weechatlog.1.gz
+    ├── irc.libera.#weechat.weechatlog.2.gz
+    └── irc.libera.#weechat.weechatlog.3.gz
+....
+
 [[logger_commands]]
 ==== Comandi
 

diff --git a/doc/ja/weechat_user.ja.adoc b/doc/ja/weechat_user.ja.adoc
index b4f0b02bf8fc6d84b90fbdf01df931c214e3ca16..f1b24b94c2779411e23f643e9bac21574367b27e 100644 (file)
--- a/doc/ja/weechat_user.ja.adoc
+++ b/doc/ja/weechat_user.ja.adoc
@@ -2550,6 +2550,49 @@ IRC サーバ名を使ったディレクトリに、チャンネル名を使っ
         ...
 ....
 
+// TRANSLATION MISSING
+[[logger_rotation_compression]]
+==== Rotation and compression
+
+It is possible to define a max size for log files, and when it is reached,
+there is automatic rotation of log file.
+
+The rotated log files can be compressed with gzip or
+https://facebook.github.io/zstd/[zstd ^↗^,window=_blank].
+
+[NOTE]
+As the compression of a file can take some time, it is performed in background.
+
+Example with a max size of 2GB and compression with gzip, using good compression
+level (slower than default one):
+
+----
+/set logger.file.rotation_compression_type gzip
+/set logger.file.rotation_compression_level 80
+/set logger.file.rotation_size_max "2g"
+----
+
+If you want to use a decimal number, you can use the unit below and multiply
+by 1000, for example to set max size to 2.5GB:
+
+----
+/set logger.file.rotation_size_max "2500m"
+----
+
+With these settings, you'll end with files like these ones (in this example
+there is rotation only for the log of #weechat channel):
+
+....
+~/.local/share/weechat
+└── logs
+    ├── core.weechat.weechatlog
+    ├── irc.server.libera.weechatlog
+    ├── irc.libera.#weechat.weechatlog
+    ├── irc.libera.#weechat.weechatlog.1.gz
+    ├── irc.libera.#weechat.weechatlog.2.gz
+    └── irc.libera.#weechat.weechatlog.3.gz
+....
+
 [[logger_commands]]
 ==== コマンド
 

diff --git a/doc/pl/weechat_user.pl.adoc b/doc/pl/weechat_user.pl.adoc
index 38852e253294f4259c0af8f651eea9e293f94ae9..a87d693f241323a9381b0233768eaa9701037bd2 100644 (file)
--- a/doc/pl/weechat_user.pl.adoc
+++ b/doc/pl/weechat_user.pl.adoc
@@ -2464,6 +2464,49 @@ Spowoduje powstanie następującej struktury:
         ...
 ....
 
+// TRANSLATION MISSING
+[[logger_rotation_compression]]
+==== Rotation and compression
+
+It is possible to define a max size for log files, and when it is reached,
+there is automatic rotation of log file.
+
+The rotated log files can be compressed with gzip or
+https://facebook.github.io/zstd/[zstd ^↗^,window=_blank].
+
+[NOTE]
+As the compression of a file can take some time, it is performed in background.
+
+Example with a max size of 2GB and compression with gzip, using good compression
+level (slower than default one):
+
+----
+/set logger.file.rotation_compression_type gzip
+/set logger.file.rotation_compression_level 80
+/set logger.file.rotation_size_max "2g"
+----
+
+If you want to use a decimal number, you can use the unit below and multiply
+by 1000, for example to set max size to 2.5GB:
+
+----
+/set logger.file.rotation_size_max "2500m"
+----
+
+With these settings, you'll end with files like these ones (in this example
+there is rotation only for the log of #weechat channel):
+
+....
+~/.local/share/weechat
+└── logs
+    ├── core.weechat.weechatlog
+    ├── irc.server.libera.weechatlog
+    ├── irc.libera.#weechat.weechatlog
+    ├── irc.libera.#weechat.weechatlog.1.gz
+    ├── irc.libera.#weechat.weechatlog.2.gz
+    └── irc.libera.#weechat.weechatlog.3.gz
+....
+
 [[logger_commands]]
 ==== Komendy
 

diff --git a/doc/sr/weechat_user.sr.adoc b/doc/sr/weechat_user.sr.adoc
index dbfdbf6013f5c82b6ccd065dbd12e9fe95fbe4ae..1bc872c79621420d7fbc0d8f94d4a04f958915ee 100644 (file)
--- a/doc/sr/weechat_user.sr.adoc
+++ b/doc/sr/weechat_user.sr.adoc
@@ -2289,6 +2289,49 @@ logger.file.mask
         ...
 ....
 
+// TRANSLATION MISSING
+[[logger_rotation_compression]]
+==== Rotation and compression
+
+It is possible to define a max size for log files, and when it is reached,
+there is automatic rotation of log file.
+
+The rotated log files can be compressed with gzip or
+https://facebook.github.io/zstd/[zstd ^↗^,window=_blank].
+
+[NOTE]
+As the compression of a file can take some time, it is performed in background.
+
+Example with a max size of 2GB and compression with gzip, using good compression
+level (slower than default one):
+
+----
+/set logger.file.rotation_compression_type gzip
+/set logger.file.rotation_compression_level 80
+/set logger.file.rotation_size_max "2g"
+----
+
+If you want to use a decimal number, you can use the unit below and multiply
+by 1000, for example to set max size to 2.5GB:
+
+----
+/set logger.file.rotation_size_max "2500m"
+----
+
+With these settings, you'll end with files like these ones (in this example
+there is rotation only for the log of #weechat channel):
+
+....
+~/.local/share/weechat
+└── logs
+    ├── core.weechat.weechatlog
+    ├── irc.server.libera.weechatlog
+    ├── irc.libera.#weechat.weechatlog
+    ├── irc.libera.#weechat.weechatlog.1.gz
+    ├── irc.libera.#weechat.weechatlog.2.gz
+    └── irc.libera.#weechat.weechatlog.3.gz
+....
+
 [[logger_commands]]
 ==== Команде