fixed reading of argument for short option 'f' that I broke a while back
[comedilib.git] / man / comedi_calibrate.8
1 .TH comedi_calibrate 8 ""
2 .SH NAME
3 \fBcomedi_calibrate\fR - COMEDI calibration utility
4 .SH SYNOPSIS
5 \fBcomedi_calibrate\fR [-f /dev/comediN]
6 .br
7 .SH DESCRIPTION
8 \fBcomedi_calibrate\fR is used to autocalibrate \fBcomedi\fR
9 devices.  Some \fBcomedi\fR devices have the ability to
10 measure internal stable voltage references and control
11 gains and offsets using programmable DACs.  On these devices,
12 \fBcomedi_calibrate\fR adjusts the programmable calibration
13 DACs so that the measured value of reference voltages fall
14 within acceptable limits.  The calibration settings are
15 saved to a file which can be fed to the comedi_apply_calibration()
16 function.
17
18 \fBComedi_calibrate\fR prints a lot of debugging information
19 as it runs.
20
21 .SH LIMITATIONS
22
23 \fBComedi_calibrate\fR only works on boards that it understands.
24 For boards that are known to have autocalibration ability,
25 but are not currently supported, \fBcomedi_calibrate\fR will
26 output basic debugging information that is useful for
27 the author to add support for your device.  Please send this
28 output to him.
29
30
31 .SH OPTIONS
32
33 \fBcomedi_calibrate\fR  recognizes the following options:
34
35 \fB--[no-]calibrate\fR  Perform calibration (or not).
36
37 \fB-f, --file /dev/comediN\fR   perform calibration on device \fB/dev/comediN\fR
38
39 \fB--help\fR    print help for options then exit
40
41 \fB-q, --quiet\fR       don't generate output to stdout
42
43 \fB--[no-]reset\fR      Reset (or don't reset) calibration subdevice to
44 a reasonable starting point before
45 performing calibration.  The default is \fB--reset\fR.  The
46 \fB--no-reset\fR option is useful if
47 a single calibration
48 pass is not sufficient, and you wish to perform another calibration
49 pass starting from the results of the previous pass.
50
51 \fB-s, --save-file <file path>\fR       save calibration information to specified file,
52 instead of default location
53
54 \fB-v, --verbose\fR     generate more verbose output to stdout, can be specified multiple times
55
56
57 .SH SEE ALSO
58
59 \fBcomedi\fR(7)
60
61 .SH VERSION
62
63 0.7.x
64
65 .SH AUTHOR
66
67 David Schleef, <ds@schleef.org>
68