'\" t
.\"     Title: PANDOC-PLANTUML
.\"    Author: Hanno Stock <opensource@hanno-stock.de>
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 11/01/2019
.\"    Manual: pandoc-plantuml User Manual
.\"    Source: pandoc-plantuml
.\"  Language: English
.\"
.TH "PANDOC\-PLANTUML" "1" "11/01/2019" "pandoc-plantuml" "pandoc-plantuml User Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
pandoc-plantuml \- Pandoc filter: converts PlantUML code blocks to PlantUML images
.SH "SYNOPSIS"
.HP \w'\fBpandoc\fR\ 'u
\fBpandoc\fR \fB\-\-filter\ pandoc\-plantuml\fR [\fB\&.\&.\&.\fR]
.SH "DESCRIPTION"
.PP
\fBpandoc\-plantuml\fR
is a filter for pandoc and is not intended to be used as a standalone command\&.
.PP
This manual page documents briefly the
\fBpandoc\-plantuml\fR
command\&.
.SH "EXAMPLES"
.PP
In your (in this example Markdown) document insert plantuml diagrams like this:
.PP
.if n \{\
.RS 4
.\}
.nf
```plantuml
Alice \-> Bob: Authentication Request
Bob \-\-> Alice: Authentication Response

Alice \-> Bob: Another authentication Request
Alice <\-\- Bob: another authentication Response
```
.fi
.if n \{\
.RE
.\}
.PP
This will create an output file with a
\fBplantuml\fR\-generated image linked in the file\&. The image will be put under the relative dir
plantuml\-images\&.
.SH "SEE ALSO"
.PP
\fBpandoc\fR(1)
.PP
See
/usr/share/doc/pandoc\-plantuml\-filter
for more information\&.
.SH "AUTHORS"
.PP
\fBHanno Stock\fR <\&opensource@hanno\-stock\&.de\&>
.RS 4
Wrote this manpage for the Debian system\&.
.RE
.PP
\fBTimo Furrer\fR
.RS 4
provided the example\&.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2019 Hanno Stock
.br
.PP
This manual page was written for the Debian system (and may be used by others)\&.
.PP
Permission is granted to copy, distribute and/or modify this document under the terms of the MIT License\&.
.PP
See
/usr/share/doc/pandoc\-plantuml\-filter/copyright
for full licensing information\&.
.sp