Add includes in synopsis.

[openssl.git] / doc / crypto / ASN1_generate_nconf.pod

diff --git a/doc/crypto/ASN1_generate_nconf.pod b/doc/crypto/ASN1_generate_nconf.pod
index c9af7e49b7864e4567dd2ca9a30394681fb0c1c1..724ccfe04030b51d6a0057f875d5d4462b94d4ac 100644 (file)
--- a/doc/crypto/ASN1_generate_nconf.pod
+++ b/doc/crypto/ASN1_generate_nconf.pod
@@ -6,6 +6,8 @@ ASN1_generate_nconf, ASN1_generate_v3 - ASN1 generation functions
 
 =head1 SYNOPSIS
 
+ #include <openssl/asn1.h>
+
  ASN1_TYPE *ASN1_generate_nconf(char *str, CONF *nconf);
  ASN1_TYPE *ASN1_generate_v3(char *str, X509V3_CTX *cnf);
 
@@ -32,7 +34,7 @@ is:
 
 That is zero or more comma separated modifiers followed by a type
 followed by an optional colon and a value. The formats of B<type>,
-B<value> and B<modifier> is explained below.
+B<value> and B<modifier> are explained below.
 
 =head2 SUPPORTED TYPES
 
@@ -45,7 +47,7 @@ only the B<ASCII> format is permissible.
 
 This encodes a boolean type. The B<value> string is mandatory and
 should be B<TRUE> or B<FALSE>. Additionally B<TRUE>, B<true>, B<Y>,
-B<y>, B<YES>, B<yes>, B<FALSE> B<false>, B<N>, B<n>, B<NO> and B<no>
+B<y>, B<YES>, B<yes>, B<FALSE>, B<false>, B<N>, B<n>, B<NO> and B<no>
 are acceptable. 
 
 =item B<NULL>
@@ -74,9 +76,9 @@ a short name, a long name or numerical format.
 Encodes an ASN1 B<UTCTime> structure, the value should be in
 the format B<YYMMDDHHMMSSZ>. 
 
-=item B<GENERALIZETIME>, B<GEN>
+=item B<GENERALIZEDTIME>, B<GENTIME>
 
-Encodes an ASN1 B<GeneralizeTime> structure, the value should be in
+Encodes an ASN1 B<GeneralizedTime> structure, the value should be in
 the format B<YYYYMMDDHHMMSSZ>. 
 
 =item B<OCTETSTRING>, B<OCT>
@@ -97,7 +99,8 @@ bits is set to zero.
 =item B<UNIVERSALSTRING>, B<UNIV>, B<IA5>, B<IA5STRING>, B<UTF8>,
 B<UTF8String>, B<BMP>, B<BMPSTRING>, B<VISIBLESTRING>,
 B<VISIBLE>, B<PRINTABLESTRING>, B<PRINTABLE>, B<T61>,
-B<T61STRING>, B<TELETEXSTRING>
+B<T61STRING>, B<TELETEXSTRING>, B<GeneralString>, B<NUMERICSTRING>,
+B<NUMERIC>
 
 These encode the corresponding string types. B<value> represents the
 contents of this structure. The format can be B<ASCII> or B<UTF8>.
@@ -106,10 +109,11 @@ contents of this structure. The format can be B<ASCII> or B<UTF8>.
 
 Formats the result as an ASN1 B<SEQUENCE> or B<SET> type. B<value>
 should be a section name which will contain the contents. The
-field names are ignored and the values are in the generated
-string format. If B<value> is absent the the content will be empty.
+field names in the section are ignored and the values are in the
+generated string format. If B<value> is absent then an empty SEQUENCE
+will be encoded.
 
-=cut
+=back
 
 =head2 MODIFIERS
 
@@ -135,10 +139,10 @@ the default is CONTEXT SPECIFIC.
 This is the same as B<EXPLICIT> except IMPLICIT tagging is used
 instead.
 
-=item B<OCTWRAP>, B<SEQWRAP>, B<BITWRAP>
+=item B<OCTWRAP>, B<SEQWRAP>, B<SETWRAP>, B<BITWRAP>
 
-The following structure is surrounded by an OCTET STRING, a SEQUENCE
-or a BIT STRING respectively. For a BIT STRING the number of unused
+The following structure is surrounded by an OCTET STRING, a SEQUENCE,
+a SET or a BIT STRING respectively. For a BIT STRING the number of unused
 bits is set to zero.
 
 =item B<FORMAT>
@@ -151,7 +155,7 @@ then the value string must be a valid B<UTF8> string. For B<HEX> the output must
 be a set of hex digits. B<BITLIST> (which is only valid for a BIT STRING) is a
 comma separated list of set bits.
 
-=cut
+=back
 
 =head1 EXAMPLES