.Dd Jul 18, 2021
.Os adr-tools 3.0.0-1
.Dt adr 1 PRM
.Sh NAME
.Nm adr 
.Nd tool for working with Architecture Decision Records (ADRs)
.Sh SYNOPSIS
.Nm adr
.Ar command
.Op ...
.Sh DESCRIPTION
The tool
.Nm
simplifies maintaining
.Em ADR
documents. 
.Sh COMMANDS
Adr is a multiplexer into individual miniature tools for specific operations.
.Ss init
Initialize directory of ADR documents.
.Ss new [-s SUPERSEDED] [-l TARGET:LINK:REVERSE-LINK] TITLE_TEXT...
Create a new numbered ADR. Elements of
.Ar TITLE_TEXT
are concatenated to form the title of the ADR.
.Ss link SOURCE LINK TARGET REVERSE-LINK
Create a link between two ADRs.
.Pp
Creates a link between two ADRs, from 
.Ar SOURCE
to
.Ar TARGET .
.Ar SOURCE
and
.Ar TARGET
are both a reference (number or partial filename) to an ADR.
.Ar LINK
is the description of the link created in the
.Ar SOURCE .
.Ar REVERSE-LINK
is the description of the link created in the
.Ar TARGET .
.Ss list
List all ADRs.
.Ss upgrade-repository
Upgrade ADR documents to the latest format.
.Ss generate toc
Generate a table of contents in in
.Em Markdown
format. 
.Ss generate graph 
Generate a visualization of the links between decision records in
.Em Graphivz
format.
.Sh BUGS
This manual page is a stub. Consider the built-in help system by running
.Em adr help .
.Sh AUTHORS
.An "Zygmunt Krynicki" Aq Mt me@zygoon.pl