From 6e1102175e67385f15a0c6a30895c1d4ecf38002 Mon Sep 17 00:00:00 2001 From: thurston Date: Wed, 18 Mar 2009 03:00:33 +0000 Subject: [PATCH] Removed backend manual pages. git-svn-id: http://svn.complang.org/ragel/trunk@746 052ea7fc-9027-0410-9066-f65837a77df0 --- doc/Makefile.in | 2 +- doc/rlgen-cd.1.in | 108 ---------------------------------------------------- doc/rlgen-dot.1.in | 62 ------------------------------ doc/rlgen-java.1.in | 71 ---------------------------------- doc/rlgen-ruby.1.in | 74 ----------------------------------- 5 files changed, 1 insertion(+), 316 deletions(-) delete mode 100644 doc/rlgen-cd.1.in delete mode 100644 doc/rlgen-dot.1.in delete mode 100644 doc/rlgen-java.1.in delete mode 100644 doc/rlgen-ruby.1.in diff --git a/doc/Makefile.in b/doc/Makefile.in index 2b8a22b..b54500d 100644 --- a/doc/Makefile.in +++ b/doc/Makefile.in @@ -34,7 +34,7 @@ datarootdir = @datarootdir@ docdir = @docdir@ mandir = @mandir@ -MANPAGES = ragel.1 rlgen-cd.1 rlgen-java.1 rlgen-ruby.1 rlgen-dot.1 +MANPAGES = ragel.1 # Rules. all: ragel-guide.pdf $(MANPAGES) diff --git a/doc/rlgen-cd.1.in b/doc/rlgen-cd.1.in deleted file mode 100644 index cd4775a..0000000 --- a/doc/rlgen-cd.1.in +++ /dev/null @@ -1,108 +0,0 @@ -.\" -.\" Copyright 2001-2007 Adrian Thurston -.\" - -.\" This file is part of Ragel. -.\" -.\" Ragel is free software; you can redistribute it and/or modify -.\" it under the terms of the GNU General Public License as published by -.\" the Free Software Foundation; either version 2 of the License, or -.\" (at your option) any later version. -.\" -.\" Ragel is distributed in the hope that it will be useful, -.\" but WITHOUT ANY WARRANTY; without even the implied warranty of -.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -.\" GNU General Public License for more details. -.\" -.\" You should have received a copy of the GNU General Public License -.\" along with Ragel; if not, write to the Free Software -.\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - -.\" Process this file with -.\" groff -man -Tascii rlgen-cd.1 -.\" -.TH RLGEN-CD 1 "@PUBDATE@" "Ragel @VERSION@" "Ragel State Machine Compiler" -.SH NAME -rlgen-cd \- code generator for Ragel State Machine Compiler -.SH SYNOPSIS -.B rlgen-cd -.RI [ options ] -.I file -.SH DESCRIPTION -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 -.BR \-l -Inhibit the writing of #line directives in generated code. -.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 \-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, -transitions, indicies and actions. The current state is stored in a variable. -The execution is a loop that looks that given the current state and current -character to process looks up the transition to take using a binary search, -executes any actions and moves to the target state. In general, the table -driven FSM produces a smaller binary and requires a less expensive host language -compile but results in slower running code. The table driven FSM is suitable -for any FSM. -.TP -.B \-T1 -Generate a faster table driven FSM by expanding action lists in the action -execute code. -.TP -.B \-F0 -Generate a flat table driven FSM. Transitions are represented as an array -indexed by the current alphabet character. This eliminates the need for a -binary search to locate transitions and produces faster code, however it is -only suitable for small alphabets. -.TP -.B \-F1 -Generate a faster flat table driven FSM by expanding action lists in the action -execute code. -.TP -.B \-G0 -Generate a goto driven FSM. The goto driven FSM represents the state machine -as a series of goto statements. While in the machine, the current state is -stored by the processor's instruction pointer. The execution is a flat function -where control is passed from state to state using gotos. In general, the goto -FSM produces faster code but results in a larger binary and a more expensive -host language compile. -.TP -.B \-G1 -Generate a faster goto driven FSM by expanding action lists in the action -execute code. -.TP -.B \-G2 -Generate a really fast goto driven FSM by embedding action lists in the state -machine control code. -.SH BUGS -Ragel is still under development and has not yet matured. There are probably -many bugs. -.SH CREDITS -Ragel was written by Adrian Thurston . 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) - -Homepage: http://www.cs.queensu.ca/~thurston/ragel/ diff --git a/doc/rlgen-dot.1.in b/doc/rlgen-dot.1.in deleted file mode 100644 index 2a16af1..0000000 --- a/doc/rlgen-dot.1.in +++ /dev/null @@ -1,62 +0,0 @@ -.\" -.\" Copyright 2001-2007 Adrian Thurston -.\" - -.\" This file is part of Ragel. -.\" -.\" Ragel is free software; you can redistribute it and/or modify -.\" it under the terms of the GNU General Public License as published by -.\" the Free Software Foundation; either version 2 of the License, or -.\" (at your option) any later version. -.\" -.\" Ragel is distributed in the hope that it will be useful, -.\" but WITHOUT ANY WARRANTY; without even the implied warranty of -.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -.\" GNU General Public License for more details. -.\" -.\" You should have received a copy of the GNU General Public License -.\" along with Ragel; if not, write to the Free Software -.\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - -.\" Process this file with -.\" groff -man -Tascii rlgen-dot.1 -.\" -.TH RLGEN-DOT 1 "@PUBDATE@" "Ragel @VERSION@" "Ragel State Machine Compiler" -.SH NAME -rlgen-dot \- Dotfile generator for Ragel State Machine Compiler -.SH SYNOPSIS -.B rlgen-dot -.RI [ options ] -.I file -.SH DESCRIPTION -This is a backend component of Ragel. This program accepts a machine -compiled by the frontend program ragel(1) and generates a Graphviz dot file. - -.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, the output is written to the standard out. -.TP -.B \-p -Display printable characters in transition labels. -.SH BUGS -Ragel is still under development and has not yet matured. There are probably -many bugs. -.SH CREDITS -Ragel was written by Adrian Thurston . Objective-C -output contributed by Erich Ocean. D output contributed by Alan West. -.SH "SEE ALSO" -.BR ragel (1), -.BR rlgen-cd (1), -.BR rlgen-java (1), -.BR rlgen-ruby (1), -.BR re2c (1), -.BR flex (1) - -Homepage: http://www.cs.queensu.ca/~thurston/ragel/ diff --git a/doc/rlgen-java.1.in b/doc/rlgen-java.1.in deleted file mode 100644 index 8851f21..0000000 --- a/doc/rlgen-java.1.in +++ /dev/null @@ -1,71 +0,0 @@ -.\" -.\" Copyright 2001-2007 Adrian Thurston -.\" - -.\" This file is part of Ragel. -.\" -.\" Ragel is free software; you can redistribute it and/or modify -.\" it under the terms of the GNU General Public License as published by -.\" the Free Software Foundation; either version 2 of the License, or -.\" (at your option) any later version. -.\" -.\" Ragel is distributed in the hope that it will be useful, -.\" but WITHOUT ANY WARRANTY; without even the implied warranty of -.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -.\" GNU General Public License for more details. -.\" -.\" You should have received a copy of the GNU General Public License -.\" along with Ragel; if not, write to the Free Software -.\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - -.\" Process this file with -.\" groff -man -Tascii rlgen-java.1 -.\" -.TH RLGEN-JAVA 1 "@PUBDATE@" "Ragel @VERSION@" "Ragel State Machine Compiler" -.SH NAME -rlgen-java \- code generator for Ragel State Machine Compiler -.SH SYNOPSIS -.B rlgen-java -.RI [ options ] -.I file -.SH DESCRIPTION -This is a backend component of Ragel. This program accepts a machine -compiled by the frontend program ragel(1) and generates Java code. - -Use it with the frontend option -J. -.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 \-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, -transitions, indicies and actions. The current state is stored in a variable. -The execution is a loop that looks that given the current state and current -character to process looks up the transition to take using a binary search, -executes any actions and moves to the target state. In general, the table -driven FSM produces a smaller binary and requires a less expensive host language -compile but results in slower running code. The table driven FSM is suitable -for any FSM. -.SH CREDITS -Ragel was written by Adrian Thurston . Contributions -to Java code generation by Colin Fleming. -.SH "SEE ALSO" -.BR ragel (1), -.BR rlgen-cd (1), -.BR rlgen-ruby (1), -.BR rlgen-dot (1), -.BR re2c (1), -.BR flex (1) - -Homepage: http://www.cs.queensu.ca/~thurston/ragel/ diff --git a/doc/rlgen-ruby.1.in b/doc/rlgen-ruby.1.in deleted file mode 100644 index db2e1fd..0000000 --- a/doc/rlgen-ruby.1.in +++ /dev/null @@ -1,74 +0,0 @@ -.\" -.\" Copyright 2001-2007 Adrian Thurston -.\" - -.\" This file is part of Ragel. -.\" -.\" Ragel is free software; you can redistribute it and/or modify -.\" it under the terms of the GNU General Public License as published by -.\" the Free Software Foundation; either version 2 of the License, or -.\" (at your option) any later version. -.\" -.\" Ragel is distributed in the hope that it will be useful, -.\" but WITHOUT ANY WARRANTY; without even the implied warranty of -.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -.\" GNU General Public License for more details. -.\" -.\" You should have received a copy of the GNU General Public License -.\" along with Ragel; if not, write to the Free Software -.\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - -.\" Process this file with -.\" groff -man -Tascii rlgen-ruby.1 -.\" -.TH RLGEN-RUBY 1 "@PUBDATE@" "Ragel @VERSION@" "Ragel State Machine Compiler" -.SH NAME -rlgen-ruby \- code generator for Ragel State Machine Compiler -.SH SYNOPSIS -.B rlgen-ruby -.RI [ options ] -.I file -.SH DESCRIPTION -This is a backend component of Ragel. This program accepts a machine -compiled by the frontend program ragel(1) and generates Ruby code. - -Use it with the frontend option -R. -.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 \-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, -transitions, indicies and actions. The current state is stored in a variable. -The execution is a loop that looks that given the current state and current -character to process looks up the transition to take using a binary search, -executes any actions and moves to the target state. In general, the table -driven FSM produces a smaller binary and requires a less expensive host language -compile but results in slower running code. The table driven FSM is suitable -for any FSM. -.SH BUGS -Ragel is still under development and has not yet matured. There are probably -many bugs. -.SH CREDITS -Ragel was written by Adrian Thurston . Objective-C -output contributed by Erich Ocean. D output contributed by Alan West. -.SH "SEE ALSO" -.BR ragel (1), -.BR rlgen-cd (1), -.BR rlgen-java (1), -.BR rlgen-dot (1), -.BR re2c (1), -.BR flex (1) - -Homepage: http://www.cs.queensu.ca/~thurston/ragel/ -- 2.7.4