.. -*- coding: utf-8 -*-












.. role:: sref(numref)
.. role:: xref(numref)
.. Copyright (C) 2020, Wolfgang Scherer, <Wolfgang.Scherer at gmx.de>

.. This file is part of Development.

.. Permission is granted to copy, distribute and/or modify this document
.. under the terms of the GNU Free Documentation License, Version 1.3
.. or any later version published by the Free Software Foundation;
.. with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
.. A copy of the license is included in the section entitled "GNU
.. Free Documentation License".

.. inline comments (with du_comment_role)
.. role:: rem(comment)
.. role:: html(raw)
   :format: html
.. role:: shx(code)
   :language: sh

.. rst-class:: narrow xmedium xlarge xhuge xultra

##################################################
:rem:`|||:sec:|||`\ Shell Tools
##################################################
.. >>CODD See `the components of a doctoral dissertation and their order <http://site.uit.no/english/writing-style/bookstructure/>`_
.. >>CODD Dedication
.. >>CODD Epigraph
.. >>CODD Abstract
.. compound::

   .. \|:here:|

.. >>CODD Introduction
.. >>CODD Chapter

========================================================================
:rem:`|||:sec:|||`\ dir_to_dot.sh - generate dot(1) graph from directory
========================================================================

.. dir-to-dot/dir_to_dot.sh --help

dir_to_dot.sh - recursive dot(1) graph from directory tree

usage: dir_to_dot.sh [OPTIONS] [directory]

OPTIONS

+-------------+----------+--------------------------------------+
| option      | args     | description                          |
+=============+==========+======================================+
| -d, --debug |          | N/I do not execute commands          |
+-------------+----------+--------------------------------------+
| -h, --help  |          | show this help                       |
+-------------+----------+--------------------------------------+
| --umlx      | RX[:TYP] | N/I extract UML diagrams matching RX |
+-------------+----------+--------------------------------------+

.. include:: _static/dir_to_dot-todo.txt

(see :xref:`fig:dir_to_dotsh generator output`)

.. _`fig:dir_to_dotsh generator output`:
.. graphviz:: _static/dir_to_dot.dot
   :caption: dir_to_dot.sh generator output

(see :xref:`fig:dir_to_dotsh generator script`)

.. _`fig:dir_to_dotsh generator script`:
.. uml:: _static/dir_to_dot-a0.puml
   :caption: dir_to_dot.sh generator script

(see :xref:`fig:list_dir recurvise graph generator`)

.. _`fig:list_dir recurvise graph generator`:
.. uml:: _static/dir_to_dot-a1.puml
   :caption: list_dir recurvise graph generator

.. >>CODD Conclusion
.. >>CODD Appendix A

.. \|:here:|

.. >>CODD Notes
.. ==================================================
.. :rem:`|||:sec:|||`\ Footnotes
.. ==================================================

:html:`<hr>`

.. \[#]

.. include:: doc_defs.inc
.. include:: abbrev_defs.inc
.. include:: doc_defs_combined.inc
..
  .. \||<-snap->|| doc_standalone
  .. include:: doc/doc_defs_secret.inc
  .. \||<-snap->|| doc_standalone
  .. \||<-snap->|| not_doc_standalone
  .. include:: doc_defs_secret.inc
  .. \||<-snap->|| not_doc_standalone

.. _`Wolfgang Scherer`: wolfgang.scherer@gmx.de