ronn/man doc improvements

pull/142/head
Josh Rabinowitz 7 years ago
parent 5c5a49bc3b
commit 74e3404f36

@ -15,13 +15,13 @@ git secret cat [\-d dir] [\-p password] filename [filenames]
.fi .fi
. .
.SH "DESCRIPTION" .SH "DESCRIPTION"
\fBgit\-secret\-cat\fR \- Outputs to stdout the contents of the files named on the command line by running a \fBgpg \-\-decrypt\fR command\. As with \fBgit\-secret\-reveal\fR, it is important to have paired secret\-key with one of the public\-keys, which were used in the encryption\. \fBgit\-secret\-cat\fR \- Outputs to stdout the contents of the files named on the command line by running \fBgpg \-\-decrypt\fR\. As with \fBgit\-secret\-reveal\fR, it is important to have the paired secret\-key with one of the public\-keys which were used in the encryption\.
. .
.SH "OPTIONS" .SH "OPTIONS"
. .
.nf .nf
\-d \- specifies `\-\-homedir` option for the `gpg`, basically use this option if your store your keys in a custom location\. \-d \- specifies `\-\-homedir` option for the `gpg`, basically use this option if you store your keys in a custom location\.
\-p \- specifies password for noinput mode, adds `\-\-passphrase` option for `gpg`\. \-p \- specifies password for noinput mode, adds `\-\-passphrase` option for `gpg`\.
\-h \- shows help\. \-h \- shows help\.
. .

@ -7,12 +7,12 @@ git-secret-cat - decrypts files passed on command line to stdout
## DESCRIPTION ## DESCRIPTION
`git-secret-cat` - Outputs to stdout the contents of the files named on the command line by running a `gpg --decrypt` command. As with `git-secret-reveal`, it is important to have paired secret-key with one of the public-keys, which were used in the encryption. `git-secret-cat` - Outputs to stdout the contents of the files named on the command line by running `gpg --decrypt`. As with `git-secret-reveal`, it is important to have the paired secret-key with one of the public-keys which were used in the encryption.
## OPTIONS ## OPTIONS
-d - specifies `--homedir` option for the `gpg`, basically use this option if your store your keys in a custom location. -d - specifies `--homedir` option for the `gpg`, basically use this option if you store your keys in a custom location.
-p - specifies password for noinput mode, adds `--passphrase` option for `gpg`. -p - specifies password for noinput mode, adds `--passphrase` option for `gpg`.
-h - shows help. -h - shows help.

@ -15,14 +15,14 @@ git secret reveal [\-f] [\-d dir] [\-p password]
.fi .fi
. .
.SH "DESCRIPTION" .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 with one of the public\-keys which were used in the encryption\. \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 the paired secret\-key with one of the public\-keys which were used in the encryption\.
. .
.SH "OPTIONS" .SH "OPTIONS"
. .
.nf .nf
\-f \- forces to overwrite exisiting files without prompt\. \-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\. \-d \- specifies `\-\-homedir` option for the `gpg`, basically use this option if you store your keys in a custom location\.
\-p \- specifies password for noinput mode, adds `\-\-passphrase` option for `gpg`\. \-p \- specifies password for noinput mode, adds `\-\-passphrase` option for `gpg`\.
\-h \- shows help\. \-h \- shows help\.
. .

@ -7,13 +7,13 @@ git-secret-reveal - decrypts all added files.
## DESCRIPTION ## DESCRIPTION
`git-secret-reveal` - decrypts all the files in the `.gitsecret/paths/mapping.cfg` by running a `gpg --decrypt` command. It is important to have paired secret-key with one of the public-keys which were used in the encryption. `git-secret-reveal` - decrypts all the files in the `.gitsecret/paths/mapping.cfg` by running a `gpg --decrypt` command. It is important to have the paired secret-key with one of the public-keys which were used in the encryption.
## OPTIONS ## OPTIONS
-f - forces to overwrite exisiting files without prompt. -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. -d - specifies `--homedir` option for the `gpg`, basically use this option if you store your keys in a custom location.
-p - specifies password for noinput mode, adds `--passphrase` option for `gpg`. -p - specifies password for noinput mode, adds `--passphrase` option for `gpg`.
-h - shows help. -h - shows help.

Loading…
Cancel
Save