This repository was archived by the owner on May 20, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy pathReadMe.htm
346 lines (309 loc) · 8.5 KB
/
ReadMe.htm
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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!--
* This Source Code Form is subject to the terms of the Mozilla Public License,
* v. 2.0. If a copy of the MPL was not distributed with this file, You can
* obtain one at http://mozilla.org/MPL/2.0/
*
* Copyright (C) 2013-2014, Peter Johnson (www.delphidabbler.com).
*
* Read-me file for Console Application Runner Classes
-->
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>
DelphiDabbler.com Console Application Runner Classes ReadMe
</title>
<style type="text/css">
body {
margin: 1em;
padding: 0;
font-family: Verdana, Arial, sans-serif;
font-size: 9pt;
line-height: 150%;
}
h1 {
margin: 0 0 1em 0;
padding: 0.5em;
border: 1px silver solid;
background-color: #eee;
font-size: 13pt;
font-weight: bold;
text-align: center;
}
h1 .subtitle {
font-style: italic;
color: #336;
}
h2 {
margin: 1em 0 0 0;
padding: 0;
padding-bottom: 6px;
border-bottom: 1px silver solid;
font-size: 11pt;
font-weight: bold;
}
h3 {
margin: 0.5em 0 0 0;
padding: 0;
font-size: 9pt;
font-weight: bold;
}
p {
margin: 0.5em 0 0 0;
padding: 0;
}
ul, ol {
margin: 0.5em 0 0 3em;
padding: 0;
}
ul {
list-style-type: square;
}
ul.spaced li,
ol.spaced li {
margin-top: 0.5em;
}
ul.spaced li,
ol.spaced li {
margin-top: 0.5em;
}
ul.unspaced li,
ol.unspaced li {
margin-top: 0;
}
ul.unspaced li.first,
ol.unspaced li.first {
margin-top: 0.5em;
}
code {
font-family: "Courier New", Courier, monospace;
}
a:link {
color: #336;
text-decoration: underline;
}
a:visited {
color: #669;
text-decoration: underline;
}
a:active {
color: #336;
text-decoration: underline;
}
a:hover {
text-decoration: underline;
}
.pullout {
border-left: 8px silver solid;
background-color: #eee;
margin: 0.5em 0 0 0;
padding: 0.25em 0.5em;
font-style: italic;
}
.indent {
margin-left: 3em;
}
.highlight {
color: #336;
font-style: italic;
font-weight: bold;
}
.endnotes {
margin: 1.5em 0 0 0;
padding: 1em 0 0 0;
border-top: 1px silver solid;
}
.comments {
font-style: italic;
}
.copyright,
.copyright a:link,
.copyright a:visited,
.copyright a:active {
margin: 1em 0 0 0;
color: gray;
font-size: 8pt;
text-align: right;
}
</style>
</head>
<body>
<h1>
Console Application Runner Classes<br />
<span class="subtitle">ReadMe</span>
</h1>
<h2 id="desc">
Description
</h2>
<p>
These classes are designed to be used to control the execution of child
console application processes. There are two classes: a class named
<var>TPJCustomConsoleApp</var> that is provided a base class for user-defined
sub-classes, and <var>TPJConsoleApp</var> that is used to provide a general
way to run and manipulate console applications. Both classes are provided in a
single unit, <var>PJConsoleApp</var>.
</p>
<p>
The classes enable the console application's standard input, standard output
and standard error to be redirected to and from files or pipes. The classes
can also time-slice the running of the console application to enable the
calling application to continue processing and to enable redirected piped
output to be processed.
</p>
<p>
For full details please see the <a
href="http://www.delphidabbler.com/url/consoleapp-docs"
>online documentation</a>.
</p>
<h3 id="compatibility">
Compatibility
</h3>
<p>
The classes require Delphi 7 and later.
</p>
<p>
<var>PJConsoleApp</var> is suitable for compilation with both the 32 bit and
64 bit Delphi compilers (Delphi XE2 and later). However, the unit uses the
Windows API so is not suitable for compilation for OSX.
</p>
<p>
The classes can be used with both the VCL and FireMonkey frameworks.
</p>
<h2 id="installation">
Installation
</h2>
<p>
The Console Application Runner Classes and associated documentation and demo
program source files are supplied in a zip file. Before installing, or using,
you need to extract all the files from the zip file, preserving the directory
structure. The following files will be extracted:
</p>
<ul>
<li>
<code><strong>PJConsoleApp.pas</strong></code> – The source code of
the console application runner classes.
</li>
<li>
<code>Docs\ChangeLog.txt</code> – The project's change log.
</li>
<li>
<code>Docs\Documentation.URL</code> – Short-cut to the project's
online documentation.
</li>
<li>
<code>Docs\MPL-2.0.txt</code> – Mozilla Public License v2.0.
</li>
<li>
<code>Docs\ReadMe.htm</code> – The project's read-me file.
</li>
</ul>
<p>
In addition to the above files you will find numerous demo projects in the
<code>Demos</code> sub-directory.
</p>
<p>
There are three possible ways to use the units.
</p>
<ol class="spaced">
<li>
The simplest way is to add <code>PJConsoleApp.pas</code> to your projects as
and when you need it.
</li>
<li>
To make the unit easier to re-use you can either copy it to a folder on your
Delphi search path, or add the folder where you extracted the units to the
search path. You then simply use the units as required without needing to
add them to your project.
</li>
<li>
For maximum portability you can add the unit to a Delphi design time
package. If you need help doing this <a
href="http://www.delphidabbler.com/url/install-comp"
>see here</a>.
</li>
</ol>
<h2 id="demo">
Demo Programs
</h2>
<p>
The source code for numerous demo projects is included in the download. All
the demos and supporting files are stored in sub-folders of the
<code>Demos</code> directory.
</p>
<p class="pullout">
Please note that some of the demos use units and classes from the
DelphiDabbler <a
href="http://www.delphidabbler.com/software/ioutils"
>IO Utility Classes</a> project. Before attempting to compile the affected
demos you need to download this project and copy the required units to the
<code>Demos\IOUtils</code> directory. Users of Delphi XE5 and later must
use IO Utility Classes v1.0.1 or later.
</p>
<p>
For more information see the file <code>README.txt</code> in the
<code>Demos</code> directory.
</p>
<p>
The demo programs are described in the <em>Examples</em> section of the <a
href="http://www.delphidabbler.com/url/consoleapp-docs"
>online documentation</a>.
</p>
<h2 id="changelog">
Update History
</h2>
<p>
A complete change log is provided in a text file that is included in the
download.
</p>
<h2 id="license">
License
</h2>
<p>
The <em>Console Application Runner Classes</em> are released under the terms
of the <a
href="http://www.mozilla.org/MPL/2.0/"
>Mozilla Public License, v2.0</a>.
</p>
<h2 id="bugs">
Bugs and Feature Requests
</h2>
<p>
Bugs can be reported or new features requested via the <a
href="http://www.delphidabbler.com/url/ddlib-issues"
>Issue Tracker</a>.
</p>
<p>
If no similar report or request has been recorded already, use the <em>New
Issue</em> link to add a new issue. Please select the most appropriate
template from the <em>Templates</em> drop down list and apply the
<code>Project-consoleapp</code> label. If there is already a similar issue
please add a comment to it if there's anything you can add.
</p>
<h2 id="author">
About the Author
</h2>
<p>
I'm Peter Johnson – a hobbyist programmer living in Ceredigion in West
Wales, UK, writing write mainly in Delphi. My programs are available for
download from <a
href="http://www.delphidabbler.com/"
>http://www.delphidabbler.com/</a>.
</p>
<div class="endnotes">
<div class="comments">
Please <a
href="http://www.delphidabbler.com/contact"
>let me know</a> if you have any comments about the classes, but please
use the <a
href="http://www.delphidabbler.com/url/ddlib-issues"
>Issue Tracker</a> discussed above to report bugs and request new features.
</div>
<div class="copyright">
This document is copyright © 2007-2014, P D Johnson, <a
href="http://www.delphidabbler.com/"
>www.delphidabbler.com</a>
</div>
</div>
</body>
</html>