Tools to make secret sharing easier.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 

128 lines
2.9 KiB

.TH GFSEC-SPLIT 08/30/2015 "gfsecret @PACKAGE_VERSION@"
.SH NAME
gfsec-split \- Split a file into shares and dispatch them
.SH SYNOPSIS
.SY gfsec-split
.RB [ \-h | --help ]
.RB [ \-v | --version ]
.RB [ \-n | --threshold
.IR N ]
.RB [ \-c | --config
.IR file ]
.RB [ \-k | --keep ]
.RB [ \-l | --list-supports ]
.B file
.B URI...
.YS
.SH DESCRIPTION
.PP
.B gfsec-split
splits a file into a number of shares and dispatches
the resulting shares onto external storage supports.
.PP
The splitted file can then be temporarily reconstructed
using the accompanying program
.BR gfsec-use (1).
.SH OPTIONS
.TP
.BR -h ", " --help
Display the help message.
.TP
.BR -v ", " --version
Display the version message.
.TP
.BR -n ", " --threshold " " \fiN\fR
Specify the minimal number of shares required to
re-assemble the splitted file. Default is 2.
.TP
.BR -c ", " --config " " \fiFILE\fR
Write the configuration file (allowing to reconstruct
the secret with
.BR gfsec-use (1)
) to the specified file. Default is the basename of
the splitted file in $XDG_CONFIG_HOME/gfsecret.
.TP
.BR -k ", " --keep
By default,
.B gfsec-split
will delete the original file once it has been
successfully splitted. Use this option to prevent
the file to be deleted.
.TP
.BR -l ", " --list-supports
List all the currently available supports which can
be used to store shares, then quit.
.SH SHARE URIs
.PP
Shares are described using a URI-like syntax. For each share,
the URI indicates a storage device and a pathname on that device.
.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.
.SH EXAMPLE INVOCATION
.PP
.nf
gfsec-split \\
/home/alice/mysecret \\
file:///home/alice/.local/share/gfsecret/mysecret \\
label://USBSTICK/mysecret \\
mtp://RF2GB6X704P/Documents/mysecret \\
.fi
.PP
The above example will split the file
.I /home/alice/mysecret
into three shares: one on the local filesystem, one on the
USB mass storage device with the label \fIUSBSTICK\fR, and
one on the MTP-compliant device with the serial \fIRF2GB6X704P\fR.
A configuration file will be written in
.I $XDG_CONFIG_HOME/gfsecret/mysecret
allowing to automatically reconstruct the file with
.BR gfsec-use (1)
provided at least one of the two removable supports are
present.
.SH REPORTING BUGS
.PP
Report bugs to
.MT @PACKAGE_BUGREPORT@
Damien Goutte-Gattat
.ME .
.SH SEE ALSO
.BR gfsec-use (1),
.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 .