From: Frank Mori Hess <fmhess@speakeasy.net>
Date: Wed, 3 Dec 2003 01:47:39 +0000 (+0000)
Subject: trying to improve calibration docs
X-Git-Tag: r0_7_22~114
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=217924bcfe6f65975601a38a8f2134919ac55424;p=comedilib.git

trying to improve calibration docs
---

diff --git a/man/comedi_calibrate.8 b/man/comedi_calibrate.8
index 2fdbca5..184ca69 100644
--- a/man/comedi_calibrate.8
+++ b/man/comedi_calibrate.8
@@ -9,12 +9,32 @@
 devices.  Some \fBcomedi\fR devices have the ability to
 measure internal stable voltage references and control
 gains and offsets using programmable DACs.  On these devices,
-\fBcomedi_calibrate\fR adjusts the programmable calibration
-DACs so that the measured value of reference voltages fall
-within acceptable limits.  The calibration settings are
-saved to a file which can be fed to comedi_apply_calibration()
+\fBcomedi_calibrate\fR determines the proper values to
+feed into the programmable calibration
+DACs.  These calibration settings are then
+saved to a file, which can be fed to comedi_apply_calibration()
 and related functions.
 
+If comedi_calibrate finds an existing calibration file, it
+will not perform a new calibration by default.  It will
+simply read its calibration information from the file.
+This behaviour
+may be overriden with the
+.B \-\-calibrate
+option, to force a new calibration to be performed.
+
+After obtaining the calibration information for the board,
+comedi_calibrate will then apply a calibration setting
+appropriate for the specified subdevice, channel, and
+range (see the
+.B \-\-subdevice
+,
+.B \-\-channel
+, and
+.B \-\-range
+options below).  See the comedilib documentation for
+comedi_apply_calibration() for more information.
+
 \fBcomedi_calibrate\fR prints a lot of debugging information
 as it runs.