mig5/bouquin
1
0
Fork 0
Code Issues Pull requests Releases 54 Wiki Activity Actions

Update Help

Miguel Jacq 2025-11-17 01:03:11 -06:00
parent 120830172e
commit 33b31aaa27
1 changed files with 10 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

11
Help.md

@ -79,6 +79,12 @@ Every 10 seconds, Bouquin will autosave the page if there were any unsaved chang
If you explicitly press `Ctrl+S` or via the **File -> Save** navigation, you will be prompted to optionally set a version note. You can either accept the default which has a reasonably meaningful message, or give it a meaningful note of your own.
## Screenshots and images
You can choose the Image icon from the toolbar to insert an image into the page.
You can also choose the Screenshot (camera) icon from the toolbar to take a screenshot. When you do this, Bouquin will give you 5 seconds to 'ready' your screen in order it to take a preview capture. It will then let you use click-and-drag to crop to a region of that preview, or else if you press Enter, it will use the whole preview image. The result will be automatically inserted into your page, and also saved as a PNG file in your workstation's 'Pictures' directory.
## Searching for data
You can enter terms into the search bar in the left sidebar.
@ -110,7 +116,6 @@ In the File -> Settings dialog, it is possible to:
- Configure the **theme** (dark, light or system mode)
- Change the locale (currently English, French and Italian supported). You must restart the app to load in the new selected language
- **Change to a different notebook** (must exist on the disk somewhere)
- **Remember the encryption key**. Doing so means that you aren't prompted for it at startup (**WARNING**: this means the encryption key is written to the application settings on the disk! It could be exfiltrated by various means if the filesystem is accessible to an attacker. Only check this option if you are not concerned with this risk.)
- **Change the encryption key**. This will prompt for a new passphrase and will re-encrypt the database with that passphrase.
- **Configure the auto-lock timeout**. The default setting is to lock the notepad if it has been idle (no key presses) for 15 minutes, after which time you must re-enter the password. You can set to 0 (Never) to turn off the auto-lock feature.
@ -148,6 +153,10 @@ The settings typically get written to `~/.config/Bouquin/Bouquin.conf`.
The default database for your notebook is stored in `~/.local/share/Bouquin/Bouquin/notebook.db`. This is an encrypted SQLCipher database, you can't open it with a normal `sqlite` CLI tool or other DBMS.
You can choose a different database file to open when starting the application (unless you have set Bouquin to remember the Encryption key). Bouquin remembers this path and saves it in the config file so that you don't have to keep selecting that database each time you start the application.
If you have set Bouquin to remember the Encryption key but wish to open a different database, first open Bouquin, navigate to the Settings and uncheck 'Remember Encryption key'. Next time you open the app, you'll be prompted for both the database path and the key as normal.
## Troubleshooting