File: ditaa.1

package info (click to toggle)
ditaa 0.9%2Bds1-3
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd, wheezy
  • size: 776 kB
  • ctags: 901
  • sloc: java: 6,660; xml: 91; makefile: 29
file content (62 lines) | stat: -rw-r--r-- 2,125 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
.TH DITAA 1 "April 15, 2010"
.SH NAME
ditaa \- convert ASCII diagrams into proper bitmap graphics
.SH SYNOPSIS
.B ditaa
.RI [ options ] " input " [ output ]
.SH DESCRIPTION
This manual page documents briefly the \fBditaa\fR command.
.PP
\fBDiTAA\fR is a small command-line utility that can convert diagrams drawn using
ASCII art ("drawings" that contain characters that resemble lines, like | /
and -), into proper bitmap graphics.
.PP
DiTAA also uses special markup syntax to increase the possibilities of shapes
and symbols that can be rendered.
.SH OPTIONS
.TP
.B \-\-help
Show summary of options.
.TP
.B \-v, \-\-verbose
Makes ditaa more verbose.
.TP
.B \-A, \-\-no\-antialias
Turns anti-aliasing off.
.TP
.B \-d, \-\-debug
Renders the debug grid over the resulting image.
.TP
.B \-E, \-\-no\-separation
Prevents the separation of common edges of shapes.
.TP
\fB\-e\fR \fIENCODING\fR, \fB\-\-encoding\fR \fIENCODING\fR
The encoding of the input file.
.TP
.B \-h, \-\-html
In this case the input is an HTML file. The contents of the \fI<pre class="textdiagram">\fR
tags are rendered as diagrams and saved in the images directory and a new HTML file is
produced with the appropriate <img> tags.
.TP
.B \-o, \-\-overwrite
If the filename of the destination image already exists, an alternative name is chosen.
If the overwrite option is selected, the image file is instead overwriten.
.TP
.B \-r, \-\-round\-corners
Causes all corners to be rendered as round corners.
.TP
\fB\-s\fR \fISCALE\fR, \fB\-\-scale\fR \fISCALE\fR
A natural number that determines the size of the rendered image. The units are fractions of
the default size (2.5 renders 1.5 times bigger than the default).
.TP
.B \-S, \-\-no\-shadows
Turns off the drop-shadow effect.
.TP
\fB\-t\fR \fITABS\fR, \fB\-\-tabs\fR \fITABS\fR
Tabs are normally interpreted as 8 spaces but it is possible to change that using this
option. It is not advisable to use tabs in your diagrams.
.SH AUTHOR
DiTAA was written by Efstathios (Stathis) Sideris.
.PP
This manual page was written by David Paleino <dapal@debian.org>,
for the Debian project (and may be used by others).