=== Released 2.2.0 ===

[platform/upstream/glib.git] / gobject / glib-mkenums.1

diff --git a/gobject/glib-mkenums.1 b/gobject/glib-mkenums.1
index 374ca95..46c6caf 100644 (file)
--- a/gobject/glib-mkenums.1
+++ b/gobject/glib-mkenums.1
@@ -1,4 +1,4 @@
-.TH GLIB-MKENUMS 1 "20 Apr 2001"
+.TH GLIB-MKENUMS 1 "27 Jul 2002"
 .SH NAME
 glib-mkenums \- C language enum description generation utility
 .SH SYNOPSIS
@@ -14,7 +14,7 @@ enum values as strings so programs can provide value name strings for introspect
 .SH INVOCATION
 
 \fBglib-mkenums\fP takes a list of valid C code files as input. The options
-specified controll the text that is output, certain substitutions are performed
+specified control the text that is output, certain substitutions are performed
 on the text templates for keywords enclosed in @ characters.
 
 
@@ -45,6 +45,20 @@ Put out <text> after iterating over all values of an enum.
 Template for auto-generated comments, the default (for C code generations) is
 "/* @comment@ */".
 .TP
+\fI--template file
+Read templates from the given file. The templates are enclosed in
+specially-formatted C comments
+.PP
+.RS
+.nf
+/*** BEGIN section ***/ 
+/*** END section ***/
+.fi
+.PP
+where section may be file-header, file-production, file-tail,
+enumeration-production, value-header, value-production, value-tail or
+comment.
+.TP
 \fI-h, --help\fP 
 Print brief help and exit.
 .TP
@@ -71,26 +85,26 @@ typedef enum
 .TP 12
 \fI@EnumName@
 The name of the enum currently being processed, enum names are assumed to be
-properly namespaced and to use mixed capitalization to seperate
+properly namespaced and to use mixed capitalization to separate
 words (e.g. PrefixTheXEnum).
 .TP 12
 \fI@enum_name@
-The enum name with words lowercase and word-seperated by underscores (e.g. prefix_the_xenum).
+The enum name with words lowercase and word-separated by underscores (e.g. prefix_the_xenum).
 .TP 12
 \fI@ENUMNAME@
-The enum name with words uppercase and word-seperated by underscores (e.g. PREFIX_THE_XENUM).
+The enum name with words uppercase and word-separated by underscores (e.g. PREFIX_THE_XENUM).
 .TP 12
 \fI@ENUMSHORT@
-The enum name with words uppercase and word-seperated by underscores, prefix stripped (e.g. THE_XENUM).
+The enum name with words uppercase and word-separated by underscores, prefix stripped (e.g. THE_XENUM).
 .TP 12
 \fI@VALUENAME@
-The enum value name currently being processed with words uppercase and word-seperated by underscores,
+The enum value name currently being processed with words uppercase and word-separated by underscores,
 this is the assumed literal notation of enum values in the C sources (e.g. PREFIX_THE_XVALUE).
 .TP 12
 \fI@valuenick@
 A nick name for the enum value currently being processed, this is usually generated by stripping
 common prefix words of all the enum values of the current enum, the words are lowercase and
-underscores are subsituted by a minus (e.g. the-xvalue).
+underscores are substituted by a minus (e.g. the-xvalue).
 .TP 12
 \fI@type@
 This is substituted either by "enum" or "flags", depending on whether the enum value definitions