added buffer resize options to man page
[comedilib.git] / man / comedi_config.8
1 .TH comedi_config 8 ""
2 .SH NAME
3 \fBcomedi_config\fR - COMEDI configuration utility
4 .SH SYNOPSIS
5 \fB/usr/sbin/comedi_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 .TP
50 .BI "--read-buffer " "num"
51 set read buffer size to
52 .I num
53 kilobytes.  The default size is 128k.
54
55 .TP
56 .BI "--write-buffer " "num"
57 set write buffer size to
58 .I num
59 kilobytes.  The default size is 128k.
60
61
62 .SH CONFIGURATION FILE
63
64 [This section has not been implemented yet.]
65
66 A list of device configurations can be put into the file
67 \fB/etc/comedi.conf\fR.  This file takes the form
68
69         <device> <driver> <param1>,<param2>,...
70
71 These configurations will be read and performed when the
72 switch \fB-a\fR is used.  This is potentially useful when
73 run from an initialization script.
74
75 .SH EXAMPLES
76
77 A National Instruments PCI-MIO E series board can be
78 configured to use /dev/comedi0 using the command:
79
80         /usr/sbin/comedi_config /dev/comedi0 ni_pcimio
81
82 A National Instruments AT-MIO E series board can be
83 configured to use /dev/comedi3 using the command:
84
85         /usr/sbin/comedi_config /dev/comedi3 ni_atmio 0x220,3
86
87 This tells the driver that the board is configured
88 for I/O base 0x220 and IRQ 3.
89
90 .SH ADDITIONAL INFORMATION
91
92 Additional text documentation can be found in /usr/doc/comedilib-0.7.11.
93 The current version of \fBComedi\fR and \fBComedilib\fR can be
94 obtained from ftp://stm.lbl.gov/pub/comedi.  The Comedi web site
95 is located at http://stm.lbl.gov/comedi.
96
97 .SH SEE ALSO
98
99 \fBcomedi\fR(7) 
100
101 .SH VERSION
102
103 0.7.x
104
105 .SH AUTHOR
106
107 David Schleef, <ds@schleef.org>
108