Browse Source

Fix spelling errors.

Thanks to Thomas Perret for pointing those out.

Closes #5
master
parent
commit
92d4d309b2
8 changed files with 28 additions and 26 deletions
  1. +3
    -3
      README.md
  2. +8
    -8
      info/gfsecret.texi
  3. +3
    -3
      man/gfsec-split-gpg.1.in
  4. +5
    -5
      man/gfsec-split.1.in
  5. +1
    -1
      man/gfsec-use.1.in
  6. +3
    -1
      src/gfsec-split.c
  7. +1
    -1
      src/secret.c
  8. +4
    -4
      src/secret.h

+ 3
- 3
README.md View File

@ -71,7 +71,7 @@ two removable devices will have to be present.
Note that the shares need not to have the same basename than the
original file.
Once the file is splitted, _gfsec-split_ will delete the original file
Once the file is split, _gfsec-split_ will delete the original file
(unless you used the `-k` option), and will create a configuration file
in `$XDG_CONFIG_HOME/gfsecret/mysecret` (or at any location specified by
the `-c` option) which could later be used by _gfsec-use_.
@ -88,12 +88,12 @@ the available volumes and select those to use in an interactive menu.
gfsec-use
---------
The _gfsec-use_ program allows to temporarily reconstruct a splitted
The _gfsec-use_ program allows to temporarily reconstruct a split
file from shares that have been dispersed on several external devices.
The program needs a configuration file (by default,
`$XDG_CONFIG_HOME/gfsecret/default.conf`) which describes the shared
secret. If the original file has been splitted using the _gfsec-split_
secret. If the original file has been split using the _gfsec-split_
program, the configuration file will have been automatically generated.
For example, here is the configuration file that could have been


+ 8
- 8
info/gfsecret.texi View File

@ -46,7 +46,7 @@ This manual is for Gfsecret (version @value{VERSION}, @value{UPDATED}).
* Introduction::
* The Share URI Syntax::
* Splitting a Secret::
* Using a Splitted Secret::
* Using a Split Secret::
* Examples::
* GNU Free Documentation License::
* Index::
@ -184,11 +184,11 @@ leave the original file intact.
The option @option{-d} (@option{--destroy-cmd}) may be used to specify
a command that @command{gfsec-split} will call to delete the secret
once it has been splitted. The same command will also be called by
once it has been split. The same command will also be called by
@command{gfsec-use} to delete the secret when it is no longer needed.
A configuration file, needed by @command{gfsec-use} to reconstruct the
splitted file, will be automatically generated in the directory
split file, will be automatically generated in the directory
@file{$XDG_CONFIG_HOME/gfsecret/@var{basename}.conf}, where
@var{basename} is the basename of the original file (without any
directory part and file extension). For example, when called to split a
@ -296,11 +296,11 @@ describe on the command line will be added to the one you select in the
menu.
@node Using a Splitted Secret
@chapter Using a Splitted Secret
@node Using a Split Secret
@chapter Using a Split Secret
The @command{gfsec-use} program allows its user to temporarily
reconstruct a previously splitted file.
reconstruct a previously split file.
It reads a configuration file (automatically generated by the
@command{gfsec-split} program, although a configuration file can also be
@ -321,7 +321,7 @@ otherwise, @command{gfsec-use} looks for a file named
@file{@var{myconfig}.conf} in the directory
@file{XDG_CONFIG_HOME/gfsecret}.
Once the splitted file has been reconstructed (if enough shares are
Once the split file has been reconstructed (if enough shares are
available), @command{gfsec-use} will either spawn a new shell, or
execute any program specified at the end of the command line. When the
shell, or the user-specified program, terminates, the reconstructed file
@ -359,7 +359,7 @@ used). That command is either specified through the @option{-d}
@section The Gfsecret Configuration File
A configuration file contains all the informations needed by
@command{gfsec-use} to reconstruct a splitted file.
@command{gfsec-use} to reconstruct a split file.
Those informations are stored as @code{key=value} pairs, with one such a
pair per line. Blank lines are ignored, as well as lines starting with a


+ 3
- 3
man/gfsec-split-gpg.1.in View File

@ -27,7 +27,7 @@ to facilitate splitting a GnuPG private primary key into
a number of shares and dispatching the resulting shares
onto external storage supports.
.PP
The splitted key can then be temporarily reconstructed
The split key can then be temporarily reconstructed
.BR gfsec-use (1).
.SH OPTIONS
@ -48,7 +48,7 @@ key.
By default,
.B gfsec-split-gpg
will remove the key from the GnuPG keyring once it has
been successfully splitted. Use this option to prevent
been successfully split. Use this option to prevent
the key from being removed.
.TP
.BR -c ", " --config " " \fifile\fR
@ -68,7 +68,7 @@ shares to create.
.TP
.BR -n ", " --threshold " " \fiN\fR
Specify the minimal number of shares required to
re-assemble the splitted file. Default is 2.
re-assemble the split file. Default is 2.
.SH NOTES
.PP


+ 5
- 5
man/gfsec-split.1.in View File

@ -30,7 +30,7 @@ gfsec-split \- Split a file into shares and dispatch them
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
The split file can then be temporarily reconstructed
using the accompanying program
.BR gfsec-use (1).
@ -44,14 +44,14 @@ 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.
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 splitted file in $XDG_CONFIG_HOME/gfsecret.
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
@ -65,7 +65,7 @@ shares to create.
By default,
.B gfsec-split
will delete the original file once it has been
successfully splitted. Use this option to prevent
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
@ -79,7 +79,7 @@ restore the secret.
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 splitted,
to destroy the secret once it has been split,
unless the -k option has been used.
.TP
.BR -l ", " --list-supports


+ 1
- 1
man/gfsec-use.1.in View File

@ -23,7 +23,7 @@ gfsec-use \- Make use of a shared secret
.PP
.B gfsec-use
reconstructs a secret file that has been previously
splitted using a tool like
split using a tool like
.BR gfsplit (1)
or the accompanying program
.BR gfsec-split (1).


+ 3
- 1
src/gfsec-split.c View File

@ -59,7 +59,7 @@ Split the specified file for later use with gfsec-use.\n"));
puts(_("\
-c, --config FILE Write configuration to the specified\n\
file. Default is the basename of the\n\
splitted file in gfsecret's configuration\n\
split file in gfsecret's configuration\n\
directory.\n"));
puts(_("\
@ -255,6 +255,8 @@ main(int argc, char **argv)
struct option options[] = {
{ "help", 0, NULL, 'h' },
{ "version", 0, NULL, 'v' },
{ "threshold", 1, NULL, 'n' },
/* Keep bogus spelling for compatibility. */
{ "treshold", 1, NULL, 'n' },
{ "share", 1, NULL, 's' },
{ "interactive", 0, NULL, 'i' },


+ 1
- 1
src/secret.c View File

@ -303,7 +303,7 @@ gfsec_secret_new(void)
}
/**
* Sets the secret to be splitted.
* Sets the secret to be split.
*
* @param secret The secret object.
* @param filename The location of the file to read the secret from.


+ 4
- 4
src/secret.h View File

@ -32,7 +32,7 @@ enum gfsec_error {
#include "schemes.h"
/**
* Represents a share of a splitted secret.
* Represents a share of a split secret.
*/
typedef struct gfsec_share {
/*
@ -59,7 +59,7 @@ typedef struct gfsec_share {
#define gfsec_share_is_full(share) (share->number == 0)
/**
* Represents a splitted secret (or a secret to be splitted).
* Represents a split secret (or a secret to be split).
*/
typedef struct gfsec_secret {
/* The location of the reconstituted secret. */
@ -73,7 +73,7 @@ typedef struct gfsec_secret {
unsigned char *data;
size_t len;
/* The number of shares this secret is splitted into. */
/* The number of shares this secret is split into. */
unsigned char n_shares;
/* The current size of the \c shares array. */
@ -82,7 +82,7 @@ typedef struct gfsec_secret {
/* The number of shares needed to reconstitute the secret. */
unsigned char threshold;
/* The shares this secret is splitted into. */
/* The shares this secret is split into. */
gfsec_share_t **shares;
/* May point to one of the shares in the \c shares array


Loading…
Cancel
Save