Let's document: graphviz

[calpa]

Graphviz is open source graph visualization software.

Graph visualization is a way of representing structural information as diagrams of abstract graphs and networks.

A complete list of binaries in the graphviz package:

• acyclic acyclic, bcomps, ccomps, edgepaint, gvcolor, gvpack, mingle, nop, sccmap, unflatten: add page #6401
• bcomps acyclic, bcomps, ccomps, edgepaint, gvcolor, gvpack, mingle, nop, sccmap, unflatten: add page #6401
• ccomps acyclic, bcomps, ccomps, edgepaint, gvcolor, gvpack, mingle, nop, sccmap, unflatten: add page #6401
• circo circo, fdp, neato, osage, patchwork, sfdp, twopi: add page #6284
• cluster cluster, diffimg, dijkstra, dotty, gvedit, gvgen, gvmap: add page #18502
• diffimg cluster, diffimg, dijkstra, dotty, gvedit, gvgen, gvmap: add page #18502
• dijkstra cluster, diffimg, dijkstra, dotty, gvedit, gvgen, gvmap: add page #18502
• dot → dot: add page #1578
• dot2gxl
• dot_builtins
• dotty cluster, diffimg, dijkstra, dotty, gvedit, gvgen, gvmap: add page #18502
• edgepaint acyclic, bcomps, ccomps, edgepaint, gvcolor, gvpack, mingle, nop, sccmap, unflatten: add page #6401
• fdp → circo, fdp, neato, osage, patchwork, sfdp, twopi: add page #6284
• gc
• gml2gv → gml2gv, graphml2gv, gv2gml, gv2gxl, gxl2gv, mm2gv: add page #6286
• graphml2gv → gml2gv, graphml2gv, gv2gml, gv2gxl, gxl2gv, mm2gv: add page #6286
• gv2gml → gml2gv, graphml2gv, gv2gml, gv2gxl, gxl2gv, mm2gv: add page #6286
• gv2gxl → gml2gv, graphml2gv, gv2gml, gv2gxl, gxl2gv, mm2gv: add page #6286
• gvcolor acyclic, bcomps, ccomps, edgepaint, gvcolor, gvpack, mingle, nop, sccmap, unflatten: add page #6401
• gvedit cluster, diffimg, dijkstra, dotty, gvedit, gvgen, gvmap: add page #18502
• gvgen cluster, diffimg, dijkstra, dotty, gvedit, gvgen, gvmap: add page #18502
• gvmap cluster, diffimg, dijkstra, dotty, gvedit, gvgen, gvmap: add page #18502
• gvmap.sh
• gvpack acyclic, bcomps, ccomps, edgepaint, gvcolor, gvpack, mingle, nop, sccmap, unflatten: add page #6401
• gvpr
• gxl2dot
• gxl2gv → gml2gv, graphml2gv, gv2gml, gv2gxl, gxl2gv, mm2gv: add page #6286
• lefty
• lneato
• mm2gv → gml2gv, graphml2gv, gv2gml, gv2gxl, gxl2gv, mm2gv: add page #6286
• neato → circo, fdp, neato, osage, patchwork, sfdp, twopi: add page #6284
• nop acyclic, bcomps, ccomps, edgepaint, gvcolor, gvpack, mingle, nop, sccmap, unflatten: add page #6401
• osage → circo, fdp, neato, osage, patchwork, sfdp, twopi: add page #6284
• patchwork → circo, fdp, neato, osage, patchwork, sfdp, twopi: add page #6284
• prune
• sccmap acyclic, bcomps, ccomps, edgepaint, gvcolor, gvpack, mingle, nop, sccmap, unflatten: add page #6401
• sfdp → circo, fdp, neato, osage, patchwork, sfdp, twopi: add page #6284
• tred
• twopi → circo, fdp, neato, osage, patchwork, sfdp, twopi: add page #6284
• unflatten acyclic, bcomps, ccomps, edgepaint, gvcolor, gvpack, mingle, nop, sccmap, unflatten: add page #6401
• vimdot

[sbrl]

Thanks for requesting this page, @calpa! Do you want to have a go yourself?

Pages are best created by people who understand the command they are about.

If you do, take a quick read of CONTRIBUTING.md, which guides you through the process of creating a new page here. Then, just simply send a pull request to this repository - and if you need any assistance, just ask :-)

[calpa]

@sbrl I will do it this week.

[mebeim]

Hi, @calpa, when you say "Graphviz" what do you mean exactly? Graphviz is a set of useful tools, not a standalone command. Care to specify?

[calpa]

@mebeim I am talking about this

[mebeim]

@calpa ok, but again as I said, that's not a specific command. That's a collection of commands which all support a certain set of options, so one cannot write a page for that, it does not fit in the scope of tldr pages. You could, however, write pages for specific graphviz commands.

[marchersimon]

A complete list of binaries in the graphviz package:

Checklist

• acyclic
• bcomps
• ccomps
• circo → circo, fdp, neato, osage, patchwork, sfdp, twopi: add page #6284
• cluster
• diffimg
• dijkstra
• dot → dot: add page #1578
• dot2gxl
• dot_builtins
• dotty
• edgepaint
• fdp → circo, fdp, neato, osage, patchwork, sfdp, twopi: add page #6284
• gc
• gml2gv → gml2gv, graphml2gv, gv2gml, gv2gxl, gxl2gv, mm2gv: add page #6286
• graphml2gv → gml2gv, graphml2gv, gv2gml, gv2gxl, gxl2gv, mm2gv: add page #6286
• gv2gml → gml2gv, graphml2gv, gv2gml, gv2gxl, gxl2gv, mm2gv: add page #6286
• gv2gxl → gml2gv, graphml2gv, gv2gml, gv2gxl, gxl2gv, mm2gv: add page #6286
• gvcolor
• gvedit
• gvgen
• gvmap
• gvmap.sh
• gvpack
• gvpr
• gxl2dot
• gxl2gv → gml2gv, graphml2gv, gv2gml, gv2gxl, gxl2gv, mm2gv: add page #6286
• lefty
• lneato
• mm2gv → gml2gv, graphml2gv, gv2gml, gv2gxl, gxl2gv, mm2gv: add page #6286
• neato → circo, fdp, neato, osage, patchwork, sfdp, twopi: add page #6284
• nop
• osage → circo, fdp, neato, osage, patchwork, sfdp, twopi: add page #6284
• patchwork → circo, fdp, neato, osage, patchwork, sfdp, twopi: add page #6284
• prune
• sccmap
• sfdp → circo, fdp, neato, osage, patchwork, sfdp, twopi: add page #6284
• tred
• twopi → circo, fdp, neato, osage, patchwork, sfdp, twopi: add page #6284
• unflatten
• vimdot

[daniel-birket]

Hello @marchersimon and all. I'd like to tackle this one as graphviz is a favorite tool of mine. I note that dot already has an entry. Please know that dot is only one of a set of alternate layout engines: dot, neato, circo, twopi, fdp, sfdp, osage and patchwork that have nearly the same parameters and flags. I'd like to tackle these as a set of entries, starting with a review of the existing dot entry (which seems too short). Is there any reason that I can't touch up dot (if required), get those changes (if any) accepted, then make a batch pull-request "graphviz : add pages" to create entries for the other seven commands that share dot's syntax? Will your work flow crash if there are multiple commands per pull-request?

There are also another score or more commands in the package that I hope to handle as well, but separate from this set.

[marchersimon]

Amazing, thanks! We're pretty flexible regarding our workflow. But maybe I'd call the PR Add graphviz layout engine pages or something like this.

[daniel-birket]

@marchersimon , @CleanMachine1, @calpa, @mebeim ,
I think that these first 14 graphviz commands are ready and stable after this last tweak requested by @navarroaxel. Please review #6270 (dot.md only), #6284 (dot.md + all layouts) and #6286 (all converters). Thank you.