Notifications

docs/man-en.md

@@ -27,6 +27,7 @@
   - [Text Editor ✏](#text-editor-)
     - [How do I configure the text editor 🦥](#how-do-i-configure-the-text-editor-)
   - [Logging 🩺](#logging-)
+  - [Notifications 📫](#notifications-)
 
 ## Usage ❓
 
@@ -304,6 +305,8 @@ These parameters can be changed:
 - **Group Dirs**: select whether directories should be groupped or not in file explorers. If `Display first` is selected, directories will be sorted using the configured method but displayed before files, viceversa if `Display last` is selected.
 - **Remote File formatter syntax**: syntax to display file info for each file in the remote explorer. See [File explorer format](#file-explorer-format)
 - **Local File formatter syntax**: syntax to display file info for each file in the local explorer. See [File explorer format](#file-explorer-format)
+- **Enable notifications?**: If set to `Yes`, notifications will be displayed.
+- **Notifications: minimum transfer size**: if transfer size is greater or equal than the specified value, notifications for transfer will be displayed. The accepted values are in format `{UNSIGNED} B/KB/MB/GB/TB/PB`
 
 ### SSH Key Storage 🔐
 
@@ -471,3 +474,18 @@ Yes, you can. Just start termscp with `-q or --quiet` option. You can alias term
 > Is logging safe?
 
 If you're concerned about security, the log file doesn't contain any plain password, so don't worry and exposes the same information the sibling file `bookmarks` reports.
+
+## Notifications 📫
+
+Termscp will send Desktop notifications for these kind of events:
+
+- on **Transfer completed**: The notification will be sent once a transfer has been successfully completed.
+  - ❗ The notification will be displayed only if the transfer total size is at least the specified `Notifications: minimum transfer size` in the configuration.
+- on **Transfer failed**: The notification will be sent once a transfer has failed due to an error.
+  - ❗ The notification will be displayed only if the transfer total size is at least the specified `Notifications: minimum transfer size` in the configuration.
+- on **Update available**: Whenever a new version of termscp is available, a notification will be displayed.
+- on **Update installed**: Whenever a new version of termscp has been installed, a notification will be displayed.
+- on **Update failed**: Whenever the installation of the update fails, a notification will be displayed.
+
+❗ If you prefer to keep notifications turned off, you can just enter setup and set `Enable notifications?` to `No` 😉.
+❗ If you want to change the minimum transfer size to display notifications, you can change the value in the configuration with key `Notifications: minimum transfer size` and set it to whatever suits better for you 🙂.

docs/man-zh.md

@@ -27,6 +27,7 @@
   - [文本编辑器](#文本编辑器)
     - [如何配置文本编辑器？](#如何配置文本编辑器)
   - [日志](#日志)
+  - [通知](#通知)
 
 ## 用法
 
@@ -297,6 +298,8 @@ termscp和书签一样，只需要保证这些路径是可访问的：
 - **Group Dirs**：选择在文件浏览器中是否对文件夹进行分组。如果选择 `Display first`，目录将根据设置的方法排序，但仍显示在文件之前；如果选择 `Display last`，则正好相反。
 - **Remote File formatter syntax**：在远程资源管理器中为每个文件显示文件信息的语法。参见[资源管理器格式](#资源管理器格式)
 - **Local File formatter syntax**：在本地资源管理器中显示每个文件的文件信息的语法。参见[资源管理器格式](#资源管理器格式)
+- **Enable notifications?**: 如果设置为 `Yes`，则会显示通知。
+- **Notifications: minimum transfer size**: 如果传输大小大于或等于指定值，将显示传输通知。 接受的值格式为 `{UNSIGNED} B/KB/MB/GB/TB/PB`
 
 ### SSH Key Storage
 
@@ -462,3 +465,18 @@ termscp会为每个会话创建一个日志文件，该文件在
 > 日志是安全的吗？
 
 如果你担心安全问题，日志文件不包含任何普通的密码，所以不用担心，它暴露的信息与同级文件 `书签` 报告的信息相同。
+
+## 通知
+
+termscp 将针对这些类型的事件发送桌面通知：
+
+- **传输完成**： 传输成功完成后将发送通知。
+  - ❗ 仅当传输总大小至少为配置中指定的 `Notifications: minimum transfer size` 时才会显示通知。
+- **传输失败**：一旦传输因错误而失败，将发送通知。
+  - ❗ 仅当传输总大小至少为配置中指定的 `Notifications: minimum transfer size` 时才会显示通知。
+- **更新可用**：每当有新版本的termscp 可用时，都会显示通知。
+- **更新已安装**：每当安装了新版本的termscp 时，都会显示通知。
+- **更新失败**：每当更新安装失败时，都会显示通知。
+
+❗ 如果您希望保持关闭通知，您只需进入设置并将 `Enable notifications?` 设置为 `No`😉。
+❗ 如果您想更改最小传输大小以显示通知，您可以使用键 `Notifications: minimum transfer size` 更改配置中的值，并将其设置为更适合您的任何值🙂。