updating documentation

This commit is contained in:
Lev Walkin 2004-08-20 13:24:01 +00:00
parent 449f8324e9
commit 1538561f0b
1 changed files with 45 additions and 52 deletions

View File

@ -6,44 +6,37 @@
asn1c \- ASN.1 Compiler
.ND ASN.1 compiler
.SH SYNOPSIS
.B asn1c
.RI "[ " option " | " filename " ].\|.\|."
asn1c [\fB\-E\fR [\fB-F\fR] | \fB\-P\fR | \fB\-R\fR | \fB\-t\fR\fIdata-string\fR]
[\fB\-S\fR\fIdir\fR]
[\fB\-W\fR\fIdebug-\fR...] [\fB\-f\fR\fIoption\fR...] [\fB\-p\fR\fIrint-\fR...]
\fIinfile\fR...
.SH DESCRIPTION
asn1c is a tool to compile the ASN.1 specifications into C language structures
and accompanying routines to perform data encoding and decoding.
asn1c compiles the ASN.1 specifications into the set of
target language (C/C++) encoders and decoders for BER, DER,
and other encoding standards.
.SH OPTIONS
.TP
.B Overall Options
\-E
\-F
\-L
\-P
\-R
.RI "\-S " directory
.RI "\-t " data-string
\fIOverall Options\fR
\fB\-E \-F \-P \-R\fR
.BI "\-S " directory
.BI "\-t " data-string
.TP
.B Language Options
\fIWarning Options\fR
.br
\-ftypes88
\-fnative-integers
\-fno-c99
\-funnamed-unions
\fB\-Werror \-Wdebug-lexer \-Wdebug-fixer \-Wdebug-compiler\fR
.TP
.B Output Options
\fILanguage Options\fR
.br
\-print-constraints
\fB\-fbless-SIZE \-fnative-integers \-funnamed-unions \-ftypes88\fR
.TP
.B Warning Options
\fIOutput Options\fR
.br
\-Werror
\-Wdebug-lexer
\-Wdebug-fixer
\-Wdebug-compiler
.B \-print-constraints \-print-lines
.SH OVERALL OPTIONS
.TP
.B \-E
Stop after the parsing stage. The output is a reconstructed ASN.1
specification code, which is sent to the standard output.
Stop after the parsing stage and print the reconstructed ASN.1
specification code to the standard output.
.TP
.B \-F
Used together with \c
@ -52,11 +45,6 @@ Used together with \c
tree fixing stage and dump the reconstructed ASN.1 specification
to the standard output.
.TP
.B \-L
Generate "-- #line" comments in
.B -E
output.
.TP
.B \-P
Dump the compiled output to the standard output instead of creating the
target language files on disk.
@ -65,31 +53,12 @@ target language files on disk.
Restrict the compiler to generate only the ASN.1 tables,
omitting the usual support code.
.TP
.B \-S directory
\fB\-S\fR \fIdirectory\fR
Use the specified directory with ASN.1 skeleton files.
.TP
.B \-t data-string
\fB\-t\fR \fIdata-string\fR
Interpret the data-string as a sequence of hexadecimal values representing
the start of BER TLV encoding. Print the human readable explanation.
.SH LANGUAGE OPTIONS
.TP
.B \-ftypes88
Use only ASN.1:1988 embedded types.
.TP
.B \-fnative-integers
Use native machine's integer types whenever possible,
instead of the complex ASN.1 INTEGER and ENUMERATED types.
.TP
.B \-fno-c99
Disable use of certain C99 extensions, like designated initializers.
.TP
.B \-funnamed-unions
Enable unnamed unions in structures definitions.
.SH OUTPUT OPTIONS
.TP
.B \-print-constraints
When -EF are also specified, this option forces the compiler to explain
its internal understanding of subtype constraints.
.SH WARNING OPTIONS
.TP
.B \-Werror
@ -103,5 +72,29 @@ Enable ASN.1 syntax tree fixer debugging during the fixing stage.
.TP
.B \-Wdebug-compiler
Enable debugging during the actual compile time.
.SH LANGUAGE OPTIONS
.TP
.B \-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.
.TP
.B \-fnative-integers
Use native machine's integer types whenever possible,
instead of the complex ASN.1 INTEGER and ENUMERATED types.
.TP
.B \-funnamed-unions
Enable unnamed unions in the definitions of target language's structures.
.TP
.B \-ftypes88
Use only ASN.1:1988 embedded types.
.SH OUTPUT OPTIONS
.TP
.B \-print-constraints
When -EF are also specified, this option forces the compiler to explain
its internal understanding of subtype constraints.
.TP
.B \-print-lines
Generate "-- #line" comments in \fB-E\fR output.
.SH AUTHORS
Lev Walkin <vlm@lionet.info>