[SCM] gfan: Program for computing with Groebner fans branch, master, updated. debian/0.3dfsg-1-24-gc204dfb

[Cédric Boutillier]

The following commit has been merged in the master branch:
commit c204dfb87565842b1cbe078e56c89aeb664cb60d
Author: Cédric Boutillier <boutil at debian.org>
Date:   Sat Feb 16 16:30:27 2013 +0100

    improved manual page

diff --git a/debian/gfan.1 b/debian/gfan.1
index b9feea3..f19a676 100644
--- a/debian/gfan.1
+++ b/debian/gfan.1
@@ -1,31 +1,66 @@
-.TH GFAN "1" "May 2008" "Gfan Groebner fan package   Version 0.3" "User Commands"
+.TH GFAN "1" "February 2013" "gfan 0.5" "Mathematics"
 .SH NAME
-Gfan \- program for computing with Groebner fans
+gfan \- tool to compute Gröbner fans and tropical varieties
+.SH SYNOPSIS
+.B gfan_\fItool\fR [\fIoptions\fR] 
+
+.B gfan _\fItool\fR [\fIoptions\fR] 
 .SH DESCRIPTION
-This is a program for computing all reduced Groebner bases of a polynomial ideal. It takes a generating set for the ideal as input. By default the enumeration is done by an almost memoryless reverse search. If the ideal is symmetric the symmetry option is useful and enumeration will be done up to symmetry using a breadth first search. The program needs a starting Groebner basis to do its computations. If the -g option is not specified it will compute one using Buchberger's algorithm.
+Gfan is a software package for computing Gröbner fans and tropical varieties.
+These are polyhedral fans associated to polynomial ideals. The maximal cones of
+a Gröbner fan are in bijection with the marked reduced Gröbner bases of its
+defining ideal. The software computes all marked reduced Gröbner bases of an
+ideal. Their union is a universal Gröbner basis. The tropical variety of a
+polynomial ideal is a certain subcomplex of the Gröbner fan. Gfan contains
+algorithms for computing this complex for general ideals and specialized
+algorithms for tropical curves, tropical hypersurfaces and tropical varieties
+of prime ideals. In addition to the above core functions the package contains
+many tools which are useful in the study of Gröbner bases, initial ideals and
+tropical geometry.
 
-Usage:
-.IP
-/usr/bin/gfan [options]
+The complete list of \fItool\fRs is:
 
+bases, buchberger, combinerays, doesidealcontain, fancommonrefinement,
+fanhomology, fanlink, fanproduct, fansubfan, genericlinearchange, groebnercone,
+groebnerfan, homogeneityspace, homogenize, initialforms, interactive,
+ismarkedgroebnerbasis, krulldimension, latticeideal, leadingterms, list,
+markpolynomialset, minkowskisum, minors, mixedvolume, overintegers, padic,
+polynomialsetunion, render, renderstaircase, saturation, secondaryfan, stats,
+substitute, symmetries, tolatex, topolyhedralfan, tropicalbasis,
+tropicalbruteforce, tropicalevaluation, tropicalfunction, tropicalhypersurface,
+tropicalintersection, tropicallifting, tropicallinearspace,
+tropicalmultiplicity, tropicalrank, tropicalstartingcone, tropicaltraverse,
+tropicalweildivisor, version.
 
+Below are presented the generic options available with all \fItool\fRs. For
+specific options of a given \fItool\fR, we refer to the help message of that
+tool.
+
+.SH OPTIONS
+.TP 
+.B \-\-help
+Display a help message describing the functionality of \fBgfan_\fItool\fR and the available specific options.
 
-.PP
-Options:
-.TP
-\fB\-g\fR
-Tells the program that the input is already a Groebner basis (with the initial term of each polynomial being the first ones listed). Use this option if it takes too much time to compute the starting (standard degree lexicographic) Groebner basis and the input is already a Groebner basis.
 .TP
-\fB\-\-symmetry\fR
- Tells the program to read in generators for a group of symmetries (subgroup of $S_n$) after having read in the ideal. The program checks that the ideal stays fixed when permuting the variables with respect to elements in the group. The program uses breadth first search to compute the set of reduced Groebner bases up to symmetry with respect to the specified subgroup.
+.B \-\-log1, \-\-log2...
+Tell Gfan how much information to write to standard error while a computation
+is running. These options are very useful when you wish to know if Gfan is
+making any progress in its computation.
+
 .TP
-\fB\-e\fR
-Echo. Output the generators for the symmetry group.
+.B \-\-stdin \fIvalue\fR
+Specify a file to use as input instead of reading from the standard input.
+
 .TP
-\fB\-\-subspace\fR
-Only do breadth first search on cones with their interior intersecting a specified subspace. The subspace is given by a list of hyperplane normals at the end of the input. The intersection of the hyperplanes is the subspace being specified. Note that the set of Groebner cones intersecting the subspace could be disconnected and that only one connected component is computed. Works only together with --symmetry.
+.B \-\-stdout \fIvalue\fR
+Specify a file to write output to instead of writing to the standard output.
+
 .TP
-\fB\-\-disableSymmetryTest\fR
-When using --symmetry this option will disable the check that the group read off from the input actually is a symmetry group with respect to the input ideal.
+.B \-\-xml
+Let polyhedral fans be output in an XML format instead of in the text
+format. (The XML files are not readable by Gfan.)
 
+.SH SEE ALSO
 
+The complete manual of Gfan is available from the website of the project:
+http://home.imf.au.dk/jensen/software/gfan/gfan.html

-- 
gfan: Program for computing with Groebner fans