summaryrefslogtreecommitdiff
path: root/support/dktools/man/man1/dkct.1
blob: 21bfd73931aa0dc3de13b2ed30a9a8d8069eb834 (plain)
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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
'\" t
.\"     Title: dkct
.\"    Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 03/28/2017
.\"    Manual: \ \&
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "DKCT" "1" "03/28/2017" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * 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"
dkct \- Dirk Krause\*(Aqs C tool
.SH "SYNOPSIS"
.sp
\fBdkt\fR [\fIoptions\fR] [\fIfiles\fR]
.sp
DESCRIPTION
.sp
The program provides:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
A preprocessor for debug/trace instructions,
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
a code generator for state machines,
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
a code generator for GUIs using the wxWidgets library\&.
.RE
.sp
The program converts *\&.ctr, *\&.cpt, *\&.mtr and *\&.jtr files to *\&.c, *\&.cpp, *\&.m and *\&.java\&. The source files can contain debug instructions in a special notation\&. When producing release versions the debug instructions are ignored\&. When producing debug versions the debug instructions are converted to output instructions\&.
.SH "OPTIONS"
.PP
\fB\-R\fR, \fB\-\-reset\fR
.RS 4
Ignore all settings from configuration files\&.
.RE
.PP
\fB\-d\fR, \fB\-\-debug\fR
.RS 4
Create debug output\&.
.RE
.PP
\fB\-s\fR, \fB\-\-debug\-stdout\fR
.RS 4
Debug output goes to standard output\&.
.RE
.PP
\fB\-t\fR, \fB\-\-timestamp\fR
.RS 4
Debug output contains a timestamp\&.
.RE
.PP
\fB\-k\fR, \fB\-\-trace\-keyword\fR
.RS 4
Debug output contains "trace" string\&.
.RE
.PP
\fB\-w\fR, \fB\-\-windows\-wide\-char\fR
.RS 4
Prepare debug output for wchar_t\&.
.RE
.PP
\fB\-p\fR, \fB\-\-portable\-output\fR
.RS 4
Create portable debug output code (implies \-w)\&.
.RE
.PP
\fB\-l\fR, \fB\-\-line\-numbers\fR
.RS 4
Write preprozessor directives "#line \&..." to output\&.
.RE
.PP
\fB\-m\fR, \fB\-\-make\fR
.RS 4
Make mode: rebuild destination files only if necessary\&.
.RE
.PP
\fB\-b\fR \fIwidth\fR, \fB\-\-box\-width=\fR\fIwidth\fR
.RS 4
Set box with for comment boxes\&.
.RE
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
Show help text\&.
.RE
.PP
\fB\-v\fR, \fB\-\-version\fR
.RS 4
Show version number\&.
.RE
.PP
\fB\-L\fR, \fB\-\-license\-terms\fR
.RS 4
Show license conditions\&.
.RE
.SH "EXIT STATUS"
.sp
The program returns 0 on success, any other value indicates an error\&.
.SH "NOTES"
.sp
This program uses DK libraries version 3\&.
.SH "AUTHOR"
.sp
Dirk Krause
.SH "COPYRIGHT AND LICENSE"
.sp
Copyright (c) 2011\-2016, Dirk Krause
.sp
All rights reserved\&.
.sp
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Neither the name of the copyright holder(s) nor the names of contributors may be used to endorse or promote products derived from this software without specific prior written permission\&.
.RE
.sp
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \(lqAS IS\(rq AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED\&. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE\&.
.SH "SEE ALSO"
.PP
\fBdkct(5)\fR
.RS 4
Input file syntax for dkct (*\&.ctr, *\&.cpt, *\&.mtr files)\&.
.RE
.PP
http://dktools\&.sourceforge\&.net
.RS 4
Project homepage\&.
.RE