help2man: generate man pages for genltl and ltlfilt

* tools/help2man, tools/x-to-1.in: New files, copied from gnulib
1af55d85d9762a679b4302d5995f05ccd883e956.
* configure.ac: Create x-to-1 and export CROSS_COMPILING.
* Makefile.am: Distribute help2man.
* src/bin/Makefile.am (SUBDIRS): New.
* src/bin/man/Makefile.am: New file.
* src/bin/man/genltl.x, src/bin/man/ltlfilt.x: New files.
* src/bin/genltl.cc: Document the RANGE in the options,
and move the bibliography to genltl.x.
* README: Document src/bin/man

src/bin/Makefile.am

@@ -19,13 +19,16 @@
 ## Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 ## 02111-1307, USA.
 
-AM_CPPFLAGS = -I$(top_srcdir)/src $(BUDDY_CPPFLAGS) \
+SUBDIRS = . man
+
+AM_CPPFLAGS = -I$(top_srcdir)/src -I$(top_builddir)/src $(BUDDY_CPPFLAGS) \
               -I$(top_builddir)/lib -I$(top_srcdir)/lib
 AM_CXXFLAGS = $(WARNING_CXXFLAGS)
 LDADD = $(top_builddir)/src/libspot.la $(top_builddir)/lib/libgnu.a
 
 bin_PROGRAMS = ltlfilt genltl
-ltlfilt_SOURCES = ltlfilt.cc common_output.cc
-genltl_SOURCES = genltl.cc common_output.cc
 
 noinst_HEADERS = common_output.hh
+
+ltlfilt_SOURCES = ltlfilt.cc common_output.cc
+genltl_SOURCES = genltl.cc common_output.cc

src/bin/genltl.cc

@@ -107,19 +107,7 @@ to the extent permitted by law.";
 const char* argp_program_bug_address = "<" SPOT_PACKAGE_BUGREPORT ">";
 
 const char argp_program_doc[] ="\
-Generate temporal logic formulas from predefined scalable patterns.\v\
-RANGE may have one of the following forms: INT, INT..INT, or ..INT\n\
-In the latter case, the missing number is assumed to be 1.\n\
-\n\
-Pattern names prefixed with 'ccj', 'gh', 'go', or 'rv' refer to:\n\
-[gh] J. Geldenhuys and H. Hansen (Spin'06): Larger automata and less \
-work for LTL model checking. LNCS 3925.\n\
-[ccj] J. Cichoń, A. Czubak, and A. Jasiński (DepCoS'09): Minimal Büchi \
-Automata for Certain Classes of LTL Formulas.\n\
-[go] P. Gastin and D. Oddoux (CAV'01): Fast LTL to Büchi Automata \
-Translation. LNCS 2102\n\
-[rv] K. Rozier and M. Vardi (Spin'07): LTL Satisfiability Checking. \
-LNCS 4595.\n";
+Generate temporal logic formulas from predefined scalable patterns.";
 
 #define OPT_AND_F 2
 #define OPT_AND_FG 3
@@ -190,7 +178,11 @@ static const argp_option options[] =
     { "u-right", OPT_U_RIGHT, "RANGE", 0, "(p1 U (p2 U (... U pn)))", 0 },
     OPT_ALIAS(gh-u2),
     OPT_ALIAS(go-phi),
-    /**************************************************/
+    { 0, 0, 0, 0, "RANGE may have one of the following forms: 'INT', "
+      "'INT..INT', or '..INT'.\nIn the latter case, the missing number "
+      "is assumed to be 1.", 0 },
+
+  /**************************************************/
     { 0, 0, 0, 0, "Output options:", -20 },
     { 0, 0, 0, 0, "Miscellaneous options:", -1 },
     { 0, 0, 0, 0, 0, 0 }

src/bin/man/Makefile.am

@@ -0,0 +1,37 @@
+## -*- coding: utf-8 -*-
+## Copyright (C) 2012 Laboratoire de Recherche et Développement
+## de l'Epita (LRDE).
+##
+## This file is part of Spot, a model checking library.
+##
+## Spot 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.
+##
+## Spot 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 Spot; see the file COPYING.  If not, write to the Free
+## Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
+## 02111-1307, USA.
+
+common_dep = $(top_builddir)/configure.ac
+x_to_1 = $(top_builddir)/tools/x-to-1
+convman = ARGP_HELP_FMT=header-col=0 $(SHELL) "$(x_to_1)" \
+          "$(PERL)" "$(top_srcdir)/tools/help2man -N"
+
+dist_man1_MANS = ltlfilt.1 genltl.1
+MAINTAINERCLEANFILES = $(dist_man1_MANS)
+man_aux = $(dist_man1_MANS:.1=.x)
+
+ltlfilt.1: $(common_dep) $(srcdir)/ltlfilt.x $(srcdir)/../ltlfilt.cc
+	$(convman) ../ltlfilt$(EXEEXT) $(srcdir)/ltlfilt.x $@
+
+genltl.1: $(common_dep) $(srcdir)/genltl.x $(srcdir)/../genltl.cc
+	$(convman) ../genltl$(EXEEXT) $(srcdir)/genltl.x $@
+
+

src/bin/man/genltl.x

@@ -0,0 +1,22 @@
+[NAME]
+genltl \- generate LTL formulas from scalable patterns
+[DESCRIPTION]
+.\" Add any additional description here
+[BIBLIOGRAPHY]
+Prefixes used in pattern names refer to the following papers:
+.TP
+gh
+J. Geldenhuys and H. Hansen: Larger automata and less
+work for LTL model checking.  Proceedings of Spin'06.  LNCS 3925.
+.TP
+ccj
+J. Cichoń, A. Czubak, and A. Jasiński (DepCoS'09): Minimal Büchi
+Automata for Certain Classes of LTL Formulas.  Proceedings of DepCoS'09.
+.TP
+go
+P. Gastin and D. Oddoux: Fast LTL to Büchi Automata Translation.
+Proceedings of CAV'01.  LNCS 2102
+.TP
+rv
+K. Rozier and M. Vardi: LTL Satisfiability Checking.
+Proceedings of Spin'07.  LNCS 4595.

src/bin/man/ltlfilt.x

@@ -0,0 +1,4 @@
+[NAME]
+ltlfilt \- filter files or lists of LTL/PSL formulas
+[DESCRIPTION]
+.\" Add any additional description here