Info Catalog gnupg: symcryptrun

gnupg: Invoking symcryptrun

 
 9.10.1 List of all commands and options
 ---------------------------------------
 
 'symcryptrun' is invoked this way:
 
      symcryptrun --class CLASS --program PROGRAM --keyfile KEYFILE
         [--decrypt | --encrypt] [inputfile]
 
    For encryption, the plain text must be provided on STDIN or as the
 argument INPUTFILE, and the ciphertext will be output to STDOUT. For
 decryption vice versa.
 
    CLASS describes the calling conventions of the external tool.
 Currently it must be given as 'confucius'.  PROGRAM is the full filename
 of that external tool.
 
    For the class 'confucius' the option '--keyfile' is required; 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.
 
 Note, that 'gpg-agent' must be running before starting 'symcryptrun'.
 
 The following additional options may be used:
 
 '-v'
 '--verbose'
      Output additional information while running.
 
 '-q'
 '--quiet'
      Try to be as quiet as possible.
 
 '--homedir DIR'
      Set the name of the home directory to DIR.  If this option is not
      used, the home directory defaults to '~/.gnupg'.  It is only
      recognized when given on the command line.  It also overrides any
      home directory stated through the environment variable 'GNUPGHOME'
      or (on Windows systems) by means of the Registry entry
      HKCU\SOFTWARE\GNU\GNUPG:HOMEDIR.
 
      On Windows systems it is possible to install GnuPG as a portable
      application.  In this case only this command line option is
      considered, all other ways to set a home directory are ignored.
 
      To install GnuPG as a portable application under Windows, create an
      empty file named 'gpgconf.ctl' in the same directory as the tool
      'gpgconf.exe'.  The root of the installation is then that
      directory; or, if 'gpgconf.exe' has been installed directly below a
      directory named 'bin', its parent directory.  You also need to make
      sure that the following directories exist and are writable:
      'ROOT/home' for the GnuPG home and 'ROOT/var/cache/gnupg' for
      internal cache files.
 
 '--log-file FILE'
      Append all logging output to FILE.  Use 'socket://' to log to
      socket.  Default is to write logging information to STDERR.
 
 The possible exit status codes of 'symcryptrun' are:
 
 '0'
      Success.
 '1'
      Some error occurred.
 '2'
      No valid passphrase was provided.
 '3'
      The operation was canceled by the user.
 

Info Catalog gnupg: symcryptrun