When a hyphen-minus should be formatted as ASCII 0x2D, it should be written escaped. Otherwise, depending on the system, the output will be a hyphen, and cannot be used straight from pasting into the command line.
Signed-off-by: Alejandro Colomar <[email protected]> --- man/pass.1 | 150 ++++++++++++++++++++++++++--------------------------- 1 file changed, 75 insertions(+), 75 deletions(-) diff --git a/man/pass.1 b/man/pass.1 index 7d5cffa..8868b78 100644 --- a/man/pass.1 +++ b/man/pass.1 @@ -1,7 +1,7 @@ .TH PASS 1 "2014 March 18" ZX2C4 "Password Store" .SH NAME -pass - stores, retrieves, generates, and synchronizes passwords securely +pass \- stores, retrieves, generates, and synchronizes passwords securely .SH SYNOPSIS .B pass @@ -19,7 +19,7 @@ .SH DESCRIPTION is a very simple password store that keeps passwords inside .BR gpg2 (1) encrypted files inside a simple directory tree residing at -.IR ~/.password-store . +.IR ~/.password\-store . The .B pass utility provides a series of commands for manipulating the password store, @@ -64,25 +64,25 @@ .SH DESCRIPTION .SH COMMANDS .TP -\fBinit\fP [ \fI--path=sub-folder\fP, \fI-p sub-folder\fP ] \fIgpg-id...\fP +\fBinit\fP [ \fI\-\-path=sub-folder\fP, \fI\-p sub-folder\fP ] \fIgpg\-id...\fP Initialize new password storage and use -.I gpg-id +.I gpg\-id for encryption. -Multiple gpg-ids may be specified, in order to encrypt each +Multiple gpg\-ids may be specified, in order to encrypt each password with multiple ids. This command must be run first before a password store can be used. -If the specified \fIgpg-id\fP is different from the key +If the specified \fIgpg\-id\fP is different from the key used in any existing files, these files will be reencrypted to use the new id. Note that use of -.BR gpg-agent (1) +.BR gpg\-agent (1) is recommended so that the batch decryption does not require as much user intervention. -If \fI--path\fP or \fI-p\fP is specified, along with an argument, -a specific gpg-id or set of gpg-ids is assigned for that specific sub folder of +If \fI\-\-path\fP or \fI\-p\fP is specified, along with an argument, +a specific gpg\-id or set of gpg\-ids is assigned for that specific sub folder of the password store. -If only one \fIgpg-id\fP is given, and it is an empty string, -then the current \fI.gpg-id\fP file for the specified \fIsub-folder\fP (or root if +If only one \fIgpg\-id\fP is given, and it is an empty string, +then the current \fI.gpg\-id\fP file for the specified \fIsub-folder\fP (or root if unspecified) is removed. .TP \fBls\fP \fIsubfolder\fP @@ -110,32 +110,32 @@ .SH COMMANDS program. This command is alternatively named \fBsearch\fP. .TP -\fBshow\fP [ \fI--clip\fP[=\fIline-number\fP], \fI-c\fP[\fIline-number\fP] ] [ \fI--qrcode\fP[=\fIline-number\fP], \fI-q\fP[\fIline-number\fP] ] \fIpass-name\fP +\fBshow\fP [ \fI\-\-clip\fP[=\fIline-number\fP], \fI\-c\fP[\fIline-number\fP] ] [ \fI\-\-qrcode\fP[=\fIline-number\fP], \fI\-q\fP[\fIline-number\fP] ] \fIpass-name\fP Decrypt and print a password named \fIpass-name\fP. -If \fI--clip\fP or \fI-c\fP +If \fI\-\-clip\fP or \fI\-c\fP is specified, do not print the password but instead copy the first (or otherwise specified) line to the clipboard using .BR xclip (1) or -.BR wl-clipboard(1) +.BR wl\-clipboard(1) and then restore the clipboard after 45 (or \fIPASSWORD_STORE_CLIP_TIME\fP) seconds. -If \fI--qrcode\fP -or \fI-q\fP is specified, do not print the password but instead display a QR code using +If \fI\-\-qrcode\fP +or \fI\-q\fP is specified, do not print the password but instead display a QR code using .BR qrencode (1) either to the terminal or graphically if supported. .TP -\fBinsert\fP [ \fI--echo\fP, \fI-e\fP | \fI--multiline\fP, \fI-m\fP ] [ \fI--force\fP, \fI-f\fP ] \fIpass-name\fP +\fBinsert\fP [ \fI\-\-echo\fP, \fI\-e\fP | \fI\-\-multiline\fP, \fI\-m\fP ] [ \fI\-\-force\fP, \fI\-f\fP ] \fIpass-name\fP Insert a new password into the password store called \fIpass-name\fP. This will read the new password from standard in. -If \fI--echo\fP or \fI-e\fP is \fInot\fP specified, +If \fI\-\-echo\fP or \fI\-e\fP is \fInot\fP specified, disable keyboard echo when the password is entered and confirm the password by asking for it twice. -If \fI--multiline\fP or \fI-m\fP is specified, lines will be read until +If \fI\-\-multiline\fP or \fI\-m\fP is specified, lines will be read until EOF or Ctrl+D is reached. Otherwise, only a single line from standard in is read. Prompt -before overwriting an existing password, unless \fI--force\fP or \fI-f\fP is specified. +before overwriting an existing password, unless \fI\-\-force\fP or \fI\-f\fP is specified. This command is alternatively named \fBadd\fP. .TP @@ -150,56 +150,56 @@ .SH COMMANDS If \fI/dev/shm\fP is not accessible, fallback to the ordinary \fITMPDIR\fP location, and print a warning. .TP -\fBgenerate\fP [ \fI--no-symbols\fP, \fI-n\fP ] [ \fI--clip\fP, \fI-c\fP ] [ \fI--in-place\fP, \fI-i\fP | \fI--force\fP, \fI-f\fP ] \fIpass-name [pass-length]\fP +\fBgenerate\fP [ \fI\-\-no\-symbols\fP, \fI\-n\fP ] [ \fI\-\-clip\fP, \fI\-c\fP ] [ \fI\-\-in\-place\fP, \fI\-i\fP | \fI\-\-force\fP, \fI\-f\fP ] \fIpass-name [pass-length]\fP Generate a new password using \fB/dev/urandom\fP of length \fIpass-length\fP (or \fIPASSWORD_STORE_GENERATED_LENGTH\fP if unspecified) and insert into \fIpass-name\fP. -If \fI--no-symbols\fP or \fI-n\fP is specified, do not use +If \fI\-\-no\-symbols\fP or \fI\-n\fP is specified, do not use any non-alphanumeric characters in the generated password. The character sets used in generating passwords can be changed with the \fIPASSWORD_STORE_CHARACTER_SET\fP and \fIPASSWORD_STORE_CHARACTER_SET_NO_SYMBOLS\fP environment variables, described below. -If \fI--clip\fP or \fI-c\fP is specified, do not print the password but instead copy +If \fI\-\-clip\fP or \fI\-c\fP is specified, do not print the password but instead copy it to the clipboard using .BR xclip (1) or -.BR wl-clipboard(1) +.BR wl\-clipboard(1) and then restore the clipboard after 45 (or \fIPASSWORD_STORE_CLIP_TIME\fP) seconds. -If \fI--qrcode\fP -or \fI-q\fP is specified, do not print the password but instead display a QR code using +If \fI\-\-qrcode\fP +or \fI\-q\fP is specified, do not print the password but instead display a QR code using .BR qrencode (1) either to the terminal or graphically if supported. Prompt before overwriting an existing password, -unless \fI--force\fP or \fI-f\fP is specified. -If \fI--in-place\fP or \fI-i\fP is +unless \fI\-\-force\fP or \fI\-f\fP is specified. +If \fI\-\-in\-place\fP or \fI\-i\fP is specified, do not interactively prompt, and only replace the first line of the password file with the new generated password, keeping the remainder of the file intact. .TP -\fBrm\fP [ \fI--recursive\fP, \fI-r\fP ] [ \fI--force\fP, \fI-f\fP ] \fIpass-name\fP +\fBrm\fP [ \fI\-\-recursive\fP, \fI\-r\fP ] [ \fI\-\-force\fP, \fI\-f\fP ] \fIpass-name\fP Remove the password named \fIpass-name\fP from the password store. This command is alternatively named \fBremove\fP or \fBdelete\fP. -If \fI--recursive\fP or \fI-r\fP +If \fI\-\-recursive\fP or \fI\-r\fP is specified, delete pass-name recursively if it is a directory. -If \fI--force\fP -or \fI-f\fP is specified, do not interactively prompt before removal. +If \fI\-\-force\fP +or \fI\-f\fP is specified, do not interactively prompt before removal. .TP -\fBmv\fP [ \fI--force\fP, \fI-f\fP ] \fIold-path\fP \fInew-path\fP +\fBmv\fP [ \fI\-\-force\fP, \fI\-f\fP ] \fIold-path\fP \fInew-path\fP Renames the password or directory named \fIold-path\fP to \fInew-path\fP. This command is alternatively named \fBrename\fP. -If \fI--force\fP is specified, +If \fI\-\-force\fP is specified, silently overwrite \fInew-path\fP if it exists. If \fInew-path\fP ends in a trailing \fI/\fP, it is always treated as a directory. Passwords are selectively reencrypted to the corresponding keys of their new destination. .TP -\fBcp\fP [ \fI--force\fP, \fI-f\fP ] \fIold-path\fP \fInew-path\fP +\fBcp\fP [ \fI\-\-force\fP, \fI\-f\fP ] \fIold-path\fP \fInew-path\fP Copies the password or directory named \fIold-path\fP to \fInew-path\fP. This command is alternatively named \fBcopy\fP. -If \fI--force\fP is specified, +If \fI\-\-force\fP is specified, silently overwrite \fInew-path\fP if it exists. If \fInew-path\fP ends in a trailing \fI/\fP, it is always treated as a directory. @@ -217,7 +217,7 @@ .SH COMMANDS is set to \fItrue\fP, then all commits will be signed using \fIuser.signingkey\fP or the default git signing key. This config key may be turned on using: -.B `pass git config --bool --add pass.signcommits true` +.B `pass git config \-\-bool \-\-add pass.signcommits true` .TP \fBhelp\fP Show usage message. @@ -231,7 +231,7 @@ .SH SIMPLE EXAMPLES Initialize password store .B zx2c4@laptop ~ $ pass init [email protected] .br -mkdir: created directory \[u2018]/home/zx2c4/.password-store\[u2019] +mkdir: created directory \[u2018]/home/zx2c4/.password\-store\[u2019] .br Password store initialized for [email protected]. .TP @@ -242,9 +242,9 @@ .SH SIMPLE EXAMPLES .br \[u251C]\[u2500]\[u2500] Business .br -\[u2502] \[u251C]\[u2500]\[u2500] some-silly-business-site.com +\[u2502] \[u251C]\[u2500]\[u2500] some\-silly\-business\-site.com .br -\[u2502] \[u2514]\[u2500]\[u2500] another-business-site.net +\[u2502] \[u2514]\[u2500]\[u2500] another\-business\-site.net .br \[u251C]\[u2500]\[u2500] Email .br @@ -271,7 +271,7 @@ .SH SIMPLE EXAMPLES .br \[u251C]\[u2500]\[u2500] Business .br -\[u2502] \[u251C]\[u2500]\[u2500] some-silly-business-site.com +\[u2502] \[u251C]\[u2500]\[u2500] some\-silly\-business\-site.com .br \[u2514]\[u2500]\[u2500] Email .br @@ -289,20 +289,20 @@ .SH SIMPLE EXAMPLES sup3rh4x3rizmynam3 .TP Copy existing password to clipboard -.B zx2c4@laptop ~ $ pass -c Email/zx2c4.com +.B zx2c4@laptop ~ $ pass \-c Email/zx2c4.com .br Copied Email/[email protected] to clipboard. Will clear in 45 seconds. .TP Add password to store -.B zx2c4@laptop ~ $ pass insert Business/cheese-whiz-factory +.B zx2c4@laptop ~ $ pass insert Business/cheese\-whiz\-factory .br -Enter password for Business/cheese-whiz-factory: omg so much cheese what am i gonna do +Enter password for Business/cheese\-whiz\-factory: omg so much cheese what am i gonna do .TP Add multiline password to store -.B zx2c4@laptop ~ $ pass insert -m Business/cheese-whiz-factory +.B zx2c4@laptop ~ $ pass insert \-m Business/cheese\-whiz\-factory .br -Enter contents of Business/cheese-whiz-factory and press Ctrl+D when finished: +Enter contents of Business/cheese\-whiz\-factory and press Ctrl+D when finished: .br .br @@ -323,59 +323,59 @@ .SH SIMPLE EXAMPLES .br The generated password to Email/jasondonenfeld.com is: .br -$(-QF&Q=IN2nFBx +$(\-QF&Q=IN2nFBx .TP Generate new alphanumeric password -.B zx2c4@laptop ~ $ pass generate -n Email/jasondonenfeld.com 12 +.B zx2c4@laptop ~ $ pass generate \-n Email/jasondonenfeld.com 12 .br The generated password to Email/jasondonenfeld.com is: .br YqFsMkBeO6di .TP Generate new password and copy it to the clipboard -.B zx2c4@laptop ~ $ pass generate -c Email/jasondonenfeld.com 19 +.B zx2c4@laptop ~ $ pass generate \-c Email/jasondonenfeld.com 19 .br Copied Email/jasondonenfeld.com to clipboard. Will clear in 45 seconds. .TP Remove password from store -.B zx2c4@laptop ~ $ pass remove Business/cheese-whiz-factory +.B zx2c4@laptop ~ $ pass remove Business/cheese\-whiz\-factory .br -rm: remove regular file \[u2018]/home/zx2c4/.password-store/Business/cheese-whiz-factory.gpg\[u2019]? y +rm: remove regular file \[u2018]/home/zx2c4/.password\-store/Business/cheese\-whiz\-factory.gpg\[u2019]? y .br -removed \[u2018]/home/zx2c4/.password-store/Business/cheese-whiz-factory.gpg\[u2019] +removed \[u2018]/home/zx2c4/.password\-store/Business/cheese\-whiz\-factory.gpg\[u2019] .SH EXTENDED GIT EXAMPLE Here, we initialize new password store, create a git repository, and then manipulate and sync passwords. Make note of the arguments to the first call of \fBpass git push\fP; consult -.BR git-push (1) +.BR git\-push (1) for more information. .B zx2c4@laptop ~ $ pass init [email protected] .br -mkdir: created directory \[u2018]/home/zx2c4/.password-store\[u2019] +mkdir: created directory \[u2018]/home/zx2c4/.password\-store\[u2019] .br Password store initialized for [email protected]. .B zx2c4@laptop ~ $ pass git init .br -Initialized empty Git repository in /home/zx2c4/.password-store/.git/ +Initialized empty Git repository in /home/zx2c4/.password\-store/.git/ .br -[master (root-commit) 998c8fd] Added current contents of password store. +[master (root\-commit) 998c8fd] Added current contents of password store. .br 1 file changed, 1 insertion(+) .br - create mode 100644 .gpg-id + create mode 100644 .gpg\-id -.B zx2c4@laptop ~ $ pass git remote add origin kexec.com:pass-store +.B zx2c4@laptop ~ $ pass git remote add origin kexec.com:pass\-store .B zx2c4@laptop ~ $ pass generate Amazon/[email protected] 21 .br -mkdir: created directory \[u2018]/home/zx2c4/.password-store/Amazon\[u2019] +mkdir: created directory \[u2018]/home/zx2c4/.password\-store/Amazon\[u2019] .br [master 30fdc1e] Added generated password for Amazon/[email protected] to store. .br -1 file changed, 0 insertions(+), 0 deletions(-) +1 file changed, 0 insertions(+), 0 deletions(\-) .br create mode 100644 Amazon/[email protected] .br @@ -383,7 +383,7 @@ .SH EXTENDED GIT EXAMPLE .br <5m,_BrZY`antNDxKN<0A -.B zx2c4@laptop ~ $ pass git push -u --all +.B zx2c4@laptop ~ $ pass git push \-u \-\-all .br Counting objects: 4, done. .br @@ -395,9 +395,9 @@ .SH EXTENDED GIT EXAMPLE .br Total 4 (delta 0), reused 0 (delta 0) .br -To kexec.com:pass-store +To kexec.com:pass\-store .br -* [new branch] master -> master +* [new branch] master \-> master .br Branch master set up to track remote branch master from origin. @@ -407,21 +407,21 @@ .SH EXTENDED GIT EXAMPLE .br [master b9b6746] Added given password for Amazon/[email protected] to store. .br -1 file changed, 0 insertions(+), 0 deletions(-) +1 file changed, 0 insertions(+), 0 deletions(\-) .br create mode 100644 Amazon/[email protected] .B zx2c4@laptop ~ $ pass rm Amazon/[email protected] .br -rm: remove regular file \[u2018]/home/zx2c4/.password-store/Amazon/[email protected]\[u2019]? y +rm: remove regular file \[u2018]/home/zx2c4/.password\-store/Amazon/[email protected]\[u2019]? y .br -removed \[u2018]/home/zx2c4/.password-store/Amazon/[email protected]\[u2019] +removed \[u2018]/home/zx2c4/.password\-store/Amazon/[email protected]\[u2019] .br rm 'Amazon/[email protected]' .br [master 288b379] Removed Amazon/[email protected] from store. .br -1 file changed, 0 insertions(+), 0 deletions(-) +1 file changed, 0 insertions(+), 0 deletions(\-) .br delete mode 100644 Amazon/[email protected] @@ -437,15 +437,15 @@ .SH EXTENDED GIT EXAMPLE .br Total 7 (delta 0), reused 0 (delta 0) .br -To kexec.com:pass-store +To kexec.com:pass\-store .SH FILES .TP -.B ~/.password-store +.B ~/.password\-store The default password storage directory. .TP -.B ~/.password-store/.gpg-id +.B ~/.password\-store/.gpg\-id Contains the default gpg key identification used for encryption and decryption. Multiple gpg keys may be specified in this file, one per line. If this file @@ -453,7 +453,7 @@ .SH FILES encrypted using those keys. This should be set using the \fBinit\fP command. .TP -.B ~/.password-store/.extensions +.B ~/.password\-store/.extensions The directory containing extension files. .SH ENVIRONMENT VARIABLES @@ -498,7 +498,7 @@ .SH ENVIRONMENT VARIABLES .TP .I PASSWORD_STORE_CHARACTER_SET_NO_SYMBOLS The character set to be used in no-symbol password generation for \fBgenerate\fP, -when \fI--no-symbols\fP, \fI-n\fP is specified. +when \fI\-\-no\-symbols\fP, \fI\-n\fP is specified. This value is to be interpreted by \fBtr\fP. See @@ -513,12 +513,12 @@ .SH ENVIRONMENT VARIABLES \fIPASSWORD_STORE_DIR/.extensions\fP. .TP .I PASSWORD_STORE_SIGNING_KEY -If this environment variable is set, then all \fB.gpg-id\fP files and non-system extension files +If this environment variable is set, then all \fB.gpg\-id\fP files and non-system extension files must be signed using a detached signature using the GPG key specified by the full 40 character upper-case fingerprint in this variable. If multiple fingerprints are specified, each separated by a whitespace character, then signatures must match at least one. -The \fBinit\fP command will keep signatures of \fB.gpg-id\fP files up to date. +The \fBinit\fP command will keep signatures of \fB.gpg\-id\fP files up to date. .TP .I EDITOR The location of the text editor used by \fBedit\fP. @@ -527,7 +527,7 @@ .SH SEE ALSO .BR tr (1), .BR git (1), .BR xclip (1), -.BR wl-clipboard (1), +.BR wl\-clipboard (1), .BR qrencode (1). .SH AUTHOR -- 2.40.1
