Browse Source

Update documentation.

Mention the possibility of using http(s) URIs with gfsec-use.
master
Damien Goutte-Gattat 3 months ago
parent
commit
c2ffb0a06f
  1. 14
      README.md
  2. 19
      info/gfsecret.texi

14
README.md

@ -25,14 +25,16 @@ A share URI has the following form:
The _scheme_ part indicates the method to use to access the share, and
can be `file` (to access a share on the local filesystem), `label` (to
access a share on an external volume identified by its label), `uuid`
(to access a share on an external volume identified by its UUID), or
`mtp` (to access a share on a MTP-compliant device identified by its
serial number).
(to access a share on an external volume identified by its UUID), `mtp`
(to access a share on a MTP-compliant device identified by its serial
number), or `http` or `https` (to access a share on a remote web server
– only supported by _gfsec-use_, not by _gfsec-split_).
The _authority_ part identifies the storage device. It's the volume's
label when using the `label://` scheme, its UUID when using the
`uuid://` scheme, and the device's serial number when using the `mtp://`
scheme. In the `file://` scheme, that part should be empty.
`uuid://` scheme, the device's serial number when using the `mtp://`
scheme, and the hostname when using the `http(s)://` scheme. In the
`file://` scheme, that part should be empty.
The _path_ part is the pathname to the share file on the device.
@ -132,6 +134,8 @@ Gfsecret depends on the following libraries at compile-time:
external volumes (typically USB storage) (optional);
- [libmtp](http://libmtp.sourceforge.net/), to access shares stored on
MTP-compliant devices (optional).
- [libcurl](http://curl.se/), to access shares stored on remote web
servers (optional).
Copying

19
info/gfsecret.texi

@ -7,7 +7,7 @@
This is the manual for Gfsecret (version @value{VERSION}, last updated
@value{UPDATED}).
Copyright @copyright{} 2017 Damien Goutte-Gattat
Copyright @copyright{} 2017,2021 Damien Goutte-Gattat
@quotation
Permission is granted to copy, distribute and/or modify this document
@ -132,16 +132,18 @@ URI-like string of the form @samp{scheme://authority/path?parameters}.
The @var{scheme} part indicates the method to use to access the share.
It can be: @samp{file} for a share on the local filesystem; @samp{label}
for a share on an external volume identified by its label; @samp{uuid}
for a share on an external volume identified by its UUID; or @samp{mtp}
for a share on a MTP-compliant device identified by its serial number.
for a share on an external volume identified by its UUID; @samp{mtp}
for a share on a MTP-compliant device identified by its serial number;
or @samp{http} or @samp{https} for a share on a remote web server.
The @var{authority} part identifies the storage device. It should be
empty when using the @samp{file://} scheme (although for consistency
with other uses of that scheme by other programs, it is permitted to
specify @samp{localhost}). It represents the volume's label when using
the @samp{label://} scheme, the volume's UUID when using the
@samp{uuid://} scheme, and the device's serial number when using the
@samp{mtp://} scheme.
@samp{uuid://} scheme, the device's serial number when using the
@samp{mtp://} scheme, and the server's hostname when using the
@samp{http://} or @samp{https://} scheme.
The @var{path} part is the pathname to the share file on the device.
The filename itself should end with a numeric extension representing the
@ -170,6 +172,13 @@ subsequent positional arguments on the command line (@ref{Specifying
Share URIs on the Command Line}), or be given through an interactive
menu (@ref{Interactive Selection of Shares}).
Note that @command{gfsec-split} does not support share URIs that use the
@samp{http} or @samp{https} scheme. If you want to put a share on a
remote web server, create the share on your system using the @samp{file}
scheme, move it to the web server, then update the generated
configuration file to replace the @samp{file://} URI by the appropriate
@samp{http} or @samp{https} URI.
The threshold, that is, the minimal number of shares needed to
reconstruct the original file, is specified with the option @option{-n}
(@option{--threshold}). The default threshold is 2. The total number of

Loading…
Cancel
Save