[PPL-devel] [GIT] ppl/ppl(master): Added a draft man page for `ppl_pips'. Other man pages updated.

Roberto Bagnara bagnara at cs.unipr.it
Mon Feb 15 22:14:43 CET 2010 

Module: ppl/ppl
Branch: master
Commit: b57e8b768d88e2a19af28c3a2bf206cc72117072
URL:    http://www.cs.unipr.it/git/gitweb.cgi?p=ppl/ppl.git;a=commit;h=b57e8b768d88e2a19af28c3a2bf206cc72117072

Author: Roberto Bagnara <bagnara at cs.unipr.it>
Date:   Mon Feb 15 22:14:04 2010 +0100

Added a draft man page for `ppl_pips'.  Other man pages updated.

---

 TODO                        |    2 +
 demos/ppl_lcdd/ppl_lcdd.1   |    2 +-
 demos/ppl_lpsol/ppl_lpsol.1 |    2 +-
 demos/ppl_pips/ppl_pips.1   |   83 +++++++++++++++++++++++++++++++++++++++++++
 devtools/generate_man_pages |    1 +
 doc/ppl-config.1            |    2 +-
 6 files changed, 89 insertions(+), 3 deletions(-)

diff --git a/TODO b/TODO
index e08798f..835ea2c 100644
--- a/TODO
+++ b/TODO
@@ -8,6 +8,8 @@ Enhancements for PPL 0.11
 - Lack of perl can cause more problems than explained in the warning
   message given by our configuration procedure.  See, e.g.,
   http://www.cs.unipr.it/pipermail/ppl-devel/2009-November/015758.html
+- Complete the ppl_pips man page.
+
 
 Commits to consider should we release PPL 0.10.3
 ================================================
diff --git a/demos/ppl_lcdd/ppl_lcdd.1 b/demos/ppl_lcdd/ppl_lcdd.1
index eca179f..e22d7e6 100644
--- a/demos/ppl_lcdd/ppl_lcdd.1
+++ b/demos/ppl_lcdd/ppl_lcdd.1
@@ -1,5 +1,5 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36.
-.TH PPL_LCDD "1" "April 2009" "ppl_lcdd 0.11" "User Commands"
+.TH PPL_LCDD "1" "April 2010" "ppl_lcdd 0.11" "User Commands"
 .SH NAME
 ppl_lcdd \- a PPL-based program for vertex/facet enumeration of convex polyhedra
 .SH SYNOPSIS
diff --git a/demos/ppl_lpsol/ppl_lpsol.1 b/demos/ppl_lpsol/ppl_lpsol.1
index 8c239dd..a2d6174 100644
--- a/demos/ppl_lpsol/ppl_lpsol.1
+++ b/demos/ppl_lpsol/ppl_lpsol.1
@@ -1,5 +1,5 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36.
-.TH PPL_LPSOL "1" "April 2009" "ppl_lpsol 0.11" "User Commands"
+.TH PPL_LPSOL "1" "April 2010" "ppl_lpsol 0.11" "User Commands"
 .SH NAME
 ppl_lpsol \- a PPL-based mixed integer programming problem solver
 .SH SYNOPSIS
diff --git a/demos/ppl_pips/ppl_pips.1 b/demos/ppl_pips/ppl_pips.1
new file mode 100644
index 0000000..3c492da
--- /dev/null
+++ b/demos/ppl_pips/ppl_pips.1
@@ -0,0 +1,83 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36.
+.TH PPL_PIPS "1" "April 2010" "ppl_pips 0.11" "User Commands"
+.SH NAME
+ppl_pips \- a PPL-based parametric integer programming problem solver
+.SH SYNOPSIS
+.B ppl_pips
+[\fIOPTION\fR]... [\fIFILE\fR]
+.SH DESCRIPTION
+Reads the definition of a Parametric Integer Programming problem
+and displays the lexicographic minimum in terms of the values of the
+parameters.
+.SH OPTIONS
+.TP
+\fB\-RMB\fR, \fB\-\-max\-memory\fR=\fIMB\fR
+limits memory usage to MB megabytes
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+prints this help text to stdout
+.TP
+\fB\-oPATH\fR, \fB\-\-output\fR=\fIPATH\fR
+appends output to PATH
+.TP
+\fB\-P\fR, \fB\-\-polylib\fR
+read problem in Polylib format (default)
+.TP
+\fB\-p\fR, \fB\-\-piplib\fR
+read problem in PIPlib format
+.TP
+\fB\-t\fR, \fB\-\-timings\fR
+prints timings to stderr
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+produces lots of output
+.TP
+\fB\-i\fR, \fB\-\-iterations\fR=\fIN\fR
+execute the resolution N times (default=1)
+.TP
+\fB\-V\fR, \fB\-\-version\fR
+prints version information to stdout
+.TP
+\fB\-cPATH\fR, \fB\-\-check\fR=\fIPATH\fR
+checks if the result is equal to what is in PATH
+.SS "Cut generation options:"
+.TP
+\fB\-f\fR, \fB\-\-cut\-first\fR
+use the first non\-integer row (default)
+.TP
+\fB\-d\fR, \fB\-\-cut\-deepest\fR
+try to generate the deepest cut
+.TP
+\fB\-a\fR, \fB\-\-cut\-all\fR
+always generate all possible cuts
+.SS "Pivot row strategy options:"
+.TP
+\fB\-F\fR, \fB\-\-row\-first\fR
+use the first row with negative parameter (default)
+.TP
+\fB\-M\fR, \fB\-\-row\-max\fR
+choose row generating the lexico\-maximal pivot column
+.SH AVAILABILITY
+The latest version of the Parma Polyhedra Library and all the documentation
+is available at \fBhttp://www.cs.unipr.it/ppl/\fR .
+.SH NOTES
+The options \fB\-CSECS\fR (\fB\-\-max\-cpu\fR=\fISECS\fR) and
+\fB\-t\fR (\fB\-\-timings\fR) are not available on some platforms.
+.SH AUTHOR
+See the file \fBCREDITS\fR in the source distribution or use the command
+\fBppl\-config \-\-credits\fR for a list of contributors.
+.SH "REPORTING BUGS"
+Report bugs to <ppl\-devel at cs.unipr.it>.
+.SH COPYRIGHT
+Copyright (C) 2001\-2010 Roberto Bagnara <bagnara at cs.unipr.it>
+.br
+This is free software; see the file \fBCOPYING\fR in the source
+distribution or use the command \fBppl\-config \-\-copying\fR to
+obtain the copying conditions.  There is NO warranty; not even for
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+.SH "SEE ALSO"
+.BR ppl-config(1)
+.sp
+Paul Feautrier.
+.IR "Parametric Integer Programming".
+RAIRO Recherche Opérationnelle, 22(3):243-268, 1988. 
diff --git a/devtools/generate_man_pages b/devtools/generate_man_pages
index 9184c2b..9bf3c31 100755
--- a/devtools/generate_man_pages
+++ b/devtools/generate_man_pages
@@ -2,4 +2,5 @@
 # See http://www.gnu.org/software/help2man/ for the help2man utility.
 help2man --name="obtain information about an installation of the Parma Polyhedra Library" -N --include=../doc/ppl-config_extra_man_text ppl-config >../doc/ppl-config.1
 help2man --name="a PPL-based mixed integer programming problem solver" -N --include=../demos/ppl_lpsol/ppl_lpsol_extra_man_text ppl_lpsol >../demos/ppl_lpsol/ppl_lpsol.1
+help2man --name="a PPL-based parametric integer programming problem solver" -N --include=../demos/ppl_pips/ppl_pips_extra_man_text ppl_pips >../demos/ppl_pips/ppl_pips.1
 help2man --name="a PPL-based program for vertex/facet enumeration of convex polyhedra" -N --include=../demos/ppl_lcdd/ppl_lcdd_extra_man_text ppl_lcdd >../demos/ppl_lcdd/ppl_lcdd.1
diff --git a/doc/ppl-config.1 b/doc/ppl-config.1
index f876a64..e08658a 100644
--- a/doc/ppl-config.1
+++ b/doc/ppl-config.1
@@ -1,5 +1,5 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36.
-.TH PPL-CONFIG "1" "April 2009" "ppl-config 0.11" "User Commands"
+.TH PPL-CONFIG "1" "April 2010" "ppl-config 0.11" "User Commands"
 .SH NAME
 ppl-config \- obtain information about an installation of the Parma Polyhedra Library
 .SH SYNOPSIS

More information about the PPL-devel mailing list