Add docs for SECRETS_VERBOSE, env vars (#398)

5 years ago · 52b46ae700
parent 22fe1ed2d4
commit 52b46ae700
18 changed files with 34 additions and 17 deletions
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@ -3,6 +3,7 @@
 ## {{Next Version}}

 - Support SECRETS_VERBOSE env var to enable verbosity (#323)
+- Document SECRETS_VERBOSE and improve env var docs (#396)
 - Use gpg without --quiet when decrypting in verbose mode (#394)
 - Add -v 'verbose' option to 'tell', showing gpg output (#320)
 - Fix link to homebrew's git-secret in README.md (#310)
--- 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" "August 2018" "sobolevn" "git-secret"
+.TH "GIT\-SECRET\-ADD" "1" "February 2019" "sobolevn" "git-secret"
 .
 .SH "NAME"
 \fBgit\-secret\-add\fR \- starts to track added files\.
--- 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" "August 2018" "sobolevn" "git-secret"
+.TH "GIT\-SECRET\-CAT" "1" "February 2019" "sobolevn" "git-secret"
 .
 .SH "NAME"
 \fBgit\-secret\-cat\fR \- decrypts files passed on command line to stdout
--- 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" "August 2018" "sobolevn" "git-secret"
+.TH "GIT\-SECRET\-CHANGES" "1" "February 2019" "sobolevn" "git-secret"
 .
 .SH "NAME"
 \fBgit\-secret\-changes\fR \- view diff of the hidden files\.
--- 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" "August 2018" "sobolevn" "git-secret"
+.TH "GIT\-SECRET\-CLEAN" "1" "March 2019" "sobolevn" "git-secret"
 .
 .SH "NAME"
 \fBgit\-secret\-clean\fR \- removes all the hidden files\.
@ -21,11 +21,14 @@ git secret clean [\-v]
 .
 .nf

-\-v  \- shows which files are deleted\.
+\-v  \- verbose mode, shows which files are deleted\.
 \-h  \- shows this help\.
 .
 .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\-clean\fR to see this note\.
 .
--- a/man/man1/git-secret-clean.1.ronn
+++ b/man/man1/git-secret-clean.1.ronn
@ -13,9 +13,11 @@ Verbose output is enabled with the -v option, in which case the program prints w

 ## OPTIONS

-    -v  - shows which files are deleted.
+    -v  - verbose mode, shows which files are deleted. 
    -h  - shows this help.

+You can also enable verbosity using the SECRETS_VERBOSE environment variable,
+as documented at [git-secret(7)](http://git-secret.io/)

 ## MANUAL

--- 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" "October 2018" "sobolevn" "git-secret"
+.TH "GIT\-SECRET\-HIDE" "1" "March 2019" "sobolevn" "git-secret"
 .
 .SH "NAME"
 \fBgit\-secret\-hide\fR \- encrypts all added files with the inner keyring\.
@ -49,6 +49,9 @@ 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\.
 .
--- a/man/man1/git-secret-hide.1.ronn
+++ b/man/man1/git-secret-hide.1.ronn
@ -45,6 +45,8 @@ folder using the SECRETS_DIR environment variable.
    -m  - encrypt files only when modified.
    -h  - shows help.

+You can also enable verbosity using the SECRETS_VERBOSE environment variable,
+as documented at [git-secret(7)](http://git-secret.io/)

 ## MANUAL

--- 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" "February 2019" "sobolevn" "git-secret"
+.TH "GIT\-SECRET\-INIT" "1" "March 2019" "sobolevn" "git-secret"
 .
 .SH "NAME"
 \fBgit\-secret\-init\fR \- initializes git\-secret repository\.
--- 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" "August 2018" "sobolevn" "git-secret"
+.TH "GIT\-SECRET\-KILLPERSON" "1" "February 2019" "sobolevn" "git-secret"
 .
 .SH "NAME"
 \fBgit\-secret\-killperson\fR \- deletes key identified by an email from the inner keyring\.
--- 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" "August 2018" "sobolevn" "git-secret"
+.TH "GIT\-SECRET\-LIST" "1" "February 2019" "sobolevn" "git-secret"
 .
 .SH "NAME"
 \fBgit\-secret\-list\fR \- prints all the added files\.
--- 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" "August 2018" "sobolevn" "git-secret"
+.TH "GIT\-SECRET\-REMOVE" "1" "February 2019" "sobolevn" "git-secret"
 .
 .SH "NAME"
 \fBgit\-secret\-remove\fR \- removes files from index\.
--- 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" "October 2018" "sobolevn" "git-secret"
+.TH "GIT\-SECRET\-REVEAL" "1" "February 2019" "sobolevn" "git-secret"
 .
 .SH "NAME"
 \fBgit\-secret\-reveal\fR \- decrypts all added files\.
--- 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" "August 2018" "sobolevn" "git-secret"
+.TH "GIT\-SECRET\-TELL" "1" "February 2019" "sobolevn" "git-secret"
 .
 .SH "NAME"
 \fBgit\-secret\-tell\fR \- adds a person, who can access private data\.
--- 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" "August 2018" "sobolevn" "git-secret"
+.TH "GIT\-SECRET\-USAGE" "1" "February 2019" "sobolevn" "git-secret"
 .
 .SH "NAME"
 \fBgit\-secret\-usage\fR \- prints all the available commands\.
--- 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" "December 2018" "sobolevn" "git-secret"
+.TH "GIT\-SECRET\-WHOKNOWS" "1" "February 2019" "sobolevn" "git-secret"
 .
 .SH "NAME"
 \fBgit\-secret\-whoknows\fR \- prints email\-labels for each key in the keyring\.
--- a/man/man7/git-secret.7
+++ b/man/man7/git-secret.7
@ -54,13 +54,16 @@ The newly added user cannot yet read the encrypted files\. Now, re\-encrypt the
 .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 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"
+.SH "Environment Variables and 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\.
 .
 .P
 The settings available to be changed are:
 .
 .IP "\(bu" 4
+\fB$SECRETS_VERBOSE\fR \- sets the verbose flag to on for all \fBgit\-secret\fR commands; is identical to using \fB\-v\fR on each command that supports it\.
+.
+.IP "\(bu" 4
 \fB$SECRETS_GPG_COMMAND\fR \- sets the \fBgpg\fR alternatives, defaults to \fBgpg\fR\. It can be changed to \fBgpg\fR, \fBgpg2\fR, \fBpgp\fR, \fB/usr/local/gpg\fR or any other value\. After doing so rerun the tests to be sure that it won\'t break anything\. Tested to be working with: \fBgpg\fR, \fBgpg2\fR\.
 .
 .IP "\(bu" 4
--- a/man/man7/git-secret.7.ronn
+++ b/man/man7/git-secret.7.ronn
@ -47,7 +47,7 @@ Note that it is possible to add yourself to the git-secret repo without decrypti
 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 `pre-receive` hook.

-## Configuration
+## Environment Variables and 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. 
@ -55,6 +55,9 @@ This can be done in your shell environment file or with each `git-secret` comman

 The settings available to be changed are:

+* `$SECRETS_VERBOSE` - sets the verbose flag to on for all `git-secret` commands; is identical
+to using `-v` on each command that supports it.
+
 * `$SECRETS_GPG_COMMAND` - sets the `gpg` alternatives, defaults to `gpg`. 
 It can be changed to `gpg`, `gpg2`, `pgp`, `/usr/local/gpg` or any other value. 
 After doing so rerun the tests to be sure that it won't break anything. Tested to be working with: `gpg`, `gpg2`.