diff options
author | Dr. David von Oheimb <David.von.Oheimb@siemens.com> | 2020-09-02 12:56:49 +0200 |
---|---|---|
committer | Dr. David von Oheimb <David.von.Oheimb@siemens.com> | 2020-09-10 12:07:33 +0200 |
commit | 115786793c2521af9dcf20a6114e9904e0c206aa (patch) | |
tree | 0ee33ee34d677633eb1a746908345fd8109264ac /doc | |
parent | app_load_config_bio(): fix crash on error (diff) | |
download | openssl-115786793c2521af9dcf20a6114e9904e0c206aa.tar.xz openssl-115786793c2521af9dcf20a6114e9904e0c206aa.zip |
X509_NAME_print_ex.pod: re-format lines to fit within 80 chars limit
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
(Merged from https://github.com/openssl/openssl/pull/12769)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man3/X509_NAME_print_ex.pod | 60 |
1 files changed, 34 insertions, 26 deletions
diff --git a/doc/man3/X509_NAME_print_ex.pod b/doc/man3/X509_NAME_print_ex.pod index a9532b1853..e5bdf1d582 100644 --- a/doc/man3/X509_NAME_print_ex.pod +++ b/doc/man3/X509_NAME_print_ex.pod @@ -9,19 +9,21 @@ X509_NAME_oneline - X509_NAME printing routines #include <openssl/x509.h> - int X509_NAME_print_ex(BIO *out, const X509_NAME *nm, int indent, unsigned long flags); - int X509_NAME_print_ex_fp(FILE *fp, const X509_NAME *nm, int indent, unsigned long flags); + int X509_NAME_print_ex(BIO *out, const X509_NAME *nm, + int indent, unsigned long flags); + int X509_NAME_print_ex_fp(FILE *fp, const X509_NAME *nm, + int indent, unsigned long flags); char *X509_NAME_oneline(const X509_NAME *a, char *buf, int size); int X509_NAME_print(BIO *bp, const X509_NAME *name, int obase); =head1 DESCRIPTION -X509_NAME_print_ex() prints a human readable version of B<nm> to BIO B<out>. Each -line (for multiline formats) is indented by B<indent> spaces. The output format -can be extensively customised by use of the B<flags> parameter. +X509_NAME_print_ex() prints a human readable version of B<nm> to BIO B<out>. +Each line (for multiline formats) is indented by B<indent> spaces. The +output format can be extensively customised by use of the B<flags> parameter. -X509_NAME_print_ex_fp() is identical to X509_NAME_print_ex() except the output is -written to FILE pointer B<fp>. +X509_NAME_print_ex_fp() is identical to X509_NAME_print_ex() +except the output is written to FILE pointer B<fp>. X509_NAME_oneline() prints an ASCII version of B<a> to B<buf>. If B<buf> is B<NULL> then a buffer is dynamically allocated and returned, and @@ -52,15 +54,18 @@ The complete set of the flags supported by X509_NAME_print_ex() is listed below. Several options can be ored together. The options B<XN_FLAG_SEP_COMMA_PLUS>, B<XN_FLAG_SEP_CPLUS_SPC>, -B<XN_FLAG_SEP_SPLUS_SPC> and B<XN_FLAG_SEP_MULTILINE> determine the field separators -to use. Two distinct separators are used between distinct RelativeDistinguishedName -components and separate values in the same RDN for a multi-valued RDN. Multi-valued -RDNs are currently very rare so the second separator will hardly ever be used. - -B<XN_FLAG_SEP_COMMA_PLUS> uses comma and plus as separators. B<XN_FLAG_SEP_CPLUS_SPC> -uses comma and plus with spaces: this is more readable that plain comma and plus. -B<XN_FLAG_SEP_SPLUS_SPC> uses spaced semicolon and plus. B<XN_FLAG_SEP_MULTILINE> uses -spaced newline and plus respectively. +B<XN_FLAG_SEP_SPLUS_SPC> and B<XN_FLAG_SEP_MULTILINE> +determine the field separators to use. +Two distinct separators are used between distinct RelativeDistinguishedName +components and separate values in the same RDN for a multi-valued RDN. +Multi-valued RDNs are currently very rare +so the second separator will hardly ever be used. + +B<XN_FLAG_SEP_COMMA_PLUS> uses comma and plus as separators. +B<XN_FLAG_SEP_CPLUS_SPC> uses comma and plus with spaces: +this is more readable that plain comma and plus. +B<XN_FLAG_SEP_SPLUS_SPC> uses spaced semicolon and plus. +B<XN_FLAG_SEP_MULTILINE> uses spaced newline and plus respectively. If B<XN_FLAG_DN_REV> is set the whole DN is printed in reversed order. @@ -84,18 +89,21 @@ control how each field value is displayed. In addition a number options can be set for commonly used formats. -B<XN_FLAG_RFC2253> sets options which produce an output compatible with RFC2253 it -is equivalent to: - C<ASN1_STRFLGS_RFC2253 | XN_FLAG_SEP_COMMA_PLUS | XN_FLAG_DN_REV | XN_FLAG_FN_SN | XN_FLAG_DUMP_UNKNOWN_FIELDS> - +B<XN_FLAG_RFC2253> sets options which produce an output compatible with RFC2253. +It is equivalent to: + C<ASN1_STRFLGS_RFC2253 | XN_FLAG_SEP_COMMA_PLUS | XN_FLAG_DN_REV + | XN_FLAG_FN_SN | XN_FLAG_DUMP_UNKNOWN_FIELDS> B<XN_FLAG_ONELINE> is a more readable one line format which is the same as: - C<ASN1_STRFLGS_RFC2253 | ASN1_STRFLGS_ESC_QUOTE | XN_FLAG_SEP_CPLUS_SPC | XN_FLAG_SPC_EQ | XN_FLAG_FN_SN> + C<ASN1_STRFLGS_RFC2253 | ASN1_STRFLGS_ESC_QUOTE | XN_FLAG_SEP_CPLUS_SPC + | XN_FLAG_SPC_EQ | XN_FLAG_FN_SN> B<XN_FLAG_MULTILINE> is a multiline format which is the same as: - C<ASN1_STRFLGS_ESC_CTRL | ASN1_STRFLGS_ESC_MSB | XN_FLAG_SEP_MULTILINE | XN_FLAG_SPC_EQ | XN_FLAG_FN_LN | XN_FLAG_FN_ALIGN> + C<ASN1_STRFLGS_ESC_CTRL | ASN1_STRFLGS_ESC_MSB | XN_FLAG_SEP_MULTILINE + | XN_FLAG_SPC_EQ | XN_FLAG_FN_LN | XN_FLAG_FN_ALIGN> -B<XN_FLAG_COMPAT> uses a format identical to X509_NAME_print(): in fact it calls X509_NAME_print() internally. +B<XN_FLAG_COMPAT> uses a format identical to X509_NAME_print(): +in fact it calls X509_NAME_print() internally. =head1 RETURN VALUES @@ -103,9 +111,9 @@ X509_NAME_oneline() returns a valid string on success or NULL on error. X509_NAME_print() returns 1 on success or 0 on error. -X509_NAME_print_ex() and X509_NAME_print_ex_fp() return 1 on success or 0 on error -if the B<XN_FLAG_COMPAT> is set, which is the same as X509_NAME_print(). Otherwise, -it returns -1 on error or other values on success. +X509_NAME_print_ex() and X509_NAME_print_ex_fp() return 1 on success or 0 on +error if the B<XN_FLAG_COMPAT> is set, which is the same as X509_NAME_print(). +Otherwise, it returns -1 on error or other values on success. =head1 SEE ALSO |