Minor fixes to documentation

* Convert hyphens to em-dash
* Fix various typos
This commit is contained in:
Jonathan White 2023-01-29 14:23:35 -05:00
parent 5226a59ede
commit b1d96cd1ee
12 changed files with 48 additions and 48 deletions

View File

@ -1,4 +1,4 @@
= KeePassXC - Auto-Type
= KeePassXC Auto-Type
:imagesdir: ../images
// tag::content[]

View File

@ -1,4 +1,4 @@
= KeePassXC - Browser Plugin
= KeePassXC Browser Plugin
include::.sharedheader[]
:imagesdir: ../images

View File

@ -1,4 +1,4 @@
= KeePassXC - Database Operations
= KeePassXC Database Operations
include::.sharedheader[]
:imagesdir: ../images
@ -11,22 +11,22 @@ To create a database, perform the following steps:
1. Open your KeePassXC application. Click the create new database button *(A)*:
+
.Create database - Welcome screen
.Create database Welcome screen
image::welcome_screen.png[]
2. The database creation wizard appears. Enter the desired database name and a short description (optional):
+
.Create database - General information
.Create database General information
image::new_db_wizard_1.png[,80%]
3. Click Continue. The Encryption Settings screen appears, we don't recommend making any changes besides increasing or decreasing the decryption time using the slider. Setting the Decryption Time slider at higher values means that the database will have higher level of protection but the time taken by the database to open will increase.
+
.Create database - Encryption settings
.Create database Encryption settings
image::new_db_wizard_2.png[,80%]
4. Click the Continue button. The Database Credentials screen appears, enter your desired database password. We recommend using a long, randomized password.
+
.Create database - Database credentials
.Create database Database credentials
image::new_db_wizard_3.png[,80%]
+
*(A)* Open the password generator +
@ -362,7 +362,7 @@ The following key derivation functions are supported:
* AES-KDF (KDBX 4 and KDBX 3.1): This key derivation function is based on iterating AES. Users can change the number of iterations. The more iterations, the harder are dictionary and guessing attacks, but also database loading/saving takes more time (linearly). KDBX 3.1 only supports AES-KDF; any other key derivation function, like for instance Argon2, requires KDBX 4.
* Argon2 (KDBX 4 - recommended): KDBX 4, the Argon2 key derivation function can be used for transforming the composite master key (as protection against dictionary attacks). The main advantage of Argon2 over AES-KDF is that it provides a better resistance against GPU/ASIC attacks (due to being a memory-hard function). The number of iterations scales linearly with the required time. By increasing the memory parameter, GPU/ASIC attacks become harder and the required time increases. The parallelism parameter can be used to specify how many threads should be used. We recommend using Argon2id to prevent against timing-based attacks. Argon2d offers maximum compatibility with other KeePass-based apps, the default settings provide sufficient protection against any known attacks.
* Argon2 (KDBX 4 recommended): KDBX 4, the Argon2 key derivation function can be used for transforming the composite master key (as protection against dictionary attacks). The main advantage of Argon2 over AES-KDF is that it provides a better resistance against GPU/ASIC attacks (due to being a memory-hard function). The number of iterations scales linearly with the required time. By increasing the memory parameter, GPU/ASIC attacks become harder and the required time increases. The parallelism parameter can be used to specify how many threads should be used. We recommend using Argon2id to prevent against timing-based attacks. Argon2d offers maximum compatibility with other KeePass-based apps, the default settings provide sufficient protection against any known attacks.
== Database Maintenance
KeePassXC offers some maintenance features that can be applied to clean up your database. Navigate to _Database_ -> _Database settings_ then click on _Maintenance_ on the left hand panel. The following screen appears. On this screen you can delete multiple icons at once and purge any unused icons in your database.
@ -395,9 +395,9 @@ The database file that you create might contain highly sensitive data and must b
Make sure that you or someone else does not accidentally delete the database file. Deletion of the database file will result in the total loss of all your information (including all your passwords!) and a lot of inconvenience to manually retrieve your logins for various web applications. Do not share the credentials to access your database file with anyone unless you absolutely trust them (spouse, child, etc.).
TIP: You can safely store your database file in the cloud (e.g., OneDrive, Dropbox, Google Drive, Nextcloud, Syncthing, etc). The database file is always fully encrypted; unencrypted data is never written to disk and is never accessible to your cloud storage provider. We recommend using a storage service that keeps automatic backups (version history) of your database file in the event of corruption or accidental deletion.
TIP: You can safely store your database file in the cloud (OneDrive, Dropbox, Google Drive, Nextcloud, Syncthing, etc.). The database file is always fully encrypted; unencrypted data is never written to disk and is never accessible to your cloud storage provider. We recommend using a storage service that keeps automatic backups (version history) of your database file in the event of corruption or accidental deletion.
== Backing up a Database File
== Backing up a Database File
It is a good practice to create copies of your database file and store the copies of your database on a different computer, smart phone, or cloud storage space such a Google Drive or Microsoft OneDrive. Backups can be created automatically by selecting the _Backup database file before saving_ option in the application settings. Additionally, you can create a backup on-demand using the _Database_ -> _Save Database Backup..._ menu feature.
.Saving a database backup

View File

@ -1,4 +1,4 @@
= KeePassXC - Download and Install
= KeePassXC Download and Install
include::.sharedheader[]
:imagesdir: ../images
@ -8,9 +8,9 @@ KeePassXC is available for download for the following operating systems and plat
* Microsoft Windows
** Portable and MSI Installer (64-bit and 32-bit)
* Linux - Official Cross-Distribution Packages
* Linux Official Cross-Distribution Packages
** AppImage and Snap Package
* Linux - Distribution-Specific Packages
* Linux Distribution-Specific Packages
** Ubuntu, Debian, Arch Linux, Gentoo, Fedora, CentOS, and OpenSUSE
* macOS
** DMG Installer, Homebrew Cask
@ -45,9 +45,9 @@ image::install_wizard_2.png[,80%]
The following options can be set when running the MSI in an unattended installation:
* *LAUNCHAPPONEXIT* - Launch KeePassXC after install (default ON)
* *AUTOSTARTPROGRAM* - KeePassXC will auto-start on login (default ON)
* *INSTALLDESKTOPSHORTCUT* - A desktop icon will be installed (default OFF)
* *LAUNCHAPPONEXIT* Launch KeePassXC after install (default ON)
* *AUTOSTARTPROGRAM* KeePassXC will auto-start on login (default ON)
* *INSTALLDESKTOPSHORTCUT* A desktop icon will be installed (default OFF)
Example: `msiexec.exe /q /i KeePassXC-Y.Y.Y-WinZZ.msi AUTOSTARTPROGRAM=0`
@ -69,4 +69,4 @@ image::macos_install.png[,80%]
// end::content[]
// tag::advanced[]
// end::advanced[]
// end::advanced[]

View File

@ -1,4 +1,4 @@
= KeePassXC - Import/Export Operations
= KeePassXC Import/Export Operations
include::.sharedheader[]
:imagesdir: ../images

View File

@ -1,4 +1,4 @@
= KeePassXC - KeeShare
= KeePassXC KeeShare
include::.sharedheader[]
:imagesdir: ../images
@ -24,10 +24,10 @@ NOTE: KeeShare does not synchronize group structure after the initial share is c
1. Open the edit sheet on a group you want to share.
2. Select the KeeShare category on the left toolbar.
3. Choose a sharing type:
a. *Inactive* - Disable sharing this group
b. *Import* - Read-only import of entries, merge changes
c. *Export* - Write-only export of entries, no merge
d. *Synchronize* - Read/Write entries from the share, merge changes
a. *Inactive* Disable sharing this group
b. *Import* Read-only import of entries, merge changes
c. *Export* Write-only export of entries, no merge
d. *Synchronize* Read/Write entries from the share, merge changes
4. Choose a path to store the shared credentials to.
5. The password to use for this share container.

View File

@ -1,4 +1,4 @@
= KeePassXC - Keyboard Shortcuts
= KeePassXC Keyboard Shortcuts
include::.sharedheader[]
:imagesdir: ../images

View File

@ -1,4 +1,4 @@
= KeePassXC - Password Generator
= KeePassXC Password Generator
include::.sharedheader[]
:imagesdir: ../images

View File

@ -1,4 +1,4 @@
= KeePassXC - Reference
= KeePassXC Reference
include::.sharedheader[]
:imagesdir: ../images
@ -53,13 +53,13 @@ A reference to another entry's field is possible using the shorthand syntax:
`<FIELD>` and `<SEARCH_IN>` can be one of following:
* T - Title
* U - Username
* P - Password
* A - URL
* N - Notes
* I - UUID (found on entry properties page)
* O - Custom Attribute _(SEARCH_IN only)_
* T Title
* U Username
* P Password
* A URL
* N Notes
* I UUID (found on entry properties page)
* O Custom Attribute _(SEARCH_IN only)_
Examples: +
`{REF:U@I:033054D445C648C59092CC1D661B1B71}` +

View File

@ -1,4 +1,4 @@
= KeePassXC - SSH Agent integration
= KeePassXC SSH Agent integration
include::.sharedheader[]
:imagesdir: ../images

View File

@ -1,22 +1,22 @@
= KeePassXC - Database Operations
= KeePassXC Database Operations
include::.sharedheader[]
:imagesdir: ../images
// tag::content[]
== Interface Overview
=== Application Layout
The KeePassXC interface is designed for simplicity and easy access to your information. The main database view is split into three main partitions detailed below. You can open multiple databases at the same time, they will appear in tabs.
The KeePassXC interface is designed for simplicity and easy access to your information. The main database view is split into four main partitions detailed below. You can open multiple databases at the same time, they will appear in tabs.
.Main database interface
image::main_interface.png[]
*(A) Groups* - Organize your entries into discrete groups to bring order to all of your sensitive information. Groups can be nested under each other to create a hierarchy. Settings from parent groups get applied to their children. You can hide this panel on the View menu.
*(A) Groups* Organize your entries into discrete groups to bring order to all of your sensitive information. Groups can be nested under each other to create a hierarchy. Settings from parent groups get applied to their children. You can hide this panel on the View menu.
*(B) Tags* - Dynamic groups of entries that can be quickly displayed with one click. Any number of custom tags can be added when editing an entry. This panel also includes useful pre-defined searches, such as finding expired and weak passwords.
*(B) Tags* Dynamic groups of entries that can be quickly displayed with one click. Any number of custom tags can be added when editing an entry. This panel also includes useful pre-defined searches, such as finding expired and weak passwords.
*\(C) Entries* - Entries contain all the information you want to store for a website or application you are storing in KeePassXC. This view shows all the entries in the selected group. Each column can be resized, reordered, and shown or hidden based on your preference. Right-click the header row to see all available options.
*\(C) Entries* Entries contain all the information you want to store for a website or application you are storing in KeePassXC. This view shows all the entries in the selected group. Each column can be resized, reordered, and shown or hidden based on your preference. Right-click the header row to see all available options.
*(D) Preview* - Shows a preview of the selected group or entry. You can temporarily hide this preview using the close button on the right hand side or completely disabled in the application settings.
*(D) Preview* Shows a preview of the selected group or entry. You can temporarily hide this preview using the close button on the right hand side or completely disabled in the application settings.
TIP: You can enable double-click copying of entry username and password in the Application Security Settings. This is turned off by default starting with version 2.7.0.
@ -26,10 +26,10 @@ The toolbar provides a quick way to perform common tasks with your database. Som
.Toolbar overview
image::toolbar.png[]
*(A) Database* - Open Database, Save Database, Lock Database +
*(B) Entries* - Create Entry, Edit Entry, Delete Selected Entries +
*\(C) Entry Data* - Copy Username, Copy Password, Copy URL, Perform Auto-Type +
*(D) Tools* - Password Generator, Application Settings +
*(A) Database* Open Database, Save Database, Lock Database +
*(B) Entries* Create Entry, Edit Entry, Delete Selected Entries +
*\(C) Entry Data* Copy Username, Copy Password, Copy URL, Perform Auto-Type +
*(D) Tools* Password Generator, Application Settings +
*(E) Search*
=== Application Settings
@ -59,7 +59,7 @@ You can use the following command line options to tailor the application to your
----
Usage: keepassxc.exe [options] [filename(s)]
KeePassXC - cross-platform password manager
KeePassXC cross-platform password manager
Options:
-?, -h, --help Displays help on commandline options.

View File

@ -1,4 +1,4 @@
= KeePassXC - Welcome
= KeePassXC Welcome
include::.sharedheader[]
:imagesdir: ../images
@ -9,7 +9,7 @@ KeePassXC is a modern, secure, and open-source password manager that stores and
KeePassXC is for people with extremely high demands of secure personal data management. It saves many different types of information, such as usernames, passwords, URLs, attachments, and notes in an offline, encrypted file that can be stored in any location, including private and public cloud solutions. For easy identification and management, user-defined titles and icons can be specified for entries. In addition, entries are sorted in customizable groups. An integrated search function allows you to use advanced patterns to easily find any entry in your database. A customizable, fast, and easy-to-use password generator utility allows you to create passwords with any combination of characters or easy to remember passphrases.
=== Overview
You can store an unlimited number of passwords and information in a KeePassXC database. Every piece of information you store in your database is encrypted at all times within the `kdbx` file. When you are accessing your database from within KeePassXC, your information in decrypted and stored in your computer's memory. KeePassXC places controls over the access to this data so other applications cannot read it (unless they have administrative rights). The interface is designed to let you quickly access your passwords, search for the right entry, perform Auto-Type or copy/paste operations, make and save changes, and then get out of your way.
You can store an unlimited number of passwords and information in a KeePassXC database. Every piece of information you store in your database is encrypted at all times within the `kdbx` file. When you are accessing your database from within KeePassXC, your information is decrypted and stored in your computer's memory. KeePassXC places controls over the access to this data so other applications cannot read it (unless they have administrative rights). The interface is designed to let you quickly access your passwords, search for the right entry, perform Auto-Type or copy/paste operations, make and save changes, and then get out of your way.
KeePassXC ships with light and dark themes specifically designed to meet accessibility standards. In most cases, the appropriate theme for your system will be determined automatically, but you can always set a specific theme in the application settings.
@ -45,4 +45,4 @@ KeePassXC has numerous features for novice and power users alike. This guide wil
** Additional encryption choices: Twofish and ChaCha20
// end::content[]
// tag::advanced[]
// end::advanced[]
// end::advanced[]