From 41fdf8b2e4d9b57ef10c67d8bf4f96d373ffe18d Mon Sep 17 00:00:00 2001 From: joshr Date: Sat, 18 Aug 2018 10:27:55 -0400 Subject: [PATCH] update man pages --- man/man1/git-secret-add.1 | 2 +- man/man1/git-secret-cat.1 | 2 +- man/man1/git-secret-changes.1 | 4 ++-- man/man1/git-secret-clean.1 | 2 +- man/man1/git-secret-hide.1 | 5 +++-- man/man1/git-secret-init.1 | 2 +- man/man1/git-secret-killperson.1 | 2 +- man/man1/git-secret-list.1 | 2 +- man/man1/git-secret-remove.1 | 2 +- man/man1/git-secret-reveal.1 | 7 ++++--- man/man1/git-secret-tell.1 | 4 ++-- man/man1/git-secret-usage.1 | 2 +- man/man1/git-secret-whoknows.1 | 2 +- man/man7/git-secret.7 | 8 ++++---- 14 files changed, 24 insertions(+), 22 deletions(-) diff --git a/man/man1/git-secret-add.1 b/man/man1/git-secret-add.1 index 9e7ea9b3..f3208e8c 100644 --- a/man/man1/git-secret-add.1 +++ b/man/man1/git-secret-add.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "GIT\-SECRET\-ADD" "1" "May 2018" "sobolevn" "git-secret" +.TH "GIT\-SECRET\-ADD" "1" "June 2018" "sobolevn" "git-secret" . .SH "NAME" \fBgit\-secret\-add\fR \- starts to track added files\. diff --git a/man/man1/git-secret-cat.1 b/man/man1/git-secret-cat.1 index 35539054..690cb0c5 100644 --- a/man/man1/git-secret-cat.1 +++ b/man/man1/git-secret-cat.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "GIT\-SECRET\-CAT" "1" "May 2018" "sobolevn" "git-secret" +.TH "GIT\-SECRET\-CAT" "1" "June 2018" "sobolevn" "git-secret" . .SH "NAME" \fBgit\-secret\-cat\fR \- decrypts files passed on command line to stdout diff --git a/man/man1/git-secret-changes.1 b/man/man1/git-secret-changes.1 index 895e48ce..fcdd05c6 100644 --- a/man/man1/git-secret-changes.1 +++ b/man/man1/git-secret-changes.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "GIT\-SECRET\-CHANGES" "1" "May 2018" "sobolevn" "git-secret" +.TH "GIT\-SECRET\-CHANGES" "1" "July 2018" "sobolevn" "git-secret" . .SH "NAME" \fBgit\-secret\-changes\fR \- view diff of the hidden files\. @@ -15,7 +15,7 @@ git secret changes [\-h] [\-d dir] [\-p password] [pathspec]\.\.\. .fi . .SH "DESCRIPTION" -\fBgit\-secret\-changes\fR \- shows changes between the current version of hidden files and the ones already commited\. You can provide any number of hidden files to this command as arguments, and it will show changes for these files only\. Note that files must be specified by their encrypted names, typically \fBfilename\.yml\.secret\fR\. If no arguments are provided, information about all hidden files will be shown\. +\fBgit\-secret\-changes\fR \- shows changes between the current version of hidden files and the ones already committed\. You can provide any number of hidden files to this command as arguments, and it will show changes for these files only\. Note that files must be specified by their encrypted names, typically \fBfilename\.yml\.secret\fR\. If no arguments are provided, information about all hidden files will be shown\. . .SH "OPTIONS" . diff --git a/man/man1/git-secret-clean.1 b/man/man1/git-secret-clean.1 index b269550f..34ddccc1 100644 --- a/man/man1/git-secret-clean.1 +++ b/man/man1/git-secret-clean.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "GIT\-SECRET\-CLEAN" "1" "May 2018" "sobolevn" "git-secret" +.TH "GIT\-SECRET\-CLEAN" "1" "June 2018" "sobolevn" "git-secret" . .SH "NAME" \fBgit\-secret\-clean\fR \- removes all the hidden files\. diff --git a/man/man1/git-secret-hide.1 b/man/man1/git-secret-hide.1 index 58149888..0156ece6 100644 --- a/man/man1/git-secret-hide.1 +++ b/man/man1/git-secret-hide.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "GIT\-SECRET\-HIDE" "1" "May 2018" "sobolevn" "git-secret" +.TH "GIT\-SECRET\-HIDE" "1" "August 2018" "sobolevn" "git-secret" . .SH "NAME" \fBgit\-secret\-hide\fR \- encrypts all added files with the inner keyring\. @@ -10,7 +10,7 @@ . .nf -git secret hide [\-c] [\-v] +git secret hide [\-c] [\-P] [\-v] [\-d] [\-m] . .fi . @@ -26,6 +26,7 @@ It is possible to modify the names of the encrypted files by setting \fBSECRETS_ \-v \- verbose, shows extra information\. \-c \- deletes encrypted files before creating new ones\. +\-P \- preserve permissions of unencrypted file in encrypted file\. \-d \- deletes unencrypted files after encryption\. \-m \- encrypt files only when modified\. \-h \- shows help\. diff --git a/man/man1/git-secret-init.1 b/man/man1/git-secret-init.1 index 3143d07b..0a9f1358 100644 --- a/man/man1/git-secret-init.1 +++ b/man/man1/git-secret-init.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "GIT\-SECRET\-INIT" "1" "May 2018" "sobolevn" "git-secret" +.TH "GIT\-SECRET\-INIT" "1" "June 2018" "sobolevn" "git-secret" . .SH "NAME" \fBgit\-secret\-init\fR \- initializes git\-secret repository\. diff --git a/man/man1/git-secret-killperson.1 b/man/man1/git-secret-killperson.1 index 7bdef58a..30a68b2f 100644 --- a/man/man1/git-secret-killperson.1 +++ b/man/man1/git-secret-killperson.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "GIT\-SECRET\-KILLPERSON" "1" "May 2018" "sobolevn" "git-secret" +.TH "GIT\-SECRET\-KILLPERSON" "1" "June 2018" "sobolevn" "git-secret" . .SH "NAME" \fBgit\-secret\-killperson\fR \- deletes key identified by an email from the inner keyring\. diff --git a/man/man1/git-secret-list.1 b/man/man1/git-secret-list.1 index 07b4f6b1..db6b8df3 100644 --- a/man/man1/git-secret-list.1 +++ b/man/man1/git-secret-list.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "GIT\-SECRET\-LIST" "1" "May 2018" "sobolevn" "git-secret" +.TH "GIT\-SECRET\-LIST" "1" "June 2018" "sobolevn" "git-secret" . .SH "NAME" \fBgit\-secret\-list\fR \- prints all the added files\. diff --git a/man/man1/git-secret-remove.1 b/man/man1/git-secret-remove.1 index cc41fac3..03f14faa 100644 --- a/man/man1/git-secret-remove.1 +++ b/man/man1/git-secret-remove.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "GIT\-SECRET\-REMOVE" "1" "May 2018" "sobolevn" "git-secret" +.TH "GIT\-SECRET\-REMOVE" "1" "June 2018" "sobolevn" "git-secret" . .SH "NAME" \fBgit\-secret\-remove\fR \- removes files from index\. diff --git a/man/man1/git-secret-reveal.1 b/man/man1/git-secret-reveal.1 index ec68ac63..4e60ac59 100644 --- a/man/man1/git-secret-reveal.1 +++ b/man/man1/git-secret-reveal.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "GIT\-SECRET\-REVEAL" "1" "May 2018" "sobolevn" "git-secret" +.TH "GIT\-SECRET\-REVEAL" "1" "August 2018" "sobolevn" "git-secret" . .SH "NAME" \fBgit\-secret\-reveal\fR \- decrypts all added files\. @@ -10,7 +10,7 @@ . .nf -git secret reveal [\-f] [\-d dir] [\-p password] +git secret reveal [\-f] [\-P] [\-d dir] [\-p password] . .fi . @@ -21,9 +21,10 @@ git secret reveal [\-f] [\-d dir] [\-p password] . .nf -\-f \- forces to overwrite exisiting files without prompt\. +\-f \- forces to overwrite existing files without prompt\. \-d \- specifies `\-\-homedir` option for the `gpg`, basically use this option if you store your keys in a custom location\. \-p \- specifies password for noinput mode, adds `\-\-passphrase` option for `gpg`\. +\-P \- preserve permissions of encrypted file in unencrypted file\. \-h \- shows help\. . .fi diff --git a/man/man1/git-secret-tell.1 b/man/man1/git-secret-tell.1 index 60fdec22..4771bd88 100644 --- a/man/man1/git-secret-tell.1 +++ b/man/man1/git-secret-tell.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "GIT\-SECRET\-TELL" "1" "May 2018" "sobolevn" "git-secret" +.TH "GIT\-SECRET\-TELL" "1" "July 2018" "sobolevn" "git-secret" . .SH "NAME" \fBgit\-secret\-tell\fR \- adds a person, who can access private data\. @@ -15,7 +15,7 @@ git secret tell [\-m] [\-d dir] [emails]\.\.\. .fi . .SH "DESCRIPTION" -\fBgit\-secret\-tell\fR receives an email addresses as an input, searches for the \fBgpg\fR\-key in the \fBgpg\fR\'s \fBhomedir\fR by these emails, then imports a person\'s public key into the \fBgit\-secret\fR\'s inner keychain\. From this moment this person can encrypt new files with the keyring which contains their key\. But they cannot decrypt the old files, which were already encrypted without their key\. They should be reencrypted with the new keyring by someone, who has the unencrypted files\. +\fBgit\-secret\-tell\fR receives an email addresses as an input, searches for the \fBgpg\fR\-key in the \fBgpg\fR\'s \fBhomedir\fR by these emails, then imports a person\'s public key into the \fBgit\-secret\fR\'s inner keychain\. From this moment this person can encrypt new files with the keyring which contains their key, but they cannot decrypt the old files, which were already encrypted without their key\. The files should be re\-encrypted with the new keyring by someone who has the unencrypted files\. . .P \fBDo not manually import secret key into \fBgit\-secret\fR\fR\. Anyways, it won\'t work with any of the secret\-keys imported\. diff --git a/man/man1/git-secret-usage.1 b/man/man1/git-secret-usage.1 index a00c54f2..204b296f 100644 --- a/man/man1/git-secret-usage.1 +++ b/man/man1/git-secret-usage.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "GIT\-SECRET\-USAGE" "1" "May 2018" "sobolevn" "git-secret" +.TH "GIT\-SECRET\-USAGE" "1" "June 2018" "sobolevn" "git-secret" . .SH "NAME" \fBgit\-secret\-usage\fR \- prints all the available commands\. diff --git a/man/man1/git-secret-whoknows.1 b/man/man1/git-secret-whoknows.1 index 177af3ae..e39932d6 100644 --- a/man/man1/git-secret-whoknows.1 +++ b/man/man1/git-secret-whoknows.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "GIT\-SECRET\-WHOKNOWS" "1" "May 2018" "sobolevn" "git-secret" +.TH "GIT\-SECRET\-WHOKNOWS" "1" "June 2018" "sobolevn" "git-secret" . .SH "NAME" \fBgit\-secret\-whoknows\fR \- prints email\-labels for each key in the keyring\. diff --git a/man/man7/git-secret.7 b/man/man7/git-secret.7 index 7f4bd715..7ce54893 100644 --- a/man/man7/git-secret.7 +++ b/man/man7/git-secret.7 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "GIT\-SECRET" "7" "June 2018" "sobolevn" "git-secret" +.TH "GIT\-SECRET" "7" "July 2018" "sobolevn" "git-secret" . .SH "NAME" \fBgit\-secret\fR @@ -44,7 +44,7 @@ Get their \fBgpg\fR public\-key\. \fBYou won\'t need their secret key\.\fR Import this key into your \fBgpg\fR setup (in ~/\.gnupg or similar) by running \fBgpg \-\-import KEY_NAME\.txt\fR . .IP "3." 4 -Now add this person to your secrets repo by running \fBgit secret tell persons@email\.id\fR (this will be the email address assocated with the public key) +Now add this person to your secrets repo by running \fBgit secret tell persons@email\.id\fR (this will be the email address associated with the public key) . .IP "4." 4 The newly added user cannot yet read the encrypted files\. Now, re\-encrypt the files using \fBgit secret reveal; git secret hide \-d\fR, and then commit and push the newly encrypted files\. (The \-d options deletes the unencrypted file after re\-encrypting it)\. Now the newly added user be able to decrypt the files in the repo using \fBgit\-secret\fR\. @@ -52,7 +52,7 @@ The newly added user cannot yet read the encrypted files\. Now, re\-encrypt the .IP "" 0 . .P -Note that it is possible to add yourself to the git\-secret repo without decrypting existing files\. It will be possible to decrypt them after reencrypting them with the new keyring\. So, if you don\'t want unexpected keys added, you can configure some server\-side security policy with the \fBpre\-receive\fR hook\. +Note that it is possible to add yourself to the git\-secret repo without decrypting existing files\. It will be possible to decrypt them after re\-encrypting them with the new keyring\. So, if you don\'t want unexpected keys added, you can configure some server\-side security policy with the \fBpre\-receive\fR hook\. . .SH "Configuration" You can configure the version of gpg used, or the extension your encrypted files use, to suit your workflow better\. To do so, just set the required variable to the value you need\. This can be done in your shell environment file or with each \fBgit\-secret\fR command\. @@ -90,7 +90,7 @@ This directory currently contains only the file \fBmapping\.cfg\fR, which lists All the other internal data is stored in the directory: . .SS "\.gitsecret/keys" -This directory contains data used by git\-secret and PGP to allow and maintain the correct encyption and access rights for the permitted parties\. +This directory contains data used by git\-secret and PGP to allow and maintain the correct encryption and access rights for the permitted parties\. . .P Generally speaking, all the files in this directory \fIexcept\fR \fBrandom_seed\fR should be checked into your repo\.