-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
78 additions
and
101 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,66 +1,44 @@ | ||
'\" t | ||
.\" Automatically generated by Pandoc 2.19.2 | ||
.\" Automatically generated by Pandoc 3.1.11.1 | ||
.\" | ||
.\" Define V font for inline verbatim, using C font in formats | ||
.\" that render this, and otherwise B font. | ||
.ie "\f[CB]x\f[]"x" \{\ | ||
. ftr V B | ||
. ftr VI BI | ||
. ftr VB B | ||
. ftr VBI BI | ||
.\} | ||
.el \{\ | ||
. ftr V CR | ||
. ftr VI CI | ||
. ftr VB CB | ||
. ftr VBI CBI | ||
.\} | ||
.TH "Keepmenu" "1" "20 June 2023" "Keepmenu 1.4.0" "User Manual" | ||
.hy | ||
.TH "Keepmenu" "1" "05 July 2024" "Keepmenu 1.4.2" "User Manual" | ||
.SH NAME | ||
.PP | ||
keepmenu - Fully featured Dmenu/Rofi frontend for autotype and managing | ||
keepmenu \- Fully featured Dmenu/Rofi frontend for autotype and managing | ||
of Keepass databases. | ||
.SH SYNOPSIS | ||
.PP | ||
\f[B]keepmenu\f[R] [\f[B]\[en]autotype\f[R] pattern] | ||
[\f[B]\[en]config\f[R] file] [\f[B]\[en]clipboard\f[R]] | ||
[\f[B]\[en]database\f[R] file] [\f[B]\[en]keyfile\f[R] file] | ||
[\f[B]\[en]totp\f[R]] | ||
.SH DESCRIPTION | ||
.PP | ||
\f[B]Keepmenu\f[R] is a fast and minimal application to facilitate | ||
password entry and manage most aspects of Keepass .kdbx databases. | ||
It is inspired in part by Passhole, but is more dmenu and less command | ||
line focused. | ||
.SH OPTIONS | ||
.PP | ||
\f[B]-a\f[R], \f[B]\[en]autotype\f[R] Autotype sequence from | ||
\f[B]\-a\f[R], \f[B]\[en]autotype\f[R] Autotype sequence from | ||
https://keepass.info/help/base/autotype.html#autoseq . | ||
Overrides global default from config.ini for current database. | ||
.PP | ||
\f[B]-c\f[R], \f[B]\[en]config\f[R] Path to config file | ||
\f[B]\-c\f[R], \f[B]\[en]config\f[R] Path to config file | ||
.PP | ||
\f[B]-C\f[R], \f[B]\[en]clipboard\f[R] Select to clipboard | ||
\f[B]\-C\f[R], \f[B]\[en]clipboard\f[R] Select to clipboard | ||
.PP | ||
\f[B]-d\f[R], \f[B]\[en]database\f[R] Path to Keepass database | ||
\f[B]\-d\f[R], \f[B]\[en]database\f[R] Path to Keepass database | ||
.PP | ||
\f[B]-k\f[R], \f[B]\[en]keyfile\f[R] Path to keyfile | ||
\f[B]\-k\f[R], \f[B]\[en]keyfile\f[R] Path to keyfile | ||
.PP | ||
\f[B]-t\f[R], \f[B]\[en]totp\f[R] TOTP mode | ||
\f[B]\-t\f[R], \f[B]\[en]totp\f[R] TOTP mode | ||
.SH EXAMPLES | ||
.IP | ||
.nf | ||
\f[C] | ||
.EX | ||
keepmenu | ||
keepmenu -t | ||
keepmenu -c /etc/keepmenu/config.ini | ||
keepmenu -d \[ti]/docs/totp_passwords.kdbx -a \[aq]{TOTP}{ENTER}\[aq] | ||
keepmenu -d \[ti]/passwords.kdbx -k \[ti]/passwords.keyfile -a \[aq]{S:security question}{ENTER}\[aq] | ||
\f[R] | ||
.fi | ||
keepmenu \-t | ||
keepmenu \-c /etc/keepmenu/config.ini | ||
keepmenu \-d \[ti]/docs/totp_passwords.kdbx \-a \[aq]{TOTP}{ENTER}\[aq] | ||
keepmenu \-d \[ti]/passwords.kdbx \-k \[ti]/passwords.keyfile \-a \[aq]{S:security question}{ENTER}\[aq] | ||
.EE | ||
.SH CONFIGURATION | ||
.PP | ||
If you start keepmenu for the first time without a config file, it will | ||
prompt you for database and keyfile locations and save them in a default | ||
config file. | ||
|
@@ -69,7 +47,7 @@ OR Copy config.ini.example to \[ti]/.config/keepmenu/config.ini and use | |
it as a reference for additional options. | ||
.PP | ||
Alternatively you can specify the file path to your config.ini using the | ||
-c/\[en]config flag. | ||
\-c/\[en]config flag. | ||
.SS config.ini options and defaults | ||
.PP | ||
.TS | ||
|
@@ -84,188 +62,186 @@ Default | |
T} | ||
_ | ||
T{ | ||
\f[V][dmenu]\f[R] | ||
\f[CR][dmenu]\f[R] | ||
T}@T{ | ||
\f[V]dmenu_command\f[R] | ||
\f[CR]dmenu_command\f[R] | ||
T}@T{ | ||
\f[V]dmenu\f[R] | ||
\f[CR]dmenu\f[R] | ||
T} | ||
T{ | ||
T}@T{ | ||
\f[V]pinentry\f[R] | ||
\f[CR]pinentry\f[R] | ||
T}@T{ | ||
None | ||
T} | ||
T{ | ||
T}@T{ | ||
\f[V]title_path\f[R] | ||
\f[CR]title_path\f[R] | ||
T}@T{ | ||
\f[V]True\f[R] | ||
\f[CR]True\f[R] | ||
T} | ||
T{ | ||
\f[V][dmenu_passphrase]\f[R] | ||
\f[CR][dmenu_passphrase]\f[R] | ||
T}@T{ | ||
\f[V]obscure\f[R] | ||
\f[CR]obscure\f[R] | ||
T}@T{ | ||
\f[V]False\f[R] | ||
\f[CR]False\f[R] | ||
T} | ||
T{ | ||
T}@T{ | ||
\f[V]obscure_color\f[R] | ||
\f[CR]obscure_color\f[R] | ||
T}@T{ | ||
\f[V]#222222\f[R] | ||
\f[CR]#222222\f[R] | ||
T} | ||
T{ | ||
\f[V][database]\f[R] | ||
\f[CR][database]\f[R] | ||
T}@T{ | ||
\f[V]database_n\f[R] | ||
\f[CR]database_n\f[R] | ||
T}@T{ | ||
None | ||
T} | ||
T{ | ||
T}@T{ | ||
\f[V]keyfile_n\f[R] | ||
\f[CR]keyfile_n\f[R] | ||
T}@T{ | ||
None | ||
T} | ||
T{ | ||
T}@T{ | ||
\f[V]password_n\f[R] | ||
\f[CR]password_n\f[R] | ||
T}@T{ | ||
None | ||
T} | ||
T{ | ||
T}@T{ | ||
\f[V]password_cmd_n\f[R] | ||
\f[CR]password_cmd_n\f[R] | ||
T}@T{ | ||
None | ||
T} | ||
T{ | ||
T}@T{ | ||
\f[V]autotype_default_n\f[R] | ||
\f[CR]autotype_default_n\f[R] | ||
T}@T{ | ||
None | ||
T} | ||
T{ | ||
T}@T{ | ||
\f[V]pw_cache_period_min\f[R] | ||
\f[CR]pw_cache_period_min\f[R] | ||
T}@T{ | ||
\f[V]360\f[R] | ||
\f[CR]360\f[R] | ||
T} | ||
T{ | ||
T}@T{ | ||
\f[V]editor\f[R] | ||
\f[CR]editor\f[R] | ||
T}@T{ | ||
\f[V]vim\f[R] | ||
\f[CR]vim\f[R] | ||
T} | ||
T{ | ||
T}@T{ | ||
\f[V]terminal\f[R] | ||
\f[CR]terminal\f[R] | ||
T}@T{ | ||
\f[V]xterm\f[R] | ||
\f[CR]xterm\f[R] | ||
T} | ||
T{ | ||
T}@T{ | ||
\f[V]gui_editor\f[R] | ||
\f[CR]gui_editor\f[R] | ||
T}@T{ | ||
None | ||
T} | ||
T{ | ||
T}@T{ | ||
\f[V]type_library\f[R] | ||
\f[CR]type_library\f[R] | ||
T}@T{ | ||
\f[V]pynput\f[R] | ||
\f[CR]pynput\f[R] | ||
T} | ||
T{ | ||
T}@T{ | ||
\f[V]hide_groups\f[R] | ||
\f[CR]hide_groups\f[R] | ||
T}@T{ | ||
None | ||
T} | ||
T{ | ||
T}@T{ | ||
\f[V]autotype_default\f[R] | ||
\f[CR]autotype_default\f[R] | ||
T}@T{ | ||
\f[V]{USERNAME}{TAB}{PASSWORD}{ENTER}\f[R] | ||
\f[CR]{USERNAME}{TAB}{PASSWORD}{ENTER}\f[R] | ||
T} | ||
T{ | ||
T}@T{ | ||
\f[V]type_url\f[R] | ||
\f[CR]type_url\f[R] | ||
T}@T{ | ||
\f[V]False\f[R] | ||
\f[CR]False\f[R] | ||
T} | ||
T{ | ||
\f[V][password_chars]\f[R] | ||
\f[CR][password_chars]\f[R] | ||
T}@T{ | ||
\f[V]lower\f[R] | ||
\f[CR]lower\f[R] | ||
T}@T{ | ||
\f[V]abcdefghijklmnopqrstuvwxyz\f[R] | ||
\f[CR]abcdefghijklmnopqrstuvwxyz\f[R] | ||
T} | ||
T{ | ||
T}@T{ | ||
\f[V]upper\f[R] | ||
\f[CR]upper\f[R] | ||
T}@T{ | ||
\f[V]ABCDEFGHIJKLMNOPQRSTUVWXYZ\f[R] | ||
\f[CR]ABCDEFGHIJKLMNOPQRSTUVWXYZ\f[R] | ||
T} | ||
T{ | ||
T}@T{ | ||
\f[V]digits\f[R] | ||
\f[CR]digits\f[R] | ||
T}@T{ | ||
\f[V]0123456789\f[R] | ||
\f[CR]0123456789\f[R] | ||
T} | ||
T{ | ||
T}@T{ | ||
\f[V]punctuation\f[R] | ||
\f[CR]punctuation\f[R] | ||
T}@T{ | ||
\f[V]!\[dq]#$%%&\[aq]()*+,-./:;<=>?\[at][\[rs]]\[ha]_\[ga]{\[br]}\[ti]\f[R] | ||
\f[CR]!\[dq]#$%%&\[aq]()*+,\-./:;<=>?\[at][\[rs]]\[ha]_\[ga]{│}\[ti]\f[R] | ||
T} | ||
T{ | ||
T}@T{ | ||
\f[V]Custom Name(s)\f[R] | ||
\f[CR]Custom Name(s)\f[R] | ||
T}@T{ | ||
\f[V]Any string\f[R] | ||
\f[CR]Any string\f[R] | ||
T} | ||
T{ | ||
\f[V][password_char_presets]\f[R] | ||
\f[CR][password_char_presets]\f[R] | ||
T}@T{ | ||
\f[V]Letters+Digits+Punctuation\f[R] | ||
\f[CR]Letters+Digits+Punctuation\f[R] | ||
T}@T{ | ||
\f[V]upper lower digits punctuation\f[R] | ||
\f[CR]upper lower digits punctuation\f[R] | ||
T} | ||
T{ | ||
T}@T{ | ||
\f[V]Letters+Digits\f[R] | ||
\f[CR]Letters+Digits\f[R] | ||
T}@T{ | ||
\f[V]upper lower digits\f[R] | ||
\f[CR]upper lower digits\f[R] | ||
T} | ||
T{ | ||
T}@T{ | ||
\f[V]Letters\f[R] | ||
\f[CR]Letters\f[R] | ||
T}@T{ | ||
\f[V]upper lower\f[R] | ||
\f[CR]upper lower\f[R] | ||
T} | ||
T{ | ||
T}@T{ | ||
\f[V]Digits\f[R] | ||
\f[CR]Digits\f[R] | ||
T}@T{ | ||
\f[V]digits\f[R] | ||
\f[CR]digits\f[R] | ||
T} | ||
T{ | ||
T}@T{ | ||
\f[V]Custom Name(s)\f[R] | ||
\f[CR]Custom Name(s)\f[R] | ||
T}@T{ | ||
\f[V]Any combo of [password_chars] entries\f[R] | ||
\f[CR]Any combo of [password_chars] entries\f[R] | ||
T} | ||
.TE | ||
.SH FILES | ||
.PP | ||
\[ti]/.config/keepmenu/config.ini | ||
.SH AUTHOR | ||
.PP | ||
Scott Hansen - <[email protected]> | ||
Scott Hansen \- \c | ||
.MT [email protected] | ||
.ME \c | ||
.SH COPYRIGHT | ||
.PP | ||
GNU General Public License 3 | ||
.SH SEE ALSO | ||
.PP | ||
Full documentation available at https://github.com/firecat53/keepmenu |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters