Add comedi_calibrate man page.

Downloaded from
  http://comedi.org/git?p=comedi/comedilib.git;a=blob_plain;f=man/comedi_calibrate.8;hb=HEAD
until I can get it moved into the comedi_calibrate repository.

diff --git a/ChangeLog b/ChangeLog
index 34f2b05aecf54b493320c6109784b36c55feb942..20acfc0fd62cd0f39c566b5cef320decb5ff8768 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -4,7 +4,7 @@
 
 *comedi-calibrate-9999 (27 Jan 2012)
   27 Jan 2012; W. Trevor King <wking@drexel.edu> ChangeLog, metadata.xml,
-      comedi-calibrate-9999.ebuild,
+      comedi-calibrate-9999.ebuild, comedi_calibrate.8,
       comedi-calibrate-9999-comedi_soft_calibrate-data-destdir.patch:
   - Created ebuild suite for comedi-calibrate.
   - Added initial ChangeLog which should be updated whenever the

diff --git a/Manifest b/Manifest
index 274165492c2b6f56cc05e87109fcca86258f9ad7..55584088b030c30107ededfb75bf067826320ff2 100644 (file)
--- a/Manifest
+++ b/Manifest
@@ -1,4 +1,5 @@
 AUX comedi-calibrate-9999-comedi_soft_calibrate-data-destdir.patch 515 RMD160 dcae09bccde0d5637a738b1bbc16dc7a97d71822 SHA1 6b4dee6c7e265aa328a9346de38bce8610a6a345 SHA256 f57712e52dab67cb7d1f45665ffe27d55ef77b3dcc1280b53a8d2032ea6d2cd7
-EBUILD comedi-calibrate-9999.ebuild 783 RMD160 72b8aca426709d041035f13e4e42ae413ab5a72b SHA1 8a4398e539271141b3314d419cd6d536cad9bfe5 SHA256 ec19176453d4f0107c75c3f2706acc03e29872747d74a3509cf69dd1b7d2aa9b
-MISC ChangeLog 772 RMD160 1c865d0e008452fcdeeee9ae0f1356437e0364e2 SHA1 2b6630c6474b7eae743a5401e58554284f9dfa51 SHA256 d41e4dbba7956d480b29d10b54bd4316cc67aa1d8be7d708a4fa4cd7e5d1628b
+AUX comedi_calibrate.8 4900 RMD160 64859e216bc54b4010c227bd3efa9ad9ce2c1d1e SHA1 78a575d045a874ed1bdceddece22049d8637e1ab SHA256 5f96b0e24cd5590197747d64d28e7ec99e724d4ea846f84abb921d4dc4a8fe2f
+EBUILD comedi-calibrate-9999.ebuild 904 RMD160 22da78f51581af2fef24be8a784a6c48475ffbd3 SHA1 a1e7e4c8a2ce0a4601869850fdcba68b15ed5014 SHA256 131efe1524b30914c07d3354eba7e5306675d2dd576702311d6049cf1f0527d0
+MISC ChangeLog 792 RMD160 6e22e5ed7fa1d3ef38fe8d11c420a0240f03e1ca SHA1 b98269489344612e965364e942f93a0b0406b1e9 SHA256 e2b6bbceb9fc1f9c61cda9b0a3324d67e5fa3de3adf6a241e0e06db50a865faa
 MISC metadata.xml 247 RMD160 6735f3a5dd2d7a2b70589d1693f35d54291b7147 SHA1 c015969fe50967340dd050a44cb9f8a30b5e34a5 SHA256 9e65060e5f9d0a50d28c7a69d9c27fed6c3037fdd3e420cc276627fde2794f72

diff --git a/comedi-calibrate-9999.ebuild b/comedi-calibrate-9999.ebuild
index 27a6c01bb1dec2721b1ad5144e490bdcf12967c1..c18f243b5ced0163ddf12fb3463af305ff260bf3 100644 (file)
--- a/comedi-calibrate-9999.ebuild
+++ b/comedi-calibrate-9999.ebuild
@@ -38,3 +38,10 @@ src_prepare()
                eautoreconf
        fi
 }
+
+src_install()
+{
+       emake DESTDIR="${D}" install
+       dodoc README AUTHORS ChangeLog
+       doman "${FILESDIR}/comedi_calibrate.8"
+}

diff --git a/files/comedi_calibrate.8 b/files/comedi_calibrate.8
new file mode 100644 (file)
index 0000000..b3c1f2f
--- /dev/null
+++ b/files/comedi_calibrate.8
@@ -0,0 +1,165 @@
+.TH comedi_calibrate 8 ""
+.SH NAME
+\fBcomedi_calibrate\fR - COMEDI calibration utility
+.SH SYNOPSIS
+\fBcomedi_calibrate\fR [-f /dev/comediN]
+.br
+.SH DESCRIPTION
+\fBcomedi_calibrate\fR is used to autocalibrate \fBcomedi\fR
+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 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.
+
+.SH LIMITATIONS
+
+\fBcomedi_calibrate\fR only works on boards that it understands.
+For boards that are known to have autocalibration ability,
+but are not currently supported, \fBcomedi_calibrate\fR will
+output basic debugging information that is useful for
+the author to add support for your device.  Please send this
+output to him.
+
+.SH EXAMPLES
+
+.TP
+.BI comedi_calibrate\ \-\-file\  /dev/comediN
+If no default calibration for \fI/dev/comediN\fR already exists,
+perform a calibration
+and save results to default location.
+
+.TP
+.BI comedi_calibrate\ \-\-calibrate
+Perform a calibration, using existing calibration (if it exists) as
+starting point.
+
+.TP
+.BI comedi_calibrate\ \-\-reset\ \-\-calibrate
+Perform a fresh calibration and save results to default location.
+
+.TP
+.BI comedi_calibrate\ \-\-no\-calibrate\ \-\-subdevice\  subd\  \-\-range\  range\  \-\-save\-file\  cal_file
+Apply calibration for subdevice \fIsubd\fR, range \fIrange\fR, using
+the settings in the calibration file \fIcal_file\fR.
+
+
+.SH OPTIONS
+
+\fBcomedi_calibrate\fR recognizes the following options:
+
+.TP
+.BI \-a\  aref ,\ \-\-aref\  aref
+Along with \fB--channel\fR, \fB--range\fR
+and \fB--subdevice\fR, this specifies which calibration you want comedi_calibrate
+leave applied to the board.  The default is 0.
+
+.TP
+.B \-\-[no\-]calibrate
+Force calibration to be performed (or not).
+By default, comedi_calibrate will only perform a new calibration if
+no existing calibration file is found (see \fB--save-file\fR).
+
+.TP
+.BI \-c\  channel, \-\-channel\  channel
+Along with \fB--subdevice\fR, \fB--range\fR
+and \fB--aref\fR, this specifies which calibration you want comedi_calibrate
+to leave applied to the board.  The default is 0.
+
+.TP
+.B \-\-[no\-]dump
+Perform (or not) dump of various information about
+state of calibration prior to performing new calibration.
+
+.TP
+.BI \-f\  /dev/comediN, \-\-file\  /dev/comediN
+Perform calibration on device \fB/dev/comediN\fR.
+
+.TP
+.B \-\-help
+Print help for options then exit.
+
+.TP
+.B \-q, \-\-quiet
+Don't generate output to stdout.
+
+.TP
+.BI \-r\  range ,\ \-\-range\  range
+Along with \fB--channel\fR, \fB--subdevice\fR
+and \fB--aref\fR, this specifies which calibration you want comedi_calibrate
+to leave applied to the board.  The default is 0.
+
+.TP
+.B \-\-[no\-]reset
+Reset (or don't reset) calibration subdevice to
+a reasonable starting point before
+performing calibration.  The default is \fB--no-reset\fR.  If
+\fB--no-reset\fR is used, the calibration routine will try to use
+an existing calibration (see \fB--save-file\fR) as a starting point.
+This is useful if
+a single calibration
+pass is not sufficient, and you wish to perform another calibration
+pass starting from the results of the previous pass.
+
+.TP
+.B \-\-[no\-]results
+Perform (or not) dump of various information about
+state of calibration after performing new calibration.
+
+.TP
+.BI \-S\  file ,\ \-\-save-file\  file
+Save calibration information to specified file,
+instead of default location.  If the file already exists, comedi_calibrate
+will also use its contents as a starting point for the calibration pass (see
+\fB--no-reset\fR).
+
+.TP
+.BI \-s\  subdevice ,\ \-\-subdevice\  subdevice
+Along with \fB--channel\fR, \fB--range\fR
+and \fB--aref\fR, this specifies which calibration you want comedi_calibrate
+to leave applied to the board.  The default is 0.
+
+.TP
+.B \-v, \-\-verbose
+Generate more verbose output to stdout, can be specified multiple times
+
+
+.SH SEE ALSO
+
+\fBcomedi\fR(7)
+
+.SH VERSION
+
+0.7.x
+
+.SH AUTHOR
+
+David Schleef, <ds@schleef.org>
+
+Frank Mori Hess, <fmhess@users.sourceforge.net>