diff options
| author | saturneric <[email protected]> | 2026-10-24 18:21:58 +0200 |
|---|---|---|
| committer | saturneric <[email protected]> | 2026-10-24 18:21:58 +0200 |
| commit | e0727fe929fd96c90123eb5ded936aa6ca2b6050 (patch) | |
| tree | 4d60f4868d246caabff183efccdae603391fdaca /src/content | |
| parent | Merge branch 'main' (diff) | |
| download | manual-e0727fe929fd96c90123eb5ded936aa6ca2b6050.tar.gz manual-e0727fe929fd96c90123eb5ded936aa6ca2b6050.zip | |
docs(interface): update toolbar and report guidance
- explain grouped Encrypt and Decrypt toolbar actions
- document toolbar click behavior and customization options
- clarify symmetric encryption access and v2.2.3 changes
- describe security reports, stamps, and view-specific saving
- update appearance settings and email protection instructions
Diffstat (limited to 'src/content')
| -rw-r--r-- | src/content/docs/email/compose-protect.md | 5 | ||||
| -rw-r--r-- | src/content/docs/guides/settings.md | 2 | ||||
| -rw-r--r-- | src/content/docs/guides/symmetric-encrypt-decrypt.mdx | 24 | ||||
| -rw-r--r-- | src/content/docs/guides/understand-interface.mdx | 81 |
4 files changed, 98 insertions, 14 deletions
diff --git a/src/content/docs/email/compose-protect.md b/src/content/docs/email/compose-protect.md index 20337ec..8a99bd1 100644 --- a/src/content/docs/email/compose-protect.md +++ b/src/content/docs/email/compose-protect.md @@ -155,8 +155,9 @@ Then use the **Security menu**: The result shows in the **Status Panel**. The status button changes to tell you what the message is now, for example **Encrypted**. -You can also use the **Sign**, **Encrypt** and **Encrypt & Sign** buttons on -the main toolbar. They do the same thing. +You can also use the **Sign** and **Encrypt** buttons on the main toolbar. They +do the same thing. **Encrypt & Sign** is in the **Encrypt** button's list: +right-click the button to find it. ### What the Security Menu Offers diff --git a/src/content/docs/guides/settings.md b/src/content/docs/guides/settings.md index 742a174..a632fbb 100644 --- a/src/content/docs/guides/settings.md +++ b/src/content/docs/guides/settings.md @@ -41,7 +41,7 @@ If you would rather browse, the pages are sorted into four groups: | Page | Group | What you change there | | --------------------- | -------------- | -------------------------------------------------------------------------------------- | | **General** | Application | Language, how operations behave, where the File Panel opens, which modules to look for | -| **Appearance** | Application | Theme, icon size, which buttons appear on the toolbar, fonts | +| **Appearance** | Application | Theme, icon size, which actions appear on the toolbar and what a click runs, fonts | | **Network** | Application | Proxy settings | | **Updates** | Application | Whether GpgFrontend checks for a new version when it starts | | **Key Databases** | Keys & Engines | Your key databases, which one is the default, and the built-in database's engine | diff --git a/src/content/docs/guides/symmetric-encrypt-decrypt.mdx b/src/content/docs/guides/symmetric-encrypt-decrypt.mdx index f63b489..2a461dd 100644 --- a/src/content/docs/guides/symmetric-encrypt-decrypt.mdx +++ b/src/content/docs/guides/symmetric-encrypt-decrypt.mdx @@ -38,20 +38,31 @@ approach is: To encrypt text using symmetric encryption in GpgFrontend (v2.1.9 and later): -### Enable Symmetric Encryption Feature +### Find Sym. Encrypt + +The easiest way: open the **Operations** menu and choose **Sym. Encrypt**. + +You can also put it on the toolbar: 1. Open **Settings** and choose **Appearance**. 2. Under **Toolbar**, in the **Actions** list, tick `Sym. Encrypt`. ![][img-1] -### Access the Symmetric Encryption Button - -After enabling, you'll see a dedicated `Sym. Encrypt` button on the main -interface. +`Sym. Encrypt` does not get a button of its own. It joins the **Encrypt** +button. To use it, right-click the **Encrypt** button (or press and hold it), +then choose `Sym. Encrypt` from the list. If no key is checked, a plain click +on **Encrypt** also opens this list. ![][img-2] +<Aside type="note" title="Changed in v2.2.3"> + +Before v2.2.3, `Sym. Encrypt` had its own toolbar button. Now it is in the +**Encrypt** button's list. + +</Aside> + ### Enter the Text or Select a File - Input the plaintext you wish to protect in the text editor. @@ -59,7 +70,8 @@ interface. ### Symmetric Encryption -1. Without selecting any public key, click the `Sym. Encrypt` button. +1. Without checking any public key, choose `Sym. Encrypt` from the + **Operations** menu, or from the **Encrypt** button's list. 2. When prompted, enter a strong, unique password. 3. This password becomes your encryption key. 4. The text or file will be encrypted into ciphertext. diff --git a/src/content/docs/guides/understand-interface.mdx b/src/content/docs/guides/understand-interface.mdx index 2614d94..d2b66c9 100644 --- a/src/content/docs/guides/understand-interface.mdx +++ b/src/content/docs/guides/understand-interface.mdx @@ -180,10 +180,37 @@ The Status Panel can now collapse to a thin bar. </Aside> +### Reading the Report + +In the **Status** view, each result is drawn as a small report page with the +heading **SECURITY OPERATION REPORT**. It has short cards for each file or +piece of text, with the important facts lined up. + +The report also has a round stamp with a check mark, a cross, or an +exclamation mark. It shows the result at a glance, in the same colours as +above. + +<Aside type="caution"> + +The stamp is only a picture. It is **not** a digital signature, and it does not +prove anything about the data. To check a signature, use **Verify** and read +the result. + +</Aside> + +<Aside type="note" title="Changed in v2.2.3"> + +The report has a new look. A cancelled or failed task now always shows a +clear card, never an empty one. + +</Aside> + ### Panel Actions - **Copy**: copies the status text to the clipboard. -- **Save**: saves the status text as a plain text file (UTF-8). +- **Save**: what it saves depends on the view. + - In the **Status** view, it saves the report as a picture (a PNG file). + - In the **Details** view, it saves the text as a plain text file. - **Magnify**: opens the summary in a bigger view. Available only when the **Status** view is showing a summary. - **Clear**: empties the panel, ready for the next task. @@ -263,23 +290,67 @@ features. Here are the buttons, from left to right: 2. **Workspace**: manage and switch between tabs (File Panel, Text Editor, Mail Editor). 3. **Encrypt**: lock the selected files or text for the chosen recipients. + This button can also hold **Encrypt & Sign** and **Sym. Encrypt**. 4. **Decrypt**: unlock the selected files or text. You don't need to pick a key; - GPG finds the right private key for you. + GPG finds the right private key for you. This button can also hold + **Decrypt & Verify**. 5. **Sign**: sign the selected files or text with your private key. 6. **Verify**: check the signature on the selected files or text. 7. **New Keypair**: make a new key pair. 8. **Import**: add existing public or private keys. 9. **Manage Keys**: open the key management window. +### Buttons With More Than One Action + +Some actions are close cousins, so they share one button: + +- The **Encrypt** button holds **Encrypt**, **Encrypt & Sign** and + **Sym. Encrypt**. +- The **Decrypt** button holds **Decrypt** and **Decrypt & Verify**. + +Here is how to use such a button: + +- **Click it** to run the action shown on the button. +- **Right-click it, or press and hold it,** to see all its actions. Then pick + the one you want. +- If the action on the button can't be used right now, a click opens the list + instead. So you can still reach the other actions. + +**Sym. Encrypt** is never the action shown on the button. You always pick it +from the list. + +<Aside type="note" title="Changed in v2.2.3"> + +Before v2.2.3, every ticked action had its own button. Now related actions +share one button, and all the buttons have the same width. + +</Aside> + ### Customization -You can hide buttons you don't use, or add ones you use often. Open -**Settings**, go to **Appearance**, and tick what you want under **Actions**. +You can hide buttons you don't use, or add ones you use often: -One of them is off by default and worth knowing about: **Sym. Encrypt**. It +1. Open **Settings** and go to **Appearance**. +2. Under **Toolbar**, tick what you want in the **Actions** list. The list is + arranged by button: the Encrypt row, then the Decrypt row, then Sign and + Verify. +3. If you ticked more than one action in the Encrypt or Decrypt row, an + **On click** choice appears for that row. Pick the action you want a plain + click to run. The other ticked actions stay in the right-click list. + +**On click** only lists the actions you ticked. It does not show at all when a +row has only one action ticked. + +One action is off by default and worth knowing about: **Sym. Encrypt**. It encrypts with a passphrase instead of a key. See [Symmetric Crypto](/guides/symmetric-encrypt-decrypt/). +<Aside type="note" title="New in v2.2.3"> + +The **On click** choice is new in v2.2.3. + +</Aside> + Instant messaging has no toolbar buttons. Its actions are in the **Operations** menu. See [Instant Messaging](/guides/instant-messaging/). |
