Debian Codegraph @

doc/man/botch-graph-descendants.pod

raw
1 =head1 NAME
2
3 botch-graph-descendants - find all descendants of a vertex in a graph in GraphML or dot format
4
5 =head1 SYNOPSIS
6
7 =over
8
9 =item B<botch-graph-descendants> [options] --source I<SOURCE> [--source I<SOURCE> ...] [I<ingraph>] [I<outgraph>]
10
11 =back
12
13 =head1 DESCRIPTION
14
15 Extract the subgraph of all descendants of a specific node in the input graph.
16
17 The B<--source> option is mandatory and can be specified more than once.
18
19 If either (or both) of the positional arguments is/are omitted, then read
20 GraphML or dot from standard input and/or write GraphML or dot to standard
21 output, respectively. Passing a '-' as either argument, explicitly specifies
22 to read the input from standard input and write the output to standard output,
23 respectively.
24
25 The input graph type will be determined automatically. If the output graph is
26 given as a filename, then the output type will be GraphML if the filename ends
27 with .xml and dot if the filename ends with .dot. If the output is done on
28 standard output then it will happen in the same format as the input graph.
29
30 =head1 OPTIONS
31
32 =over 4
33
34 =item B<-h, --help>
35
36 Display help.
37
38 =item B<--source=>I<SOURCE>
39
40 This option picks the source vertex of which the descendants are computed. The
41 SOURCE argument is a key/value pair (separated by a colon) of a graph attribute
42 and its desired value. If more than one vertex matches the given key/value
43 pair, then the smallest (by node comparison) is chosen.
44
45 The special key C<__ID__> allows one to select the unique vertex identifier.
46
47 This option can be specified more than once. The final set of vertices is
48 chosen such that all vertices match all key/value pairs. Multiple B<--source>
49 options thus form a logical conjunction (they are AND-ed together).
50
51 =item B<-v, --verbose>
52
53 Be verbose.
54
55 =back
56
57 =head1 EXAMPLE
58
59 Extract the subgraph of all descendants of a binary packages vertex with name
60 "build-essential" and version "11.7".
61
62 botch-graph-descendants --source name:build-essential --source version:11.7 --source type:bin < in.xml > out.xml
63
64 or giving input and output as positional arguments:
65
66 botch-graph-descendants --source name:build-essential --source version:11.7 --source type:bin in.xml out.xml
67
68 =head1 BUGS
69
70 See L<http://bugs.debian.org/botch>.
71
72 =head1 SEE ALSO
73
74 Debian doc-base Manual F</usr/share/doc/botch/wiki/Home.html>
75
76 =head1 AUTHOR
77
78 This man page was written by Johannes Schauer. Botch is written by Johannes
79 Schauer and Pietro Abate.
80
81 =head1 COPYRIGHT
82
83 Copyright 2012-2014 Johannes Schauer, Pietro Abate
84
85 This program is free software: you can redistribute it and/or modify it under
86 the terms of the GNU Lesser General Public License as published by the Free
87 Software Foundation, either version 3 of the License, or (at your option) any
88 later version. A special linking exception to the GNU Lesser General Public
89 License applies to this library, see the COPYING file for more information.
90