From: Rich Salz Date: Wed, 25 Sep 2019 19:20:11 +0000 (-0400) Subject: Consistent formatting of flags with args X-Git-Tag: openssl-3.0.0-alpha1~1244 X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=e8769719c9bbe53d7af088111b7625671660d4db;p=oweals%2Fopenssl.git Consistent formatting of flags with args For documentation of all commands with "-flag arg" format them consistently: "B<-flag> I", except when arg is literal (for example "B<-inform> B|B") Update find-doc-nits to complain if badly formatted strings are found. Reviewed-by: Tomas Mraz Reviewed-by: Richard Levitte (Merged from https://github.com/openssl/openssl/pull/10022) --- diff --git a/doc/man1/CA.pl.pod b/doc/man1/CA.pl.pod index b055622bff..c4fa87c336 100644 --- a/doc/man1/CA.pl.pod +++ b/doc/man1/CA.pl.pod @@ -21,13 +21,13 @@ B<-signCA> | B<-signcert> | B<-crl> | B<-newca> -[B<-extra-cmd> extra-params] +[B<-extra-cmd> I] -B B<-pkcs12> [B<-extra-pkcs12> extra-params] [B] +B B<-pkcs12> [B<-extra-pkcs12> I] [I] -B B<-verify> [B<-extra-verify> extra-params] B... +B B<-verify> [B<-extra-verify> I] I... -B B<-revoke> [B<-extra-ca> extra-params] B [B] +B B<-revoke> [B<-extra-ca> I] I [I] =head1 DESCRIPTION @@ -106,7 +106,7 @@ Extra params are passed on to B and B commands. Generate a CRL. Executes B command. -=item B<-revoke certfile [reason]> +=item B<-revoke> I [I] Revoke the certificate contained in the specified B. An optional reason may be specified, and must be one of: B, diff --git a/doc/man1/openssl-asn1parse.pod b/doc/man1/openssl-asn1parse.pod index ccb2f034b1..73824bfe14 100644 --- a/doc/man1/openssl-asn1parse.pod +++ b/doc/man1/openssl-asn1parse.pod @@ -8,21 +8,21 @@ openssl-asn1parse - ASN.1 parsing tool B B [B<-help>] -[B<-inform PEM|DER>] -[B<-in filename>] -[B<-out filename>] +[B<-inform> B|B] +[B<-in> I] +[B<-out> I] [B<-noout>] -[B<-offset number>] -[B<-length number>] +[B<-offset> I] +[B<-length> I] [B<-i>] -[B<-oid filename>] +[B<-oid> I] [B<-dump>] -[B<-dlimit num>] -[B<-strparse offset>] -[B<-genstr string>] -[B<-genconf file>] +[B<-dlimit> I] +[B<-strparse> I] +[B<-genstr> I] +[B<-genconf> I] [B<-strictpem>] -[B<-item name>] +[B<-item> I] =head1 DESCRIPTION @@ -37,16 +37,16 @@ structures. It can also be used to extract data from ASN.1 formatted data. Print out a usage message. -=item B<-inform> B +=item B<-inform> B|B -The input format. B is binary format and B (the default) is base64 +The input format. I is binary format and I (the default) is base64 encoded. -=item B<-in filename> +=item B<-in> I The input file, default is standard input. -=item B<-out filename> +=item B<-out> I Output file to place the DER encoded data into. If this option is not present then no data will be output. This is most useful when @@ -56,11 +56,11 @@ combined with the B<-strparse> option. Don't output the parsed version of the input file. -=item B<-offset number> +=item B<-offset> I Starting offset to begin parsing, default is start of file. -=item B<-length number> +=item B<-length> I Number of bytes to parse, default is until end of file. @@ -68,7 +68,7 @@ Number of bytes to parse, default is until end of file. Indents the output according to the "depth" of the structures. -=item B<-oid filename> +=item B<-oid> I A file containing additional OBJECT IDENTIFIERs (OIDs). The format of this file is described in the NOTES section below. @@ -77,16 +77,16 @@ file is described in the NOTES section below. Dump unknown data in hex format. -=item B<-dlimit num> +=item B<-dlimit> I Like B<-dump>, but only the first B bytes are output. -=item B<-strparse offset> +=item B<-strparse> I Parse the contents octets of the ASN.1 object starting at B. This option can be used multiple times to "drill down" into a nested structure. -=item B<-genstr string>, B<-genconf file> +=item B<-genstr> I, B<-genconf> I Generate encoded data based on B, B or both using L format. If B only is @@ -103,7 +103,7 @@ processed whether it has the normal PEM BEGIN and END markers or not. This option will ignore any data prior to the start of the BEGIN marker, or after an END marker in a PEM file. -=item B<-item name> +=item B<-item> I Attempt to decode and print the data as B. This can be used to print out the fields of any supported ASN.1 structure if the type is known. @@ -143,7 +143,7 @@ Some knowledge of the ASN.1 structure is needed to interpret the output. In this example the BIT STRING at offset 229 is the certificate public key. The contents octets of this will contain the public key information. This can -be examined using the option B<-strparse 229> to yield: +be examined using the option C<-strparse 229> to yield: 0:d=0 hl=3 l= 137 cons: SEQUENCE 3:d=1 hl=3 l= 129 prim: INTEGER :E5D21E1F5C8D208EA7A2166C7FAF9F6BDF2059669C60876DDB70840F1A5AAFA59699FE471F379F1DD6A487E7D5409AB6A88D4A9746E24B91D8CF55DB3521015460C8EDE44EE8A4189F7A7BE77D6CD3A9AF2696F486855CF58BF0EDF2B4068058C7A947F52548DDF7E15E96B385F86422BEA9064A3EE9E1158A56E4A6F47E5897 diff --git a/doc/man1/openssl-ca.pod b/doc/man1/openssl-ca.pod index 9826fbfc9d..3159ee21f2 100644 --- a/doc/man1/openssl-ca.pod +++ b/doc/man1/openssl-ca.pod @@ -9,55 +9,55 @@ openssl-ca - sample minimal CA application B B [B<-help>] [B<-verbose>] -[B<-config filename>] -[B<-name section>] +[B<-config> I] +[B<-name> I
] [B<-gencrl>] -[B<-revoke file>] -[B<-valid file>] -[B<-status serial>] +[B<-revoke> I] +[B<-valid> I] +[B<-status> I] [B<-updatedb>] -[B<-crl_reason reason>] -[B<-crl_hold instruction>] -[B<-crl_compromise time>] -[B<-crl_CA_compromise time>] -[B<-crldays days>] -[B<-crlhours hours>] -[B<-crlexts section>] -[B<-startdate date>] -[B<-enddate date>] -[B<-days arg>] -[B<-md arg>] -[B<-policy arg>] -[B<-keyfile arg>] -[B<-keyform PEM|DER>] -[B<-key arg>] -[B<-passin arg>] -[B<-cert file>] +[B<-crl_reason> I] +[B<-crl_hold> I] +[B<-crl_compromise> I