BOTCH-GRAPH-NEIGHBORHOOD(1)

📦
version 0.24 · 6 versions
, in debian bookworm, ubuntu noble

💖 BOTCH-GRAPH-NEIGHBORHOOD 💖

okay bestie, welcome to botch-graph-neighborhood — she's a lil tool from the botch suite and she does exactly one job: extract the neighborhood around a vertex 🫶. Like, you point at a vertex, you say "gimme everyone around them," and she delivers. iconic behavior honestly.

✨ SYNOPSIS ✨

botch-graph-neighborhood [options] --center CENTER [--center CENTER ...]
[ingraph] [outgraph]

🌸 DESCRIPTION 🌸

So the whole vibe is: you've got a graph in GraphML or dot format, and you wanna pull out the neighborhood around a center vertex. That's it. That's the whole assignment. 💅

The --center option is mandatory — like, you literally cannot skip it, bestie — and you can specify it more than once. Multiple times. As many as your heart desires.

Now, the positional arguments. There's [ingraph] and [outgraph], and both are optional:

  • If you skip one (or both!) of them, then she reads GraphML or dot from standard input and/or writes GraphML or dot to standard output, respectively. 🌈
  • If you pass a '-' as either argument, that explicitly says "read the input from standard input" and "write the output to standard output," respectively. So - = stdin/stdout, spelled out on purpose. 💫

The input graph type? She figures it out automatically, no cap. And if the output graph is given as a filename, then the output type is determined by the extension:

  • filename ends with .xml → output is GraphML 🎀
  • filename ends with .dot → output is dot 🦋

But if the output goes to standard output, then it comes out in the same format as the input graph. periodt.

💅 OPTIONS 💅

  • -h, --help — Display help. (your emotional support flag 🥺)
  • --depth=DEPTH — range of neighborhood to extract (Default: 1)
  • --center=CENTER — This one picks the center vertex of which the neighborhood is computed. The CENTER argument is a key/value pair (separated by a colon) of a graph attribute and its desired value. If more than one vertex matches the given key/value pair, then the smallest (by node comparison) is chosen.

The special key "__ID__" allows one to select the unique vertex identifier. 🆔

This option can be specified more than once. The final set of vertices is chosen such that all vertices match all key/value pairs. Multiple --center options thus form a logical conjunction (they are AND-ed together).

  • -v, --verbose — Be verbose. (she'll tell you what she's doing, she's a talker 💬)

💀 BUGS 💀

See <http://bugs.debian.org/botch>.

(yeah, she said what she said. go file it bestie 🐛)

👀 SEE ALSO 👀

Debian doc-base Manual /usr/share/doc/botch/wiki/Home.html

👑 AUTHOR 👑

This man page was written by Johannes Schauer. Botch is written by Johannes Schauer and Pietro Abate. (shoutout to the devs, fr fr 🫶)

Copyright 2012-2014 Johannes Schauer, Pietro Abate

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. A special linking exception to the GNU Lesser General Public License applies to this library, see the COPYING file for more information.

🎀 and that's the whole page bestie, no notes 🎀

signing off from the group chat — this was perl v5.36.0, dated 2023-02-17. mwah 💋✨

📦 where this page comes from