Lev Walkin | f15320b | 2004-06-03 03:38:44 +0000 | [diff] [blame] | 1 | .de Id |
| 2 | .. |
| 3 | .Id $Id" |
| 4 | .TH ASN1C 1 "\*(Dt" "ASN.1 Compiler" "ASN.1 Compiler" |
| 5 | .SH NAME |
| 6 | asn1c \- ASN.1 Compiler |
| 7 | .ND ASN.1 compiler |
| 8 | .SH SYNOPSIS |
Lev Walkin | 1538561 | 2004-08-20 13:24:01 +0000 | [diff] [blame] | 9 | asn1c [\fB\-E\fR [\fB-F\fR] | \fB\-P\fR | \fB\-R\fR | \fB\-t\fR\fIdata-string\fR] |
| 10 | [\fB\-S\fR\fIdir\fR] |
| 11 | [\fB\-W\fR\fIdebug-\fR...] [\fB\-f\fR\fIoption\fR...] [\fB\-p\fR\fIrint-\fR...] |
| 12 | \fIinfile\fR... |
Lev Walkin | f15320b | 2004-06-03 03:38:44 +0000 | [diff] [blame] | 13 | .SH DESCRIPTION |
Lev Walkin | 1538561 | 2004-08-20 13:24:01 +0000 | [diff] [blame] | 14 | asn1c compiles the ASN.1 specifications into the set of |
| 15 | target language (C/C++) encoders and decoders for BER, DER, |
| 16 | and other encoding standards. |
Lev Walkin | f15320b | 2004-06-03 03:38:44 +0000 | [diff] [blame] | 17 | .SH OPTIONS |
| 18 | .TP |
Lev Walkin | 1538561 | 2004-08-20 13:24:01 +0000 | [diff] [blame] | 19 | \fIOverall Options\fR |
| 20 | \fB\-E \-F \-P \-R\fR |
| 21 | .BI "\-S " directory |
| 22 | .BI "\-t " data-string |
Lev Walkin | f15320b | 2004-06-03 03:38:44 +0000 | [diff] [blame] | 23 | .TP |
Lev Walkin | 1538561 | 2004-08-20 13:24:01 +0000 | [diff] [blame] | 24 | \fIWarning Options\fR |
Lev Walkin | f15320b | 2004-06-03 03:38:44 +0000 | [diff] [blame] | 25 | .br |
Lev Walkin | 1538561 | 2004-08-20 13:24:01 +0000 | [diff] [blame] | 26 | \fB\-Werror \-Wdebug-lexer \-Wdebug-fixer \-Wdebug-compiler\fR |
Lev Walkin | f15320b | 2004-06-03 03:38:44 +0000 | [diff] [blame] | 27 | .TP |
Lev Walkin | 1538561 | 2004-08-20 13:24:01 +0000 | [diff] [blame] | 28 | \fILanguage Options\fR |
Lev Walkin | 3aed7ff | 2004-08-19 13:24:58 +0000 | [diff] [blame] | 29 | .br |
Lev Walkin | dd32b59 | 2004-09-06 08:07:29 +0000 | [diff] [blame^] | 30 | \fB\-fall-defs-global \-fbless-SIZE \-fnative-integers \-funnamed-unions \-ftypes88\fR |
Lev Walkin | 3aed7ff | 2004-08-19 13:24:58 +0000 | [diff] [blame] | 31 | .TP |
Lev Walkin | 1538561 | 2004-08-20 13:24:01 +0000 | [diff] [blame] | 32 | \fIOutput Options\fR |
Lev Walkin | f15320b | 2004-06-03 03:38:44 +0000 | [diff] [blame] | 33 | .br |
Lev Walkin | 1538561 | 2004-08-20 13:24:01 +0000 | [diff] [blame] | 34 | .B \-print-constraints \-print-lines |
Lev Walkin | f15320b | 2004-06-03 03:38:44 +0000 | [diff] [blame] | 35 | .SH OVERALL OPTIONS |
| 36 | .TP |
| 37 | .B \-E |
Lev Walkin | 1538561 | 2004-08-20 13:24:01 +0000 | [diff] [blame] | 38 | Stop after the parsing stage and print the reconstructed ASN.1 |
| 39 | specification code to the standard output. |
Lev Walkin | f15320b | 2004-06-03 03:38:44 +0000 | [diff] [blame] | 40 | .TP |
| 41 | .B \-F |
| 42 | Used together with \c |
| 43 | .B \-E\c |
| 44 | , instructs the compiler to stop after the ASN.1 syntax |
| 45 | tree fixing stage and dump the reconstructed ASN.1 specification |
| 46 | to the standard output. |
| 47 | .TP |
Lev Walkin | f15320b | 2004-06-03 03:38:44 +0000 | [diff] [blame] | 48 | .B \-P |
| 49 | Dump the compiled output to the standard output instead of creating the |
| 50 | target language files on disk. |
| 51 | .TP |
Lev Walkin | f15320b | 2004-06-03 03:38:44 +0000 | [diff] [blame] | 52 | .B \-R |
| 53 | Restrict the compiler to generate only the ASN.1 tables, |
| 54 | omitting the usual support code. |
Lev Walkin | 3aed7ff | 2004-08-19 13:24:58 +0000 | [diff] [blame] | 55 | .TP |
Lev Walkin | 1538561 | 2004-08-20 13:24:01 +0000 | [diff] [blame] | 56 | \fB\-S\fR \fIdirectory\fR |
Lev Walkin | 3aed7ff | 2004-08-19 13:24:58 +0000 | [diff] [blame] | 57 | Use the specified directory with ASN.1 skeleton files. |
| 58 | .TP |
Lev Walkin | 1538561 | 2004-08-20 13:24:01 +0000 | [diff] [blame] | 59 | \fB\-t\fR \fIdata-string\fR |
Lev Walkin | 3aed7ff | 2004-08-19 13:24:58 +0000 | [diff] [blame] | 60 | Interpret the data-string as a sequence of hexadecimal values representing |
| 61 | the start of BER TLV encoding. Print the human readable explanation. |
Lev Walkin | f15320b | 2004-06-03 03:38:44 +0000 | [diff] [blame] | 62 | .SH WARNING OPTIONS |
| 63 | .TP |
| 64 | .B \-Werror |
| 65 | Treat warnings as errors; abort if any warning is produced. |
| 66 | .TP |
| 67 | .B \-Wdebug-lexer |
| 68 | Enable lexer debugging during the ASN.1 parsing stage. |
| 69 | .TP |
| 70 | .B \-Wdebug-fixer |
| 71 | Enable ASN.1 syntax tree fixer debugging during the fixing stage. |
| 72 | .TP |
| 73 | .B \-Wdebug-compiler |
| 74 | Enable debugging during the actual compile time. |
Lev Walkin | 1538561 | 2004-08-20 13:24:01 +0000 | [diff] [blame] | 75 | .SH LANGUAGE OPTIONS |
| 76 | .TP |
Lev Walkin | dd32b59 | 2004-09-06 08:07:29 +0000 | [diff] [blame^] | 77 | .B \-fall-defs-global |
| 78 | Normally the compiler hides the definitions (asn1_DEF_xxx) of the inner |
| 79 | structure elements (members of SEQUENCE, SET and other types). This option |
| 80 | makes all such definitions global. |
| 81 | Enabling this option may pollute the namespace by making lots of asn1_DEF_xxx |
| 82 | structures globally visible, but will allow you to manipulate |
| 83 | (encode and decode) the individual members of any complex ASN.1 structure. |
| 84 | .TP |
Lev Walkin | 1538561 | 2004-08-20 13:24:01 +0000 | [diff] [blame] | 85 | .B \-fbless-SIZE |
| 86 | Allow SIZE() constraint for INTEGER, ENUMERATED, and other types for which this |
| 87 | constraint is normally prohibited by the standard. This is a violation of |
| 88 | an ASN.1 standard and compiler may fail to produce the meaningful code. |
| 89 | .TP |
| 90 | .B \-fnative-integers |
| 91 | Use native machine's integer types whenever possible, |
| 92 | instead of the complex ASN.1 INTEGER and ENUMERATED types. |
| 93 | .TP |
| 94 | .B \-funnamed-unions |
| 95 | Enable unnamed unions in the definitions of target language's structures. |
| 96 | .TP |
| 97 | .B \-ftypes88 |
| 98 | Use only ASN.1:1988 embedded types. |
| 99 | .SH OUTPUT OPTIONS |
| 100 | .TP |
| 101 | .B \-print-constraints |
| 102 | When -EF are also specified, this option forces the compiler to explain |
| 103 | its internal understanding of subtype constraints. |
| 104 | .TP |
| 105 | .B \-print-lines |
| 106 | Generate "-- #line" comments in \fB-E\fR output. |
Lev Walkin | f15320b | 2004-06-03 03:38:44 +0000 | [diff] [blame] | 107 | .SH AUTHORS |
| 108 | Lev Walkin <vlm@lionet.info> |