.TH GFSEC-SPLIT 1 2017-07-25 "gfsecret 0.4.6" "Gfsecret Manual"

.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 [ \-i | --interactive ]
.RB [ \-k | --keep ]
.RB [ \-o | --output
.IR file ]
.RB [ \-r | --restore-cmd
.IR command ]
.RB [ \-d | --destroy-cmd
.IR command ]
.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 split 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 split 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 split file in $XDG_CONFIG_HOME/gfsecret.
If \fiFILE\fR is a single filename without extension and
without a directory part, the file will be placed under
the $XDG_CONFIG_HOME/gfsecret directory with a .conf
extension.
.TP
.BR -i ", " --interactive
Present the user with an interactive menu to specify the
shares to create.
.TP
.BR -k ", " --keep
By default,
.B gfsec-split
will delete the original file once it has been
successfully split. Use this option to prevent
the file to be deleted.
.BR -o ", " --output " " \fIfile\fR
Specify the location where gfsec-use will write the
reconstructed secret. The default is to use the
original location. If set to an empty string, no
location will be written in the configuration file.
.BR -r ", " --restore-cmd " " \fIcommand\fR
Specify the command that gfsec-use will call to
restore the secret.
.BR -d ", " --destroy-cmd " " \fIcommand\fR
Specify the command that gfsec-use will call to
destroy the secret when it is no longer needed.
The same command will also be called by gfsec-split
to destroy the secret once it has been split,
unless the -k option has been used.
.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 devel@incenp.org
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 2017 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 .