← Back to branch summary

~ubuntu-branches/ubuntu/gutsy/vnc4/gutsy

« back to all changes in this revision

Viewing changes to unix/xc/programs/xieperf/xieperf.man

  • Committer: Bazaar Package Importer
  • Author(s): Ola Lundqvist
  • Date: 2006-05-15 20:35:17 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20060515203517-l4lre1ku942mn26k
Tags: 4.1.1+X4.3.0-10
* Correction of critical security issue. Thanks to Martin Kogler
  <e9925248@student.tuwien.ac.at> that informed me about the issue,
  and provided the patch.
  This flaw was originally found by Steve Wiseman of intelliadmin.com.
* Applied patch from Javier Kohen <jkohen@users.sourceforge.net> that
  inform the user that only 8 first characters of the password will
  actually be used when typing more than 8 characters, closes:
  #355619.

Show diffs side-by-side

added added

removed removed

Lines of Context:
unix/xc/programs/xieperf/xieperf.man
 
1
.\" $Xorg: xieperf.man,v 1.4 2001/02/09 02:05:49 xorgcvs Exp $
 
2
.\" Copyright 1993, 1994, 1998  The Open Group
 
3
.\" 
 
4
.\" Permission to use, copy, modify, distribute, and sell this software and its
 
5
.\" documentation for any purpose is hereby granted without fee, provided that
 
6
.\" the above copyright notice appear in all copies and that both that
 
7
.\" copyright notice and this permission notice appear in supporting
 
8
.\" documentation.
 
9
.\"
 
10
.\" The above copyright notice and this permission notice shall be included
 
11
.\" in all copies or substantial portions of the Software.
 
12
.\" 
 
13
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 
14
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 
15
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 
16
.\" IN NO EVENT SHALL THE OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR
 
17
.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 
18
.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 
19
.\" OTHER DEALINGS IN THE SOFTWARE.
 
20
.\" 
 
21
.\" Except as contained in this notice, the name of The Open Group shall
 
22
.\" not be used in advertising or otherwise to promote the sale, use or
 
23
.\" other dealings in this Software without prior written authorization
 
24
.\" from The Open Group.
 
25
.\" 
 
26
.\" 
 
27
.\"                             NOTICE
 
28
.\"                               
 
29
.\" This software is being provided by AGE Logic, Inc. under the
 
30
.\" following license.  By obtaining, using and/or copying this software,
 
31
.\" you agree that you have read, understood, and will comply with these
 
32
.\" terms and conditions:
 
33
.\" 
 
34
.\"      Permission to use, copy, modify, distribute and sell this
 
35
.\"      software and its documentation for any purpose and without
 
36
.\"      fee or royalty and to grant others any or all rights granted
 
37
.\"      herein is hereby granted, provided that you agree to comply
 
38
.\"      with the following copyright notice and statements, including
 
39
.\"      the disclaimer, and that the same appears on all copies and
 
40
.\"      derivative works of the software and documentation you make.
 
41
.\"      
 
42
.\"      "Copyright 1993, 1994 by AGE Logic, Inc."
 
43
.\"      
 
44
.\"      THIS SOFTWARE IS PROVIDED "AS IS".  AGE LOGIC MAKES NO
 
45
.\"      REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED.  By way of
 
46
.\"      example, but not limitation, AGE LOGIC MAKE NO
 
47
.\"      REPRESENTATIONS OR WARRANTIES OF MERCHANTABILITY OR FITNESS
 
48
.\"      FOR ANY PARTICULAR PURPOSE OR THAT THE SOFTWARE DOES NOT
 
49
.\"      INFRINGE THIRD-PARTY PROPRIETARY RIGHTS.  AGE LOGIC 
 
50
.\"      SHALL BEAR NO LIABILITY FOR ANY USE OF THIS SOFTWARE.  IN NO
 
51
.\"      EVENT SHALL EITHER PARTY BE LIABLE FOR ANY INDIRECT,
 
52
.\"      INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOSS
 
53
.\"      OF PROFITS, REVENUE, DATA OR USE, INCURRED BY EITHER PARTY OR
 
54
.\"      ANY THIRD PARTY, WHETHER IN AN ACTION IN CONTRACT OR TORT OR
 
55
.\"      BASED ON A WARRANTY, EVEN IF AGE LOGIC LICENSEES
 
56
.\"      HEREUNDER HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH
 
57
.\"      DAMAGES.
 
58
.\"     
 
59
.\"      The name of AGE Logic, Inc. may not be used in
 
60
.\"      advertising or publicity pertaining to this software without
 
61
.\"      specific, written prior permission from AGE Logic.
 
62
.\" 
 
63
.\"      Title to this software shall at all times remain with AGE
 
64
.\"      Logic, Inc.
 
65
.\"
 
66
.\" $XFree86: xc/programs/xieperf/xieperf.man,v 1.8 2001/12/14 20:01:53 dawes Exp $
 
67
.\"
 
68
.TH xieperf 1 __xorgversion__
 
69
.SH NAME
 
70
xieperf - XIE server extension test and demo program
 
71
.SH SYNTAX
 
72
.B xieperf
 
73
[-option ...]
 
74
.SH DESCRIPTION
 
75
The
 
76
.I xieperf
 
77
program is based upon R5 
 
78
.I x11perf(1)
 
79
, and while not entirely comprehensive in its coverage of the XIE 
 
80
protocol (see BUGS, below), it is intended to be useful in the evaluation of 
 
81
XIE implementations in the areas of protocol adherance and performance. 
 
82
The
 
83
.I xieperf 
 
84
program includes tests which execute each of the protocol requests and photoflo 
 
85
elements specified by revision 5.0 of the XIE protocol. In addition, 
 
86
.I xieperf 
 
87
provides a set of tests which can be used to validate the detection and 
 
88
transmission of XIE protocol request errors, such as FloMatch, FloValue, and 
 
89
so forth. Finally, 
 
90
.I xieperf
 
91
provides a customizable demonstration program for XIE.
 
92
.PP
 
93
A test is made up of three components executed in sequence - an 
 
94
initialization function, a test function, and an end function. The 
 
95
initialization function is responsible for allocating and populating test 
 
96
resources, such as photomaps and LUTs, and for creating a stored photoflo 
 
97
which will be executed by the test function. The test function, in most cases, 
 
98
simply executes the stored photoflo for a specified number of repetitions. 
 
99
The end function, which is called following the test function, is used 
 
100
primarily to destroy any non-cachable server resources used by the test, and 
 
101
to free any memory which was dynamically allocated by the client. Some tests, 
 
102
such as -modify1, -await, -abort, and -redefine, perform additional steps 
 
103
within the test function inner loop, as required by the element being tested, 
 
104
or in an attempt to make the test more visually appealing. 
 
105
.PP
 
106
Evaluating the performance of individual XIE elements is not
 
107
as simple as measuring Core X drawing times. The XIE
 
108
protocol requires elements to be embedded within photoflos
 
109
in order to be exercised,  and the minimum possible photoflo
 
110
size is two.  This implies that it is impossible to measure
 
111
performance of a single element in isolation - the time it
 
112
takes to run the flo depends on what other elements exist in 
 
113
the flo.  Extrapolating performance of a single elment 
 
114
(or technique) in a flo must be done carefully, on a case-by-case 
 
115
basis,  since in general measured element performance depends on 
 
116
input image size, data type, and other factors,  all of which can 
 
117
be influenced by upstream flo elements.  Note further that the
 
118
number and type of elements in a flo can be influenced by the 
 
119
visuals available on the display,  so even flo-flo comparisons 
 
120
on machines with different visuals must be done with caution.
 
121
.PP 
 
122
Many test labels contain an abbreviated pipeline description. For
 
123
instance. IP/IL/P/ED indicates ImportPhotomap, ImportLUT, Point, and
 
124
ExportDrawable. Pipelines ending in ED (ExportDrawable) often include
 
125
hidden elements such as BandExtract, ConvertToIndex, Dither, or Point
 
126
to match the flo output to the screen visual.  Pipelines ending in EP
 
127
(ExportPhotomap) will result in a blank window.
 
128
.PP
 
129
.I xieperf
 
130
is compatible with 
 
131
.I x11perfcomp(1), 
 
132
which is used to compare the outputs of different 
 
133
.I xieperf
 
134
and
 
135
.I x11perf
 
136
runs in a nice, tabular format. In
 
137
.I xieperf
 
138
you will need to use the -labels option (see OPTIONS, below), and provide
 
139
the resulting labels file to 
 
140
.I x11perfcomp(1)
 
141
to obtain correct output. See the
 
142
.I x11perfcomp(1)
 
143
man pages for more details on this. 
 
144
.SH OPTIONS
 
145
.I xieperf 
 
146
accepts the options listed below:
 
147
.TP 14
 
148
.B \-display host:dpy
 
149
Specifies which display to use.
 
150
.TP 14
 
151
.B \-images \fI<path>\fP
 
152
Normally,
 
153
.I xieperf
 
154
references image files located in the directory ``images'', which 
 
155
.I xieperf
 
156
assumes is located in your current directory. If the ``images'' directory is 
 
157
not in your current directory, or the file has been renamed, use this option 
 
158
to specify its location.
 
159
.TP 14
 
160
.B \-timeout \fI<s>\fP
 
161
Some tests require the reception of an event such as FloNotify to continue, and
 
162
may cause 
 
163
.I xieperf 
 
164
to hang should these events not be received. This option allows the user to 
 
165
specify a timeout value which, if exceeded, will cause
 
166
.I xieperf
 
167
to give up waiting for an event, and continue on with the next test in sequence.
 
168
Should an event timeout, a warning message will be printed to stderr. The 
 
169
default timeout value is 60 seconds. 
 
170
.TP 14
 
171
.B \-sync
 
172
Runs the tests in synchronous mode.
 
173
.TP 14
 
174
.B \-script \fI<file>\fP
 
175
Using this option gives the user the ability to run a subset of the available
 
176
tests and control the number of times the tests are executed on an individual
 
177
basis. This is thought to be especially useful for those running
 
178
.I xieperf
 
179
for demonstration purposes. Using this option causes 
 
180
.I xieperf
 
181
to read commands specified in a script file, or from stdin if \fI<file>\fP is 
 
182
``-''. Tests are specified by newline-terminated input lines of the form 
 
183
"command [-reps n ] [ -repeat m ]".  Characters following and including "#" 
 
184
are treated as comments. See the -mkscript option.
 
185
.TP 14
 
186
.B \-repeat \fI<n>\fP
 
187
Repeats each test 
 
188
.I n
 
189
times (by default each test is run 2 times). This option may be used in
 
190
script files also, in which case the script file -repeat overrides the
 
191
command line option. 
 
192
.TP 14
 
193
.B \-time \fI<s>\fP
 
194
Specifies how long in seconds each test should be run (default 5 seconds).
 
195
.TP 14
 
196
.B \-depth <depth>
 
197
Use a visual with <depth> planes per pixel (default is the default
 
198
visual).
 
199
.TP 14
 
200
.B \-GrayScale
 
201
Use a GrayScale visual (default is the default visual). 
 
202
.TP 14
 
203
.B \-PseudoColor
 
204
Use a PseudoColor visual (default is the default visual). 
 
205
.TP 14
 
206
.B \-StaticGray
 
207
Use a StaticGray visual (default is the default visual). 
 
208
.TP 14
 
209
.B \-StaticColor
 
210
Use a StaticColor visual (default is the default visual). 
 
211
.TP 14
 
212
.B \-TrueColor
 
213
Use a TrueColor visual (default is the default visual). 
 
214
.TP 14
 
215
.B \-DirectColor
 
216
Use a DirectColor visual (default is the default visual). 
 
217
.TP 14
 
218
.B \-WMSafe
 
219
If
 
220
.I xieperf
 
221
must be run in a window manager environment, use this flag to make 
 
222
.I xieperf 
 
223
aware of this. If specified,
 
224
.I xieperf
 
225
will create a window, identical to the size of the root window, and all
 
226
further windows created by
 
227
.I xieperf
 
228
will be transient popup children of this window. If this flag is omitted,
 
229
.I xieperf
 
230
will set the override_redirect attribute of all windows to ``True'' 
 
231
and will also do evil things such as calling XInstallColormap. 
 
232
Using this option will cause the window 
 
233
manager to (hopefully) obey window geometry hints specified by 
 
234
.I xieperf
 
235
.TP 14
 
236
.B \-showtechs
 
237
Display a comprehensive list of techniques, by category, indicating which of
 
238
the techniques are supported by the XIE server.
 
239
.TP 14
 
240
.B \-showlabels
 
241
Print test label to screen prior to calling any of the test code. This allows
 
242
the user to know which test is executing in case the test hangs for some reason.
 
243
.TP 14
 
244
.B \-showevents
 
245
Be verbose when running event and error tests. Also, can be used to catch and
 
246
display information on any signals received during execution of
 
247
.I xieperf
 
248
. Note that this flag is best used in a debugging situation, or to validate
 
249
that the error events received by 
 
250
.I xieperf
 
251
are valid the first time the tests are executed on a new platform.
 
252
.TP 14
 
253
.B \-events
 
254
Run tests which test for event generation.
 
255
.TP 14
 
256
.B \-errors
 
257
Run tests which test for error event generation.
 
258
.TP 14
 
259
.B \-loCal
 
260
Skip test calibration. This may be used when running 
 
261
.I xieperf 
 
262
in situations where execution timing is not important. Execution times will
 
263
not be reported by 
 
264
.I xieperf
 
265
when this option is enabled. The inner loop repeat count, additionally, is 
 
266
set to a value of 5 (but can be overridden by the -reps option).
 
267
.TP 14
 
268
.B \-all
 
269
Runs all tests. This may take a while, depending on the speed of your machine,
 
270
and its floating point capabilities. This option is ignored if a script file
 
271
is used.
 
272
.TP 14
 
273
.B \-tests
 
274
Generate a list of the available tests for the
 
275
.I xieperf
 
276
program. In
 
277
.I x11perf
 
278
, this list is normally displayed in the usage statement. It was yanked from 
 
279
the usage of
 
280
.I xieperf
 
281
because it was too lengthy. 
 
282
.TP 14
 
283
.B \-mkscript
 
284
Generate a script file suitable for use with the script option. If -repeat
 
285
or -reps are also specified, they will be automatically placed at the end
 
286
of each command in the script. The script is generated to stderr. See the
 
287
-script command, above.
 
288
.TP 14
 
289
.B \-cache \fI<n>\fP
 
290
Most test flos utilize a photomap resource for a source.  A photomap cache
 
291
of up to n entries is controlled by 
 
292
.I xieperf
 
293
to avoid having to constantly reload these images during test initialization.
 
294
The default cache size is 4. If a value less than the default is specified, the cache size will be set to the default.
 
295
.TP 14
 
296
.B \-labels
 
297
Generates just the descriptive labels for each test specified. Use -all or
 
298
-range to specify which tests are included. See
 
299
.I x11perfcomp(1)
 
300
for more details.
 
301
.TP 14
 
302
.B \-DIS
 
303
Pretend we are running 
 
304
.I xieperf
 
305
while connected to a DIS-only capable implementation of XIE. This will cause
 
306
.I xieperf
 
307
to execute those tests which only use protocol requests found in the DIS subset of 
 
308
XIE, and bypass those which are not DIS compatible. If 
 
309
.I xieperf
 
310
detects a DIS server, it will do this automatically, and this option is ignored.
 
311
Use -all or -range to specify the initial range of tests.
 
312
.TP 14
 
313
.B \-range \fI<test1>\fP[,\fI<test2>\fP]
 
314
Runs all the tests starting from the specified name \fItest1\fP until
 
315
the name \fItest2\fP, including both the specified tests. Some tests, 
 
316
like the event and error tests, also require the -errors or -events
 
317
options to specified. This option is ignored if a script it used.
 
318
.TP 14
 
319
.B \-reps \fI<n>\fP
 
320
Fix the inner loop repetitions to n. This indicates how many time the photoflo
 
321
will be executed each time the test is run. This option is overridden on a 
 
322
per-test basis if specified in a script. Typically, 
 
323
.I xieperf 
 
324
determines the ideal number of reps during each test's calibration period. 
 
325
.TP 14
 
326
.B \-ImportObscuredEvent through \-ExportAvailable
 
327
Test generation of events. Requires -events flag.
 
328
.TP 14
 
329
.B \-BadValue through \-FloValueError           
 
330
Test generation of errors. Requires -errors flag. 
 
331
.B \-ColorList
 
332
Create and destroy ColorList resource test.         
 
333
.TP 14
 
334
.B \-LUT                
 
335
Create and destroy LUT resource test.         
 
336
.TP 14
 
337
.B \-Photomap         
 
338
Create and destroy Photomap resource test.         
 
339
.TP 14
 
340
.B \-ROI              
 
341
Create and destroy ROI resource test.         
 
342
.TP 14
 
343
.B \-Photospace       
 
344
Create and destroy Photospace test.         
 
345
.TP 14
 
346
.B \-Photoflo         
 
347
Create and destroy Photoflo test.         
 
348
.TP 14
 
349
.B \-QueryPhotomap    
 
350
Query Photomap resource test.
 
351
.TP 14
 
352
.B \-QueryColorList   
 
353
Query ColorList resource test.
 
354
.TP 14
 
355
.B \-QueryTechniquesDefault through \-QueryTechniquesWhiteAdjust
 
356
Query techniques as specified by test name.
 
357
.TP 14
 
358
.B \-QueryPhotoflo        
 
359
Query photoflo test.
 
360
.TP 14
 
361
.B \-PurgeColorList       
 
362
PurgeColorList test.
 
363
.TP 14
 
364
.B \-Abort 
 
365
This tests creates a photoflo which is started and blocks for data provided by 
 
366
PutClientData(). Instead of sending the data, the test uses XieAbort() to
 
367
stop the photoflo, and then waits for PhotofloDone event to be send by the
 
368
server. If the test times out waiting for the event, a error message is sent
 
369
to stderr. 
 
370
.TP 14
 
371
.B \-Await                
 
372
This test creates a flo of the form ImportClientLUT -> ExportLUT, and starts
 
373
the flo executing. 
 
374
.I xieperf
 
375
then forks, and the child process streams the LUT data to the flo using 
 
376
PutClientData, while the parent blocks in XieAwait. If the flo successfully
 
377
finishes, XieAwait will return and the flo state, after query, will indicate
 
378
that it has completed. If XieAwait does not complete naturally, or after return 
 
379
from XieAwait the flo is still active, an error is reported to stderr. Note, on
 
380
a really slow machine, it is possible that XieAwait will return before the
 
381
flo has a chance to finish. In this case, use the -timeout option to increase
 
382
the timeout for this test.
 
383
.TP 14
 
384
.B \-importclientlut1     
 
385
ImportClientLUT -> ExportLUT test.
 
386
.TP 14
 
387
.B \-importclientphoto1 through \-importclientphoto9 
 
388
Flos of the form ImportClientPhoto -> ExportPhotomap using various
 
389
decode techniques, e.g. G32D, TIFF2, UncompressedTriple, and so forth. 
 
390
.TP 14
 
391
.B \-importclientroi1    
 
392
ImportClientROI with 10 rectangles.
 
393
.TP 14
 
394
.B \-importclientroi2    
 
395
ImportClientROI with 100 rectangles.
 
396
.TP 14
 
397
.B \-encodephoto1 through \-encodephoto14
 
398
Flos of the form ImportPhotomap -> ExportPhotomap using various
 
399
encode techniques, e.g. G32D, TIFF2, UncompressedTriple, and so forth.
 
400
Original encoding is shown in left window, image after encoding is 
 
401
shown in right window. 
 
402
.TP 14
 
403
.B \-encodeclientphoto1 through \-encodeclientphoto11  
 
404
Two flos, one of the form ImportPhotomap -> ExportClientPhoto, and the
 
405
other of the form ImportClientPhoto -> ExportPhotomap, where ExportClientPhoto
 
406
in the first flo uses various encode techniques, e.g. G32D, TIFF2, 
 
407
UncompressedTriple, and so forth. The image before encoding is displayed in
 
408
the left window, while the right window shows the image which was encoded
 
409
in the first flo and read back in the second flo.
 
410
.TP 14
 
411
.B \-exportclientlut1    
 
412
ExportClientLUT test. LUT is displayed in a histogram window. 
 
413
.TP 14
 
414
.B \-exportclientroi1         
 
415
ExportClientROI test, 10 ROIs. The ROIs which are sent to the server are 
 
416
represented by the filled rectangles. The ROIs which are received back from
 
417
the server by the client are drawn as white bordered non-filled rectangles.
 
418
The resulting output illustrates how the server combined the rectangles sent 
 
419
to it.
 
420
.TP 14
 
421
.B \-exportclientroi2         
 
422
Same as exportclientroi1, except using 100 rectangles.
 
423
.TP 14
 
424
.B \-exportclienthistogram1 through \-exportclienthistogram4
 
425
ExportClientHistogram tests using various images. The histogram is displayed
 
426
in a window which overlaps the image.   
 
427
.TP 14
 
428
.B \-exportclienthistogramroi1 through \-exportclienthistogramroi4
 
429
Same as the ExportClientHistogram test, but using a ROI to identify the area
 
430
of interest.
 
431
.TP 14
 
432
.B \-exportclienthistogramcplane1 through \-exportclienthistogramcplane4
 
433
Same as the ExportClientHistogram test, but using a Control Plane to identify the area of interest.
 
434
.TP 14
 
435
.B \-importlut1
 
436
Test ImportLUT element, LUT size is 256.
 
437
.TP 14
 
438
.B \-importphoto1
 
439
ImportPhotomap -> ExportPhotomap, with source and destination equal.
 
440
.TP 14
 
441
.B \-importphoto2
 
442
ImportPhotomap -> ExportDrawable, window destination.        
 
443
.TP 14
 
444
.B \-importroi1            
 
445
ImportROI -> ExportROI, 10 rectangles, source and destination ROIs equal.
 
446
.TP 14
 
447
.B \-importroi2            
 
448
ImportROI -> ExportROI, 100 rectangles, source and destination ROIs equal.
 
449
.TP 14
 
450
.B \-importdrawable1
 
451
ImportDrawable -> ExportDrawable, Source is pixmap, destination is window. 
 
452
.TP 14
 
453
.B \-importdrawable2      
 
454
ImportDrawable -> ExportDrawable, Source and destination is window. 
 
455
.TP 14
 
456
.B \-importdrawable3      
 
457
ImportDrawable -> ExportDrawable, Destination window obscured by source window. 
 
458
.TP 14
 
459
.B \-importdrawable4      
 
460
ImportDrawable -> ExportDrawable, Source window obscured by destination window. 
 
461
.TP 14
 
462
.B \-importdrawable5      
 
463
ImportDrawablePlane -> ExportDrawablePlane, pixmap, source = destination.
 
464
.TP 14
 
465
.B \-importdrawable6      
 
466
ImportDrawablePlane -> ExportDrawablePlane, window, source = destination.
 
467
.TP 14
 
468
.B \-importdrawable7      
 
469
ImportDrawablePlane -> ExportDrawablePlane, window, source obscures destination.
 
470
.TP 14
 
471
.B \-importdrawable8      
 
472
ImportDrawablePlane -> ExportDrawablePlane, window, destination obscures source.
 
473
.TP 14
 
474
.B \-constrain1
 
475
Constrain HardClip technique test, drawable destination.          
 
476
.TP 14
 
477
.B \-constrain2           
 
478
Constrain ClipScale technique test, drawable destination.
 
479
.TP 14
 
480
.B \-constrainphoto1      
 
481
Constrain HardClip technique test, photomap destination.
 
482
.TP 14
 
483
.B \-constrainphoto2      
 
484
Constrain ClipScale technique test, photomap destination.
 
485
.TP 14
 
486
.B \-convolve1            
 
487
Boxcar 3x3 convolution test. Smoothing or lowpass filter.
 
488
.TP 14
 
489
.B \-convolve2            
 
490
Boxcar 5x5 convolution test. Smoothing or lowpass filter.
 
491
.TP 14
 
492
.B \-convolve3
 
493
LaPlacian 3x3 convolution test. Edge or highpass filter. 
 
494
.TP 14
 
495
.B \-convolve4            
 
496
LaPlacian 5x5 convolution test. Edge or highpass filter.
 
497
.TP 14
 
498
.B \-convolveroi1         
 
499
LaPlacian 3x3 convolution test, with ROI.
 
500
.TP 14
 
501
.B \-convolveroi2         
 
502
LaPlacian 5x5 convolution test, with ROI.
 
503
.TP 14
 
504
.B \-convolvecplane1         
 
505
LaPlacian 3x3 convolution test, with Control Plane.
 
506
.TP 14
 
507
.B \-convolvecplane2         
 
508
LaPlacian 5x5 convolution test, with Control Plane.
 
509
.TP 14
 
510
.B \-math1 through \-mathcplane7
 
511
Various tests which exercise the Math element, some tests using ROIs and control planes. 
 
512
.TP 14
 
513
.B \-arithmeticdyadic1 through \-arithmeticdyadic5
 
514
Arithmetic element tests, using photomaps as the operands.    
 
515
.TP 14
 
516
.B \-arithmeticmonadic1 through \-arithmeticmonadic9
 
517
Arithmetic element tests, photomap and constant operands. 
 
518
.TP 14
 
519
.B \-arithmeticdyadicroi1 through \-arithmeticdyadicroi5   
 
520
Arithmetic element tests, using photomaps as the operands, with ROIs.
 
521
.TP 14
 
522
.B \-arithmeticmonadicroi1 through \-arithmeticmonadicroi9 
 
523
Arithmetic element tests, photomap and constant operands, with ROIs. 
 
524
.TP 14
 
525
.B \-arithmeticdyadiccplane1 through \-arithmeticdyadiccplane5   
 
526
Arithmetic element tests, using photomaps as the operands, with Control Planes.
 
527
.TP 14
 
528
.B \-arithmeticmonadiccplane1 through \-arithmeticmonadiccplane9 
 
529
Arithmetic element tests, photomap and constant operands, with Control Planes. 
 
530
.TP 14
 
531
.B \-arithmeticfloatdyadic1 though \-arithmeticfloatdyadic5 
 
532
Arithmetic element tests, using photomaps as the operands, unconstrained.
 
533
.TP 14
 
534
.B \-arithmeticfloatmonadic1 though \-arithmeticfloatmonadic9
 
535
Arithmetic element tests, photomap and constant operands, unconstrained.
 
536
.TP 14
 
537
.B \-arithmeticroifloatdyadic1 to \-arithmeticroifloatdyadic5 
 
538
Arithmetic element tests, photomaps as the operands, ROIs, unconstrained.
 
539
.TP 14
 
540
.B \-arithmeticroifloatmonadic1 to -\arithmeticroifloatmonadic9
 
541
Arithmetic element tests, photomap and constant operands, ROIs, unconstrained.
 
542
.TP 14
 
543
.B \-band1
 
544
BandSelect element test. Image input is triple band. If visual of 
 
545
.I xieperf
 
546
window is a color visual, then three BandSelect elements are used to extract
 
547
the indivudual bands, they are combined once again using BandCombine, and
 
548
displayed using ConvertToIndex. If the visual is not color, e.g. GrayScale or
 
549
StaticGray, then the flo simply uses one BandSelect element to extract a single
 
550
band for display.
 
551
.TP 14
 
552
.B \-band2                    
 
553
BandCombine test. Input bands are made of of three separate single band 
 
554
photomaps. These are combined using a BandCombine element, which is 
 
555
followed by a BandExtract and ExportDrawable. CCIR 601-1 coefficients.
 
556
.TP 14
 
557
.B \-band3
 
558
BandExtract test. Input is a triple band photomap. CCIR 601-1 coefficients.
 
559
Destination window colormap is gray ramp.
 
560
.TP 14
 
561
.B \-band4
 
562
BandExtract test. Input is a triple band photomap. CCIR 601-1 coefficients.
 
563
Destination window colormap is RGB_BEST_MAP standard colormap.
 
564
.TP 14
 
565
.B \-band5                 
 
566
BandExtract test. Input is a triple band photomap. CCIR 601-1 coefficients.
 
567
Destination window colormap is RGB_DEFAULT_MAP standard colormap.
 
568
.TP 14
 
569
.B \-comparedyadic1 through \-comparedyadic6        
 
570
Test various Compare operators with dyadic photomap operands.
 
571
.TP 14
 
572
.B \-comparemonadic1 through \-comparemonadic6      
 
573
Test various compare operators with photomap, constant operands.
 
574
.TP 14
 
575
.B \-compareroidyadic1 through \-compareroidyadic6   
 
576
Test various Compare operators with dyadic photomap operands, using ROIs.
 
577
.TP 14
 
578
.B \-compareroimonadic1 through \-compareroimonadic6  
 
579
Test various compare operators with photomap, constant operands, using ROIs.
 
580
.TP 14
 
581
.B \-comparecplanedyadic1 through \-comparecplanedyadic6   
 
582
Test various Compare operators with dyadic photomap operands, Control Planes.
 
583
.TP 14
 
584
.B \-comparecplanemonadic1 through \-comparecplanemonadic6  
 
585
Test various compare operators with photomap, constant operands, Control Planes.
 
586
.TP 14
 
587
.B \-matchhistogram1 through \-matchhistogram18     
 
588
MatchHistogram element tests, using various images and histogram matching techniques.
 
589
.TP 14
 
590
.B \-matchhistogramroi1 through \-matchhistogramroi6 
 
591
A selection of MatchHistogram element tests, with ROIs.
 
592
.TP 14
 
593
.B \-matchhistogramcplane1 through \-matchhistogramcplane6 
 
594
A selection of MatchHistogram element tests, with Control Planes.
 
595
.TP 14
 
596
.B \-unconstrain1
 
597
ImportPhotomap, Unconstrain, Constrain(ClipScale), ExportDrawable test.
 
598
.TP 14
 
599
.B \-pasteup1 through \-pasteup2            
 
600
PasteUp element tests.
 
601
.TP 14
 
602
.B \-geometry1 through \-geometry14           
 
603
Geometry element tests, including rotations, scales, and mirroring. 
 
604
NearestNeighbor technique.
 
605
.TP 14 
 
606
.B \-geometry15 through \-geometry28         
 
607
Geometry element tests, including rotations, scales, and mirroring. 
 
608
AntiAlias technique.
 
609
.TP 14
 
610
.B \-geometry29 through \-geometry42       
 
611
Geometry element tests, including rotations, scales, and mirroring. 
 
612
BilinearInterpolation technique.
 
613
.TP 14
 
614
.B \-geomg31dscale1 through \-geometryfaxradio1     
 
615
Tests to exercise the various FAX decoders and the Geometry element.
 
616
.TP 14
 
617
.B \-dither1            
 
618
Dither test, ErrorDiffusion dither technique, ExportDrawable.
 
619
.TP 14
 
620
.B \-dither2            
 
621
Dither test, ErrorDiffusion dither technique, ExportDrawablePlane.
 
622
.TP 14
 
623
.B \-dither3            
 
624
Dither test, Ordered(4) dither technique, ExportDrawable.
 
625
.TP 14
 
626
.B \-dither4
 
627
Dither test, Ordered(4) dither technique, ExportDrawablePlane.
 
628
.TP 14
 
629
.B \-dither5
 
630
Dither test, Ordered(8) dither technique, ExportDrawable.
 
631
.TP 14
 
632
.B \-dither6            
 
633
Dither test, Ordered(8) dither technique, ExportDrawablePlane.
 
634
.TP 14
 
635
.B \-dither7
 
636
Dither test, Default dither technique, ExportDrawable.
 
637
.TP 14
 
638
.B \-dither8             
 
639
Dither test, Default dither technique, ExportDrawablePlane.
 
640
.TP 14
 
641
.B \-logicalmonadic1 through \-logicalmonadic16     
 
642
Logical element, photomap and a constant of 0 as operands, various operators.
 
643
.TP 14
 
644
.B \-logicaldyadic1 through \-logicaldyadic16      
 
645
Logical element tests, dyadic photomaps as operands, various operators.
 
646
.TP 14
 
647
.B \-logicalmonadicroi1 through \-logicalmonadicroi16     
 
648
Logical element, photomap and constant of 0 operands, various operators, ROIs.
 
649
.TP 14
 
650
.B \-logicaldyadicroi1 through \-logicaldyadicroi16      
 
651
Logical element, dyadic photomaps as operands, various operators, ROIs.
 
652
.TP 14
 
653
.B \-logicalmonadiccplane1 through \-logicalmonadiccplane16     
 
654
Logical element, photomap and constant of 0 operands, various operators, Control Planes. 
 
655
.TP 14
 
656
.B \-logicaldyadiccplane1 through \-logicaldyadiccplane16      
 
657
Logical element, dyadic photomaps as operands, various operators, Control Planes. 
 
658
.TP 14
 
659
.B \-blend1                  
 
660
Blend element test. Monadic source, 0.1 source constant. Alpha constant of 0.5.
 
661
.TP 14
 
662
.B \-blend2                 
 
663
Blend element test. Dyadic sources. Alpha constant of 0.5.
 
664
.TP 14
 
665
.B \-blendroi1             
 
666
Blend test. Monadic source, 0.1 source constant. Alpha constant of 0.5. ROIs.
 
667
.TP 14
 
668
.B \-blendroi2            
 
669
Blend element test. Dyadic sources. Alpha constant of 0.5. Uses ROIs.
 
670
.TP 14
 
671
.B \-blendcplane1             
 
672
Blend test. Monadic source, 0.1 source constant. Alpha constant of 0.5. Control Plane.
 
673
.TP 14
 
674
.B \-blendcplane2            
 
675
Blend element test. Dyadic sources. Alpha constant of 0.5. Control Plane. 
 
676
.TP 14
 
677
.B \-blendalpha1
 
678
Blend test. Monadic source, 220 source constant. Alpha plane is a photomap.
 
679
.TP 14
 
680
.B \-blendalpha2        
 
681
Blend test. Dyadic sources. Alpha plane is a constant 220.      
 
682
.TP 14
 
683
.B \-blendalpharoi1    
 
684
Blend test. Monadic source, 220 source constant. Alpha plane photomap. ROIs.
 
685
.TP 14
 
686
.B \-blendalpharoi2   
 
687
Blend test. Dyadic sources. Alpha plane is a constant 220. ROIs.     
 
688
.TP 14
 
689
.B \-triplepoint1 through \-triplepoint2
 
690
Illustrate use of point and Standard colormaps for rendering triple band images.
 
691
.TP 14
 
692
.B \-funnyencode1 through \-funnyencode8
 
693
These tests are design to perform limited exercising of XIE's capability of
 
694
dealing with various encodings of flo source data. The test init function
 
695
obtains a photomap using ICP -> EP. A series of independent permanent flo pairs,
 
696
one of the form IP -> EP, and the other of the basic form IP -> ED, are 
 
697
constructed. The encoding parameters for the ExportPhotomap (EP) element
 
698
in the first flo are derived from test configuration. The number of flo
 
699
pairs created is also dependent upon test configuration. The tests can
 
700
be configured so that the test init function will constrain the input
 
701
photomap to a specified number of levels, on a per-band basis, so that
 
702
word-sized and quad-sized pixels are passed through the flos. Some tests
 
703
below take advantage of this. See tests.c for test configuration, and
 
704
hints on how to add similar tests. 
 
705
.TP 14
 
706
.B \-point1 through \-point3        
 
707
Simple Point element tests. Drawable destination.
 
708
.B \-pointroi1   
 
709
Simple Point element test which uses ROIs. Drawable destination.
 
710
.TP 14
 
711
.B \-pointcplane1   
 
712
Simple Point element test which uses a Control Plane. Drawable destination.
 
713
.TP 14
 
714
.B \-pointphoto1             
 
715
Simple Point element test. Photomap destination.
 
716
.TP 14
 
717
.B \-pointroiphoto1         
 
718
Simple Point element test which uses a ROIs. Photomap destination.
 
719
.TP 14
 
720
.B \-pointcplanephoto1         
 
721
Simple Point element test which uses a Control Plane. Photomap destination.
 
722
.TP 14
 
723
.B \-redefine
 
724
Two flographs are created which are the same in structure, expect for the
 
725
x and y offsets specified for the ExportDrawable flo elements. The test
 
726
init function creates a photoflo based upon one of the two flographs.
 
727
The inner loop of the test function uses XieRedefinePhotoflo() to alternate 
 
728
between each of the flographs. Make sure that your ineer loop reps are
 
729
2 or greater in order to exercise this test fully (see -reps).
 
730
.TP 14
 
731
.B \-modify1
 
732
Test XieModifyPhotoflo() by adjust ROI offsets and size.  
 
733
.TP 14
 
734
.B \-modify2             
 
735
Test XieModifyPhotoflo() by changing the LUT input to a Point element. 
 
736
.TP 14
 
737
.B \-modify3            
 
738
Test XieModifyPhotoflo() by changing ExportDrawable x and y offsets. 
 
739
.TP 14
 
740
.B \-modify4
 
741
This test creates a rather long flo of arithmetic elements, each which does 
 
742
nothing more than add 1 to a small image. The test init function 
 
743
scales the input photomap. The ExportDrawable x and y offset is modified
 
744
randomly during each iteration of the test function inner loop.
 
745
.TP 14
 
746
.B \-modify5          
 
747
This test creates a rather long flo of arithmetic elements, each which does 
 
748
nothing more than add 1 to a large image.  Each rep, the Geometry 
 
749
and ExportDrawable elements at the end of the flo are modifed to
 
750
crop a small piece of the
 
751
input into its appropriate place in the larger image.
 
752
.TP 14
 
753
.B \-rgb1 through \-rgb16
 
754
These tests all basically take an UncompressedTriple image as input, send it
 
755
to ConvertFromRGB which converts the image to some configured colorspace, 
 
756
and then send the converted image on to ConvertToRGB prior to display. The
 
757
original image is displayed in the lefthand window, and the image which has
 
758
passed through the flo is shown in the righthand window. The goal of these
 
759
test is to show that ConvertFromRGB -> ConvertToRGB is lossless. 
 
760
.TP 14
 
761
.B \-converttoindexpixel
 
762
ConvertToIndex test, TripleBand BandByPixel.
 
763
.TP 14
 
764
.B \-converttoindexplane
 
765
ConvertToIndex test, TripleBand BandByPlane.
 
766
.TP 14
 
767
.B \-convertfromindex 
 
768
The test init function uses a flo containing ConvertToIndex to display an
 
769
image in the left window. The test function uses this drawable as input
 
770
to a flo which does ConvertFromIndex -> ConvertToIndex and sends the
 
771
resulting image to the right window. The result should be lossless.
 
772
.TP 14
 
773
.B \-complex 
 
774
A somewhat large flo which uses control planes, LUTs, Point, PasteUp, Logical, Constrain, Dither, Geometry, MatchHistogram, BandCombine, and BandSelect elements. See the Postscript file ''complex.ps'' for a rendition of the photoflo which is executed.
 
775
.SH X DEFAULTS
 
776
There are no X defaults used by this program.
 
777
.SH "SEE ALSO"
 
778
X(__miscmansuffix__), x11perf(1), x11perfcomp(1)
 
779
.SH BUGS
 
780
There should be a IMAGES environment variable to augment the -images option.
 
781
.PP
 
782
Many tests only scratch the surface of possible test cases. 
 
783
Some of the options available for certain flo elements are either inadequately 
 
784
tested, or ignored altogether. 
 
785
There are insufficent tests for bitonal, large pixel, or triple band tests.
 
786
.PP 
 
787
Some of the test names are inconsistently cased, e.g. -Abort and -dither1.
 
788
.PP
 
789
Some tests are hopelessly slow when run against machines with slow FPUs.
 
790
.PP 
 
791
Bitonal images are for the most part displayed using the ExportDrawable flo 
 
792
element, however, ExportDrawablePlane would be a better choice.
 
793
.SH AUTHOR
 
794
Syd Logan, AGE Logic, Inc.