~ubuntu-branches/ubuntu/feisty/comedilib/feisty

« back to all changes in this revision

Viewing changes to man/comedi_config.8

  • Committer: Bazaar Package Importer
  • Author(s): David Schleef
  • Date: 2003-09-23 18:11:12 UTC
  • Revision ID: james.westby@ubuntu.com-20030923181112-sat05jyh702rb1at
Tags: upstream-0.7.21
ImportĀ upstreamĀ versionĀ 0.7.21

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH comedi_config 8 ""
 
2
.SH NAME
 
3
\fBcomedi_config\fR - COMEDI configuration utility
 
4
.SH SYNOPSIS
 
5
\fBcomedi_config\fR [-vVq] /dev/comediN <driver>
 
6
[<option1>[,<option2>...]]
 
7
.br
 
8
.SH DESCRIPTION
 
9
\fBcomedi_config\fR is used to configure \fBcomedi\fR drivers.
 
10
You must have \fBcomedi\fR support compiled
 
11
into your kernel or loaded as a separate module in order
 
12
to use this utility.
 
13
Each control and measurement device is associated with a
 
14
particular \fBcomedi\fR device file \fB/dev/comedi\fRN, where
 
15
N is 0,1,2,3, etc.
 
16
\fBComedi_config\fR allows you to associate a particular
 
17
driver and device with a \fBcomedi\fR device file, and also
 
18
configure driver parameters for the particular device.
 
19
 
 
20
\fBComedi_config\fR can be used with optional
 
21
parameters which are driver dependent.  Parameters are
 
22
specified by comma-delimited list of integers.  The integers
 
23
may be expressed as decimal, hexidecimal (starting with 0x)
 
24
or octal (stating with 0).  In addition, a parameter may be
 
25
left blank, indicating 0.  PCI-based devices typically
 
26
require no parameters, although some allow you to specify
 
27
the bus and slot of the card to configure
 
28
as the first two parameters.
 
29
ISA-based devices typically use
 
30
the first and second parameters to indicate I/O base
 
31
address and interrupt level.
 
32
 
 
33
More information about the parameters required by individual
 
34
drivers can be found in the \fBcomedi\fR documentation, in
 
35
the file \fBdrivers.txt\fR.
 
36
 
 
37
 
 
38
 
 
39
.SH OPTIONS
 
40
 
 
41
\fBcomedi_config\fR recognizes the following options:
 
42
 
 
43
\fB-q, --quiet\fR       don't print output while running.
 
44
 
 
45
\fB-v, --verbose\fR     print verbose output while running.
 
46
 
 
47
\fB-V, --version\fR     print version number and exit.
 
48
 
 
49
\fB-r, --remove\fR      remove previously configured driver.
 
50
 
 
51
.TP
 
52
.BI "--read-buffer " "num"
 
53
set read buffer size to
 
54
.I num
 
55
kilobytes.  The default size is 16k.
 
56
 
 
57
.TP
 
58
.BI "--write-buffer " "num"
 
59
set write buffer size to
 
60
.I num
 
61
kilobytes.  The default size is 16k.
 
62
 
 
63
 
 
64
.SH CONFIGURATION FILE
 
65
 
 
66
[This section has not been implemented yet.]
 
67
 
 
68
A list of device configurations can be put into the file
 
69
\fB/etc/comedi.conf\fR.  This file takes the form
 
70
 
 
71
        <device> <driver> <param1>,<param2>,...
 
72
 
 
73
These configurations will be read and performed when the
 
74
switch \fB-a\fR is used.  This is potentially useful when
 
75
run from an initialization script.
 
76
 
 
77
.SH EXAMPLES
 
78
 
 
79
A National Instruments PCI-MIO E series board can be
 
80
configured to use /dev/comedi0 using the command:
 
81
 
 
82
        comedi_config /dev/comedi0 ni_pcimio
 
83
 
 
84
A National Instruments AT-MIO E series board can be
 
85
configured to use /dev/comedi3 using the command:
 
86
 
 
87
        comedi_config /dev/comedi3 ni_atmio 0x220,3
 
88
 
 
89
This tells the driver that the board is configured
 
90
for I/O base 0x220 and IRQ 3.
 
91
 
 
92
.SH ADDITIONAL INFORMATION
 
93
 
 
94
Additional text documentation can be found in /usr/doc/comedilib-0.7.11.
 
95
The current version of \fBComedi\fR and \fBComedilib\fR can be
 
96
obtained from ftp://ftp.comedi.org/pub/comedi.  The Comedi web site
 
97
is located at http://www.comedi.org/comedi.
 
98
 
 
99
.SH SEE ALSO
 
100
 
 
101
\fBcomedi\fR(7) 
 
102
 
 
103
.SH VERSION
 
104
 
 
105
0.7.x
 
106
 
 
107
.SH AUTHOR
 
108
 
 
109
David Schleef, <ds@schleef.org>
 
110