-
Notifications
You must be signed in to change notification settings - Fork 0
/
sqlite2dot.1
104 lines (104 loc) · 2.78 KB
/
sqlite2dot.1
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
.\" $Id$
.\"
.\" Copyright (c) 2016 Kristaps Dzonsons <kristaps@bsd.lv>
.\"
.\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
.\" copyright notice and this permission notice appear in all copies.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
.Dd $Mdocdate: June 29 2016 $
.Dt SQLITE2DOT 1
.Os
.Sh NAME
.Nm sqlite2dot
.Nd convert sqlite3 schema to GraphViz input
.\" .Sh LIBRARY
.\" For sections 2, 3, and 9 only.
.\" Not used in OpenBSD.
.Sh SYNOPSIS
.Nm sqlite2dot
.Op Fl v
.Op Fl c Ar attrs
.Op Fl h Ar attrs
.Op Fl p Ar prefix
.Op Fl t Ar attrs
.Op Ar schema
.Sh DESCRIPTION
The
.Nm
utility converts an
.Xr sqlite3 1
schema file to a GraphViz file readable by
.Xr dot 1 .
Its arguments are as follows:
.Bl -tag -width Ds
.It Fl v
Emits informational messages to standard error.
.It Fl c Ar attrs
Table-cell attributes.
See the GraphViz documentation for HTML labels for a list of cell
attributes (except
.Dq href ) .
You should invoke this once per attribute (they will accumulate).
.It Fl h Ar attrs
First table-cell (header) attributes.
If unset, this will use
.Fl c .
See the GraphViz documentation for HTML labels for a list of cell
attributes (except
.Dq href ) .
You should invoke this once per attribute (they will accumulate).
.It Fl p Ar prefix
Prefix to use for creating HTML ID tags.
.It Fl t Ar attrs
Table attributes.
See the GraphViz documentation for HTML labels for a list of cell
attributes (except
.Dq href ) .
You should invoke this once per attribute (they will accumulate).
.It Ar schema
An SQLite schema file.
.El
.Pp
The outputted GraphViz file serialises tables as HTML-label nodes, each
of which has one row per table column.
Table nodes are connected by foreign keys.
.Pp
.Nm
is best when creating image maps by piping into
.Xr dot 1
with
.Fl T Ar cmapx
then
.Fl T Ar png
or similar backing, then using the
.Li usemap
attribute for the HTML
.Li <img>
tag.
You can then use
.Xr sqlite2html 1
for linking to the documentation.
.Sh SEE ALSO
.Xr dot 1 ,
.Xr sqlite2html 1 ,
.Xr sqlite3 1
.\" .Sh STANDARDS
.\" .Sh HISTORY
.\" .Sh AUTHORS
.Sh CAVEATS
The schema language accepted by
.Nm
is currently limited to the table declaration with a subset of the
column specification.
.\" .Sh BUGS
.\" .Sh SECURITY CONSIDERATIONS
.\" Not used in OpenBSD.