Debian Codegraph @

doc/man/botch-graph-shortest-path.pod

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