Debian Codegraph @

doc/man/botch-extract-scc.pod

raw
1 =head1 NAME
2
3 botch-extract-scc - extract all strongly connected components
4
5 =head1 SYNOPSIS
6
7 =over
8
9 =item B<botch-extract-scc> [options] I<graph.xml> [I<prefix>]
10
11 =back
12
13 =head1 DESCRIPTION
14
15 Extract strongly connected components (SCC) from an input graph in GraphML or
16 dot format.
17
18 The strongly connected components are stored as one file each in either the
19 current directory or the directory given by the B<--outdir> option.
20
21 The file names that were generated for them are printed on standard output.
22
23 By default that filename is of the format PREFIX_VERTEX_SIZE.EXT where PREFIX
24 can be set on the command line, while VERTEX defaults to the vertex ID chosen
25 by network, SIZE is the size of the SCC and EXT is xml by default but can be
26 set using the B<--extension> option. This is to reduce the possibility that two
27 output graph files happen to have the same name. You can make them more unique
28 by using the B<--outfnamevert> and B<--outfnameattr> options which refine the
29 string that will be printed for VERTEX.
30
31 =head1 OPTIONS
32
33 =over 4
34
35 =item B<-h, --help>
36
37 Show help.
38
39 =item B<--outdir=>I<DIR>
40
41 output directory. Default is current directory
42
43 =item B<--outfnamevert=>I<VERT>
44
45 This option picks the set of vertices from which the smallest one (by string
46 comparison of the attribute determined by the B<--outfnameattr> option) will be
47 chosen to be stored in place of VERTEX in the output file name. The VERT
48 argument is a key/value pair (separated by a colon) of a graph attribute and
49 its value. By default (without this option), all vertices of the graph are
50 considered.
51
52 The special key C<__ID__> allows one to select the unique vertex identifier.
53
54 This option can be specified more than once. The final set of vertices is
55 chosen such that all vertices match all key/value pairs. Multiple
56 B<--outfnamevert> options thus form a logical conjunction (they are AND-ed
57 together).
58
59 =item B<--outfnameattr=>I<attribute>
60
61 This option picks the vertex attribute that is to be printed in VERTEX in the
62 output file name.
63
64 =item B<--extension=>I<EXT>
65
66 Output files have extension I<EXT>. Default is xml. This option also governs
67 the output format. The xml extension saves in GraphML format while the dot
68 extension saves in the dot format.
69
70 =item B<-v, --verbose>
71
72 Be verbose.
73
74 =back
75
76 =head1 EXAMPLE
77
78 Extract the strongly connected components of a buildgraph and store them in the
79 directory "out", prefixing each filename with "cyclic" and let the VERTEX value
80 be the cudfname field of source packages only.
81
82 botch-extract-scc --verbose --outdir=out --outfnameattr=cudfname --outfnamevert type:src buildgraph.xml cyclic
83
84 =head1 BUGS
85
86 See L<http://bugs.debian.org/botch>.
87
88 =head1 SEE ALSO
89
90 Debian doc-base Manual F</usr/share/doc/botch/wiki/Home.html>
91
92 =head1 AUTHOR
93
94 This man page was written by Johannes Schauer. Botch is written by Johannes
95 Schauer and Pietro Abate.
96
97 =head1 COPYRIGHT
98
99 Copyright 2012-2014 Johannes Schauer, Pietro Abate
100
101 This program is free software: you can redistribute it and/or modify it under
102 the terms of the GNU Lesser General Public License as published by the Free
103 Software Foundation, either version 3 of the License, or (at your option) any
104 later version. A special linking exception to the GNU Lesser General Public
105 License applies to this library, see the COPYING file for more information.
106