summaryrefslogtreecommitdiff
path: root/doc/fr
diff options
context:
space:
mode:
authorSébastien Helleu <flashcode@flashtux.org>2022-09-27 20:49:12 +0200
committerSébastien Helleu <flashcode@flashtux.org>2022-09-27 20:49:12 +0200
commit26e6fdc64561d7575b3c937a9bb4f39cc8c0954f (patch)
tree7792b2f0824875006f1de4998056aa047e8eb008 /doc/fr
parente7b6e8c60f0001c4b228bda570ec0d1b7dc3a739 (diff)
downloadweechat-26e6fdc64561d7575b3c937a9bb4f39cc8c0954f.zip
api: add function file_compress
Diffstat (limited to 'doc/fr')
-rw-r--r--doc/fr/weechat_plugin_api.fr.adoc41
1 files changed, 41 insertions, 0 deletions
diff --git a/doc/fr/weechat_plugin_api.fr.adoc b/doc/fr/weechat_plugin_api.fr.adoc
index f6d6af359..09b4fca84 100644
--- a/doc/fr/weechat_plugin_api.fr.adoc
+++ b/doc/fr/weechat_plugin_api.fr.adoc
@@ -4258,6 +4258,47 @@ if (weechat_file_copy ("/tmp/test.txt", "/path/to/test2.txt"))
[NOTE]
Cette fonction n'est pas disponible dans l'API script.
+==== file_compress
+
+_WeeChat ≥ 3.7._
+
+Compresser un fichier avec gzip ou zstd.
+
+Prototype :
+
+[source,c]
+----
+int weechat_file_compress (const char *from, const char *to,
+ const char *compressor, int compression_level);
+----
+
+Paramètres :
+
+* _from_ : fichier source
+* _to_ : fichier cible
+* _compressor_ : le compresseur à utiliser, un parmi :
+** _gzip_ : compression gzip
+** _zstd_ : compression zstandard
+* _compression_level_ : niveau de compression, entre 1 (rapide, peu de
+ compression) à 100 (lent, meilleure compression)
+
+Valeur de retour :
+
+* 1 si OK, 0 si erreur
+
+Exemple en C :
+
+[source,c]
+----
+if (weechat_file_compress ("/tmp/test.txt", "/tmp/test.txt.zst", "zstd", 50))
+{
+ /* OK */
+}
+----
+
+[NOTE]
+Cette fonction n'est pas disponible dans l'API script.
+
[[util]]
=== Util