manuals updated, development hook created

Makefile

@@ -9,8 +9,6 @@ clean:
 
 build: git-secret
 
-develop: clean build
-
 install-test:
 	git clone https://github.com/sstephenson/bats.git vendor/bats
 
@@ -27,3 +25,9 @@ install-man:
 build-man:
 	@if [ ! `gem list ronn -i` == "true" ]; then make install-man; fi
 	ronn --roff man/man1/*.ronn
+
+install-hooks:
+	@ln -fs "${PWD}/utils/pre-commit.sh" "${PWD}/.git/hooks/pre-commit"
+	@chmod +x "${PWD}/.git/hooks/pre-commit"
+
+develop: clean build install-hooks

man/man1/git-secret-add.1

@@ -7,7 +7,12 @@
 \fBgit\-secret\-add\fR \- starts to track added files\.
 .
 .SH "SYNOPSIS"
-\fBgit\-secret\-add\fR \- receives a list of files, then adds them into the \fBgit\-secret\fR, these files will be encrypted and decrypted on the appropriate commands\.
+.
+.nf
+
+git secret add [<pathspec>\.\.\.]
+.
+.fi
 .
 .SH "DESCRIPTION"
 \fBgit\-secret\-add\fR adds a filepath(es) into the \fB\.gitsecret/paths/mapping\.cfg\fR\. When adding files, ensure that they are ignored by \fBgit\fR, since they must be secure and not be commited into the remote repository unencrypted\.

man/man1/git-secret-add.1.ronn

@@ -2,7 +2,8 @@ git-secret-add - starts to track added files.
 =============================================
 
 ## SYNOPSIS
-`git-secret-add` - receives a list of files, then adds them into the `git-secret`, these files will be encrypted and decrypted on the appropriate commands.
+
+    git secret add [<pathspec>...]
 
 
 ## DESCRIPTION

man/man1/git-secret-hide.1

@@ -7,7 +7,12 @@
 \fBgit\-secret\-hide\fR \- encrypts all added files with the inner keyring\.
 .
 .SH "SYNOPSIS"
-\fBgit\-secret\-hide\fR \- uses a \fBgpg\fR\'s \fB\-\-encrypt\fR for all receipients in the \fBgit\-secret\fR\'s keyring\.
+.
+.nf
+
+git secret hide [\-c] [\-v] [\-h]
+.
+.fi
 .
 .SH "DESCRIPTION"
 \fBgit\-secret\-hide\fR create an encrypted version for each file added by \fBgit\-secret\-add\fR command\. Now anyone one from the \fBgit\-secret\fR\'s keyring can decrypt these files using the their secret key\.

man/man1/git-secret-hide.1.ronn

@@ -2,7 +2,8 @@ git-secret-hide - encrypts all added files with the inner keyring.
 ==================================================================
 
 ## SYNOPSIS
-`git-secret-hide` - uses a `gpg`'s `--encrypt` for all receipients in the `git-secret`'s keyring.
+
+    git secret hide [-c] [-v] [-h]
 
 
 ## DESCRIPTION

man/man1/git-secret-init.1

@@ -7,7 +7,12 @@
 \fBgit\-secret\-init\fR \- initializes git\-secret repository\.
 .
 .SH "SYNOPSIS"
-\fBgit\-secret\-init\fR \- creates \fB\.gitsecret\fR directory\.
+.
+.nf
+
+git secret init
+.
+.fi
 .
 .SH "DESCRIPTION"
 \fBgit\-secret\-init\fR should be runned inside a \fBgit\fR repo\. \fBgit\-secret\-init\fR is the first command to be runned, until the git\-secret repository is inited other commands are unavailable\.

man/man1/git-secret-init.1.ronn

@@ -2,7 +2,8 @@ git-secret-init - initializes git-secret repository.
 ====================================================
 
 ## SYNOPSIS
-`git-secret-init` - creates `.gitsecret` directory.
+
+    git secret init
 
 
 ## DESCRIPTION

man/man1/git-secret-reveal.1

@@ -7,7 +7,12 @@
 \fBgit\-secret\-reveal\fR \- decrypts all added files\.
 .
 .SH "SYNOPSIS"
-\fBgit\-secret\-reveal\fR \- uses a \fBgpg\fR\'s \fB\-\-decrypt\fR to decrypt files with the user\'s secret key, which is store somewhere outside the \fBgit\-secret\fR repo\.
+.
+.nf
+
+git secret reveal [\-p] [\-d] [\-h]
+.
+.fi
 .
 .SH "DESCRIPTION"
 \fBgit\-secret\-reveal\fR \- decrypts all the files in the \fB\.gitsecret/paths/mapping\.cfg\fR by running a \fBgpg \-\-decrypt\fR command\. It is important to have paired secret\-key for one of the public\-keys, which were used in the encryption\.

man/man1/git-secret-reveal.1.ronn

@@ -2,7 +2,8 @@ git-secret-reveal - decrypts all added files.
 =============================================
 
 ## SYNOPSIS
-`git-secret-reveal` - uses a `gpg`'s `--decrypt` to decrypt files with the user's secret key, which is store somewhere outside the `git-secret` repo.
+
+    git secret reveal [-p] [-d] [-h]
 
 
 ## DESCRIPTION

man/man1/git-secret-tell.1

@@ -7,7 +7,12 @@
 \fBgit\-secret\-tell\fR \- adds a person, who can access a private data\.
 .
 .SH "SYNOPSIS"
-\fBgit\-secret\-tell\fR \- adds a person\'s key into the keychain, who can encrypt and decrypt all the secret files\.
+.
+.nf
+
+git secret tell [\-m] [\-d] [\-h]
+.
+.fi
 .
 .SH "DESCRIPTION"
 \fBgit\-secret\-tell\fR receives an email address as an input, searches for the \fBgpg\fR\-key in the \fBgpg\fR\'s \fBhomedir\fR by this email, then import a person\'s public key into the \fBgit\-secret\fR\'s inner keychain\. Since this moment this person can encrypt new files with the keyring which contains his key\. But he cannot decrypt the old files, which were already encrypted without his key\. They should be reencrypted with the new keyring by someone, who has the unencrypted files\.

man/man1/git-secret-tell.1.ronn

@@ -2,7 +2,8 @@ git-secret-tell - adds a person, who can access a private data.
 ===============================================================
 
 ## SYNOPSIS
-`git-secret-tell` - adds a person's key into the keychain, who can encrypt and decrypt all the secret files.
+
+    git secret tell [-m] [-d] [-h]
 
 
 ## DESCRIPTION

utils/pre-commit.sh

@@ -0,0 +1,9 @@
+#!/bin/sh
+
+set -e
+
+# Run tests:
+make test
+
+# Build new manuals:
+make build-man