mirror of
git://git.gnupg.org/gnupg.git
synced 2025-04-17 15:44:34 +02:00
doc: Remove man page for symcryptrun.
-- The tool has no more configure option to build it and thus the man page does not make sense. We keep the actual file for reference, though. GnuPG-bug-id: 5290
This commit is contained in:
parent
4ca8ca5f7f
commit
db687d15e6
@ -93,7 +93,7 @@ myman_sources = gnupg7.texi gpg.texi gpgsm.texi gpg-agent.texi \
|
|||||||
dirmngr.texi scdaemon.texi tools.texi wks.texi
|
dirmngr.texi scdaemon.texi tools.texi wks.texi
|
||||||
myman_pages = gpgsm.1 gpg-agent.1 dirmngr.8 scdaemon.1 \
|
myman_pages = gpgsm.1 gpg-agent.1 dirmngr.8 scdaemon.1 \
|
||||||
watchgnupg.1 gpgconf.1 addgnupghome.8 gpg-preset-passphrase.1 \
|
watchgnupg.1 gpgconf.1 addgnupghome.8 gpg-preset-passphrase.1 \
|
||||||
gpg-connect-agent.1 gpgparsemail.1 symcryptrun.1 gpgtar.1 \
|
gpg-connect-agent.1 gpgparsemail.1 gpgtar.1 \
|
||||||
applygnupgdefaults.8 gpg-wks-client.1 gpg-wks-server.1 \
|
applygnupgdefaults.8 gpg-wks-client.1 gpg-wks-server.1 \
|
||||||
dirmngr-client.1
|
dirmngr-client.1
|
||||||
if USE_GPG2_HACK
|
if USE_GPG2_HACK
|
||||||
|
122
doc/tools.texi
122
doc/tools.texi
@ -19,7 +19,6 @@ GnuPG comes with a couple of smaller tools:
|
|||||||
* gpg-connect-agent:: Communicate with a running agent.
|
* gpg-connect-agent:: Communicate with a running agent.
|
||||||
* dirmngr-client:: How to use the Dirmngr client tool.
|
* dirmngr-client:: How to use the Dirmngr client tool.
|
||||||
* gpgparsemail:: Parse a mail message into an annotated format
|
* gpgparsemail:: Parse a mail message into an annotated format
|
||||||
* symcryptrun:: Call a simple symmetric encryption tool.
|
|
||||||
* gpgtar:: Encrypt or sign files into an archive.
|
* gpgtar:: Encrypt or sign files into an archive.
|
||||||
@end menu
|
@end menu
|
||||||
|
|
||||||
@ -1783,127 +1782,6 @@ debugging. Run it with @code{--help} for usage information.
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
@c
|
|
||||||
@c SYMCRYPTRUN
|
|
||||||
@c
|
|
||||||
@node symcryptrun
|
|
||||||
@section Call a simple symmetric encryption tool
|
|
||||||
@manpage symcryptrun.1
|
|
||||||
@ifset manverb
|
|
||||||
.B symcryptrun
|
|
||||||
\- Call a simple symmetric encryption tool
|
|
||||||
@end ifset
|
|
||||||
|
|
||||||
@mansect synopsis
|
|
||||||
@ifset manverb
|
|
||||||
.B symcryptrun
|
|
||||||
.B \-\-class
|
|
||||||
.I class
|
|
||||||
.B \-\-program
|
|
||||||
.I program
|
|
||||||
.B \-\-keyfile
|
|
||||||
.I keyfile
|
|
||||||
.RB [ --decrypt | --encrypt ]
|
|
||||||
.RI [ inputfile ]
|
|
||||||
@end ifset
|
|
||||||
|
|
||||||
@mansect description
|
|
||||||
Sometimes simple encryption tools are already in use for a long time
|
|
||||||
and there might be a desire to integrate them into the GnuPG
|
|
||||||
framework. The protocols and encryption methods might be non-standard
|
|
||||||
or not even properly documented, so that a full-fledged encryption
|
|
||||||
tool with an interface like @command{gpg} is not doable.
|
|
||||||
@command{symcryptrun} provides a solution: It operates by calling the
|
|
||||||
external encryption/decryption module and provides a passphrase for a
|
|
||||||
key using the standard @command{pinentry} based mechanism through
|
|
||||||
@command{gpg-agent}.
|
|
||||||
|
|
||||||
Note, that @command{symcryptrun} is only available if GnuPG has been
|
|
||||||
configured with @samp{--enable-symcryptrun} at build time.
|
|
||||||
|
|
||||||
@menu
|
|
||||||
* Invoking symcryptrun:: List of all commands and options.
|
|
||||||
@end menu
|
|
||||||
|
|
||||||
@manpause
|
|
||||||
@node Invoking symcryptrun
|
|
||||||
@subsection List of all commands and options
|
|
||||||
|
|
||||||
@noindent
|
|
||||||
@command{symcryptrun} is invoked this way:
|
|
||||||
|
|
||||||
@example
|
|
||||||
symcryptrun --class CLASS --program PROGRAM --keyfile KEYFILE
|
|
||||||
[--decrypt | --encrypt] [inputfile]
|
|
||||||
@end example
|
|
||||||
@mancont
|
|
||||||
|
|
||||||
For encryption, the plain text must be provided on STDIN or as the
|
|
||||||
argument @var{inputfile}, and the ciphertext will be output to STDOUT.
|
|
||||||
For decryption vice versa.
|
|
||||||
|
|
||||||
@var{CLASS} describes the calling conventions of the external tool.
|
|
||||||
Currently it must be given as @samp{confucius}. @var{PROGRAM} is
|
|
||||||
the full filename of that external tool.
|
|
||||||
|
|
||||||
For the class @samp{confucius} the option @option{--keyfile} is
|
|
||||||
required; @var{keyfile} is the name of a file containing the secret key,
|
|
||||||
which may be protected by a passphrase. For detailed calling
|
|
||||||
conventions, see the source code.
|
|
||||||
|
|
||||||
@noindent
|
|
||||||
Note, that @command{gpg-agent} must be running before starting
|
|
||||||
@command{symcryptrun}.
|
|
||||||
|
|
||||||
@noindent
|
|
||||||
The following additional options may be used:
|
|
||||||
|
|
||||||
@table @gnupgtabopt
|
|
||||||
@item -v
|
|
||||||
@itemx --verbose
|
|
||||||
@opindex verbose
|
|
||||||
Output additional information while running.
|
|
||||||
|
|
||||||
@item -q
|
|
||||||
@item --quiet
|
|
||||||
@opindex q
|
|
||||||
@opindex quiet
|
|
||||||
Try to be as quiet as possible.
|
|
||||||
|
|
||||||
@include opt-homedir.texi
|
|
||||||
|
|
||||||
|
|
||||||
@item --log-file @var{file}
|
|
||||||
@opindex log-file
|
|
||||||
Append all logging output to @var{file}. Use @file{socket://} to log
|
|
||||||
to socket. Default is to write logging information to STDERR.
|
|
||||||
|
|
||||||
@end table
|
|
||||||
|
|
||||||
@noindent
|
|
||||||
The possible exit status codes of @command{symcryptrun} are:
|
|
||||||
|
|
||||||
@table @code
|
|
||||||
@item 0
|
|
||||||
Success.
|
|
||||||
@item 1
|
|
||||||
Some error occurred.
|
|
||||||
@item 2
|
|
||||||
No valid passphrase was provided.
|
|
||||||
@item 3
|
|
||||||
The operation was canceled by the user.
|
|
||||||
|
|
||||||
@end table
|
|
||||||
|
|
||||||
@mansect see also
|
|
||||||
@ifset isman
|
|
||||||
@command{gpg}(1),
|
|
||||||
@command{gpgsm}(1),
|
|
||||||
@command{gpg-agent}(1),
|
|
||||||
@end ifset
|
|
||||||
@include see-also-note.texi
|
|
||||||
|
|
||||||
|
|
||||||
@c
|
@c
|
||||||
@c GPGTAR
|
@c GPGTAR
|
||||||
@c
|
@c
|
||||||
|
Loading…
x
Reference in New Issue
Block a user