summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorRichard Levitte <levitte@openssl.org>2019-10-01 20:29:52 +0200
committerRichard Levitte <levitte@openssl.org>2019-10-09 10:45:05 +0200
commita43384fde39261adc86f0c3f2d67fb4c0efb4e57 (patch)
tree8684b45baaf16857f90a83f35f47e00e025bdeb5 /doc
parent1948394d0e8a8dbffa62c3125fc0aaf9ef187b70 (diff)
Command docs: wrap literal input/output with C<>
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> (Merged from https://github.com/openssl/openssl/pull/10065)
Diffstat (limited to 'doc')
-rw-r--r--doc/man1/openssl-asn1parse.pod6
-rw-r--r--doc/man1/openssl-ca.pod7
-rw-r--r--doc/man1/openssl-genpkey.pod2
-rw-r--r--doc/man1/openssl-list.pod14
-rw-r--r--doc/man1/openssl-ocsp.pod4
-rw-r--r--doc/man1/openssl-req.pod8
-rw-r--r--doc/man1/openssl-storeutl.pod6
-rw-r--r--doc/man1/openssl-x509.pod6
8 files changed, 27 insertions, 26 deletions
diff --git a/doc/man1/openssl-asn1parse.pod b/doc/man1/openssl-asn1parse.pod
index 4b99338ccd..183f5134ac 100644
--- a/doc/man1/openssl-asn1parse.pod
+++ b/doc/man1/openssl-asn1parse.pod
@@ -132,9 +132,9 @@ The output will typically contain lines like this:
.....
This example is part of a self-signed certificate. Each line starts with the
-offset in decimal. B<d=XX> specifies the current depth. The depth is increased
-within the scope of any SET or SEQUENCE. B<hl=XX> gives the header length
-(tag and length octets) of the current type. B<l=XX> gives the length of
+offset in decimal. C<d=XX> specifies the current depth. The depth is increased
+within the scope of any SET or SEQUENCE. C<hl=XX> gives the header length
+(tag and length octets) of the current type. C<l=XX> gives the length of
the contents octets.
The B<-i> option can be used to make the output more readable.
diff --git a/doc/man1/openssl-ca.pod b/doc/man1/openssl-ca.pod
index d58bd0ed66..a939f4d6e3 100644
--- a/doc/man1/openssl-ca.pod
+++ b/doc/man1/openssl-ca.pod
@@ -260,7 +260,8 @@ for all available algorithms.
Supersedes subject name given in the request.
The arg must be formatted as C</type0=value0/type1=value1/type2=...>.
-Keyword characters may be escaped by \ (backslash), and whitespace is retained.
+Keyword characters may be escaped by C<\> (backslash), and whitespace is
+retained.
Empty values are permitted, but the corresponding type will not be included
in the resulting certificate.
@@ -289,9 +290,9 @@ This overrides any option or configuration to use a serial number file.
This option causes the -subj argument to be interpreted with full
support for multivalued RDNs. Example:
-I</DC=org/DC=OpenSSL/DC=users/UID=123456+CN=John Doe>
+C</DC=org/DC=OpenSSL/DC=users/UID=123456+CN=John Doe>
-If B<-multi-rdn> is not used then the UID value is I<123456+CN=John Doe>.
+If B<-multi-rdn> is not used then the UID value is C<123456+CN=John Doe>.
=item B<-rand> I<files>
diff --git a/doc/man1/openssl-genpkey.pod b/doc/man1/openssl-genpkey.pod
index 075bcfbfa7..08cffa36fc 100644
--- a/doc/man1/openssl-genpkey.pod
+++ b/doc/man1/openssl-genpkey.pod
@@ -128,7 +128,7 @@ The number of primes in the generated key. If not specified 2 is used.
=item B<rsa_keygen_pubexp:value>
The RSA public exponent value. This can be a large decimal or
-hexadecimal value if preceded by B<0x>. Default value is 65537.
+hexadecimal value if preceded by C<0x>. Default value is 65537.
=back
diff --git a/doc/man1/openssl-list.pod b/doc/man1/openssl-list.pod
index 3a3c5ab4a9..46ea02bc8d 100644
--- a/doc/man1/openssl-list.pod
+++ b/doc/man1/openssl-list.pod
@@ -57,10 +57,10 @@ as input to the L<dgst(1)> or L<speed(1)> commands.
=item B<-digest-algorithms>
Display a list of message digest algorithms.
-If a line is of the form C<foo =E<gt> bar> then B<foo> is an alias for the
-official algorithm name, B<bar>.
-If a line is of the form C<foo @ bar>, then B<foo> is provided by the provider
-B<bar>.
+If a line is of the form C<foo =E<gt> bar> then C<foo> is an alias for the
+official algorithm name, C<bar>.
+If a line is of the form C<foo @ bar>, then C<foo> is provided by the provider
+C<bar>.
In verbose mode, the algorithms provided by a provider will get additional
information on what parameters each implementation supports.
@@ -81,10 +81,10 @@ to the L<dgst(1)> or L<speed(1)> commands.
=item B<-cipher-algorithms>
Display a list of cipher algorithms.
-If a line is of the form C<foo =E<gt> bar> then B<foo> is an alias for the
+If a line is of the form C<foo =E<gt> bar> then C<foo> is an alias for the
official algorithm name, B<bar>.
-If a line is of the form C<foo @ bar>, then B<foo> is provided by the provider
-B<bar>.
+If a line is of the form C<foo @ bar>, then C<foo> is provided by the provider
+C<bar>.
In verbose mode, the algorithms provided by a provider will get additional
information on what parameters each implementation supports.
diff --git a/doc/man1/openssl-ocsp.pod b/doc/man1/openssl-ocsp.pod
index 1963824d83..50d0080e50 100644
--- a/doc/man1/openssl-ocsp.pod
+++ b/doc/man1/openssl-ocsp.pod
@@ -134,8 +134,8 @@ issuer certificate is specified.
Same as the B<-cert> option except the certificate with serial number
B<num> is added to the request. The serial number is interpreted as a
-decimal integer unless preceded by B<0x>. Negative integers can also
-be specified by preceding the value by a B<-> sign.
+decimal integer unless preceded by C<0x>. Negative integers can also
+be specified by preceding the value by a C<-> sign.
=item B<-signer> I<filename>, B<-signkey> I<filename>
diff --git a/doc/man1/openssl-req.pod b/doc/man1/openssl-req.pod
index 59da90cb79..2449a580bc 100644
--- a/doc/man1/openssl-req.pod
+++ b/doc/man1/openssl-req.pod
@@ -229,7 +229,7 @@ see L<openssl(1)/COMMAND SUMMARY>.
Sets subject name for new request or supersedes the subject name
when processing a request.
-The arg must be formatted as I</type0=value0/type1=value1/type2=...>.
+The arg must be formatted as C</type0=value0/type1=value1/type2=...>.
Keyword characters may be escaped by \ (backslash), and whitespace is retained.
Empty values are permitted, but the corresponding type will not be included
in the request.
@@ -239,9 +239,9 @@ in the request.
This option causes the -subj argument to be interpreted with full
support for multivalued RDNs. Example:
-I</DC=org/DC=OpenSSL/DC=users/UID=123456+CN=John Doe>
+C</DC=org/DC=OpenSSL/DC=users/UID=123456+CN=John Doe>
-If -multi-rdn is not used then the UID value is I<123456+CN=John Doe>.
+If -multi-rdn is not used then the UID value is C<123456+CN=John Doe>.
=item B<-x509>
@@ -264,7 +264,7 @@ be a positive integer. The default is 30 days.
=item B<-set_serial> I<n>
Serial number to use when outputting a self signed certificate. This
-may be specified as a decimal value or a hex value if preceded by B<0x>.
+may be specified as a decimal value or a hex value if preceded by C<0x>.
=item B<-addext> I<ext>
diff --git a/doc/man1/openssl-storeutl.pod b/doc/man1/openssl-storeutl.pod
index 7133dd7a66..dbe0d9f844 100644
--- a/doc/man1/openssl-storeutl.pod
+++ b/doc/man1/openssl-storeutl.pod
@@ -81,7 +81,7 @@ returned.
=item B<-subject> I<arg>
Search for an object having the subject name I<arg>.
-The arg must be formatted as I</type0=value0/type1=value1/type2=...>.
+The arg must be formatted as C</type0=value0/type1=value1/type2=...>.
Keyword characters may be escaped by \ (backslash), and whitespace is retained.
Empty values are permitted but are ignored for the search. That is,
a search with an empty value will have the same effect as not specifying
@@ -93,10 +93,10 @@ the type at all.
Search for an object having the given issuer name and serial number.
These two options I<must> be used together.
-The issuer arg must be formatted as I</type0=value0/type1=value1/type2=...>,
+The issuer arg must be formatted as C</type0=value0/type1=value1/type2=...>,
characters may be escaped by \ (backslash), no spaces are skipped.
The serial arg may be specified as a decimal value or a hex value if preceded
-by B<0x>.
+by C<0x>.
=item B<-alias> I<arg>
diff --git a/doc/man1/openssl-x509.pod b/doc/man1/openssl-x509.pod
index 8da1601a7e..f7e56abf22 100644
--- a/doc/man1/openssl-x509.pod
+++ b/doc/man1/openssl-x509.pod
@@ -409,7 +409,7 @@ the B<-signkey> or B<-CA> options. If used in conjunction with the B<-CA>
option the serial number file (as specified by the B<-CAserial> or
B<-CAcreateserial> options) is not used.
-The serial number can be decimal or hex (if preceded by B<0x>).
+The serial number can be decimal or hex (if preceded by C<0x>).
=item B<-CA> I<filename>
@@ -484,10 +484,10 @@ The format of the key file can be specified using the B<-keyform> option.
=item B<-subj> I<arg>
When a certificate is created set its subject name to the given value.
-The arg must be formatted as I</type0=value0/type1=value1/type2=...>.
+The arg must be formatted as C</type0=value0/type1=value1/type2=...>.
Keyword characters may be escaped by \ (backslash), and whitespace is retained.
Empty values are permitted, but the corresponding type will not be included
-in the certificate. Giving a single I</> will lead to an empty sequence of RDNs
+in the certificate. Giving a single C</> will lead to an empty sequence of RDNs
(a NULL subject DN).
Unless the B<-CA> option is given the issuer is set to the same value.