Browse Source

Update documentation

Update README file and manual page for the change in gfsec-split
syntax.
master
Damien Goutte-Gattat 5 years ago
parent
commit
7680515f1e
  1. 14
      README.md
  2. 18
      man/gfsec-split.1.in

14
README.md

@ -49,17 +49,17 @@ The _gfsec-split_ program allows to split a file into _M_ shares,
dispatch them at distinct locations (including external storage
devices), then delete the original file.
The program takes the path to the file to split as its single positional
argument. Use the `-s` option to specify a share to create using the URI
syntax described above (use one `-s` option for each share).
The program takes the path to the file to split as its first positional
argument. The remaining positional arguments are URIs describing the
shares to create using the URI syntax described above.
Consider the following example:
gfsec-split -n 2 \
-s file:///home/alice/.local/share/gfsecret/mysecret \
-s label://USBSTICK/mysecret \
-s mtp://RF2GB6X704P/Documents/mysecret \
/home/alice/mysecret
/home/alice/mysecret \
file:///home/alice/.local/share/gfsecret/mysecret \
label://USBSTICK/mysecret \
mtp://RF2GB6X704P/Documents/mysecret
This will split the file `/home/alice/mysecret` into three shares: one
in Alice's home directory on the local filesystem, one on a USB storage

18
man/gfsec-split.1.in

@ -9,13 +9,12 @@ gfsec-split \- Split a file into shares and dispatch them
.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
.B URI...
.YS
.SH DESCRIPTION
@ -40,13 +39,6 @@ Display the version message.
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
@ -92,10 +84,10 @@ specified serial number.
.PP
.nf
gfsec-split \\
-s file:///home/alice/.local/share/gfsecret/mysecret \\
-s label://USBSTICK/mysecret \\
-s mtp://RF2GB6X704P/Documents/mysecret \\
/home/alice/mysecret
/home/alice/mysecret \\
file:///home/alice/.local/share/gfsecret/mysecret \\
label://USBSTICK/mysecret \\
mtp://RF2GB6X704P/Documents/mysecret \\
.fi
.PP

Loading…
Cancel
Save