4 changed files with 132 additions and 2 deletions
@ -0,0 +1,128 @@
|
||||
.TH GFSEC-USE 07/02/2016 "gfsecret @PACKAGE_VERSION@" |
||||
|
||||
.SH NAME |
||||
gfsec-use \- Make use of a shared secret |
||||
|
||||
.SH SYNOPSIS |
||||
.SY gfsec-use |
||||
.RB [ \-h | --help ] |
||||
.RB [ \-v | --version ] |
||||
.RB [ \-c | --config |
||||
.IR file ] |
||||
.RB [ \-o | --output |
||||
.IR file ] |
||||
.RB [ command... ] |
||||
.YS |
||||
|
||||
.SH DESCRIPTION |
||||
.PP |
||||
.B gfsec-use |
||||
reconstructs a secret file that has been previously |
||||
splitted using a tool like |
||||
.BR gfsplit (1). |
||||
.PP |
||||
A user-specified command (or a shell) is spawn once |
||||
the secret has been reconstructed, and the secret |
||||
file is deleted when the command terminates. |
||||
|
||||
.SH OPTIONS |
||||
.TP |
||||
.BR -h ", " --help |
||||
Display the help message. |
||||
.TP |
||||
.BR -v ", " --version |
||||
Display the version message. |
||||
.TP |
||||
.BR -c ", " --config " " \fIfile\fR |
||||
Specify a configuration file. If the specified |
||||
file does not exist, a .conf extension is appended |
||||
to the filename and a corresponding file is searched |
||||
in $XDG_CONFIG_HOME/gfsecret. When that option is |
||||
not used, a default configuration |
||||
$XDG_CONFIG_HOME/gfsecret/default.conf is assumed. |
||||
.TP |
||||
.BR -o ", " --output " " \fIfile\fR |
||||
Write the reconstructed secret in the specified |
||||
file. This overrides the OUTFILE parameter in the |
||||
configuration file. |
||||
|
||||
.SH CONFIGURATION FILE |
||||
.PP |
||||
A configuration file describes one secret file to reconstruct. |
||||
Blank lines and lines starting with a # character are ignored. |
||||
.PP |
||||
The following directives can be used: |
||||
.TP |
||||
OUTFILE=\fIfile\fR |
||||
Specify the file to write the reconstructed secret into. |
||||
.TP |
||||
MINSHARES=\fIn\fR |
||||
Specify the minimal number of shares needed to reconstruct |
||||
the secret. The default if unspecified is 2. |
||||
.TP |
||||
URI=\fIuri\fR |
||||
Specify an URI indicating where to find a share. |
||||
|
||||
.PP |
||||
Supported URI schemes are: |
||||
.TP |
||||
file:/// |
||||
Indicates a file on the local filesystem. |
||||
.TP |
||||
uuid://\fIuuid\fR/ |
||||
Indicates a file on the external volume identified |
||||
by the specified UUID. |
||||
.TP |
||||
label://\fIlabel\fR/ |
||||
Indicates a file on the external volume identified |
||||
by the specified label. |
||||
.TP |
||||
mtp://\fIserial\fR/ |
||||
Indicates a file on the MTP device identified by the |
||||
specified serial number. |
||||
|
||||
.PP |
||||
Whatever the scheme, the file part of the URI must end |
||||
with an extension indicating the share number, as |
||||
generated by |
||||
.BR gfsplit (1). |
||||
|
||||
.PP |
||||
The URI may include a \fIshare=no\fR parameter, |
||||
indicating that the corresponding file contains the |
||||
whole secret and not only a share (in that case, the |
||||
previous remark about the share number in the extension |
||||
does not apply). |
||||
|
||||
.SH EXAMPLE CONFIGURATION FILE |
||||
.PP |
||||
.nf |
||||
OUTFILE=/home/alice/mysecret |
||||
MINSHARES=2 |
||||
URI=file:///home/alice/.local/share/gfsecret/mysecret.024 |
||||
URI=label://USBSTICK/mysecret.070 |
||||
URI=mtp://RF2GB6X704P/Documents/mysecret.139 |
||||
.fi |
||||
|
||||
.SH REPORTING BUGS |
||||
.PP |
||||
Report bugs to |
||||
.MT @PACKAGE_BUGREPORT@ |
||||
Damien Goutte-Gattat |
||||
.ME . |
||||
|
||||
.SH SEE ALSO |
||||
.BR gfsplit (1), |
||||
.BR gfcombine (1), |
||||
.BR libgfshare (3), |
||||
.BR gfshare (7) |
||||
|
||||
.SH COPYRIGHT |
||||
.ad l |
||||
.PP |
||||
Copyright \(co 2016 Damien Goutte-Gattat |
||||
.PP |
||||
This program is released under the GNU General Public License. |
||||
See the COPYING file in the source distribution or |
||||
.UR http://www.gnu.org/licenses/gpl.html |
||||
.UE . |
Loading…
Reference in new issue