diff --git a/doc/asn1c-usage.html b/doc/asn1c-usage.html index c2e33774..8bd76d68 100644 --- a/doc/asn1c-usage.html +++ b/doc/asn1c-usage.html @@ -177,7 +177,7 @@ standardized encoding rules (BER, DER, XER).

For example, suppose the following ASN.1 module is given1.1: + HREF="#foot843">1.1:

@@ -195,7 +195,7 @@ END The compiler would read this ASN.1 definition and produce the following C type1.2: + HREF="#foot844">1.2:

@@ -219,8 +219,8 @@ Quick start with asn1c

After building and installing the compiler, the asn1c1.3 command may be used to compile the ASN.1 module1.4: + HREF="#foot845">1.3 command may be used to compile the ASN.1 module1.4:

@@ -328,7 +328,7 @@ the compiler's behavior.


-
+
@@ -336,92 +336,101 @@ The list of asn1c command line options +Overall Options - - - - - - + - + - - - - - + - +the individual members of any complex ASN.1 structure. - - + + - + - + + - - + -
Table 1: The list of asn1c command line options
-Overall Options -Description
+Description
-E +
-E Stop after the parsing stage and print the reconstructed ASN.1 specification code to the standard output.
-F +
-F Used together with -E, instructs the compiler to stop after the ASN.1 syntax tree fixing stage and dump the reconstructed ASN.1 specification to the standard output.
-P +
-P Dump the compiled output to the standard output instead of cre- ating the target language files on disk.
-R +
-R Restrict the compiler to generate only the ASN.1 tables, omit- ting the usual support code.
-S <directory> +
-S <directory> Use the specified directory with ASN.1 skeleton files.
-X -Generate the XML DTD for the specified ASN.1 modules.
-X +Generate the XML DTD for the specified ASN.1 modules.
Warning Options -Description
Warning Options +Description
-Werror +
-Werror Treat warnings as errors; abort if any warning is produced.
-Wdebug-lexer +
-Wdebug-lexer Enable lexer debugging during the ASN.1 parsing stage.
-Wdebug-fixer +
-Wdebug-fixer Enable ASN.1 syntax tree fixer debugging during the fixing stage.
-Wdebug-compiler +
-Wdebug-compiler Enable debugging during the actual compile time.
Language Options -Description
Language Options +Description
-fall-defs-global -Normally the compiler hides the definitions (asn_DEF_xxx) of the -inner structure elements (members of SEQUENCE, SET and other types). -This option makes all such definitions global. Enabling this option -may pollute the namespace by making lots of asn_DEF_xxx structures +
-fall-defs-global +Normally the compiler hides the definitions (asn_DEF_xxx) +of the inner structure elements (members of SEQUENCE, SET and other +types). This option makes all such definitions global. Enabling this +option may pollute the namespace by making lots of asn_DEF_xxx structures globally visible, but will allow you to manipulate (encode and decode) -the individual members of any complex ASN.1 structure.
-fbless-SIZE +
-fbless-SIZE Allow SIZE() constraint for INTEGER, ENUMERATED, and other types for which this constraint is normally prohibited by the standard. This is a violation of an ASN.1 standard and compiler may fail to produce the meaningful code.
-fnative-types +
-fcompound-names +Use complex names for C structures. Using complex names prevents +name clashes in case the module reuses the same identifiers in multiple +contexts.
-fnative-types Use the native machine's data types (int, double) whenever possible, instead of the compound INTEGER_t, ENUMERATED_t and REAL_t types.
-fno-constraints -Do not generate ASN.1 subtype constraint checking code. This may make -a shorter executable.
-fno-constraints +Do not generate ASN.1 subtype constraint checking code. This +may produce a shorter executable.
-funnamed-unions +
-fno-include-deps +Do not generate courtesy #include lines for non-critical +dependencies.
-funnamed-unions Enable unnamed unions in the definitions of target language's structures.
-ftypes88 +
-ftypes88 Pretend to support only ASN.1:1988 embedded types. Certain reserved words, such as UniversalString and BMPString, become ordinary type references and may be redefined by the specification.
Output Options -Description
Output Options +Description
--print-constraints +-print-constraints When -EF are also specified, this option forces the compiler to explain its internal understanding of subtype constraints.
-print-lines +
-print-lines Generate "- #line" comments in -E output.
@@ -485,7 +494,7 @@ are of interest:
ber_decoder
This is the generic restartable2.1 BER decoder (Basic Encoding Rules). This decoder would create + HREF="#foot181">2.1 BER decoder (Basic Encoding Rules). This decoder would create and/or fill the target structure for you. Please refer to Section sub:Decoding-BER.
@@ -719,7 +728,7 @@ DER encoder will essentially do the same thing (i.e., encode the data) but no callbacks will be invoked (so the data goes nowhere). It may prove useful to determine the size of the structure's encoding before actually doing the encoding2.2. + HREF="#foot250">2.2.

Please look into der_encoder.h for the precise definition of der_encode() @@ -1262,7 +1271,7 @@ END main() routine shown in the Section A Rectangle Decoder) by placing the following snippet of code before encoding and/or after decoding the Rectangle type4.1: + HREF="#foot923">4.1:

@@ -1732,44 +1741,44 @@ ISBN:0-12-6333361-0.


Footnotes

-
... given... given1.1
Please look into Part par:ASN.1-Basics for a quick reference on how to understand the ASN.1 notation.
-
... type... type1.2
-fnative-types compiler option is used to produce basic C int types instead of infinite width INTEGER_t structures. See Table 1.
-
...asn1c...asn1c1.3
The 1 symbol in asn1c is a digit, not an ''ell'' letter.
-
... module... module1.4
This is probably not what you want to try out right now - read through the rest of this chapter and check the Table 1 to find out about -P and -R options.
-
...restartable...restartable2.1
Restartable means that if the decoder encounters the end of the buffer, it will fail, but may later be invoked again with the rest of the buffer to continue decoding.
-
... encoding... encoding2.2
It is actually faster too: the encoder might skip over some computations which aren't important for the size determination.
-
... type... type4.1
Placing the constraint checking code before encoding helps to make sure you know the data is correct and within constraints before @@ -1784,7 +1793,7 @@ the application got the valid contents before making use of it.

Lev Walkin -2005-02-21 +2005-03-04
diff --git a/doc/asn1c-usage.lyx b/doc/asn1c-usage.lyx index 5efe9d6a..f000c895 100644 --- a/doc/asn1c-usage.lyx +++ b/doc/asn1c-usage.lyx @@ -71,7 +71,7 @@ status Open \backslash lhead{This document describes \backslash -href{http://lionet.info/asn1c}{asn1c-0.9.9}} +href{http://lionet.info/asn1c}{asn1c-0.9.11}} \layout Standard \backslash @@ -459,7 +459,7 @@ collapsed false \begin_inset Tabular - + @@ -471,6 +471,7 @@ collapsed false \series bold +\size small Overall Options \end_inset @@ -481,6 +482,7 @@ Overall Options \series bold +\size small Description \end_inset @@ -491,6 +493,8 @@ Description \layout Standard + +\size small -E \end_inset @@ -512,6 +516,8 @@ Stop after the parsing stage and print the reconstructed ASN.1 specification \layout Standard + +\size small -F \end_inset @@ -534,6 +540,8 @@ Used together with -E, instructs the compiler to stop after the ASN.1 syntax \layout Standard + +\size small -P \end_inset @@ -555,6 +563,8 @@ Dump the compiled output to the standard output instead of cre- ating the \layout Standard + +\size small -R \end_inset @@ -576,6 +586,8 @@ Restrict the compiler to generate only the ASN.1 tables, omit- ting the usual \layout Standard + +\size small -S \emph on @@ -598,6 +610,8 @@ Use the specified directory with ASN.1 skeleton files. \layout Standard + +\size small -X \end_inset @@ -606,6 +620,8 @@ Use the specified directory with ASN.1 skeleton files. \layout Standard + +\size small Generate the XML DTD for the specified ASN.1 modules. \end_inset @@ -618,6 +634,7 @@ Generate the XML DTD for the specified ASN.1 modules. \series bold +\size small Warning Options \end_inset @@ -628,6 +645,7 @@ Warning Options \series bold +\size small Description \end_inset @@ -638,6 +656,8 @@ Description \layout Standard + +\size small -Werror \end_inset @@ -658,6 +678,8 @@ Treat warnings as errors; abort if any warning is produced. \layout Standard + +\size small -Wdebug-lexer \end_inset @@ -678,6 +700,8 @@ Enable lexer debugging during the ASN.1 parsing stage. \layout Standard + +\size small -Wdebug-fixer \end_inset @@ -698,6 +722,8 @@ Enable lexer debugging during the ASN.1 parsing stage. \layout Standard + +\size small -Wdebug-compiler \end_inset @@ -720,6 +746,7 @@ Enable debugging during the actual compile time. \series bold +\size small Language Options \end_inset @@ -730,6 +757,7 @@ Language Options \series bold +\size small Description \end_inset @@ -740,6 +768,8 @@ Description \layout Standard + +\size small -fall-defs-global \end_inset @@ -748,6 +778,8 @@ Description \layout Standard + +\size small Normally the compiler hides the definitions (asn_DEF_xxx) of the inner structure elements (members of SEQUENCE, SET and other types). This option makes all such definitions global. @@ -763,6 +795,8 @@ Normally the compiler hides the definitions (asn_DEF_xxx) of the inner structure \layout Standard + +\size small -fbless-SIZE \end_inset @@ -786,6 +820,32 @@ Allow SIZE() constraint for INTEGER, ENUMERATED, and other types for which \layout Standard + +\size small +-fcompound-names +\end_inset + + +\begin_inset Text + +\layout Standard + + +\size small +Use complex names for C structures. + Using complex names prevents name clashes in case the module reuses the + same identifiers in multiple contexts. +\end_inset + + + + +\begin_inset Text + +\layout Standard + + +\size small -fnative-types \end_inset @@ -808,6 +868,8 @@ Use the native machine's data types (int, double) whenever possible, instead \layout Standard + +\size small -fno-constraints \end_inset @@ -816,8 +878,10 @@ Use the native machine's data types (int, double) whenever possible, instead \layout Standard + +\size small Do not generate ASN.1 subtype constraint checking code. - This may make a shorter executable. + This may produce a shorter executable. \end_inset @@ -827,6 +891,30 @@ Do not generate ASN.1 subtype constraint checking code. \layout Standard + +\size small +-fno-include-deps +\end_inset + + +\begin_inset Text + +\layout Standard + + +\size small +Do not generate courtesy #include lines for non-critical dependencies. +\end_inset + + + + +\begin_inset Text + +\layout Standard + + +\size small -funnamed-unions \end_inset @@ -847,6 +935,8 @@ Enable unnamed unions in the definitions of target language's structures. \layout Standard + +\size small -ftypes88 \end_inset @@ -871,6 +961,7 @@ Pretend to support only ASN.1:1988 embedded types. \series bold +\size small Output Options \end_inset @@ -881,6 +972,7 @@ Output Options \series bold +\size small Description \end_inset @@ -891,6 +983,8 @@ Description \layout Standard + +\size small -print-constraints \end_inset @@ -912,6 +1006,8 @@ When -EF are also specified, this option forces the compiler to explain \layout Standard + +\size small -print-lines \end_inset diff --git a/doc/asn1c-usage.pdf b/doc/asn1c-usage.pdf index 0896ef1f..90168cd8 100644 Binary files a/doc/asn1c-usage.pdf and b/doc/asn1c-usage.pdf differ