From 92be14c23274c5c4ffe42a6250878226a5034a33 Mon Sep 17 00:00:00 2001 From: sobolevn Date: Sun, 29 May 2016 13:37:25 +0300 Subject: [PATCH] Updated the missing manual for `git-secret-changes` --- man/man1/git-secret-add.1 | 5 ++-- man/man1/git-secret-changes.1 | 31 +++++++++++++++++++++++++ man/man1/git-secret-reveal.1 | 5 ++-- man/man7/git-secret.7 | 43 ++++++++++++++++++++++++++++------- 4 files changed, 72 insertions(+), 12 deletions(-) create mode 100644 man/man1/git-secret-changes.1 diff --git a/man/man1/git-secret-add.1 b/man/man1/git-secret-add.1 index d5a3cc4a..313253bc 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" "February 2016" "" "" +.TH "GIT\-SECRET\-ADD" "1" "May 2016" "" "" . .SH "NAME" \fBgit\-secret\-add\fR \- starts to track added files\. @@ -10,7 +10,7 @@ . .nf -git secret add \.\.\. +git secret add [\-i] \.\.\. . .fi . @@ -27,6 +27,7 @@ It is not recommened to add filenames directly into the \fB\.gitsecret/paths/map . .nf +\-i \- auto adds given files to the `\.gitignore` if they are unignored at the moment\. \-h \- shows this help\. . .fi diff --git a/man/man1/git-secret-changes.1 b/man/man1/git-secret-changes.1 new file mode 100644 index 00000000..eee5f776 --- /dev/null +++ b/man/man1/git-secret-changes.1 @@ -0,0 +1,31 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "GIT\-SECRET\-CHANGES" "1" "May 2016" "" "" +. +.SH "NAME" +\fBgit\-secret\-changes\fR \- view diff of the hidden files\. +. +.SH "SYNOPSIS" +. +.nf + +git secret changes [\-h] [\-d dir] [\-p password] \.\.\. +. +.fi +. +.SH "DESCRIPTION" +\fBgit\-secret\-changes\fR \- shows changes between the current version of hidden files and the ones already commited\. +. +.SH "OPTIONS" +. +.nf + +\-d \- specifies `\-\-homedir` option for the `gpg`, basically use this option if your store your keys in a custom location\. +\-p \- specifies password for noinput mode, adds `\-\-passphrase` option for `gpg`\. +\-h \- shows help\. +. +.fi +. +.SH "SEE ALSO" +git\-secret\-add(1), git\-secret\-tell(1), git\-secret\-hide(1), git\-secret\-reveal(1) diff --git a/man/man1/git-secret-reveal.1 b/man/man1/git-secret-reveal.1 index 7f8956ab..1125954f 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 2016" "" "" +.TH "GIT\-SECRET\-REVEAL" "1" "May 2016" "" "" . .SH "NAME" \fBgit\-secret\-reveal\fR \- decrypts all added files\. @@ -10,7 +10,7 @@ . .nf -git secret reveal [\-d dir] [\-p password] +git secret reveal [\-f] [\-d dir] [\-p password] . .fi . @@ -21,6 +21,7 @@ git secret reveal [\-d dir] [\-p password] . .nf +\-f \- forces to overwrite exisiting files without prompt\. \-d \- specifies `\-\-homedir` option for the `gpg`, basically use this option if your store your keys in a custom location\. \-p \- specifies password for noinput mode, adds `\-\-passphrase` option for `gpg`\. \-h \- shows help\. diff --git a/man/man7/git-secret.7 b/man/man7/git-secret.7 index 28db63f7..e7e87031 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 2016" "" "" +.TH "GIT\-SECRET" "7" "May 2016" "" "" . .SH "NAME" \fBgit\-secret\fR @@ -17,6 +17,9 @@ .IP "3." 4 \fIUsage\fR . +.IP "4." 4 +\fIConfiguration\fR +. .IP "" 0 . .SH "Intro" @@ -69,29 +72,38 @@ There are several ways to install \fBgit\-secret\fR: \fBBrew\fR . .IP "1." 4 -Run \fBbrew install sobolevn/tap/git\-secret\fR +Run \fBbrew install git\-secret\fR\. That will do\. Also, there are two options: +. +.IP "2." 4 +\fB\-\-without\-gpg\fR to build without \fBgpg\fR support +. +.IP "3." 4 +\fB\-\-HEAD\fR to install \fBHEAD\fR version +. +.IP "4." 4 +Note, that we have migrated from \fBtap\fR to the official \fBbrew\fR repo . .IP "" 0 . .P -\fB\fBantigen\fR plugin (or any other \fBoh\-my\-zsh\fR\-styled plugin\-systems)\fR +\fBManual\fR . .IP "1." 4 -Add line \fBantigen bundle sobolevn/git\-secret\fR to your \fB\.zshrc\fR +Clone the repository first: \fBgit clone https://github\.com/sobolevn/git\-secret\.git git\-secret\fR . .IP "2." 4 -Run \fBsource ~/\.zshrc\fR or reopen the terminal +Run \fBPREFIX="/usr/local" make install\fR, note that you can install to any prefix in your \fBPATH\fR . .IP "" 0 . .P -\fB\fBmake install\fR\fR +\fB\fBantigen\fR plugin (or any other \fBoh\-my\-zsh\fR\-styled plugin\-systems)\fR . .IP "1." 4 -Download the latest realease here \fIhttps://github\.com/sobolevn/git\-secret/releases\fR +Add line \fBantigen bundle sobolevn/git\-secret\fR to your \fB\.zshrc\fR . .IP "2." 4 -Unpack and run \fBmake install PREFIX="your/installation/path"\fR, note that this command may require \fBsudo\fR +Run \fBsource ~/\.zshrc\fR or reopen the terminal . .IP "" 0 . @@ -164,3 +176,18 @@ Reencypt the files, now they will be able to decrypt them with their secret key\ . .P Note, that it is possible to add yourself to the system 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, make sure to configure some server\-side security policy with the \fBpre\-receive\fR hook\. +. +.SH "Configuration" +You can configure several things 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 the each \fBgit\-secret\fR command\. +. +.P +These settings are available to be changed: +. +.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 tests to be sure, that it won\'t break anything\. Tested to be working with: \fBgpg\fR, \fBgpg2\fR\. +. +.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 "" 0 +