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