core: add option `-save` in command `/upgrade` (closes #1630)

1 files changed, 90 insertions, 81 deletions

diff --git a/doc/pl/includes/autogen_user_commands.pl.adoc b/doc/pl/includes/autogen_user_commands.pl.adoc
index cc0d3867c..ae57e473c 100644
--- a/doc/pl/includes/autogen_user_commands.pl.adoc
+++ b/doc/pl/includes/autogen_user_commands.pl.adoc
@@ -2121,35 +2121,42 @@ Przykłady:
 ----
 
 [[command_weechat_upgrade]]
-* `+upgrade+`: przeładowanie pliku binarnego WeeChat bez rozłączania z serwerami
+* `+upgrade+`: save WeeChat session and reload the WeeChat binary without disconnecting from servers
 
 ----
-/upgrade  [-yes] [<ścieżka_do_binarki>|-quit]
+/upgrade  [-yes] [<path_to_binary>|-save|-quit]
 
-          -yes: wymagane, jeśli "weechat.look.confirm_upgrade" jest włączona
-ścieżka_do_binarki: ścieżka do pliku binarnego WeeChat (domyślnie jest to obecny plik)
-        -dummy: nic nie rób (opcja użyta w celu zapobiegnięcia przypadkowego dopełnienia za pomocą"-quit")
-         -quit: zamyka *WSZYSTKIE* połączenia, zapisuje sesję i wyłącza WeeChat, umożliwia to późniejsze przywrócenie (zobacz niżej)
+          -yes: required if option "weechat.look.confirm_upgrade" is enabled
+path_to_binary: path to WeeChat binary (default is current binary)
+        -dummy: do nothing (option used to prevent accidental completion with "-quit")
+         -save: only save the session, do not quit nor reload WeeChat; the configuration files are not saved (if needed you can use /save before this command)
+         -quit: close *ALL* connections, save session and quit WeeChat, which makes possible a delayed restoration (see below)
 
-Ta komenda uaktualnia i przeładowuje działającą sesję WeeChat. Nowy plik binarny WeeChat powinien zostać skompilowany lub zainstalowany za pomocą managera pakietów przed uruchomieniem tej komendy.
+This command upgrades and reloads a running WeeChat session. The new WeeChat binary must have been compiled or installed with a package manager before running this command.
 
-Uwaga: połączenia SSL są przerywane podczas uaktualniania, ponieważ przeładowanie sesji SSL nie jest obecnie możliwe za pomocą GnuTLS. Po uaktualnieniu nastąpi ponowne ich połączenie.
+Note: SSL connections are lost during upgrade (except with -save), because the reload of SSL sessions is currently not possible with GnuTLS. There is automatic reconnection after upgrade.
 
-Proces uaktualnienia składa się z 4 kroków:
-  1. zapisania sesji do plików dla rdzenia i wtyczek (bufory, historia, ..)
-  2. wyładowanie wszystkich wtyczek (zapisanie plików konfiguracyjnych *.conf)
-  3. zapisanie konfiguracji WeeChat (weechat.conf)
-  4. uruchomienie nowego pliku binarnego WeeChat i przeładowanie sesji.
+Important: use of option -save can be dangerous, it is recommended to use only /upgrade (or with -quit) for a standard upgrade and a restart; the option -save can be used to save the session regularly and restore it in case of after abnormal exit (power outage, crash, etc.)
 
-Z opcją "-quit", proces przebiega inaczej:
-  1. zamknięcie *WSZYSTKICH* połączeń (irc, xfer, relay, ...)
-  2. zapisanie sesji do pliku (*.upgrade)
-  3. wyładowanie wszystkich wtyczek
-  4. zapisanie konfiguracji WeeChat
-  5. wyłączenie WeeChat
-Następnie można przywrócić sesję za pomocą komendy: weechat --upgrade
-WAŻNE: należy przywracać sesję z identyczną konfiguracją (pliki *.conf).
-Jest możliwe przywrócenie sesji WeeChat na innej maszynie, jeśli skopiujemy zawartość katalogów domowych WeeChat (zobacz /debug dirs).
+Upgrade process has 4 steps:
+  1. save session into files for core and plugins (buffers, history, ..)
+  2. unload all plugins (configuration files (*.conf) are written on disk)
+  3. save WeeChat configuration (weechat.conf)
+  4. execute new WeeChat binary and reload session.
+
+With option "-quit", the process is:
+  1. close *ALL* connections (irc, xfer, relay, ...)
+  2. save session into files (*.upgrade)
+  3. unload all plugins
+  4. save WeeChat configuration
+  5. quit WeeChat
+
+With option "-save", the process is:
+  1. save session into files (*.upgrade) with a disconnected state for IRC servers and Relay clients (but no disconnection is made)
+
+With -quit or -save, you can restore the session later with this command: weechat --upgrade
+IMPORTANT: you must restore the session with exactly same configuration (files *.conf) and if possible the same WeeChat version (or a more recent one).
+It is possible to restore WeeChat session on another machine if you copy the content of WeeChat home directories (see /debug dirs).
 ----
 
 [[command_weechat_uptime]]
@@ -3129,70 +3136,72 @@ Bez argumentów ta komenda wyświetli wszystkie załadowane wtyczki.
           default -yes
           monitor [<filtr>]
 
-       list: lista triggerów (jeśli nie podano argumentu, wyświetli się ta lista)
-   listfull: lista triggerów ze szczegółowymi informacjami
-listdefault: lista domyślnych triggerów
-        add: dodaje trigger
-     addoff: dodaje trigger (wyłączony)
- addreplace: dodaje lub zastępuje istniejący trigger
-       nazwa: nazwa triggera
+       list: list triggers (without argument, this list is displayed)
+   listfull: list triggers with detailed info for each trigger
+listdefault: list default triggers
+        add: add a trigger
+     addoff: add a trigger (disabled)
+ addreplace: add or replace an existing trigger
+       name: name of trigger
        hook: signal, hsignal, modifier, line, print, command, command_run, timer, config, focus, info, info_hashtable
-  argumenty: argumenty dla uchwytu, w zależności od jego typu (oddzielone średnikami):
-             signal: nazwa(-y) signal (wymagane)
-             hsignal: nazwa(-y) hsignal (wymagane)
-             modifier: nazwa(-y) modifier (wymagane)
-             line: typ bufora("formatted", "free" lub "*"), lista mask buforów, tagi
-             print: bufor, tagi, wiadomość, pomiń kolory
-             command: komenda (wymagane), opis, argumenty, opis argumentów, dopełnienie (wszystkie argumenty poza komendą są przetwarzane, "${tg_trigger_name}" jest zastępowane przez nazwę triggera, zobacz /help eval)
-             command_run: komenda(-y) (wymagane)
-             timer: interwał (wymagane), wyrównanie sekund, ilość wywołań
-             config: nazwa(-y) opcji (wymagane)
-             focus: nazwa(-y) obszarów (wymagane)
-             info: nazwa(y) informacji (wymagane)
-             info_hashtable: nazwa(y) informacji (wymagane)
- warunki: przetwarzane warunki dla triggera
-      regex: jedno lub więcej wyrażeń regularnych do zastępowania ciągów w zmiennych
-    komenda: komenda do wykonania (wiele komend można oddzielić ";")
-zwracany_kod: kod zwracany w callbacku (ok (domyślne), ok_eat, error)
-post_action: akcja do wykonania po zakończeniu (none (domyślne), disable, delete)
-   addinput: ustawia wejście z domyślnymi argumentami do stworzenia triggera
-      input: ustawia wejście z komendą użytą do stworzenia triggera
-     output: wysyła komendę do stworzenia triggera do buforu
-   recreate: tak samo jak "input", z opcją "addreplace" zamiast "add"
-        set: ustawia opcje triggera
-     opcja: nazwa opcji: name, hook, arguments, conditions, regex, command, return_code
-             (aby uzyskać pomoc na temat opcji możesz wpisać: /help trigger.trigger.<nazwa>.<opcja>)
-      wartość: nowa wartość dla opcji
-     rename: zmienia nazwę triggera
-       copy: kopiuje trigger
-     enable: włącza trigger(y) (bez argumentów: włącza triggery globalnie)
-    disable: wyłącza trigger(y) (bez argumentów: wyłącza triggery globalnie)
-     toggle: zmienia stan triggera(-ów) (bez argumentów: zmienia stan triggerów globalnie)
-    restart: restartuje trigger(y) (tworzy na nowo uchwyty)
-       show: pokazuje szczegółowe informacje o triggerze (z niektórymi statystykami)
-        del: usuwa trigger
-       -all: wykonaj akcję na wszystkich triggerach
-    restore: przywraca trigger(y) z domyślnymi wartościami (działa tylko dla domyślnych triggerów)
-    default: przywraca domyślne triggery
-    monitor: otwiera bufor monitorowania triggerów, z opcjonalnym filtrem:
-     filtr: filtruje uchwyty/triggery do wyświetlenia (uchwyt musi się zaczynać od "@", na przykład "@signal"), wiele filtrów może być oddzielonych przecinkiem; dzika karta "*" jest dozwolona w nazwie każdego triggera
-
-Kiedy callback triggera jest wywoływany, wykonywane są następujące akcje, w kolejności:
-  1. sprawdzenie warunków; jeśli nie są spełnione, wyjście
-  2. zastąpienie tekstu za pomocą rozszerzonych wyrażeń regularnych POSIX (jeśli zdefiniowane)
-  3. wykonanie komend(y) (jeśli zdefiniowane)
-  4. wyjście z kodem wyjścia (poza modifiers i focus)
-  5. wykonanie akcji kończącej
-
-Przykłady (możesz też spojrzeć na domyślne triggery za pomocą /trigger listdefault):
-  dodaje atrybuty tekstu *bold*, _underline_ i /italic/ (tylko w wiadomościach użytkowników):
+  arguments: arguments for the hook, depending on hook (separated by semicolons):
+             signal: name(s) of signal (required)
+             hsignal: name(s) of hsignal (required)
+             modifier: name(s) of modifier (required)
+             line: buffer type ("formatted", "free" or "*"), list of buffer masks, tags
+             print: buffer, tags, message, strip colors
+             command: command (required), description, arguments, description of arguments, completion (all arguments except command are evaluated, "${tg_trigger_name}" is replaced by the trigger name, see /help eval)
+             command_run: command(s) (required)
+             timer: interval (required), align on second, max calls
+             config: name(s) of option (required)
+             focus: name(s) of area (required)
+             info: name(s) of info (required)
+             info_hashtable: name(s) of info (required)
+ conditions: evaluated conditions for the trigger
+      regex: one or more regular expressions to replace strings in variables
+    command: command to execute (many commands can be separated by ";")
+return_code: return code in callback (ok (default), ok_eat, error)
+post_action: action to take after execution (none (default), disable, delete)
+   addinput: set input with default arguments to create a trigger
+      input: set input with the command used to create the trigger
+     output: send the command to create the trigger on the buffer
+   recreate: same as "input", with option "addreplace" instead of "add"
+        set: set an option in a trigger
+     option: name of option: name, hook, arguments, conditions, regex, command, return_code
+             (for help on option, you can type: /help trigger.trigger.<name>.<option>)
+      value: new value for the option
+     rename: rename a trigger
+       copy: copy a trigger
+     enable: enable trigger(s) (without arguments: enable triggers globally)
+    disable: disable trigger(s) (without arguments: disable triggers globally)
+     toggle: toggle trigger(s) (without arguments: toggle triggers globally)
+    restart: restart trigger(s) (recreate the hooks)
+       show: show detailed info on a trigger (with some stats)
+        del: delete a trigger
+       -all: do action on all triggers
+    restore: restore trigger(s) with the default values (works only for default triggers)
+    default: delete all triggers and restore default ones
+    monitor: open the trigger monitor buffer, with optional filter:
+     filter: filter hooks/triggers to display (a hook must start with "@", for example "@signal"), many filters can be separated by commas; wildcard "*" is allowed in each trigger name
+
+When a trigger callback is called, following actions are performed, in this order:
+  1. check conditions; if false, exit
+  2. replace text using POSIX extended regular expression(s) (if defined in trigger)
+  3. execute command(s) (if defined in trigger)
+  4. exit with a return code (except for modifier, line, focus, info and info_hashtable)
+  5. perform post action
+
+Examples (you can also look at default triggers with /trigger listdefault):
+  add text attributes *bold*, _underline_ and /italic/ (only in user messages):
     /trigger add effects modifier weechat_print "${tg_tag_nick}" "==\*([^ ]+)\*==*${color:bold}${re:1}${color:-bold}*== ==_([^ ]+)_==_${color:underline}${re:1}${color:-underline}_== ==/([^ ]+)/==/${color:italic}${re:1}${color:-italic}/"
-  ukrywa pasek z nickami na małych terminalach:
+  hide nicklist bar on small terminals:
     /trigger add resize_small signal signal_sigwinch "${info:term_width} < 100" "" "/bar hide nicklist"
     /trigger add resize_big signal signal_sigwinch "${info:term_width} >= 100" "" "/bar show nicklist"
-  cichy zapis plików konfiguracyjnych co każdą godzinę:
+  silently save config each hour:
     /trigger add cfgsave timer 3600000;0;0 "" "" "/mute /save"
-  otwiera monitor triggerów i pokazuje tylko modifiers i triggery, których nazwa zaczyna się od "resize":
+  silently save WeeChat session at midnight (see /help upgrade):
+    /trigger add session_save signal day_changed "" "" "/mute /upgrade -save"
+  open trigger monitor and show only modifiers and triggers whose name starts with "resize":
     /trigger monitor @modifier,resize*
 ----
 // end::trigger_commands[]