summaryrefslogtreecommitdiffstats
path: root/upstream/debian-bookworm/man1/openssl-speed.1ssl
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
commitfc22b3d6507c6745911b9dfcc68f1e665ae13dbc (patch)
treece1e3bce06471410239a6f41282e328770aa404a /upstream/debian-bookworm/man1/openssl-speed.1ssl
parentInitial commit. (diff)
downloadmanpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.tar.xz
manpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.zip
Adding upstream version 4.22.0.upstream/4.22.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'upstream/debian-bookworm/man1/openssl-speed.1ssl')
-rw-r--r--upstream/debian-bookworm/man1/openssl-speed.1ssl269
1 files changed, 269 insertions, 0 deletions
diff --git a/upstream/debian-bookworm/man1/openssl-speed.1ssl b/upstream/debian-bookworm/man1/openssl-speed.1ssl
new file mode 100644
index 00000000..fa100705
--- /dev/null
+++ b/upstream/debian-bookworm/man1/openssl-speed.1ssl
@@ -0,0 +1,269 @@
+.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" 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 C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
+.ie n \{\
+. 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\}
+.el\{\
+. 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.
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\"
+.\" 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'.
+.de IX
+..
+.nr rF 0
+.if \n(.g .if rF .nr rF 1
+.if (\n(rF:(\n(.g==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
+.if n \{\
+. ds #H 0
+. ds #V .8m
+. ds #F .3m
+. ds #[ \f1
+. ds #] \fP
+.\}
+.if t \{\
+. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
+. ds #V .6m
+. ds #F 0
+. ds #[ \&
+. ds #] \&
+.\}
+. \" simple accents for nroff and troff
+.if n \{\
+. ds ' \&
+. ds ` \&
+. ds ^ \&
+. ds , \&
+. ds ~ ~
+. ds /
+.\}
+.if t \{\
+. 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
+.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
+.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
+.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
+.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
+.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
+.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
+.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
+.ds ae a\h'-(\w'a'u*4/10)'e
+.ds Ae A\h'-(\w'A'u*4/10)'E
+. \" corrections for vroff
+.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
+.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
+. \" for low resolution devices (crt and lpr)
+.if \n(.H>23 .if \n(.V>19 \
+\{\
+. 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
+.\}
+.rm #[ #] #H #V #F C
+.\" ========================================================================
+.\"
+.IX Title "OPENSSL-SPEED 1SSL"
+.TH OPENSSL-SPEED 1SSL "2023-10-23" "3.0.11" "OpenSSL"
+.\" For nroff, turn off justification. Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
+.SH "NAME"
+openssl\-speed \- test library performance
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+\&\fBopenssl speed\fR
+[\fB\-help\fR]
+[\fB\-elapsed\fR]
+[\fB\-evp\fR \fIalgo\fR]
+[\fB\-hmac\fR \fIalgo\fR]
+[\fB\-cmac\fR \fIalgo\fR]
+[\fB\-mb\fR]
+[\fB\-aead\fR]
+[\fB\-multi\fR \fInum\fR]
+[\fB\-async_jobs\fR \fInum\fR]
+[\fB\-misalign\fR \fInum\fR]
+[\fB\-decrypt\fR]
+[\fB\-primes\fR \fInum\fR]
+[\fB\-seconds\fR \fInum\fR]
+[\fB\-bytes\fR \fInum\fR]
+[\fB\-mr\fR]
+[\fB\-rand\fR \fIfiles\fR]
+[\fB\-writerand\fR \fIfile\fR]
+[\fB\-engine\fR \fIid\fR]
+[\fB\-provider\fR \fIname\fR]
+[\fB\-provider\-path\fR \fIpath\fR]
+[\fB\-propquery\fR \fIpropq\fR]
+[\fIalgorithm\fR ...]
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+This command is used to test the performance of cryptographic algorithms.
+.SH "OPTIONS"
+.IX Header "OPTIONS"
+.IP "\fB\-help\fR" 4
+.IX Item "-help"
+Print out a usage message.
+.IP "\fB\-elapsed\fR" 4
+.IX Item "-elapsed"
+When calculating operations\- or bytes-per-second, use wall-clock time
+instead of \s-1CPU\s0 user time as divisor. It can be useful when testing speed
+of hardware engines.
+.IP "\fB\-evp\fR \fIalgo\fR" 4
+.IX Item "-evp algo"
+Use the specified cipher or message digest algorithm via the \s-1EVP\s0 interface.
+If \fIalgo\fR is an \s-1AEAD\s0 cipher, then you can pass \fB\-aead\fR to benchmark a
+TLS-like sequence. And if \fIalgo\fR is a multi-buffer capable cipher, e.g.
+aes\-128\-cbc\-hmac\-sha1, then \fB\-mb\fR will time multi-buffer operation.
+.Sp
+To see the algorithms supported with this option, use
+\&\f(CW\*(C`openssl list \-digest\-algorithms\*(C'\fR or \f(CW\*(C`openssl list \-cipher\-algorithms\*(C'\fR
+command.
+.IP "\fB\-multi\fR \fInum\fR" 4
+.IX Item "-multi num"
+Run multiple operations in parallel.
+.IP "\fB\-async_jobs\fR \fInum\fR" 4
+.IX Item "-async_jobs num"
+Enable async mode and start specified number of jobs.
+.IP "\fB\-misalign\fR \fInum\fR" 4
+.IX Item "-misalign num"
+Misalign the buffers by the specified number of bytes.
+.IP "\fB\-hmac\fR \fIdigest\fR" 4
+.IX Item "-hmac digest"
+Time the \s-1HMAC\s0 algorithm using the specified message digest.
+.IP "\fB\-cmac\fR \fIcipher\fR" 4
+.IX Item "-cmac cipher"
+Time the \s-1CMAC\s0 algorithm using the specified cipher e.g.
+\&\f(CW\*(C`openssl speed \-cmac aes128\*(C'\fR.
+.IP "\fB\-decrypt\fR" 4
+.IX Item "-decrypt"
+Time the decryption instead of encryption. Affects only the \s-1EVP\s0 testing.
+.IP "\fB\-mb\fR" 4
+.IX Item "-mb"
+Enable multi-block mode on EVP-named cipher.
+.IP "\fB\-aead\fR" 4
+.IX Item "-aead"
+Benchmark EVP-named \s-1AEAD\s0 cipher in TLS-like sequence.
+.IP "\fB\-primes\fR \fInum\fR" 4
+.IX Item "-primes num"
+Generate a \fInum\fR\-prime \s-1RSA\s0 key and use it to run the benchmarks. This option
+is only effective if \s-1RSA\s0 algorithm is specified to test.
+.IP "\fB\-seconds\fR \fInum\fR" 4
+.IX Item "-seconds num"
+Run benchmarks for \fInum\fR seconds.
+.IP "\fB\-bytes\fR \fInum\fR" 4
+.IX Item "-bytes num"
+Run benchmarks on \fInum\fR\-byte buffers. Affects ciphers, digests and the \s-1CSPRNG.\s0
+The limit on the size of the buffer is \s-1INT_MAX\s0 \- 64 bytes, which for a 32\-bit
+int would be 2147483583 bytes.
+.IP "\fB\-mr\fR" 4
+.IX Item "-mr"
+Produce the summary in a mechanical, machine-readable, format.
+.IP "\fB\-rand\fR \fIfiles\fR, \fB\-writerand\fR \fIfile\fR" 4
+.IX Item "-rand files, -writerand file"
+See \*(L"Random State Options\*(R" in \fBopenssl\fR\|(1) for details.
+.IP "\fB\-engine\fR \fIid\fR" 4
+.IX Item "-engine id"
+See \*(L"Engine Options\*(R" in \fBopenssl\fR\|(1).
+This option is deprecated.
+.IP "\fB\-provider\fR \fIname\fR" 4
+.IX Item "-provider name"
+.PD 0
+.IP "\fB\-provider\-path\fR \fIpath\fR" 4
+.IX Item "-provider-path path"
+.IP "\fB\-propquery\fR \fIpropq\fR" 4
+.IX Item "-propquery propq"
+.PD
+See \*(L"Provider Options\*(R" in \fBopenssl\fR\|(1), \fBprovider\fR\|(7), and \fBproperty\fR\|(7).
+.IP "\fIalgorithm\fR ..." 4
+.IX Item "algorithm ..."
+If any \fIalgorithm\fR is given, then those algorithms are tested, otherwise a
+pre-compiled grand selection is tested.
+.SH "BUGS"
+.IX Header "BUGS"
+The \fIalgorithm\fR can be selected only from a pre-compiled subset of things
+that the \f(CW\*(C`openssl speed\*(C'\fR command knows about. To test any additional digest
+or cipher algorithm supported by OpenSSL use the \f(CW\*(C`\-evp\*(C'\fR option.
+.PP
+There is no way to test the speed of any additional public key algorithms
+supported by third party providers with the \f(CW\*(C`openssl speed\*(C'\fR command.
+.SH "HISTORY"
+.IX Header "HISTORY"
+The \fB\-engine\fR option was deprecated in OpenSSL 3.0.
+.SH "COPYRIGHT"
+.IX Header "COPYRIGHT"
+Copyright 2000\-2022 The OpenSSL Project Authors. All Rights Reserved.
+.PP
+Licensed under the Apache License 2.0 (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>.