GVMAP.SH(1)

πŸ“¦
version 16.1.0 Β· 2 versions
, in alpine 3.22, alpine 3.23, alpine 3.24, arch rolling, fedora 43, fedora 44, nixos 26.05, nixpkgs unstable, opensuse-leap 16.0, ubuntu resolute, ubuntu stonking

πŸ’– GVMAP.SH(1) πŸ’–

okay bestie, welcome to the General Commands Manual for gvmap.sh, no cap 🫢


✨ NAME ✨

gvmap.sh β€” the whole pipeline for running gvmap, like a little relay race but for graphs πŸƒβ™€οΈπŸ’¨


🌸 SYNOPSIS 🌸

gvmap.sh [-vV?] [ options ] [ -o outfile ] [ files ]

πŸ¦‹ DESCRIPTION πŸ¦‹

so here's the tea β˜• β€” gvmap.sh takes a graph in DOT format as input, does a layout, runs the output through gvmap, and then renders the output. Three steps, one script, main character energy πŸ‘‘

and lowkey? at some point, it is hoped to integrate all of these tasks into gvmap. so like, this script is doing a lot of emotional labor rn but one day it'll all be one program. we love a future plan πŸ’…


πŸ’… OPTIONS πŸ’…

these are the options that are supported, periodt:

  • -a k β€” the integer k says how many artificial points get added along the bounding box of the labels (on average). why tho? to avoid a country boundary cutting straight through the boundary box of the labels, which would be tragic πŸ™ˆ computing time is proportional to k, so for large graphs, bestie, use a small value of k. and if k = -1, a suitable value of k is automatically selected based on the graph size. by default k = -1.
  • -K layout β€” picks which program should be used for the initial layout. by default, sfdp is run. also by default, the layout is passed the flag -Goverlap=prism. you can override that using a -g flag ✨
  • -T format β€” sets the final output format. works exactly the same way as the -T flag for any Graphviz layout program. classic.
  • -N attr=val β€” sets a default node attribute during the rendering phase. same energy as the -N flag for any Graphviz layout program.
  • -G attr=val β€” sets a graph attribute during the rendering phase. same energy as the -G flag for any Graphviz layout program.
  • -E attr=val β€” sets a default edge attribute during the rendering phase. same energy as the -E flag for any Graphviz layout program.
  • -n attr=val β€” sets a default node attribute during the layout phase. same energy as the -N flag for any Graphviz layout program.
  • -g attr=val β€” sets a graph attribute during the layout phase. same energy as the -G flag for any Graphviz layout program.
  • -e attr=val β€” sets a default edge attribute during the layout phase. same energy as the -E flag for any Graphviz layout program.
  • -A flag β€” passes a flag through to gvmap. for example, gvmap.sh -Ae -As3 causes gvmap -e -s3 to be run. slay πŸŽ€
  • -v β€” set verbose mode. she's chatty now πŸ’¬
  • -V β€” print version information and exit. bye πŸ‘‹
  • -? β€” print usage information and exit. also bye πŸ‘‹

🌈 EXAMPLES 🌈

this invocation creates a map with edges in semi-transparent light gray and nodes laid out using sfdp:

gvmap.sh -Ae -Ecolor=#55555522 -Tpng foo.gv > foo.png

and fr fr, it is equivalent to running this whole pipeline:

sfdp -Goverlap=prism foo.gv | gvmap -e | neato -n2 -Ecolor=#55555522 -Tpng > foo.png

like, same thing, just spelled out the long way 🧚


πŸ‘‘ AUTHOR πŸ‘‘

Emden R. Gansner <erg@research.att.com>


πŸ“ SEE ALSO πŸ“

gvmap(1), sfdp(1), neato(1), gvpr(1)

E. R. Gansner, Y. Hu, S. G. Kobourov, "GMap: Visualizing graphs and clusters as maps," Proc. Pacific Vis. 2010, pp. 201‐208.


and that's the whole manual bestie, mwah πŸ’– this was the gvmap.sh page, dated 31 March 2011 β€” go forth and make maps, you absolute icon 🫢✨

πŸ“¦ where this page comes from