From d5096614cc02827238c42aac8de036c46687f173 Mon Sep 17 00:00:00 2001 From: Josh Rabinowitz Date: Wed, 18 Sep 2019 16:56:42 -0400 Subject: [PATCH] update man pages and changelog --- CHANGELOG.md | 6 ++++++ man/man1/git-secret-add.1 | 2 +- man/man1/git-secret-cat.1 | 5 ++++- man/man1/git-secret-changes.1 | 5 ++++- man/man1/git-secret-clean.1 | 2 +- man/man1/git-secret-hide.1 | 10 +++++----- 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 | 8 ++++---- man/man1/git-secret-tell.1 | 2 +- man/man1/git-secret-usage.1 | 2 +- man/man1/git-secret-whoknows.1 | 2 +- man/man7/git-secret.7 | 5 ++++- 15 files changed, 36 insertions(+), 21 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 13c4247b..566bee79 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # Changelog +## {{Next Version}} + +## Misc + +Update man pages from roff sources. + ## Version 0.3.0 ### Features diff --git a/man/man1/git-secret-add.1 b/man/man1/git-secret-add.1 index 4b9ca514..947d429f 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" "March 2019" "sobolevn" "git-secret" +.TH "GIT\-SECRET\-ADD" "1" "September 2019" "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 5d2df471..eb63d2a0 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" "February 2019" "sobolevn" "git-secret" +.TH "GIT\-SECRET\-CAT" "1" "September 2019" "sobolevn" "git-secret" . .SH "NAME" \fBgit\-secret\-cat\fR \- decrypts files passed on command line to stdout @@ -17,6 +17,9 @@ git secret cat [\-d dir] [\-p password] filename [filenames] .SH "DESCRIPTION" \fBgit\-secret\-cat\fR \- Outputs to stdout the contents of the files named on the command line\. As with \fBgit\-secret\-reveal\fR, you\'ll need to have a public/private keypair that is allowed to decrypt this repo\. . +.P +Note also that this command can be affected by the \fBSECRETS_PINENTRY\fR environment variable\. See (See git\-secret(7) \fIhttp://git\-secret\.io/git\-secret\fR for information using \fBSECRETS_PINENTRY\fR\. +. .SH "OPTIONS" . .nf diff --git a/man/man1/git-secret-changes.1 b/man/man1/git-secret-changes.1 index 1cb0cefc..f9dd1c30 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" "February 2019" "sobolevn" "git-secret" +.TH "GIT\-SECRET\-CHANGES" "1" "September 2019" "sobolevn" "git-secret" . .SH "NAME" \fBgit\-secret\-changes\fR \- view diff of the hidden files\. @@ -17,6 +17,9 @@ git secret changes [\-h] [\-d dir] [\-p password] [pathspec]\.\.\. .SH "DESCRIPTION" \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\. . +.P +Note also that this command can be affected by the \fBSECRETS_PINENTRY\fR environment variable\. See (See git\-secret(7) \fIhttp://git\-secret\.io/git\-secret\fR for information using \fBSECRETS_PINENTRY\fR\. +. .SH "OPTIONS" . .nf diff --git a/man/man1/git-secret-clean.1 b/man/man1/git-secret-clean.1 index 3c84ac8d..3f99a12e 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" "March 2019" "sobolevn" "git-secret" +.TH "GIT\-SECRET\-CLEAN" "1" "September 2019" "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 adf9529e..b6f96263 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" "March 2019" "sobolevn" "git-secret" +.TH "GIT\-SECRET\-HIDE" "1" "September 2019" "sobolevn" "git-secret" . .SH "NAME" \fBgit\-secret\-hide\fR \- encrypts all added files with the inner keyring\. @@ -27,7 +27,7 @@ Otherwise the keychain (the one stored in \fB\.gitsecret/keys/*\.gpg\fR), may ha In other words, unless you re\-encrypt all the files in a repo each time you \'hide\' any, it\'s possible to make it so some files can no longer be decrypted by users who should be (and would appear) able to decrypt them, and vice\-versa\. . .P -If you know what you are doing and wish to encrypt or re\-encrypt only a subset of the files even after reading the above paragraphs, you can use the \-F option to force \fBgit secret hide\fR to skip any hidden files where the unencrypted versions aren\'t present\. +If you know what you are doing and wish to encrypt or re\-encrypt only a subset of the files even after reading the above paragraphs, you can use the \-F or \-m option to only encrypted a subset of files\. The \-F option forces \fBgit secret hide\fR to skip any hidden files where the unencrypted versions aren\'t present\. The \-m option skips any hidden files that have not be modified since the last time they were encrypted\. . .P Also, it is possible to modify the names of the encrypted files by setting \fBSECRETS_EXTENSION\fR variable\. @@ -35,6 +35,9 @@ Also, it is possible to modify the names of the encrypted files by setting \fBSE .P (See git\-secret(7) \fIhttp://git\-secret\.io/git\-secret\fR for information about renaming the \.gitsecret folder using the SECRETS_DIR environment variable\. . +.P +You can also enable verbosity using the SECRETS_VERBOSE environment variable, as documented at git\-secret(7) \fIhttp://git\-secret\.io/\fR +. .SH "OPTIONS" . .nf @@ -49,9 +52,6 @@ Also, it is possible to modify the names of the encrypted files by setting \fBSE . .fi . -.P -You can also enable verbosity using the SECRETS_VERBOSE environment variable, as documented at git\-secret(7) \fIhttp://git\-secret\.io/\fR -. .SH "MANUAL" Run \fBman git\-secret\-hide\fR to see this note\. . diff --git a/man/man1/git-secret-init.1 b/man/man1/git-secret-init.1 index d440c86e..881e282d 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" "March 2019" "sobolevn" "git-secret" +.TH "GIT\-SECRET\-INIT" "1" "July 2019" "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 82cffd9a..99d9b960 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" "February 2019" "sobolevn" "git-secret" +.TH "GIT\-SECRET\-KILLPERSON" "1" "July 2019" "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 a83122b4..bcad575c 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" "February 2019" "sobolevn" "git-secret" +.TH "GIT\-SECRET\-LIST" "1" "July 2019" "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 548b8f8d..194ad1f5 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" "February 2019" "sobolevn" "git-secret" +.TH "GIT\-SECRET\-REMOVE" "1" "July 2019" "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 d77df4d4..45eb4e56 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" "March 2019" "sobolevn" "git-secret" +.TH "GIT\-SECRET\-REVEAL" "1" "September 2019" "sobolevn" "git-secret" . .SH "NAME" \fBgit\-secret\-reveal\fR \- decrypts all added files\. @@ -17,9 +17,6 @@ git secret reveal [\-f] [\-F] [\-P] [\-v] [\-d dir] [\-p password] [pathspec]\.\ .SH "DESCRIPTION" \fBgit\-secret\-reveal\fR \- decrypts all the files in \fB\.gitsecret/paths/mapping\.cfg\fR, or the passed \fBpathspec\fRs\. You will need to have imported the paired secret\-key with one of the public\-keys which were used in the encryption\. Under the hood, this uses the \fBgpg \-\-decrypt\fR command\. . -.P -(See git\-secret(7) \fIhttp://git\-secret\.io/git\-secret\fR for information about renaming the \.gitsecret folder using the SECRETS_DIR environment variable\. -. .SH "OPTIONS" . .nf @@ -34,6 +31,9 @@ git secret reveal [\-f] [\-F] [\-P] [\-v] [\-d dir] [\-p password] [pathspec]\.\ . .fi . +.P +(See git\-secret(7) \fIhttp://git\-secret\.io/git\-secret\fR for information about renaming the \.gitsecret folder using the SECRETS_DIR environment variable\. +. .SH "MANUAL" Run \fBman git\-secret\-reveal\fR to see this note\. . diff --git a/man/man1/git-secret-tell.1 b/man/man1/git-secret-tell.1 index 496beb4a..0a257a71 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" "February 2019" "sobolevn" "git-secret" +.TH "GIT\-SECRET\-TELL" "1" "July 2019" "sobolevn" "git-secret" . .SH "NAME" \fBgit\-secret\-tell\fR \- adds a person, who can access private data\. diff --git a/man/man1/git-secret-usage.1 b/man/man1/git-secret-usage.1 index d68bfc40..458a784c 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" "February 2019" "sobolevn" "git-secret" +.TH "GIT\-SECRET\-USAGE" "1" "July 2019" "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 e4382fa3..185413dc 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" "February 2019" "sobolevn" "git-secret" +.TH "GIT\-SECRET\-WHOKNOWS" "1" "July 2019" "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 02ce68ce..e8dff960 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" "March 2019" "sobolevn" "git-secret" +.TH "GIT\-SECRET" "7" "September 2019" "sobolevn" "git-secret" . .SH "NAME" \fBgit\-secret\fR \- bash tool to store private data inside a git repo\. @@ -72,6 +72,9 @@ The settings available to be changed are: .IP "\(bu" 4 \fB$SECRETS_DIR\fR \- sets the directory where git\-secret stores its files, defaults to \.gitsecret\. It can be changed to any valid directory name\. . +.IP "\(bu" 4 +\fB$SECRETS_PINENTRY\fR \- allows user to specify a setting for \fBgpg\fR\'s \-\-pinentry option\. See \fBgpg\fR docs for details about gpg\'s \-\-pinentry option\. +. .IP "" 0 . .SH "The \.gitsecret folder (can be overridden with SECRETS_DIR)"