~ubuntu-branches/ubuntu/trusty/scotch/trusty-proposed

« back to all changes in this revision

Viewing changes to debian/ptscotch_dgtst.1

  • Committer: Bazaar Package Importer
  • Author(s): "Adam C. Powell, IV", Christophe Trophime, Adam C. Powell, IV
  • Date: 2010-12-29 13:07:19 UTC
  • mfrom: (1.1.6 upstream)
  • Revision ID: james.westby@ubuntu.com-20101229130719-jwalolw5d6av6wqx
Tags: 5.1.11.dfsg-1
[Christophe Trophime]
* New upstream release
* Forward-ported patches to version 5.1.10b.
* Install scotch headers properly.
* Fix chrpath commands in debian/rules.
* Fix (pt)scotch library install paths.
* Fix lintian errors and warnings.

[Adam C. Powell, IV]
* Forward-ported patches to version 5.1.11.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.\" Text automatically generated by txt2man
2
 
.TH ptscotch_dgtst 1 "June 05, 2008" "" "PT-Scotch user's manual"
3
 
.SH NAME
4
 
\fBptscotch_dgtst \fP- test the consistency of Scotch source graphs in parallel
5
 
\fB
6
 
.SH SYNOPSIS
7
 
.nf
8
 
.fam C
9
 
\fBptscotch_dgtst\fP [\fIoptions\fP] [\fIgfile\fP] [\fIlfile\fP]
10
 
.fam T
11
 
.fi
12
 
.SH DESCRIPTION
13
 
The \fBptscotch_dgtst\fP program checks, in a parallel way, the consistency of a
14
 
source graph, and outputs some statistics regarding edge weights,
15
 
vertex weights, and vertex degrees in case of success.
16
 
.PP
17
 
It produces the very same results as the \fBgtst\fP(1) program of the
18
 
Scotch sequential distribution, but unlike this latter it can handle
19
 
distributed graphs.
20
 
.PP
21
 
Source graph file \fIgfile\fP is either a centralized graph file, or a set
22
 
of files representing fragments of a distributed graph. The
23
 
resulting statistics are stored in file \fIlfile\fP. When file names are
24
 
not specified, data is read from standard input and written to
25
 
standard output. Standard streams can also be explicitly
26
 
represented by a dash '-'.
27
 
.PP
28
 
When the proper libraries have been included at compile time, \fBptscotch_dgtst\fP
29
 
can directly handle compressed graphs, both as input and output. A
30
 
stream is treated as compressed whenever its name is postfixed with
31
 
a compressed file extension, such as in 'brol.grf.bz2' or '-.gz'. The
32
 
compression formats which can be supported are the bzip2 format
33
 
('.bz2'), the gzip format ('.gz'), and the lzma format ('.lzma', on
34
 
input only).
35
 
.PP
36
 
\fBptscotch_dgtst\fP bases on implementations of the MPI interface to spread work
37
 
across the processing elements. It is therefore not likely to be run
38
 
directly, but instead through some launcher command such as \fBmpirun\fP.
39
 
.SH OPTIONS
40
 
.TP
41
 
.B
42
 
\fB-h\fP
43
 
Display some help.
44
 
.TP
45
 
.B
46
 
\fB-r\fP\fIpnum\fP
47
 
Set root process for centralized files (default is 0).
48
 
.TP
49
 
.B
50
 
\fB-V\fP
51
 
Display program version and copyright.
52
 
.SH EXAMPLE
53
 
Run \fBptscotch_dgtst\fP on 5 processing elements to test the consistency of graph brol.grf
54
 
.PP
55
 
.nf
56
 
.fam C
57
 
      $ mpirun -np 5 ptscotch_dgtst brol.grf
58
 
 
59
 
.fam T
60
 
.fi
61
 
Run dgord on 5 processing elements to test the consistency of a
62
 
distributed graph stored on graph fragment files brol5-0.grf to
63
 
brol5-4.grf, and save the resulting ordering to file brol.ord (see
64
 
\fBdgscat\fP(1) for an explanation of the '%p' and '%r' sequences in names
65
 
of distributed graph fragments).
66
 
.PP
67
 
.nf
68
 
.fam C
69
 
      $ mpirun -np 5 ptscotch_dgtst brol%p-%r.grf brol.ord
70
 
 
71
 
.fam T
72
 
.fi
73
 
.SH SEE ALSO
74
 
\fBptscotch_dgscat\fP(1), \fBptscotch_gtst\fP(1), \fBptscotch_dgord\fP(1).
75
 
.PP
76
 
PT-Scotch user's manual.
77
 
.SH AUTHOR
78
 
Francois Pellegrini <francois.pellegrini@labri.fr>