1
0
mirror of https://github.com/weechat/weechat.git synced 2026-06-26 12:56:37 +02:00

doc: add upgrade chapter in user's guide

This commit is contained in:
Sébastien Helleu
2021-03-13 15:17:01 +01:00
parent 5311c103d5
commit d2c56084f8
6 changed files with 428 additions and 0 deletions
+72
View File
@@ -524,6 +524,78 @@ Sollte WeeChat abgestürzt sein, muss der Befehl `bt full` genutzt werden:
(gdb) bt full
----
// TRANSLATION MISSING
[[upgrade]]
=== Upgrade
If a new stable version of WeeChat is released, this is time for you to
switch to this version.
First of all, you must install the new version of WeeChat, either with your
package manager or by compiling yourself, so that the `weechat` binary and all
required files are in the same paths. +
This can be done while WeeChat is running.
// TRANSLATION MISSING
[[upgrade_command]]
==== Upgrade command
WeeChat can restart the new binary, in place, using the
<<command_weechat_upgrade,/upgrade>> command: the buffer contents and non-SSL
connections are preserved. +
The SSL connections are lost during upgrade and you are automatically
reconnected after the upgrade (reload of SSL sessions is currently not possible
with GnuTLS).
The command can also be used if you have to restart the machine, for example
to upgrade the kernel or to move your WeeChat to another machine:
----
/upgrade -quit
----
This saves the current state in `*.upgrade` files. You can then either reboot
or move the whole directory `~/.weechat` to another machine, and restart
WeeChat later with this command:
----
$ weechat --upgrade
----
// TRANSLATION MISSING
[[restart_after_upgrade]]
==== Restart after upgrade
===== Release notes
After an upgrade, it is *strongly recommended* to read the
https://weechat.org/files/releasenotes/ReleaseNotes-devel.html[release notes]
which contain important information about breaking changes and some
manual actions that could be required.
You must read the release notes of all versions between your old (excluded) and
your new version (included). +
For example if you switch from version 3.0 to 3.2, you must read release notes
of versions 3.1 and 3.2.
===== Configuration upgrade
WeeChat has an automatic upgrade of configuration files (`*.conf`):
* new options are silently added with default value
* obsolete options are automatically discarded and WeeChat displays a warning
with the value read from file.
Example of warning when an option has been removed:
----
=!= Warnung: /home/xxx/.weechat/sec.conf, Zeile 15: unbekannte Einstellung für Sektion "crypt": passphrase_file = ""
----
That means the option `sec.crypt.passphrase_file` has been removed, and you
had value set to empty string, which was the default value in the previous version
(in this case no manual action is required).
[[usage]]
== Nutzung
+69
View File
@@ -515,6 +515,75 @@ Then like for a crash, use command `bt full`:
(gdb) bt full
----
[[upgrade]]
=== Upgrade
If a new stable version of WeeChat is released, this is time for you to
switch to this version.
First of all, you must install the new version of WeeChat, either with your
package manager or by compiling yourself, so that the `weechat` binary and all
required files are in the same paths. +
This can be done while WeeChat is running.
[[upgrade_command]]
==== Upgrade command
WeeChat can restart the new binary, in place, using the
<<command_weechat_upgrade,/upgrade>> command: the buffer contents and non-SSL
connections are preserved. +
The SSL connections are lost during upgrade and you are automatically
reconnected after the upgrade (reload of SSL sessions is currently not possible
with GnuTLS).
The command can also be used if you have to restart the machine, for example
to upgrade the kernel or to move your WeeChat to another machine:
----
/upgrade -quit
----
This saves the current state in `*.upgrade` files. You can then either reboot
or move the whole directory `~/.weechat` to another machine, and restart
WeeChat later with this command:
----
$ weechat --upgrade
----
[[restart_after_upgrade]]
==== Restart after upgrade
===== Release notes
After an upgrade, it is *strongly recommended* to read the
https://weechat.org/files/releasenotes/ReleaseNotes-devel.html[release notes]
which contain important information about breaking changes and some
manual actions that could be required.
You must read the release notes of all versions between your old (excluded) and
your new version (included). +
For example if you switch from version 3.0 to 3.2, you must read release notes
of versions 3.1 and 3.2.
===== Configuration upgrade
WeeChat has an automatic upgrade of configuration files (`*.conf`):
* new options are silently added with default value
* obsolete options are automatically discarded and WeeChat displays a warning
with the value read from file.
Example of warning when an option has been removed:
----
=!= Warning: /home/xxx/.weechat/sec.conf, line 15: unknown option for section "crypt": passphrase_file = ""
----
That means the option `sec.crypt.passphrase_file` has been removed, and you
had value set to empty string, which was the default value in the previous version
(in this case no manual action is required).
[[usage]]
== Usage
+71
View File
@@ -527,6 +527,77 @@ Ensuite comme pour un crash, utilisez la commande `bt full` :
(gdb) bt full
----
[[upgrade]]
=== Mise à jour
Si une nouvelle version stable de WeeChat est disponible, il est temps pour vous
de passer à cette version.
Avant toute chose, vous devez installer la nouvelle version de WeeChat, soit
via votre gestionnaire de paquets ou en le compilant vous-même, de telle sorte
que le nouveau binaire `weechat` et tous les fichiers requis sont dans les mêmes
répertoires. +
Cela peut être fait pendant que WeeChat tourne.
[[upgrade_command]]
==== Commande de mise à jour
WeeChat peut redémarrer le nouveau binaire avec la commande
<<command_weechat_upgrade,/upgrade>> : le contenu des tampons et les connexions
non SSL sont préservées. +
Les connexions SSL sont perdues pendant la mise à jour et vous êtres automatiquement
reconnectés après la mise à jour (le rechargement des sessions SSL n'est pas
possible actuellement avec GnuTLS).
La commande peut aussi être utilisée si vous devez redémarrer la machine, par
exemple pour mettre à jour le noyau ou déplacer WeeChat vers une autre machine :
----
/upgrade -quit
----
Cela sauvegarde l'état actuel dans des fichiers `*.upgrade`. Vous pouvez soit
rebooter ou déplacer le répertoire entier `~/.weechat` vers une autre machine,
et redémarrer WeeChat plus tard avec cette commande :
----
$ weechat --upgrade
----
[[restart_after_upgrade]]
==== Redémarrage après mise à jour
===== Notes de version
Après une mise à jour, il est *fortement recommandé* de lire les
https://weechat.org/files/releasenotes/ReleaseNotes-devel.html[notes de version]
qui contiennent des informations importantes sur les changements majeurs et
quelques actions manuelles qui pourraient être nécessaires.
Vous devez lire les notes des versions entre votre version ancienne (exclue)
et votre nouvelle version (incluse). +
Par exemple si vous passez de la version 3.0 à 3.2, vous devez lire les notes
des versions 3.1 et 3.2.
===== Mise à jour de la configuration
WeeChat a un système de mise à jour automatique des fichiers de configuration
(`*.conf`) :
* les nouvelles options sont silencieusement ajoutées avec la valeur par défaut
* les options obsolètes sont automatiquement supprimées et WeeChat affiche un
avertissement avec la valeur lue dans le fichier.
Exemple d'avertissement lorsqu'une option a été supprimée :
----
=!= Attention : /home/xxx/.weechat/sec.conf, ligne 15 : option inconnue pour la section "crypt" : passphrase_file = ""
----
Cela signifie que l'option `sec.crypt.passphrase_file` a été supprimée, et vous
aviez la valeur définie à une chaîne vide, ce qui était la valeur par défaut
dans la version précédente (dans ce cas aucune action manuelle n'est nécessaire).
[[usage]]
== Utilisation
+72
View File
@@ -570,6 +570,78 @@ Poi, come per un crash, usare il comando `bt full`:
(gdb) bt full
----
// TRANSLATION MISSING
[[upgrade]]
=== Upgrade
If a new stable version of WeeChat is released, this is time for you to
switch to this version.
First of all, you must install the new version of WeeChat, either with your
package manager or by compiling yourself, so that the `weechat` binary and all
required files are in the same paths. +
This can be done while WeeChat is running.
// TRANSLATION MISSING
[[upgrade_command]]
==== Upgrade command
WeeChat can restart the new binary, in place, using the
<<command_weechat_upgrade,/upgrade>> command: the buffer contents and non-SSL
connections are preserved. +
The SSL connections are lost during upgrade and you are automatically
reconnected after the upgrade (reload of SSL sessions is currently not possible
with GnuTLS).
The command can also be used if you have to restart the machine, for example
to upgrade the kernel or to move your WeeChat to another machine:
----
/upgrade -quit
----
This saves the current state in `*.upgrade` files. You can then either reboot
or move the whole directory `~/.weechat` to another machine, and restart
WeeChat later with this command:
----
$ weechat --upgrade
----
// TRANSLATION MISSING
[[restart_after_upgrade]]
==== Restart after upgrade
===== Release notes
After an upgrade, it is *strongly recommended* to read the
https://weechat.org/files/releasenotes/ReleaseNotes-devel.html[release notes]
which contain important information about breaking changes and some
manual actions that could be required.
You must read the release notes of all versions between your old (excluded) and
your new version (included). +
For example if you switch from version 3.0 to 3.2, you must read release notes
of versions 3.1 and 3.2.
===== Configuration upgrade
WeeChat has an automatic upgrade of configuration files (`*.conf`):
* new options are silently added with default value
* obsolete options are automatically discarded and WeeChat displays a warning
with the value read from file.
Example of warning when an option has been removed:
----
=!= Attenzione: /home/xxx/.weechat/sec.conf, riga 15: opzione sconosciuta per la sezione "crypt": passphrase_file = ""
----
That means the option `sec.crypt.passphrase_file` has been removed, and you
had value set to empty string, which was the default value in the previous version
(in this case no manual action is required).
[[usage]]
== Utilizzo
+72
View File
@@ -531,6 +531,78 @@ gdb /usr/bin/weechat 12345
(gdb) bt full
----
// TRANSLATION MISSING
[[upgrade]]
=== Upgrade
If a new stable version of WeeChat is released, this is time for you to
switch to this version.
First of all, you must install the new version of WeeChat, either with your
package manager or by compiling yourself, so that the `weechat` binary and all
required files are in the same paths. +
This can be done while WeeChat is running.
// TRANSLATION MISSING
[[upgrade_command]]
==== Upgrade command
WeeChat can restart the new binary, in place, using the
<<command_weechat_upgrade,/upgrade>> command: the buffer contents and non-SSL
connections are preserved. +
The SSL connections are lost during upgrade and you are automatically
reconnected after the upgrade (reload of SSL sessions is currently not possible
with GnuTLS).
The command can also be used if you have to restart the machine, for example
to upgrade the kernel or to move your WeeChat to another machine:
----
/upgrade -quit
----
This saves the current state in `*.upgrade` files. You can then either reboot
or move the whole directory `~/.weechat` to another machine, and restart
WeeChat later with this command:
----
$ weechat --upgrade
----
// TRANSLATION MISSING
[[restart_after_upgrade]]
==== Restart after upgrade
===== Release notes
After an upgrade, it is *strongly recommended* to read the
https://weechat.org/files/releasenotes/ReleaseNotes-devel.html[release notes]
which contain important information about breaking changes and some
manual actions that could be required.
You must read the release notes of all versions between your old (excluded) and
your new version (included). +
For example if you switch from version 3.0 to 3.2, you must read release notes
of versions 3.1 and 3.2.
===== Configuration upgrade
WeeChat has an automatic upgrade of configuration files (`*.conf`):
* new options are silently added with default value
* obsolete options are automatically discarded and WeeChat displays a warning
with the value read from file.
Example of warning when an option has been removed:
----
=!= 警告: /home/xxx/.weechat/sec.conf, 行 15: セクション "crypt" の無効なオプション: passphrase_file = ""
----
That means the option `sec.crypt.passphrase_file` has been removed, and you
had value set to empty string, which was the default value in the previous version
(in this case no manual action is required).
[[usage]]
== 使い方
+72
View File
@@ -521,6 +521,78 @@ Następnie jak w przypadku awarii, użyj polecenia `bt full`:
(gdb) bt full
----
// TRANSLATION MISSING
[[upgrade]]
=== Upgrade
If a new stable version of WeeChat is released, this is time for you to
switch to this version.
First of all, you must install the new version of WeeChat, either with your
package manager or by compiling yourself, so that the `weechat` binary and all
required files are in the same paths. +
This can be done while WeeChat is running.
// TRANSLATION MISSING
[[upgrade_command]]
==== Upgrade command
WeeChat can restart the new binary, in place, using the
<<command_weechat_upgrade,/upgrade>> command: the buffer contents and non-SSL
connections are preserved. +
The SSL connections are lost during upgrade and you are automatically
reconnected after the upgrade (reload of SSL sessions is currently not possible
with GnuTLS).
The command can also be used if you have to restart the machine, for example
to upgrade the kernel or to move your WeeChat to another machine:
----
/upgrade -quit
----
This saves the current state in `*.upgrade` files. You can then either reboot
or move the whole directory `~/.weechat` to another machine, and restart
WeeChat later with this command:
----
$ weechat --upgrade
----
// TRANSLATION MISSING
[[restart_after_upgrade]]
==== Restart after upgrade
===== Release notes
After an upgrade, it is *strongly recommended* to read the
https://weechat.org/files/releasenotes/ReleaseNotes-devel.html[release notes]
which contain important information about breaking changes and some
manual actions that could be required.
You must read the release notes of all versions between your old (excluded) and
your new version (included). +
For example if you switch from version 3.0 to 3.2, you must read release notes
of versions 3.1 and 3.2.
===== Configuration upgrade
WeeChat has an automatic upgrade of configuration files (`*.conf`):
* new options are silently added with default value
* obsolete options are automatically discarded and WeeChat displays a warning
with the value read from file.
Example of warning when an option has been removed:
----
=!= Ostrzeżenie: /home/xxx/.weechat/sec.conf, linia 15: nieznana opcja dla sekcji "crypt": passphrase_file = ""
----
That means the option `sec.crypt.passphrase_file` has been removed, and you
had value set to empty string, which was the default value in the previous version
(in this case no manual action is required).
[[usage]]
== Używanie