Updated the help and version information in the backend programs. Also updated
[external/ragel.git] / doc / rlgen-cd.1.in
similarity index 83%
rename from doc/rlcodegen.1.in
rename to doc/rlgen-cd.1.in
index ff2242c..c312158 100644 (file)
@@ -1,5 +1,5 @@
 .\"
-.\"   Copyright 2001 Adrian Thurston <thurston@cs.queensu.ca>
+.\"   Copyright 2001-2007 Adrian Thurston <thurston@cs.queensu.ca>
 .\"
 
 .\"   This file is part of Ragel.
 .\"   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA 
 
 .\"   Process this file with
-.\"   groff -man -Tascii rlcodegen.1
+.\"   groff -man -Tascii rlgen-cd.1
 .\"
-.TH RAGEL 1 "@PUBDATE@" "Ragel @VERSION@" "Ragel State Machine Compiler"
+.TH RLGEN-CD 1 "@PUBDATE@" "Ragel @VERSION@" "Ragel State Machine Compiler"
 .SH NAME
-rlcodegen \- code generator for Ragel State Machine Compiler
+rlgen-cd \- code generator for Ragel State Machine Compiler
 .SH SYNOPSIS
-.B rlcodegen 
+.B rlgen-cd 
 .RI [ options ]
 .I file
 .SH DESCRIPTION
-.B Note:
-this is the backend component of Ragel. This program accepts a machine
-compiled by the frontend program ragel(1) and generates either code or a
-graphviz dot file.
+This is a backend component of Ragel. This program accepts a machine compiled
+by the frontend program ragel(1) and generates either C (compatible
+with C++ and Objective-C) or D code.
 
+Use it with the frontend options -C or -D.
 .SH OPTIONS
 .TP
 .BR \-h ", " \-H ", " \-? ", " \-\-help
 Display help and exit.
 .TP
+.BR \-v 
+Display version information and exit.
+.TP
 .B \-o " file"
 Write output to file. If -o is not given, a default file name is chosen by
 replacing the suffix of the input. For source files ending in .rh the suffix .h
 is used. For all other source files a suffix based on the output language
 is used (.c, .cpp, .m, .dot)
 .TP
-.B \-V
-Generate a Graphviz dotfile instead of code. By default this option writes the
-dotfile to standard output. The frontend options -M and -S can be used
-to specify a subset of the grammar to write.
-.TP
-.B \-p
-Print printable characters in Graphviz output.
-.TP
 .B \-T0
 Generate a table driven FSM. This is the default code style.  The table driven
 FSM represents the state machine as static data. There are tables of states,
@@ -101,6 +96,9 @@ Ragel was written by Adrian Thurston <thurston@cs.queensu.ca>.  Objective-C
 output contributed by Erich Ocean. D output contributed by Alan West. 
 .SH "SEE ALSO"
 .BR ragel (1),
+.BR rlgen-java (1),
+.BR rlgen-ruby (1),
+.BR rlgen-dot (1),
 .BR re2c (1),
 .BR flex (1)