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
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
|
<HTML>
<HEAD>
<TITLE>
EMBOSS: acdvalid
</TITLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF" text="#000000">
<table align=center border=0 cellspacing=0 cellpadding=0>
<tr><td valign=top>
<A HREF="/" ONMOUSEOVER="self.status='Go to the EMBOSS home page';return true"><img border=0 src="/images/emboss_icon.jpg" alt="" width=150 height=48></a>
</td>
<td align=left valign=middle>
<b><font size="+6">
acdvalid
</font></b>
</td></tr>
</table>
<br>
<p>
<H2>
Wiki
</H2>
The master copies of EMBOSS documentation are available
at <a href="http://emboss.open-bio.org/wiki/Appdocs">
http://emboss.open-bio.org/wiki/Appdocs</a>
on the EMBOSS Wiki.
<p>
Please help by correcting and extending the Wiki pages.
<H2>
Function
</H2>
Validate an application ACD file
<H2>
Description
</H2>
<p><b>acdvalid</b> processes an ACD file and reports any errors or warnings caused by incorrect, deprecated or obsolete syntax. The tests go above and beyond those of <b>acdc</b> and <b>acdtrace</b>. It highlights ACD syntax that might cause problems to third-party parsing software which wrap the EMBOSS applications.</p>
<p><b>acdvalid</b> validates the ACD file, testing many features which will not prevent an application from running, but will create problems for the interfaces, whether on the command-line or some other type.</p>
<H2>
Usage
</H2>
Here is a sample session with <b>acdvalid</b>
<p>
<p>
<table width="90%"><tr><td bgcolor="#CCFFFF"><pre>
% <b>acdvalid antigenic </b>
</pre></td></tr></table><p>
<p>
<p>
<H2>
Command line arguments
</H2>
The first parameter is the name of the program to compile.
All other command line parameters and qualifiers are defined for that
program - see the documentation for the program of choice.
<P>
<table CELLSPACING=0 CELLPADDING=3 BGCOLOR="#f5f5ff" ><tr><td>
<pre>
Validate an application ACD file
Version: EMBOSS:6.6.0.0
Standard (Mandatory) qualifiers: (none)
Additional (Optional) qualifiers: (none)
Advanced (Unprompted) qualifiers: (none)
Associated qualifiers: (none)
General qualifiers:
-auto boolean Turn off prompts
-stdout boolean Write first file to standard output
-filter boolean Read first file from standard input, write
first file to standard output
-options boolean Prompt for standard and additional values
-debug boolean Write debug output to program.dbg
-verbose boolean Report some/full command line options
-help boolean Report command line options and exit. More
information on associated and general
qualifiers can be found with -help -verbose
-warning boolean Report warnings
-error boolean Report errors
-fatal boolean Report fatal errors
-die boolean Report dying program messages
-version boolean Report version number and exit
</pre>
</td></tr></table>
<P>
<table border cellspacing=0 cellpadding=3 bgcolor="#ccccff">
<tr bgcolor="#FFFFCC">
<th align="left">Qualifier</th>
<th align="left">Type</th>
<th align="left">Description</th>
<th align="left">Allowed values</th>
<th align="left">Default</th>
</tr>
<tr bgcolor="#FFFFCC">
<th align="left" colspan=5>Standard (Mandatory) qualifiers</th>
</tr>
<tr>
<td colspan=5>(none)</td>
</tr>
<tr bgcolor="#FFFFCC">
<th align="left" colspan=5>Additional (Optional) qualifiers</th>
</tr>
<tr>
<td colspan=5>(none)</td>
</tr>
<tr bgcolor="#FFFFCC">
<th align="left" colspan=5>Advanced (Unprompted) qualifiers</th>
</tr>
<tr>
<td colspan=5>(none)</td>
</tr>
<tr bgcolor="#FFFFCC">
<th align="left" colspan=5>Associated qualifiers</th>
</tr>
<tr>
<td colspan=5>(none)</td>
</tr>
<tr bgcolor="#FFFFCC">
<th align="left" colspan=5>General qualifiers</th>
</tr>
<tr bgcolor="#FFFFCC">
<td> -auto</td>
<td>boolean</td>
<td>Turn off prompts</td>
<td>Boolean value Yes/No</td>
<td>N</td>
</tr>
<tr bgcolor="#FFFFCC">
<td> -stdout</td>
<td>boolean</td>
<td>Write first file to standard output</td>
<td>Boolean value Yes/No</td>
<td>N</td>
</tr>
<tr bgcolor="#FFFFCC">
<td> -filter</td>
<td>boolean</td>
<td>Read first file from standard input, write first file to standard output</td>
<td>Boolean value Yes/No</td>
<td>N</td>
</tr>
<tr bgcolor="#FFFFCC">
<td> -options</td>
<td>boolean</td>
<td>Prompt for standard and additional values</td>
<td>Boolean value Yes/No</td>
<td>N</td>
</tr>
<tr bgcolor="#FFFFCC">
<td> -debug</td>
<td>boolean</td>
<td>Write debug output to program.dbg</td>
<td>Boolean value Yes/No</td>
<td>N</td>
</tr>
<tr bgcolor="#FFFFCC">
<td> -verbose</td>
<td>boolean</td>
<td>Report some/full command line options</td>
<td>Boolean value Yes/No</td>
<td>Y</td>
</tr>
<tr bgcolor="#FFFFCC">
<td> -help</td>
<td>boolean</td>
<td>Report command line options and exit. More information on associated and general qualifiers can be found with -help -verbose</td>
<td>Boolean value Yes/No</td>
<td>N</td>
</tr>
<tr bgcolor="#FFFFCC">
<td> -warning</td>
<td>boolean</td>
<td>Report warnings</td>
<td>Boolean value Yes/No</td>
<td>Y</td>
</tr>
<tr bgcolor="#FFFFCC">
<td> -error</td>
<td>boolean</td>
<td>Report errors</td>
<td>Boolean value Yes/No</td>
<td>Y</td>
</tr>
<tr bgcolor="#FFFFCC">
<td> -fatal</td>
<td>boolean</td>
<td>Report fatal errors</td>
<td>Boolean value Yes/No</td>
<td>Y</td>
</tr>
<tr bgcolor="#FFFFCC">
<td> -die</td>
<td>boolean</td>
<td>Report dying program messages</td>
<td>Boolean value Yes/No</td>
<td>Y</td>
</tr>
<tr bgcolor="#FFFFCC">
<td> -version</td>
<td>boolean</td>
<td>Report version number and exit</td>
<td>Boolean value Yes/No</td>
<td>N</td>
</tr>
</table>
<H2>
Input file format
</H2>
The input is whatever the chosen application reads.
<p>
<H2>
Output file format
</H2>
<p>
The output file is empty, but any format available to the specified
program can be used.
<p>
<H2>
Data files
</H2>
Acdvalid will use any data files specified in the ACD file of the
specified program, but will ignore any data files that are only used
directly by the program's code.
<p>
EMBOSS data files are distributed with the application and stored
in the standard EMBOSS data directory, which is defined
by the EMBOSS environment variable EMBOSS_DATA.
<p>
To see the available EMBOSS data files, run:
<p>
<pre>
% embossdata -showall
</pre>
<p>
To fetch one of the data files (for example 'Exxx.dat') into your
current directory for you to inspect or modify, run:
<pre>
% embossdata -fetch -file Exxx.dat
</pre>
<p>
Users can provide their own data files in their own directories.
Project specific files can be put in the current directory, or for
tidier directory listings in a subdirectory called
".embossdata". Files for all EMBOSS runs can be put in the user's home
directory, or again in a subdirectory called ".embossdata".
<p>
The directories are searched in the following order:
<ul>
<li> . (your current directory)
<li> .embossdata (under your current directory)
<li> ~/ (your home directory)
<li> ~/.embossdata
</ul>
<p>
<H2>
Notes
</H2>
<p><b>acdvalid</b> does not have its own options, but takes a single parameter which is the name of the EMBOSS application that is being testsed. It is invoked by specifying the name of the application to be tested along with any command-line options after the name of the utility application itself:</p>
<p><b>acdvalid</b> ApplicationName Options</p>
<p><b>acdvalid</b> will run the command line interface of any EMBOSS program by reading its ACD file and processing the command line and user responses in exactly the same way as if the true program itself were running. The application proper is <emphasis>not</emphasis> run; it is only the ACD file that is read.Any command-line options for the application being called can be specified. The user is prompted for any required values for application parameters and any input files are read. Output files can be specified in any available format however they will be empty (the application code is not called so there will be no output).</p>
<p><b>acdvalid</b> will use any data files specified in the ACD file of the specified program, but will ignore any data files that are only used directly by the program's code. EMBOSS data files are distributed with the application and stored in the standard EMBOSS data directory (see EMBOSS Users Manual for further information).</p>
<p><b>acdvalid</b> generates both error and warning messages. If the message is an "Error" then the ACD file will not work and requires fixing. Most of the messages from <b>acdvalid</b> are "Warnings" and do not prevent a program from running, however it is still worth trying to fix the problem.
<p>Although the warning messages are only advisory, as many warnings as possible are fixed for any application in the main release. Further validation tests will be added in future releases so it is worth running <b>acdvalid</b> on all local ACD files with each new version of EMBOSS</p>
<H2>
References
</H2>
<H2>
Warnings
</H2>
None.
<H2>
Diagnostic Error Messages
</H2>
<H2>
Exit status
</H2>
It exits with status 0.
<H2>
Known bugs
</H2>
None.
<h2><a name="See also">See also</a></h2>
<table border cellpadding=4 bgcolor="#FFFFF0">
<tr><th>Program name</th>
<th>Description</th></tr>
<tr>
<td><a href="acdc.html">acdc</a></td>
<td>Test an application ACD file</td>
</tr>
<tr>
<td><a href="acdpretty.html">acdpretty</a></td>
<td>Correctly reformat an application ACD file</td>
</tr>
<tr>
<td><a href="acdtable.html">acdtable</a></td>
<td>Generate an HTML table of parameters from an application ACD file</td>
</tr>
<tr>
<td><a href="acdtrace.html">acdtrace</a></td>
<td>Trace processing of an application ACD file (for testing)</td>
</tr>
</table>
<H2>
Author(s)
</H2>
Peter Rice
<br>
European Bioinformatics Institute, Wellcome Trust Genome Campus, Hinxton, Cambridge CB10 1SD, UK
<p>
Please report all bugs to the EMBOSS bug team (emboss-bug © emboss.open-bio.org) not to the original author.
<H2>
History
</H2>
Written 2004
<H2>
Target users
</H2>
This program is intended to be used by developers of applications and
interfaces.
<H2>
Comments
</H2>
None
</BODY>
</HTML>
|
