[scotch] 01/12: Create a fill-in man page scotch_binaries.1 for undocumented binaries
Drew Parsons
dparsons at moszumanska.debian.org
Wed Dec 20 07:14:43 UTC 2017
This is an automated email from the git hooks/post-receive script.
dparsons pushed a commit to tag debian/6.0.4.dfsg1-8
in repository scotch.
commit b166b93aa362a487c12c7ee908b3198ce9f91096
Author: Drew Parsons <dparsons at debian.org>
Date: Wed Dec 20 10:53:45 2017 +0800
Create a fill-in man page scotch_binaries.1 for undocumented binaries
Covers sundry binaries
scotch_esmumps, scotch_gbase, acpl, amk_grf, mcv
for which a man page is not available.
Closes: #883824.
---
debian/acpl.1 | 18 ----
debian/amk_ccc.1 | 18 ----
debian/changelog | 3 +
debian/dgscat.1 | 136 ------------------------
debian/genmanpage.sh | 29 -----
debian/gout.1 | 267 -----------------------------------------------
debian/rules | 15 ++-
debian/scotch.install | 1 +
debian/scotch_binaries.1 | 29 +++++
debian/scotch_esmumps.1 | 18 ----
10 files changed, 39 insertions(+), 495 deletions(-)
diff --git a/debian/acpl.1 b/debian/acpl.1
deleted file mode 100644
index d4fbd8a..0000000
--- a/debian/acpl.1
+++ /dev/null
@@ -1,18 +0,0 @@
-.\" -*- nroff -*-
-.TH scotch_esmumps 1 "April 2009" "Scotch"
-.SH NAME
-scotch_esmumps \- scotch command
-.SH SYNOPSIS
-.B scotch_esmumps
-.br
-.SH DESCRIPTION
-This manual page documents briefly the
-.BR scotch_esmumps
-command.
-
-You can find information in the scotch manual and on the scotch web
-page http://www.labri.fr/perso/pelegrin/scotch/ and project page
-http://gforge.inria.fr/projects/scotch/.
-
-.SH AUTHOR
-The Debian Scientific Computing Team
diff --git a/debian/amk_ccc.1 b/debian/amk_ccc.1
deleted file mode 100644
index 8cd6eab..0000000
--- a/debian/amk_ccc.1
+++ /dev/null
@@ -1,18 +0,0 @@
-.\" -*- nroff -*-
-.TH ptscotch_esmumps 1 "April 2009" "Scotch"
-.SH NAME
-ptscotch_esmumps \- scotch command
-.SH SYNOPSIS
-.B ptscotch_esmumps
-.br
-.SH DESCRIPTION
-This manual page documents briefly the
-.BR ptscotch_esmumps
-command.
-
-You can find information in the scotch manual and on the scotch web
-page http://www.labri.fr/perso/pelegrin/scotch/ and project page
-http://gforge.inria.fr/projects/scotch/.
-
-.SH AUTHOR
-The Debian Scientific Computing Team
diff --git a/debian/changelog b/debian/changelog
index a6f01e2..1ceb3f2 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -5,6 +5,9 @@ scotch (6.0.4.dfsg1-8) UNRELEASED; urgency=medium
(may segfault on INTSIZE64, but the default INT is still useful)
* Skip tests altogether on hurd, m68k (their timeout and qemu test
failures can't simply be ignored).
+ * Create a fill-in man page scotch_binaries.1 to cover sundry
+ binaries scotch_esmumps, scotch_gbase, acpl, amk_grf, mcv for which
+ a man page is not available. Closes: #883824.
-- Drew Parsons <dparsons at debian.org> Mon, 27 Nov 2017 22:48:30 +0800
diff --git a/debian/dgscat.1 b/debian/dgscat.1
deleted file mode 100644
index 8ed1d9e..0000000
--- a/debian/dgscat.1
+++ /dev/null
@@ -1,136 +0,0 @@
-." Text automatically generated by txt2man
-.TH dgscat 1 "August 03, 2010" "" "PT-Scotch user's manual"
-.SH NAME
-\fBdggath, dgscat, gscat \fP- convert distributed source graphs to or from centralized ones
-\fB
-.SH SYNOPSIS
-.nf
-.fam C
-\fBdggath\fP [\fIoptions\fP] [\fIigfile\fP] [\fIogfile\fP]
-.PP
-\fBdgscat\fP [\fIoptions\fP] [\fIigfile\fP] [\fIogfile\fP]
-.PP
-\fBgscat\fP [\fIoptions\fP] [\fIigfile\fP] [\fIogfile\fP]
-.fam T
-.fi
-.SH DESCRIPTION
-The \fBdggath\fP program gathers distributed graphs into centralized
-graphs. It reads a set of files \fIigfile\fP representing fragments of a
-distributed source graph, and writes them back on the form of a
-single centralized source graph \fIogfile\fP.
-.PP
-The \fBdgscat\fP program scatters centralized source graphs into
-distributed graphs. It reads a centralized source graph \fIigfile\fP and
-writes it back on the form of a set of files \fIogfile\fP representing
-fragments of the corresponding distributed source graph.
-.PP
-The \fBgscat\fP program does exactly the same as \fBdgscat\fP, but does not
-require to be run in a parallel environment. Since \fBgscat\fP processes
-the input centralized graph file as a text stream, it does not need
-to load the full graph in memory before building the distributed
-graph fragment files. It is therefore much less resource consuming,
-but does not allow for the checking of graph consistency, as it has
-no global vision of the graph structure.
-.PP
-When file names are not specified, data is read from standard input
-and written to standard output. Standard streams can also be
-explicitly represented by a dash '-'.
-.PP
-When the proper libraries have been included at compile time, \fBdggath\fP
-and \fBdgscat\fP can directly handle compressed graphs, both as input and
-output. A stream is treated as compressed whenever its name is
-postfixed with a compressed file extension, such as
-in 'brol.grf.bz2' or '-.gz'. The compression formats which can be
-supported are the bzip2 format ('.bz2'), the gzip format ('.gz'),
-and the lzma format ('.lzma', on input only).
-.PP
-\fBdggath\fP and \fBdgscat\fP base on implementations of the MPI interface to
-spread work across the processing elements. It is therefore not
-likely to be run directly, but instead through some launcher command
-such as \fBmpirun\fP.
-.SH DISTRIBUTED FILE NAMES
-In order to tell whether programs should read from, or write to, a
-single file located on only one processor, or to multiple instances
-of the same file on all of the processors, or else to distinct files
-on each of the processors, a special grammar has been designed,
-which is based on the '%' escape character. Four such escape
-sequences are defined, which are interpreted independently on every
-processor, prior to file opening. By default, when a filename is
-provided, it is assumed that the file is to be opened on only one of
-the processors, called the root processor, which is usually process
-0 of the communicator within which the program is run. The index
-of the root processor can be changed by means of the \fB-r\fP
-option. Using any of the first three escape sequences below will
-instruct programs to open in parallel a file of name equal to the
-interpreted filename, on every processor on which they are run.
-.TP
-.B
-%p
-Replaced by the number of processes in the global communicator in
-which the program is run. Leads to parallel opening.
-.TP
-.B
-%r
-Replaced on each process running the program by the rank of this
-process in the global communicator. Leads to parallel opening.
-.TP
-.B
-%-
-Discarded, but leads to parallel opening. This sequence is mainly
-used to instruct programs to open on every processor a file of
-identical name. The opened files can be, according whether the
-given path leads to a shared directory or to directories that
-are local to each processor, either to the opening of multiple
-instances of the same file, or to the opening of distinct files
-which may each have a different content, respectively (but in
-this latter case it is much recommended to identify files by
-means of the '%r' sequence).
-.TP
-.B
-%%
-Replaced by a single '%' character. File names using this escape
-sequence are not considered for parallel opening, unless one or
-several of the three other escape sequences are also present.
-.RE
-.PP
-For instance, filename 'brol' will lead to the opening of file 'brol'
-on the root processor only, filename '%\fB-brol\fP' (or even 'br%\fB-ol\fP') will
-lead to the parallel opening of files called 'brol' on every
-processor, and filename 'brol%p-%r' will lead to the opening of
-files 'brol2-0' and 'brol2-1', respectively, on each of the two processors
-on which the program were to run.
-.SH OPTIONS
-.TP
-.B
-\fB-c\fP
-For \fBdggath\fP and \fBdgscat\fP only. Check the consistency of the
-input source graph after loading it into memory.
-.TP
-.B
-\fB-h\fP
-Display some help.
-.TP
-.B
-\fB-r\fP\fIpnum\fP
-Set root process for centralized files (default is 0).
-.TP
-.B
-\fB-V\fP
-Display program version and copyright.
-.SH EXAMPLE
-Run \fBdgscat\fP on 5 processing elements to scatter centralized graph
-file brol.grf into 5 gzipped file fragments brol5-0.dgr.gz to
-brol5-4.dgr.gz.
-.PP
-.nf
-.fam C
- $ mpirun -np 5 dgscat brol.grf brol%p-%r.dgr.gz
-
-.fam T
-.fi
-.SH SEE ALSO
-\fBdgmap\fP(1), \fBdgord\fP(1), \fBdgtst\fP(1), \fBgmk_hy\fP(1).
-.PP
-PT-Scotch user's manual.
-.SH AUTHOR
-Francois Pellegrini <francois.pellegrini at labri.fr>
diff --git a/debian/genmanpage.sh b/debian/genmanpage.sh
deleted file mode 100644
index 9ac6455..0000000
--- a/debian/genmanpage.sh
+++ /dev/null
@@ -1,29 +0,0 @@
-#! /usr/bin/sh
-#set -x
-#for name in scotch_acpl scotch_amk_ccc scotch_amk_fft2 scotch_amk_grf scotch_amk_hy scotch_amk_m2 scotch_amk_p2 scotch_atst scotch_gbase scotch_gcv scotch_gmap scotch_gmk_hy scotch_gmk_m2 scotch_gmk_m3 scotch_gmk_msh scotch_gmk_ub2 scotch_gmtst scotch_gord scotch_gotst scotch_gout scotch_gtst scotch_mcv scotch_mmk_m2 scotch_mmk_m3 scotch_mord scotch_mtst scotch_esmumps; do
-for name in scotch_esmumps ptscotch_esmumps; do
-
-manname=`echo -n ${name}.1`
-cat > $manname <<EOF
-.\" -*- nroff -*-
-.TH $name 1 "April 2009" "Scotch"
-.SH NAME
-$name \- scotch command
-.SH SYNOPSIS
-.B $name
-.br
-.SH DESCRIPTION
-This manual page documents briefly the
-.BR $name
-command.
-
-You can find information in the scotch manual and on the scotch web
-page http://www.labri.fr/perso/pelegrin/scotch/ and project page
-http://gforge.inria.fr/projects/scotch/.
-
-.SH AUTHOR
-The Debian Scientific Computing Team
-EOF
-echo debian/$manname /usr/share/man/man1
-done
-
diff --git a/debian/gout.1 b/debian/gout.1
deleted file mode 100644
index ff37507..0000000
--- a/debian/gout.1
+++ /dev/null
@@ -1,267 +0,0 @@
-." Text automatically generated by txt2man
-.TH gout 1 "August 03, 2010" "" "Scotch user's manual"
-.SH NAME
-\fBgout \fP- output graphics from matrices and graphs
-\fB
-.SH SYNOPSIS
-.nf
-.fam C
-\fBgout\fP [\fIoptions\fP] [\fIgfile\fP] [\fIxfile\fP] [\fImfile\fP] [\fIvfile\fP]
-.fam T
-.fi
-.SH DESCRIPTION
-The \fBgout\fP program creates graphics files of various types,
-representing the Scotch graph and mapping data which is passed to it.
-.PP
-Source graph file \fIgfile\fP can only be a centralized graph file. File
-\fIxfile\fP stores its associated geometry, whenever necessary. File
-\fImfile\fP represents label information attached to each of the graph
-vertices, for instance the index of the part to which each vertex
-belongs in the case of a mapping file. File \fIvfile\fP is the output
-graphics file, the type of which may differ according to the input
-parameters. When file names are not specified, data is read from
-standard input and written to standard output. Standard streams can
-also be explicitly represented by a dash '-'.
-.PP
-When the proper libraries have been included at compile time, gtst
-can directly handle compressed graphs, both as input and output. A
-stream is treated as compressed whenever its name is postfixed with
-a compressed file extension, such as in 'brol.grf.bz2' or '-.gz'. The
-compression formats which can be supported are the bzip2 format
-('.bz2'), the gzip format ('.gz'), and the lzma format ('.lzma', on
-input only).
-.SH OPTIONS
-.TP
-.B
-\fB-h\fP
-Display some help.
-.TP
-.B
-\fB-g\fP\fIgeop\fP
-Geometry parameters, which can be an arbitrary
-combination of any of the following code letters:
-.RS
-.TP
-.B
-n
-Do not read geometry data, when it is not
-available or not required, such as when using
-the \fB-om\fP option.
-.TP
-.B
-p
-Permute Y and Z geometry dimensions.
-.TP
-.B
-r
-Rotate geometry by 90 degrees in the (X,Y) plane.
-.RE
-.TP
-.B
-\fB-h\fP
-Display some help.
-.TP
-.B
-\fB-mn\fP
-Do not read mapping data, when it is not available or
-not required.
-.TP
-.B
-\fB-o\fP\fIoutp\fP
-Select the output file type and allows to provide
-additional parameters between braces and separated
-by commas:
-.RS
-.TP
-.B
-i
-OpenInventor 3D mesh file, to be viewed by means of
-programs such as \fBivview\fP. Additional parameters for
-this output file type are:
-.RS
-.TP
-.B
-c
-Color output.
-.TP
-.B
-g
-Gray level output.
-.TP
-.B
-r
-Remove cut edges.
-.TP
-.B
-v
-View cut edges.
-.RE
-.TP
-.B
-m
-PostScript matrix pattern file. Additional parameters
-for this output file type are:
-.RS
-.TP
-.B
-e
-EPSF-type output.
-.TP
-.B
-f
-Full-page output.
-.RE
-.TP
-.B
-p
-PostScript 2D mesh file. This output module was
-intended for 2D meshes; as a fallback, the Z
-coordinate is projected according to isometric
-perspective rules, but drawings of full 3D objects
-are most likely to be unreadable. Additional parameters
-for this output file type are:
-.RS
-.TP
-.B
-c
-Color output.
-.TP
-.B
-g
-Gray level output.
-.TP
-.B
-e
-EPSF-type output.
-.TP
-.B
-f
-Full-page output.
-.TP
-.B
-s
-Short clipping (disks excluded).
-.TP
-.B
-l
-Large clipping (disks included).
-.TP
-.B
-a
-Avoid displaying disks.
-.TP
-.B
-d
-Display disks.
-.TP
-.B
-r
-Remove cut edges.
-.TP
-.B
-v
-View cut edges.
-.TP
-.B
-X=\fIrat\fP
-Maximum x clipping ratio (in [0.0;1.0]).
-.TP
-.B
-x=\fIrat\fP
-Minimum x clipping ratio.
-.TP
-.B
-Y=\fIrat\fP
-Maximum y clipping ratio.
-.TP
-.B
-y=\fIrat\fP
-Minimum y clipping ratio.
-.RE
-.TP
-.B
-t
-Tulip 3D mesh file. Additional parameters
-for this output file type are:
-.RS
-.TP
-.B
-b
-Black and white output.
-.TP
-.B
-c
-Color output.
-.TP
-.B
-a
-Avoid displaying disks.
-.TP
-.B
-d
-Display disks.
-.TP
-.B
-r
-Remove cut edges.
-.TP
-.B
-v
-View cut edges.
-.RE
-.RE
-.TP
-.B
-\fB-V\fP
-Display program version and copyright.
-.SH EXAMPLES
-Build an OpenInventor file of the mapping of graph brol.grf
-contained in file brol.map. Vertices with no mapping information
-attached to them will be rendered in white, while distinct colors
-will be used to represent the different parts. Cut edges will be
-removed:
-.PP
-.nf
-.fam C
- $ gout '-oi{r}' brol.grf brol.xyz brol.map brol.iv
- $ ivview brol.iv
-
-.fam T
-.fi
-Build an OpenInventor file of graph brol.grf without any vertex
-information associated to it. Mapping data are not required and
-will not be read, but a file name has to be provided, hence the '-':
-.PP
-.nf
-.fam C
- $ gout -oi -mn brol.grf brol.xyz - brol.iv
-
-.fam T
-.fi
-Output the pattern of matrix brol.grf on the form of a PostScript
-flat drawing. Geometry and mapping data are not required and will
-not be read, but file names have to be provided, hence the
-two '-'s:
-.PP
-.nf
-.fam C
- $ gout -om -gn -mn brol.grf - - brol.ps
-
-.fam T
-.fi
-Output a PostScript 2D drawing of a rectangular portion graph
-brol.grf, with disks representing mapping data:
-.PP
-.nf
-.fam C
- $ gout '-op{c,e,d,x=0.3,X=0.6,y=0.2,Y=0.5}' brol.grf brol.xyz brol.map brol.ps
-
-
-.fam T
-.fi
-.SH SEE ALSO
-\fBgmap\fP(1), \fBgout\fP(1), \fBgtst\fP(1).
-.PP
-Scotch user's manual.
-.SH AUTHOR
-Francois Pellegrini <francois.pellegrini at labri.fr>
diff --git a/debian/rules b/debian/rules
index ad95379..8602dd0 100755
--- a/debian/rules
+++ b/debian/rules
@@ -140,11 +140,6 @@ install: build
(cd long/bin && mv $$file $$file-long); \
done
-# Fix lintian macro `brol2-0'' not defined
- cp -f debian/dgscat.1 int/share/man/man1
-# Fix lintian macro `-':' not defined
- cp -f debian/gout.1 int/share/man/man1
- cp -f debian/acpl.1 int/share/man/man1
# Fix lintian warnings for undefined macro in man pages
perl -pi -e 's|\.\"|\.\\\"|' int/share/man/man1/*.1
## mv int/share/man/man1/gbase.1 int/share/man/man1/scotch_gbase.1
@@ -152,13 +147,15 @@ install: build
mv int/share/man/man1/gmap.1 int/share/man/man1/scotch_gmap.1
mv int/share/man/man1/gpart.1 int/share/man/man1/scotch_gpart.1
# Fix lintian missing man pages
- cp debian/scotch_esmumps.1 int/share/man/man1
- cp debian/ptscotch_esmumps.1 int/share/man/man1
+ cp debian/scotch_binaries.1 int/share/man/man1
+ cp debian/ptscotch_esmumps.1 int/share/man/man1
# Fix lintian warnings
- for file in $(shell ls int/bin); do \
+ for file in $(shell ls int/bin) scotch_binaries; do \
(cd int/share/man/man1 && gzip -9n $$file.1); \
done
-
+ for file in scotch_esmumps scotch_gbase acpl amk_grf mcv; do \
+ (cd int/share/man/man1 && ln -sf scotch_binaries.1.gz $$file.1.gz); \
+ done
for file in $(shell ls int/bin); do \
(cd int/share/man/man1 && ln -sf $$file.1.gz $$file-int32.1.gz); \
(cd int/share/man/man1 && ln -sf $$file.1.gz $$file-int64.1.gz); \
diff --git a/debian/scotch.install b/debian/scotch.install
index cbc5885..4bf9419 100644
--- a/debian/scotch.install
+++ b/debian/scotch.install
@@ -148,3 +148,4 @@ int/share/man/man1/mmk_m3*.1.gz /usr/share/man/man1
int/share/man/man1/mord*.1.gz /usr/share/man/man1
int/share/man/man1/mtst*.1.gz /usr/share/man/man1
int/share/man/man1/scotch_esmumps*.1.gz /usr/share/man/man1
+int/share/man/man1/scotch_binaries*.1.gz /usr/share/man/man1
diff --git a/debian/scotch_binaries.1 b/debian/scotch_binaries.1
new file mode 100644
index 0000000..fb3e861
--- /dev/null
+++ b/debian/scotch_binaries.1
@@ -0,0 +1,29 @@
+." Text adapted from amk_ccc.1 and scotch_esmumps.1
+.TH scotch_binaries 1 "December, 2017" "" "Sundry Scotch Binaries"
+.SH NAME
+\fBscotch_esmumps, scotch_gbase, acpl, amk_grf, mcv \fP- sundry Scotch binary commands
+\fB
+.SH SYNOPSIS
+.nf
+.fam C
+\fBscotch_esmumps\fP
+.PP
+\fBscotch_gbase\fP
+.PP
+\fBacpl\fP
+.PP
+\fBamk_grf\fP
+.PP
+\fBmcv\fP
+.PP
+.fam T
+.fi
+.SH DESCRIPTION
+This manual page briefly documents scotch binary programs which
+do not have their own manual page.
+.PP
+You can find information in the scotch manual and on the scotch web
+page http://www.labri.fr/perso/pelegrin/scotch/ and project page
+http://gforge.inria.fr/projects/scotch/.
+.SH AUTHOR
+The Debian Scientific Computing Team
\ No newline at end of file
diff --git a/debian/scotch_esmumps.1 b/debian/scotch_esmumps.1
deleted file mode 100644
index d4fbd8a..0000000
--- a/debian/scotch_esmumps.1
+++ /dev/null
@@ -1,18 +0,0 @@
-.\" -*- nroff -*-
-.TH scotch_esmumps 1 "April 2009" "Scotch"
-.SH NAME
-scotch_esmumps \- scotch command
-.SH SYNOPSIS
-.B scotch_esmumps
-.br
-.SH DESCRIPTION
-This manual page documents briefly the
-.BR scotch_esmumps
-command.
-
-You can find information in the scotch manual and on the scotch web
-page http://www.labri.fr/perso/pelegrin/scotch/ and project page
-http://gforge.inria.fr/projects/scotch/.
-
-.SH AUTHOR
-The Debian Scientific Computing Team
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/scotch.git
More information about the debian-science-commits
mailing list