diff options
| author | Richard Levitte <levitte@openssl.org> | 2019-09-28 08:07:18 +0200 |
|---|---|---|
| committer | Richard Levitte <levitte@openssl.org> | 2019-10-01 22:31:30 +0200 |
| commit | 723e9c8983f92bc256a7e8677cc02f05b47e227c (patch) | |
| tree | f3fef2a633b61bfc9f2d6c1244bfe77556ecaacc /doc/man3/ASN1_STRING_print_ex.pod | |
| parent | e8769719c9bbe53d7af088111b7625671660d4db (diff) | |
Make ASN1 manuals conform with man-pages(7)
Details from man-pages(7) that are used:
Formatting conventions for manual pages describing functions
...
Variable names should, like argument names, be specified in italics.
...
Formatting conventions (general)
...
Special macros, which are usually in uppercase, are in bold.
Exception: don't boldface NULL.
...
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/10042)
Diffstat (limited to 'doc/man3/ASN1_STRING_print_ex.pod')
| -rw-r--r-- | doc/man3/ASN1_STRING_print_ex.pod | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/man3/ASN1_STRING_print_ex.pod b/doc/man3/ASN1_STRING_print_ex.pod index 5377ab05b0..0ff03d798d 100644 --- a/doc/man3/ASN1_STRING_print_ex.pod +++ b/doc/man3/ASN1_STRING_print_ex.pod @@ -20,15 +20,15 @@ ASN1_tag2str, ASN1_STRING_print_ex, ASN1_STRING_print_ex_fp, ASN1_STRING_print These functions output an B<ASN1_STRING> structure. B<ASN1_STRING> is used to represent all the ASN1 string types. -ASN1_STRING_print_ex() outputs B<str> to B<out>, the format is determined by -the options B<flags>. ASN1_STRING_print_ex_fp() is identical except it outputs -to B<fp> instead. +ASN1_STRING_print_ex() outputs I<str> to I<out>, the format is determined by +the options I<flags>. ASN1_STRING_print_ex_fp() is identical except it outputs +to I<fp> instead. -ASN1_STRING_print() prints B<str> to B<out> but using a different format to +ASN1_STRING_print() prints I<str> to I<out> but using a different format to ASN1_STRING_print_ex(). It replaces unprintable characters (other than CR, LF) with '.'. -ASN1_tag2str() returns a human-readable name of the specified ASN.1 B<tag>. +ASN1_tag2str() returns a human-readable name of the specified ASN.1 I<tag>. =head1 NOTES @@ -38,7 +38,7 @@ ASN1_STRING_print_ex() instead. Although there are a large number of options frequently B<ASN1_STRFLGS_RFC2253> is suitable, or on UTF8 terminals B<ASN1_STRFLGS_RFC2253 & ~ASN1_STRFLGS_ESC_MSB>. -The complete set of supported options for B<flags> is listed below. +The complete set of supported options for I<flags> is listed below. Various characters can be escaped. If B<ASN1_STRFLGS_ESC_2253> is set the characters determined by RFC2253 are escaped. If B<ASN1_STRFLGS_ESC_CTRL> is set control @@ -96,7 +96,7 @@ characters written or -1 if an error occurred. ASN1_STRING_print() returns 1 on success or 0 on error. -ASN1_tag2str() returns a human-readable name of the specified ASN.1 B<tag>. +ASN1_tag2str() returns a human-readable name of the specified ASN.1 I<tag>. =head1 SEE ALSO |