Rev | Author | # | Line |
---|---|---|---|
1 | perry | 1 | mdetect |
2 | !!!mdetect | ||
3 | NAME | ||
4 | SYNOPSIS | ||
5 | OPTIONS | ||
6 | DESCRIPTION | ||
7 | NOTES | ||
8 | DIAGNOSTICS | ||
9 | BUGS | ||
10 | AUTHORS | ||
11 | LICENSING | ||
12 | SEE ALSO | ||
13 | ---- | ||
14 | !!NAME | ||
15 | |||
16 | |||
17 | mdetect - mouse device autodetection tool | ||
18 | !!SYNOPSIS | ||
19 | |||
20 | |||
21 | mdetect [[''option ...''] | ||
22 | !!OPTIONS | ||
23 | |||
24 | |||
25 | mdetect may be run without arguments. | ||
26 | |||
27 | |||
28 | __-h__ | ||
29 | |||
30 | |||
31 | display a help message and exit | ||
32 | |||
33 | |||
34 | __-n__ | ||
35 | |||
36 | |||
37 | do not search for PnP (Plug 'n' Play) mice | ||
38 | |||
39 | |||
40 | __-r__ | ||
41 | |||
42 | |||
43 | [[not yet implemented] | ||
44 | |||
45 | |||
46 | __-v__ | ||
47 | |||
48 | |||
49 | be verbose; this option may be specified multiple times for | ||
50 | increasing levels of verbosity | ||
51 | |||
52 | |||
53 | __-o__ | ||
54 | |||
55 | |||
56 | produce output appropriate for XFree86 3.x | ||
57 | configuration | ||
58 | |||
59 | |||
60 | __-x__ | ||
61 | |||
62 | |||
63 | produce output appropriate for XFree86 4.x | ||
64 | configuration | ||
65 | !!DESCRIPTION | ||
66 | |||
67 | |||
68 | __mdetect__ is a tool for autoconfiguring mice and | ||
69 | compatible pointing devices; it is typically used as the | ||
70 | backend to some user-friendly frontend code that, for | ||
71 | example, asks the user to move the mouse for a moment. | ||
72 | __mdetect__ is then run while user is producing input on | ||
73 | the mouse device. While mouse motion during detection is | ||
74 | sometimes unnecessary, it is seldom | ||
75 | problematic. | ||
76 | |||
77 | |||
78 | __mdetect__ writes the autodetected mouse device and | ||
79 | protocol to standard output. Unless either of the __-o__ | ||
80 | or __-x__ options is given, __mdetect__ produces | ||
81 | output appropriate for configuring the gpm(1) | ||
82 | program. Alternatively, output appropriate for an XFree86 X | ||
83 | server configuration file is produced. If the __-v__ | ||
84 | option is given, some information about the program's status | ||
85 | is also written to standard output, but this is largely | ||
86 | unimplemented at this writing. | ||
87 | |||
88 | |||
89 | If __mdetect__ is unable to find a mouse device, it exits | ||
90 | after a few seconds of searching. | ||
91 | !!NOTES | ||
92 | |||
93 | |||
94 | Detection of serial and PS/2 devices is often aided by | ||
95 | moving the mouse while __mdetect__ runs. | ||
96 | |||
97 | |||
98 | Terminals connected to serial ports may display a small | ||
99 | amount of garbage to the screen while __mdetect__ probes | ||
100 | them, but this a harmless side-effect; the terminal's line | ||
101 | settings are restored after the port has been | ||
102 | probed. | ||
103 | !!DIAGNOSTICS | ||
104 | |||
105 | |||
106 | __mdetect__'s exit status is used to communicate | ||
107 | information. | ||
108 | |||
109 | |||
110 | 0 | ||
111 | |||
112 | |||
113 | __mdetect__ found a mouse and exited | ||
114 | normally. | ||
115 | |||
116 | |||
117 | 1 | ||
118 | |||
119 | |||
120 | An error occurred while attempting to read from the mouse | ||
121 | device. | ||
122 | |||
123 | |||
124 | 2 | ||
125 | |||
126 | |||
127 | __mdetect__ timed out and gave up searching for a mouse | ||
128 | device; this indicates either that no mouse device is | ||
129 | attached to the computer, or that a mouse device exists | ||
130 | which __mdetect__ knows nothing about. This also happens | ||
131 | if your only mouse device(s) are already open and in use; | ||
132 | for instance, by __gpm__ or an X Window System | ||
133 | server. | ||
134 | |||
135 | |||
136 | 3 | ||
137 | |||
138 | |||
139 | An error occurred while trying to set up __mdetect__'s | ||
140 | signal handler. | ||
141 | !!BUGS | ||
142 | |||
143 | |||
144 | Please report bugs in __mdetect__ to | ||
145 | __ | ||
146 | !!AUTHORS | ||
147 | |||
148 | |||
149 | __mdetect__ is copyright 1999 Caldera Systems, Inc. The | ||
150 | actual authors are unknown. Branden Robinson of Progeny | ||
151 | Linux Systems, Inc. and the Debian Project added several | ||
152 | enhancements, including the XFree86-aware code and this | ||
153 | manual page. Richard Hirst wrote code to save and restore | ||
154 | serial port settings. | ||
155 | !!LICENSING | ||
156 | |||
157 | |||
158 | The __mdetect__ source code is licensed under the Q | ||
159 | Public License (QPL); see | ||
160 | __ | ||
161 | |||
162 | |||
163 | This manual page is licensed under the GNU General Public | ||
164 | License. | ||
165 | !!SEE ALSO | ||
166 | |||
167 | |||
168 | gpm(1), ''XFree86''(1) | ||
169 | ---- |