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