Tools to make secret sharing easier.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

133 lines
3.0 KiB

  1. .TH GFSEC-SPLIT 08/30/2015 "gfsecret @PACKAGE_VERSION@"
  2. .SH NAME
  3. gfsec-split \- Split a file into shares and dispatch them
  4. .SH SYNOPSIS
  5. .SY gfsec-split
  6. .RB [ \-h | --help ]
  7. .RB [ \-v | --version ]
  8. .RB [ \-n | --threshold
  9. .IR N ]
  10. .RB [ \-c | --config
  11. .IR file ]
  12. .RB [ \-i | --interactive ]
  13. .RB [ \-k | --keep ]
  14. .RB [ \-l | --list-supports ]
  15. .B file
  16. .B URI...
  17. .YS
  18. .SH DESCRIPTION
  19. .PP
  20. .B gfsec-split
  21. splits a file into a number of shares and dispatches
  22. the resulting shares onto external storage supports.
  23. .PP
  24. The splitted file can then be temporarily reconstructed
  25. using the accompanying program
  26. .BR gfsec-use (1).
  27. .SH OPTIONS
  28. .TP
  29. .BR -h ", " --help
  30. Display the help message.
  31. .TP
  32. .BR -v ", " --version
  33. Display the version message.
  34. .TP
  35. .BR -n ", " --threshold " " \fiN\fR
  36. Specify the minimal number of shares required to
  37. re-assemble the splitted file. Default is 2.
  38. .TP
  39. .BR -c ", " --config " " \fiFILE\fR
  40. Write the configuration file (allowing to reconstruct
  41. the secret with
  42. .BR gfsec-use (1)
  43. ) to the specified file. Default is the basename of
  44. the splitted file in $XDG_CONFIG_HOME/gfsecret.
  45. .TP
  46. .BR -i ", " --interactive
  47. Present the user with an interactive menu to specify the
  48. shares to create.
  49. .TP
  50. .BR -k ", " --keep
  51. By default,
  52. .B gfsec-split
  53. will delete the original file once it has been
  54. successfully splitted. Use this option to prevent
  55. the file to be deleted.
  56. .TP
  57. .BR -l ", " --list-supports
  58. List all the currently available supports which can
  59. be used to store shares, then quit.
  60. .SH SHARE URIs
  61. .PP
  62. Shares are described using a URI-like syntax. For each share,
  63. the URI indicates a storage device and a pathname on that device.
  64. .PP
  65. Supported URI schemes are:
  66. .TP
  67. file:///
  68. Indicates a file on the local filesystem.
  69. .TP
  70. uuid://\fIuuid\fR/
  71. Indicates a file on the external volume identified
  72. by the specified UUID.
  73. .TP
  74. label://\fIlabel\fR/
  75. Indicates a file on the external volume identified
  76. by the specified label.
  77. .TP
  78. mtp://\fIserial\fR/
  79. Indicates a file on the MTP device identified by the
  80. specified serial number.
  81. .SH EXAMPLE INVOCATION
  82. .PP
  83. .nf
  84. gfsec-split \\
  85. /home/alice/mysecret \\
  86. file:///home/alice/.local/share/gfsecret/mysecret \\
  87. label://USBSTICK/mysecret \\
  88. mtp://RF2GB6X704P/Documents/mysecret \\
  89. .fi
  90. .PP
  91. The above example will split the file
  92. .I /home/alice/mysecret
  93. into three shares: one on the local filesystem, one on the
  94. USB mass storage device with the label \fIUSBSTICK\fR, and
  95. one on the MTP-compliant device with the serial \fIRF2GB6X704P\fR.
  96. A configuration file will be written in
  97. .I $XDG_CONFIG_HOME/gfsecret/mysecret
  98. allowing to automatically reconstruct the file with
  99. .BR gfsec-use (1)
  100. provided at least one of the two removable supports are
  101. present.
  102. .SH REPORTING BUGS
  103. .PP
  104. Report bugs to
  105. .MT @PACKAGE_BUGREPORT@
  106. Damien Goutte-Gattat
  107. .ME .
  108. .SH SEE ALSO
  109. .BR gfsec-use (1),
  110. .BR gfsplit (1),
  111. .BR gfcombine (1),
  112. .BR libgfshare (3),
  113. .BR gfshare (7)
  114. .SH COPYRIGHT
  115. .ad l
  116. .PP
  117. Copyright \(co 2016 Damien Goutte-Gattat
  118. .PP
  119. This program is released under the GNU General Public License.
  120. See the COPYING file in the source distribution or
  121. .UR http://www.gnu.org/licenses/gpl.html
  122. .UE .