diff --git a/man/man1/git-secret-add.1 b/man/man1/git-secret-add.1 index f3208e8c..5b94ec6f 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" "June 2018" "sobolevn" "git-secret" +.TH "GIT\-SECRET\-ADD" "1" "August 2018" "sobolevn" "git-secret" . .SH "NAME" \fBgit\-secret\-add\fR \- starts to track added files\. @@ -15,7 +15,10 @@ git secret add [\-i] \.\.\. .fi . .SH "DESCRIPTION" -\fBgit\-secret\-add\fR adds a filepath(es) into \fB\.gitsecret/paths/mapping\.cfg\fR\. When adding files to encrypt, ensure that they are ignored by \fBgit\fR by mentioning them in \.gitignore, since they must be secure and not be committed into the remote repository unencrypted\. +\fBgit\-secret\-add\fR adds a filepath(es) into \fB\.gitsecret/paths/mapping\.cfg\fR\. +. +.P +When adding files to encrypt, ensure that they are ignored by \fBgit\fR by mentioning them in \.gitignore, since they must be secure and not be committed into the remote repository unencrypted\. . .P If there\'s no users in the \fBgit\-secret\fR\'s keyring, when adding a file, an exception will be raised\. @@ -26,6 +29,9 @@ Use the \fBgit secret add\fR command to add filenames to this file\. .br It is not recommended to add filenames directly into \fB\.gitsecret/paths/mapping\.cfg\fR\. . +.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 diff --git a/man/man1/git-secret-cat.1 b/man/man1/git-secret-cat.1 index 690cb0c5..75da68ee 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" "June 2018" "sobolevn" "git-secret" +.TH "GIT\-SECRET\-CAT" "1" "August 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 fcdd05c6..a0e4ad1f 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" "July 2018" "sobolevn" "git-secret" +.TH "GIT\-SECRET\-CHANGES" "1" "August 2018" "sobolevn" "git-secret" . .SH "NAME" \fBgit\-secret\-changes\fR \- view diff of the hidden files\. diff --git a/man/man1/git-secret-clean.1 b/man/man1/git-secret-clean.1 index 34ddccc1..77a47dcf 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" "June 2018" "sobolevn" "git-secret" +.TH "GIT\-SECRET\-CLEAN" "1" "August 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 0156ece6..08d9aa44 100644 --- a/man/man1/git-secret-hide.1 +++ b/man/man1/git-secret-hide.1 @@ -20,6 +20,9 @@ git secret hide [\-c] [\-P] [\-v] [\-d] [\-m] .P It is possible to modify the names of the encrypted files by setting \fBSECRETS_EXTENSION\fR variable\. . +.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 diff --git a/man/man1/git-secret-init.1 b/man/man1/git-secret-init.1 index 0a9f1358..758e4a50 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" "June 2018" "sobolevn" "git-secret" +.TH "GIT\-SECRET\-INIT" "1" "August 2018" "sobolevn" "git-secret" . .SH "NAME" \fBgit\-secret\-init\fR \- initializes git\-secret repository\. @@ -17,6 +17,9 @@ git secret init .SH "DESCRIPTION" \fBgit\-secret\-init\fR should be run inside a \fBgit\fR repo to set up the \.gitsecret directory and initialize the repo for git\-secret\. Until repository is initialized with \fBgit secret init\fR, all other \fBgit\-secret\fR commands are unavailable\. . +.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 diff --git a/man/man1/git-secret-killperson.1 b/man/man1/git-secret-killperson.1 index 30a68b2f..597047a9 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" "June 2018" "sobolevn" "git-secret" +.TH "GIT\-SECRET\-KILLPERSON" "1" "August 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 db6b8df3..c3ff9fc0 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" "June 2018" "sobolevn" "git-secret" +.TH "GIT\-SECRET\-LIST" "1" "August 2018" "sobolevn" "git-secret" . .SH "NAME" \fBgit\-secret\-list\fR \- prints all the added files\. @@ -17,6 +17,9 @@ git secret list .SH "DESCRIPTION" \fBgit\-secret\-list\fR prints all the currently added tracked files from the \fB\.gitsecret/paths/mapping\.cfg\fR\. . +.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 diff --git a/man/man1/git-secret-remove.1 b/man/man1/git-secret-remove.1 index 03f14faa..7d2e9e42 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" "June 2018" "sobolevn" "git-secret" +.TH "GIT\-SECRET\-REMOVE" "1" "August 2018" "sobolevn" "git-secret" . .SH "NAME" \fBgit\-secret\-remove\fR \- removes files from index\. @@ -17,6 +17,9 @@ git secret remove [\-c] \.\.\. .SH "DESCRIPTION" \fBgit\-secret\-remove\fR deletes files from \fB\.gitsecret/paths/mapping\.cfg\fR, so they won\'t be encrypted or decrypted in the future\. There\'s also a \-c option to delete existing encrypted versions of the files provided\. . +.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 diff --git a/man/man1/git-secret-reveal.1 b/man/man1/git-secret-reveal.1 index 4e60ac59..07a1a015 100644 --- a/man/man1/git-secret-reveal.1 +++ b/man/man1/git-secret-reveal.1 @@ -17,6 +17,9 @@ git secret reveal [\-f] [\-P] [\-d dir] [\-p password] .SH "DESCRIPTION" \fBgit\-secret\-reveal\fR \- decrypts all the files in \fB\.gitsecret/paths/mapping\.cfg\fR\. 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 diff --git a/man/man7/git-secret.7 b/man/man7/git-secret.7 index 7ce54893..81bc07b2 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" "July 2018" "sobolevn" "git-secret" +.TH "GIT\-SECRET" "7" "August 2018" "sobolevn" "git-secret" . .SH "NAME" \fBgit\-secret\fR @@ -66,16 +66,22 @@ The settings available to be changed are: .IP "\(bu" 4 \fB$SECRETS_EXTENSION\fR \- sets the secret files extension, defaults to \fB\.secret\fR\. It can be changed to any valid file extension\. . +.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 "" 0 . -.SH "The \.gitsecret folder" +.SH "The \.gitsecret folder (can be overridden with SECRETS_DIR)" This folder contains information about the files encrypted by git\-secret, and about which public/private key sets can access the encrypted data\. . .P +You can change the name of this directory using the SECRETS_DIR environment variable\. +. +.P Use the various \'git secret\' commands to manipulate the files in \fB\.gitsecret\fR, you should not change the data in these files directly\. . .P -Exactly which files exist in the \.gitsecret folder and what their contents are vary slightly across different versions of gpg\. Thus it is best to use git\-secret with the same version of gpg being used by all users\. This can be forced using SECRETS_GPG_COMMAND environment variable\. +Exactly which files exist in the \fB\.gitsecret\fR folder and what their contents are vary slightly across different versions of gpg\. Thus it is best to use git\-secret with the same version of gpg being used by all users\. This can be forced using SECRETS_GPG_COMMAND environment variable\. . .P Specifically, there is an issue between gpg version 2\.1\.20 and later versions which can cause problems reading and writing keyring files between systems (this shows up in errors like \'gpg: skipped packet of type 12 in keybox\')\. @@ -97,3 +103,6 @@ Generally speaking, all the files in this directory \fIexcept\fR \fBrandom_seed\ . .br By default, \fBgit secret init\fR will add the file \fB\.gitsecret/keys/random_seed\fR to your \.gitignore file\. +. +.P +Again, you can change the name of this directory using the SECRETS_DIR environment variable\.