<commit_before>.\"
.\" Copyright (c) 2012-2014 <NAME> <<EMAIL>>
.\" 
.\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
.\" copyright notice and this permission notice appear in all copies.
.\" 
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
.Dd $Mdocdate: January 18 2014 $
.Dt MDP 1
.Os
.Sh NAME
.Nm mdp
.Nd minimalist password safe
.Sh SYNOPSIS
.Nm mdp
.Bk -words
.Op Fl Vh
.Op Fl c Ar config
.\" .Op Fl k Ar key_id
.Ar command
.Op Ar arguments ...
.Ek
.Sh DESCRIPTION
.Nm
wraps GnuPG, your favorite editor, a password generator and a custom temporary
full-screen pager to let you manage your password library.
.Pp
Naturally edit your password file (create, sort, delete) with your editor, rely
on GnuPG to do the right thing for crypto and let
.Nm
do the rest. In order to avoid passwords to linger on your screen, results
from your queries are displayed through a custom pager that gets cleared after
a customizable timeout (default 10 seconds).
.Pp
The following options are global and apply to all the subsequent commands:
.Bl -tag -width Ds
.It Fl c Ar config
Use an alternate configuration file.
.It Fl V
Print version.
.It Fl h
Print general usage. If you wish to get the usage for a specic command, you can
place this flag after the command name. For example 'mdp edit -h'.
.El
.Sh COMMANDS
.\" mdp edit
.Nm mdp
.Bk -words
.Ar edit
.Op Fl h
.Op Fl k Ar keyid
.Ek
.Bd -ragged -offset indent
Edit your password file (decrypt and re-encrypt after the fact). This command
creates a temporary file in mdp's configuration folder and starts your editor
on it, the file is fed to GnuPG when your editor quits and if the file has
changed in any way. The -k option is used in case you haven't specified a
default key in your configuration file.
.Pp
The only option for edit command is:
.Bl -tag -width Ds
.It Fl k Ar key_id
GnuPG key id (8 alpha-numeric characters). This could be used to specify your
GnuPG key id in case you did not define it in your configuration file.
.El
.Ed
.\" mdp generate
.Pp
.Nm mdp
.Bk -words
.Ar generate
.Op Fl h
.Op Fl p Ar profile
.Op Fl n Ar count
.Op Fl l Ar length
.Ek
.Bd -ragged -offset indent
Generate password(s) according to your configuration or command-line arguments.
Without profile specified, this will use the top-level definitions for the character
set, password length and count. All the flags specified on the command-line will
override the ones specified in the profile or top-level definitions. You can call
this command with the 'gen' shortcut.
.Pp
The options for the generate command are:
.Bl -tag -width Ds
.It Fl p Ar profile
Choose which profile to use among the ones defined in your configuration file.
.It Fl n Ar count
Number of passwords to generate. This command line parameter will override all
other values of password_count (global and profile).
.It Fl l Ar length
Length of generated passwords (in bytes). This command line parameter will
override all other values of password_count (global and profile).
.El
.Ed
.\" mdp get
.Pp
.Nm mdp
.Bk -words
.Ar get
.Op Fl hEr
.Ar keywords ...
.Ek
.Bd -ragged -offset indent
Return all the password entries matching the given keywords or regexs (if using
-E). By default, this command will open a full-screen pager to display the result<commit_msg>Clarify a few statements in the man page.<commit_after>.\"
.\" Copyright (c) 2012-2014 <NAME> <<EMAIL>>
.\" 
.\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
.\" copyright notice and this permission notice appear in all copies.
.\" 
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
.Dd $Mdocdate: January 18 2014 $
.Dt MDP 1
.Os
.Sh NAME
.Nm mdp
.Nd minimalist password safe
.Sh SYNOPSIS
.Nm mdp
.Bk -words
.Op Fl Vh
.Op Fl c Ar config
.\" .Op Fl k Ar key_id
.Ar command
.Op Ar arguments ...
.Ek
.Sh DESCRIPTION
.Nm
wraps GnuPG, your favorite editor, a password generator and a custom temporary
full-screen pager to let you manage your password library.
.Pp
Naturally edit your password file (create, sort, delete) with your editor, rely
on GnuPG to do the right thing for crypto and let
.Nm
do the rest. In order to avoid passwords to linger on your screen, results
from your queries are displayed through a custom pager that gets cleared after
a customizable timeout (default 10 seconds).
.Pp
The following options are global and apply to all the subsequent commands:
.Bl -tag -width Ds
.It Fl c Ar config
Use an alternate configuration file.
.It Fl V
Print version.
.It Fl h
Print general usage. If you wish to get the usage for a specic command, you can
place this flag after the command name. For example 'mdp edit -h'.
.El
.Sh COMMANDS
.\" mdp edit
.Nm mdp
.Bk -words
.Ar edit
.Op Fl h
.Op Fl k Ar keyid
.Ek
.Bd -ragged -offset indent
Edit your password file (decrypt and re-encrypt after the fact). This command
creates a temporary file in mdp's configuration folder and starts your editor
on it, the file is fed to GnuPG when your editor quits and if the file has
changed in any way.
.Pp
The only option for edit command is:
.Bl -tag -width Ds
.It Fl k Ar key_id
The argument is a GnuPG key id (8 alpha-numeric characters), it could be used
to specify your key id in case you did not define it in your configuration
file.
.El
.Ed
.\" mdp generate
.Pp
.Nm mdp
.Bk -words
.Ar generate
.Op Fl h
.Op Fl p Ar profile
.Op Fl n Ar count
.Op Fl l Ar length
.Ek
.Bd -ragged -offset indent
Generate password(s) according to your configuration or command-line arguments.
Without profile specified, this will use the top-level definitions for the character
set, password length and count (see CONFIGURATION below). All the flags
specified on the command-line will override the ones specified in the profile
or top-level definitions. You can call this command with the 'gen' shortcut.
.Pp
The options for the generate command are:
.Bl -tag -width Ds
.It Fl p Ar profile
Choose which profile to use among the ones defined in your configuration file.
.It Fl n Ar count
Number of passwords to generate. This command line parameter will override all
other values of password_count (global and profile).
.It Fl l Ar length
Length of generated passwords (in bytes). This command line parameter will
override all other values of password_count (global and profile).
.El
.Ed
.\" mdp get
.Pp
.Nm mdp
.Bk -words
.Ar get
.Op Fl hEr
.Ar keywords ...
.Ek
.Bd -ragged -offset indent
Return all the password entries matching the given keywords or regexs (if using
-E). By default, this command will open a full-screen pager to display the result
{'fraction_non_alphanumeric': 0.06432134418482541, 'fraction_numerical': 0.0047256497768443165, 'mean_word_length': 3.5980687990343996, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 9, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '24602', 'n_tokens_mistral': 2269, 'n_tokens_neox': 2132, 'n_words': 1291}