Browse Source

Update man pages

Update the man page for gfsec-use and add one for gfsec-split.
master
Damien Goutte-Gattat 5 years ago
parent
commit
fbcc3538b8
  1. 2
      configure.ac
  2. 2
      man/Makefile.am
  3. 136
      man/gfsec-split.1.in
  4. 12
      man/gfsec-use.1.in

2
configure.ac

@ -55,7 +55,7 @@ AC_DEFINE_UNQUOTED([GFSEC_SECRET_MAX_SIZE], [$max_secret_size],
dnl Output files
AC_CONFIG_FILES([Makefile lib/Makefile src/Makefile
man/Makefile man/gfsec-use.1])
man/Makefile man/gfsec-use.1 man/gfsec-split.1])
AC_OUTPUT
dnl Summary

2
man/Makefile.am

@ -1 +1 @@
man_MANS = gfsec-use.1
man_MANS = gfsec-use.1 gfsec-split.1

136
man/gfsec-split.1.in

@ -0,0 +1,136 @@
.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 [ \-s | --share
.IR URI ]
.RB [ \-c | --config
.IR file ]
.RB [ \-k | --keep ]
.RB [ \-l | --list-supports ]
.B file
.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 -s ", " --share " " \fiURI\fR
Specify the location of a share. See below for the
format of the
.I URI
parameter. Repeat this option for all of the shares
to be generated.
.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 \\
-s file:///home/alice/.local/share/gfsecret/mysecret \\
-s label://USBSTICK/mysecret \\
-s mtp://RF2GB6X704P/Documents/mysecret \\
/home/alice/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 .

12
man/gfsec-use.1.in

@ -19,7 +19,9 @@ gfsec-use \- Make use of a shared secret
.B gfsec-use
reconstructs a secret file that has been previously
splitted using a tool like
.BR gfsplit (1).
.BR gfsplit (1)
or the accompanying program
.BR gfsec-split (1).
.PP
A user-specified command (or a shell) is spawn once
the secret has been reconstructed, and the secret
@ -100,6 +102,13 @@ expected SHA-256 hash value of the share data. If such a
parameter is specified, a share will only be used if the
data matches the expected hash value.
.PP
The
.BR gfsec-split (1)
program, used to split a file into shares, will automatically
generate a suitable configuration file allowing to reconstruct
the original file.
.SH EXAMPLE CONFIGURATION FILE
.PP
.nf
@ -118,6 +127,7 @@ Damien Goutte-Gattat
.ME .
.SH SEE ALSO
.BR gfsec-split (1),
.BR gfsplit (1),
.BR gfcombine (1),
.BR libgfshare (3),

Loading…
Cancel
Save