From 0710d076c27d1fd0e01439ede483ff1d48072fa1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Helleu?= Date: Sun, 20 Nov 2016 20:01:32 +0100 Subject: [PATCH] doc: add note in quickstart guide to mention it's not recommended to edit config files by hand (issue #851) --- doc/cs/weechat_quickstart.cs.adoc | 11 +++++++++-- doc/de/weechat_quickstart.de.adoc | 11 ++++++++--- doc/en/weechat_quickstart.en.adoc | 10 ++++++++-- doc/es/weechat_quickstart.es.adoc | 12 +++++++++--- doc/fr/weechat_quickstart.fr.adoc | 11 ++++++++--- doc/it/weechat_quickstart.it.adoc | 11 +++++++++-- doc/ja/weechat_quickstart.ja.adoc | 10 ++++++++-- doc/pl/weechat_quickstart.pl.adoc | 11 +++++++++-- doc/ru/weechat_quickstart.ru.adoc | 11 +++++++++-- 9 files changed, 77 insertions(+), 21 deletions(-) diff --git a/doc/cs/weechat_quickstart.cs.adoc b/doc/cs/weechat_quickstart.cs.adoc index f23c85f5b..b5ab016ea 100644 --- a/doc/cs/weechat_quickstart.cs.adoc +++ b/doc/cs/weechat_quickstart.cs.adoc @@ -78,8 +78,15 @@ Můžete zobrazit nápovědu pro voblby s `/help`, například: Všechna nastavení jsou uložena při ukončení WeeChatu (nebo použitím příkazu `/save` k vynucení zapsaní voleb). -Můžete editovat konfigurační soubory (*.conf) ručně a znovu je načíst příkazem -`/reload` pokud nechcete použít příkaz `/set`. +// TRANSLATION MISSING +[IMPORTANT] +It is *not recommended* to edit configuration files by hand because WeeChat +may write them at any time (for example on <>) +and after any change you must run the command <> +(with the risk of loosing other changes that were not yet saved with +<>). + +You can use the command <>, which checks the value +and applies immediately the changes. [[core_vs_plugins]] == Jádro versus pluginy diff --git a/doc/de/weechat_quickstart.de.adoc b/doc/de/weechat_quickstart.de.adoc index c4fa448b4..0f95fd2e0 100644 --- a/doc/de/weechat_quickstart.de.adoc +++ b/doc/de/weechat_quickstart.de.adoc @@ -90,9 +90,14 @@ Du kannst dir mit dem Befehl `/help` eine Hilfe für Optionen anzeigen lassen, z Beim Beenden von WeeChat werden alle Einstellungen gespeichert (mittels des Befehls `/save` kann das Sichern der Optionen manuell durchgeführt werden). -Konfigurationsdateien (*.conf) können auch per Hand editiert und mit dem Befehl -`/reload` neu eingelesen werden (falls man z.B. den `/set` Befehl nicht -verwenden möchte). +[IMPORTANT] +Es wird *nicht empfohlen* die Konfigurationsdateien manuell zu editieren, da WeeChat +diese Dateien zu jeder Zeit überschreiben kann (zum Beispiel: <>) +und man eine veränderte Datei mit dem Befehl <> neu +laden muss (mit dem Risiko von Datenverlust da Daten kommentarlos überschrieben werden, +bevor man diese ggf. gesichert hat <>). + +Man sollte immer den <> Befehl nutzen, da der Befehl die +Eingabe prüft und Änderungen sofort wirksam werden. [[core_vs_plugins]] == Kern (Core) vs Erweiterungen diff --git a/doc/en/weechat_quickstart.en.adoc b/doc/en/weechat_quickstart.en.adoc index 330aef1e3..b85f1e3df 100644 --- a/doc/en/weechat_quickstart.en.adoc +++ b/doc/en/weechat_quickstart.en.adoc @@ -78,8 +78,14 @@ You can display help for an option with `/help`, for example: All settings are saved when WeeChat ends (or with `/save` command to force a write of the options). -You can edit configuration files (*.conf) by hand and reload them by -`/reload` command if you don't want to use `/set` command. +[IMPORTANT] +It is *not recommended* to edit configuration files by hand because WeeChat +may write them at any time (for example on <>) +and after any change you must run the command <> +(with the risk of loosing other changes that were not yet saved with +<>). + +You can use the command <>, which checks the value +and applies immediately the changes. [[core_vs_plugins]] == Core vs plugins diff --git a/doc/es/weechat_quickstart.es.adoc b/doc/es/weechat_quickstart.es.adoc index d3dbf27db..27904f4cc 100644 --- a/doc/es/weechat_quickstart.es.adoc +++ b/doc/es/weechat_quickstart.es.adoc @@ -88,9 +88,15 @@ Todas las opciones se salvarán de manera automática cuando cierre WeeChat o usando el comando `/save` para forzar la forzar a WeeChat a guardar todos los archivos de configuración. -Puede editar los ficheros de configuración (*.conf) directamente y -después recargarlos con el comando `/reload` si no desea usar el -comando `/set`. +// TRANSLATION MISSING +[IMPORTANT] +It is *not recommended* to edit configuration files by hand because WeeChat +may write them at any time (for example on <>) +and after any change you must run the command <> +(with the risk of loosing other changes that were not yet saved with +<>). + +You can use the command <>, which checks the value +and applies immediately the changes. [[core_vs_plugins]] == Núcleo vs Plugins diff --git a/doc/fr/weechat_quickstart.fr.adoc b/doc/fr/weechat_quickstart.fr.adoc index 8dbf2071e..3025d0228 100644 --- a/doc/fr/weechat_quickstart.fr.adoc +++ b/doc/fr/weechat_quickstart.fr.adoc @@ -82,9 +82,14 @@ Vous pouvez afficher de l'aide sur une option avec `/help`, par exemple : Toutes les options sont sauvées quand WeeChat quitte (ou avec la commande `/save` pour forcer une écriture des options). -Vous pouvez éditer les fichiers de configuration (*.conf) à la main et les -recharger par la commande `/reload` si vous ne souhaitez pas utiliser la -commande `/set`. +[IMPORTANT] +Il n'est *pas recommandé* de modifier les fichiers de configuration à la main +car WeeChat peut les écrire à tout moment (par exemple sur +<>) et après chaque changement vous devez lancer la +commande <> (avec le risque de perdre d'autres +changements qui n'auraient pas été sauvés avec <>). + +Vous pouvez utiliser la commande <>, qui vérifie la +valeur et applique les changements immédiatement. [[core_vs_plugins]] == Cœur vs extensions diff --git a/doc/it/weechat_quickstart.it.adoc b/doc/it/weechat_quickstart.it.adoc index b0eaf376a..9d09ff63f 100644 --- a/doc/it/weechat_quickstart.it.adoc +++ b/doc/it/weechat_quickstart.it.adoc @@ -86,8 +86,15 @@ Per esempio: Tutte le impostazioni vengono salvato all'uscita di WeeChat (o con il comando `/save` per forzare il salvataggio di una o più opzioni). -Si possono modificare manualmente i file di configurazione (*.conf) e -ricaricarli con il comando `/reload` se non si vuole usare il comando `/set`. +// TRANSLATION MISSING +[IMPORTANT] +It is *not recommended* to edit configuration files by hand because WeeChat +may write them at any time (for example on <>) +and after any change you must run the command <> +(with the risk of loosing other changes that were not yet saved with +<>). + +You can use the command <>, which checks the value +and applies immediately the changes. [[core_vs_plugins]] == Core vs plugin diff --git a/doc/ja/weechat_quickstart.ja.adoc b/doc/ja/weechat_quickstart.ja.adoc index 71d36a135..5872811cb 100644 --- a/doc/ja/weechat_quickstart.ja.adoc +++ b/doc/ja/weechat_quickstart.ja.adoc @@ -84,8 +84,14 @@ WeeChat を再起動する必要は *ありません*)。 すべての設定は WeeChat の終了時 (または強制的に設定保存を行う `/save` コマンドを使用した場合) に保存されます。 -`/set` コマンド以外の設定方法として、設定ファイル (*.conf) -を直接修正し、`/reload` コマンドでリロードすることもできます。 +[IMPORTANT] +手作業で設定ファイルを編集することは *推奨されません*。なぜなら +WeeChat は常時 (例えば <> コマンドの実行時など) +設定ファイルに書き込む可能性がありますし、手作業で修正を加えた後には必ず <> +コマンドを実行しなければいけない (これには <> +を使って保存されていない変更を失うリスクがあります) からです。 + +設定を編集するには <> +コマンドを使ってください。これは値を検査し、設定の変更をすぐに適用します。 [[core_vs_plugins]] == コア vs プラグイン diff --git a/doc/pl/weechat_quickstart.pl.adoc b/doc/pl/weechat_quickstart.pl.adoc index 140dbedcc..5f2585af7 100644 --- a/doc/pl/weechat_quickstart.pl.adoc +++ b/doc/pl/weechat_quickstart.pl.adoc @@ -84,8 +84,15 @@ Możesz wyświetlić pomoc dla opcji dzięki `/help`, na przykład: Wszystkie ustawienia są zapisywane podczas wyjścia z WeeChat (lub za pomocą komendy `/save`, która wymusza zapisanie opcji). -Możesz edytować ręcznie pliki konfiguracyjne (*.conf) i przeładować je za pomocą -komendy `/reload`, jeśli nie chcesz użyć komendy `/set`. +// TRANSLATION MISSING +[IMPORTANT] +It is *not recommended* to edit configuration files by hand because WeeChat +may write them at any time (for example on <>) +and after any change you must run the command <> +(with the risk of loosing other changes that were not yet saved with +<>). + +You can use the command <>, which checks the value +and applies immediately the changes. [[core_vs_plugins]] == Rdzeń vs wtyczki diff --git a/doc/ru/weechat_quickstart.ru.adoc b/doc/ru/weechat_quickstart.ru.adoc index 7bd137fdc..1edca59d3 100644 --- a/doc/ru/weechat_quickstart.ru.adoc +++ b/doc/ru/weechat_quickstart.ru.adoc @@ -85,8 +85,15 @@ WeeChat немедленно применяет все изменения (ва Все параметры сохраняются при выходе из WeeChat (или путём принудительной записи с помощью команды `/save`). -Можно редактировать файлы конфигурации (*.conf) вручную и применять параметры -с помощью команды `/reload`, в случае, если вы не хотите использовать `/set`. +// TRANSLATION MISSING +[IMPORTANT] +It is *not recommended* to edit configuration files by hand because WeeChat +may write them at any time (for example on <>) +and after any change you must run the command <> +(with the risk of loosing other changes that were not yet saved with +<>). + +You can use the command <>, which checks the value +and applies immediately the changes. [[core_vs_plugins]] == Ядро и плагины