libcrypto/man/openssl_engine.1

 $NetBSD: openssl_engine.1,v 1.1.1.1 2023/04/18 14:19:15 christos Exp $

 Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)

 Standard preamble:
 ========================================================================
..
..

..
 Set up some character translations and predefined strings. \*(-- will
 give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
 double quote, and \*(R" will give a right double quote. \*(C+ will
 give a nicer C++. Capital omega is used to do unbreakable dashes and
 therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
 nothing in troff, for use with C<>.
.tr \(*W-
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}

 Escape single quotes in literal strings from groff's Unicode transform.

 If the F register is >0, we'll generate index entries on stderr for
 titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
 entries marked with X<> in POD. Of course, you'll have to process the
 output yourself in some meaningful fashion.

 Avoid warning from groff about undefined register 'F'.
..
.nr rF 0
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF

 Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
 Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #]
.\}
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
. \" corrections for vroff
. \" for low resolution devices (crt and lpr)
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
 ========================================================================

 Title "ENGINE 1"  ENGINE 1 "2020-01-23" "1.1.1i" "OpenSSL"
 For nroff, turn off justification. Always turn off hyphenation; it makes
 way too many mistakes in technical documents.
.nh
 "NAME"
openssl-engine,
engine - load and query engines
 "LIBRARY"
libcrypto, -lcrypto
 "SYNOPSIS"
 Header "SYNOPSIS" \fBopenssl engine
[ engine... ]
[-v]
[-vv]
[-vvv]
[-vvv]
[-vvv]
[-c]
[-t]
[-tt]
[-pre command]
[-post command]
[ engine... ]
 "DESCRIPTION"
 Header "DESCRIPTION" The engine command is used to query the status and capabilities
of the specified engine's.
Engines may be specified before and after all other command-line flags.
Only those specified are queried.
 "OPTIONS"
 Header "OPTIONS"  "-v -vv -vvv -vvvv" 4
 Item "-v -vv -vvv -vvvv" Provides information about each specified engine. The first flag lists
all the possible run-time control commands; the second adds a
description of each command; the third adds the input flags, and the
final option adds the internal input flags.
 "-c" 4
 Item "-c" Lists the capabilities of each engine.
 "-t" 4
 Item "-t" Tests if each specified engine is available, and displays the answer.
 "-tt" 4
 Item "-tt" Displays an error trace for any unavailable engine.
 "-pre command" 4
 Item "-pre command"  0
 "-post command" 4
 Item "-post command"
Command-line configuration of engines.
The -pre command is given to the engine before it is loaded and
the -post command is given after the engine is loaded.
The command is of the form cmd:val where cmd is the command,
and val is the value for the command.
See the example below.
 "EXAMPLES"
 Header "EXAMPLES" To list all the commands available to a dynamic engine:

.Vb 10
 $ openssl engine -t -tt -vvvv dynamic
 (dynamic) Dynamic engine loading support
  [ unavailable ]
  SO_PATH: Specifies the path to the new ENGINE shared library
  (input flags): STRING
  NO_VCHECK: Specifies to continue even if version checking fails (boolean)
  (input flags): NUMERIC
  ID: Specifies an ENGINE id name for loading
  (input flags): STRING
  LIST_ADD: Whether to add a loaded ENGINE to the internal list (0=no,1=yes,2=mandatory)
  (input flags): NUMERIC
  DIR_LOAD: Specifies whether to load from \*(AqDIR_ADD\*(Aq directories (0=no,1=yes,2=mandatory)
  (input flags): NUMERIC
  DIR_ADD: Adds a directory from which ENGINEs can be loaded
  (input flags): STRING
  LOAD: Load up the ENGINE specified by other settings
  (input flags): NO_INPUT
.Ve

To list the capabilities of the rsax engine:

.Vb 4
 $ openssl engine -c
 (rsax) RSAX engine support
  [RSA]
 (dynamic) Dynamic engine loading support
.Ve
 "ENVIRONMENT"
 Header "ENVIRONMENT"  "\s-1OPENSSL_ENGINES\s0" 4
 Item "OPENSSL_ENGINES" The path to the engines directory.
 "SEE ALSO"
 Header "SEE ALSO" \fBconfig\|(5)
 "COPYRIGHT"
 Header "COPYRIGHT" Copyright 2016-2019 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use
this file except in compliance with the License. You can obtain a copy
in the file \s-1LICENSE\s0 in the source distribution or at
<https://www.openssl.org/source/license.html>.