freebsd-dev/share/man/man4/joy.4

.\"
.\" $FreeBSD$
.\"
.Dd January 23, 1995
.Dt JOY 4
.Os
.Sh NAME
.Nm joy
.Nd joystick device driver
.Sh SYNOPSIS
To compile this driver into the kernel,
place the following lines in your
kernel configuration file:
.Bd -ragged -offset indent
.Cd "device joy"
.Ed
.Pp
Alternatively, to load the driver as a
module at boot time, place the following line in
.Xr loader.conf 5 :
.Bd -literal -offset indent
joy_load="YES"
.Ed
.Pp
In
.Pa /boot/device.hints :
.Cd hint.joy.0.at="isa"
.Cd hint.joy.0.port="0x201"
.Cd hint.joy.1.at="isa"
.Cd hint.joy.1.port="0x201"
.Pp
.In sys/joystick.h
.Sh DESCRIPTION
The joystick device driver allows applications to read the status of
the PC joystick.
.Pp
This device may be opened by only one process at a time.
.Pp
The joystick status is read from a structure via a read()
call.
The structure is defined in the header file as follows:
.Bd -literal -offset indent
	struct joystick {
		int x;         /* x position */
		int y;         /* y position */
		int b1;	       /* button 1 status */
		int b2;	       /* button 2 status */
	};
.Ed
.Pp
Positions are typically in the range 0-2000.
.Ss One line perl example:
.Bd -literal -compact
perl -e 'open(JOY,"/dev/joy0")||die;while(1)
{sysread(JOY,$x,16);@j=unpack("iiii",$x);print "@j\\n";sleep(1);}'
.Ed
.Ss ioctl calls
Several ioctl() calls are also available.
They take an argument of
type int *
.Bl -tag -width JOY_SET_X_OFFSET
.It Dv JOY_SETTIMEOUT Fa int *limit
Set the time limit (in microseconds) for reading the joystick
status.
Setting a value
too small may prevent to get correct values for the positions (which
are then set to -2147483648), however this can be useful if one is
only interested by the buttons status.
.It Dv JOY_GETTIMEOUT Fa int *limit
Get the time limit (in microseconds) used for reading the joystick
status.
.It Dv JOY_SET_X_OFFSET Fa int *offset
Set the value to be added to the X position when reading the joystick
status.
.It Dv JOY_SET_Y_OFFSET Fa int *offset
Set the value to be added to the Y position when reading the joystick
status.
.It Dv JOY_GET_X_OFFSET Fa int *offset
Get the value which is added to the X position when reading the joystick
status.
.It Dv JOY_GET_Y_OFFSET Fa int *offset
Get the value which is added to the Y position when reading the joystick
status.
.El
.Sh TECHNICAL SPECIFICATIONS
The pinout of the DB-15 connector is as follow:
.Bd -literal
  1  XY1 (+5v)
  2  Switch 1
  3  X1 (potentiometer #1)
  4  Switch 1 (GND)
  5  Switch 2 (GND)
  6  Y1 (potentiometer #2)
  7  Switch 2
  8  N.C.
  9  XY2 (+5v)
 10  Switch 4
 11  X2 (potentiometer #3)
 12  Switch 3&4 (GND)
 13  Y2 (potentiometer #4)
 14  Switch 3
 15  N.C.
.Ed
.Pp
Pots are normally 0-150k variable resistors (0-100k sometimes), and
according to the IBM technical reference, the time is given by
Time = 24.2e-6s + 0.011e-6s * R/Ohms
.Sh FILES
.Bl -tag -width /dev/joy?
.It Pa /dev/joy?
joystick device files
.El
.Sh HISTORY
The
.Nm
driver appeared in
.Fx 2.0.5 .
.Sh AUTHORS
.An Jean-Marc Zucconi Aq Mt jmz@cabri.obs-besancon.fr
add missing cvs Id lines. 1997-03-07 02:50:01 +00:00			`.\"`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
add missing cvs Id lines. 1997-03-07 02:50:01 +00:00			`.\"`
Add joystick man page 1995-01-25 21:41:09 +00:00			`.Dd January 23, 1995`
Remove the MD part from the document title. Forgotten by: obrien 2001-02-20 11:07:27 +00:00			`.Dt JOY 4`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 15:31:11 +00:00			`.Os`
Add joystick man page 1995-01-25 21:41:09 +00:00			`.Sh NAME`
			`.Nm joy`
			`.Nd joystick device driver`
			`.Sh SYNOPSIS`
- Use the standard section 4 SYNOPSIS - Utilize .Nm MFC after: 3 days 2007-02-09 17:21:23 +00:00			`To compile this driver into the kernel,`
			`place the following lines in your`
			`kernel configuration file:`
			`.Bd -ragged -offset indent`
			`.Cd "device joy"`
			`.Ed`
Update the SYNOPSIS to reflect that the driver can be loaded as a module. While here, I also updated the kernel config style, although I wouldn't recommend doing this for the whole of section 4 yet, since our kernel config style is still in a state of flux. 2000-11-02 14:23:53 +00:00			`.Pp`
- Use the standard section 4 SYNOPSIS - Utilize .Nm MFC after: 3 days 2007-02-09 17:21:23 +00:00			`Alternatively, to load the driver as a`
			`module at boot time, place the following line in`
			`.Xr loader.conf 5 :`
			`.Bd -literal -offset indent`
Use the correct line to put into loader.conf. Duh! Clue bat applied by: ru Pointy hat to: brueffer 2007-02-12 20:58:32 +00:00			`joy_load="YES"`
- Use the standard section 4 SYNOPSIS - Utilize .Nm MFC after: 3 days 2007-02-09 17:21:23 +00:00			`.Ed`
Update the SYNOPSIS to reflect that the driver can be loaded as a module. While here, I also updated the kernel config style, although I wouldn't recommend doing this for the whole of section 4 yet, since our kernel config style is still in a state of flux. 2000-11-02 14:23:53 +00:00			`.Pp`
Update man pages in the section 4 to match the reality in -CURRENT. - Change lines referring to kernel configuration file: device foo0 at isa port xxx irq yyy... to device foo Describe resource "hints" in /boot/device.hints. - Try to describe resource allocation and probe/attach behavior in the newbus framework. 2001-10-13 09:08:37 +00:00			`In`
Fixed path to /boot/device.hints. 2002-07-12 13:44:37 +00:00			`.Pa /boot/device.hints :`
Update man pages in the section 4 to match the reality in -CURRENT. - Change lines referring to kernel configuration file: device foo0 at isa port xxx irq yyy... to device foo Describe resource "hints" in /boot/device.hints. - Try to describe resource allocation and probe/attach behavior in the newbus framework. 2001-10-13 09:08:37 +00:00			`.Cd hint.joy.0.at="isa"`
			`.Cd hint.joy.0.port="0x201"`
List /boot/device.hints entries for the second joystick. Approved by: joel 2005-11-11 12:53:37 +00:00			`.Cd hint.joy.1.at="isa"`
			`.Cd hint.joy.1.port="0x201"`
Update man pages in the section 4 to match the reality in -CURRENT. - Change lines referring to kernel configuration file: device foo0 at isa port xxx irq yyy... to device foo Describe resource "hints" in /boot/device.hints. - Try to describe resource allocation and probe/attach behavior in the newbus framework. 2001-10-13 09:08:37 +00:00			`.Pp`
Install sys/security/lomac/.h to /usr/include/security/lomac/. Install sys/<arch>/include/pc/.h to /usr/include/machine/pc/. PR: docs/29534 Install sys/netatm//.h to /usr/include/netatm/*/. Don't install compatibility symlinks for <machine/soundcard.h> and <machine/joystick.h>. Three years is enough to be aware of the change, and these weren't visible in the SHARED=symlinks case. Back out include/Makefile,v 1.160 that was a null change anyway due to the bug in the path, and we now don't want to install these headers because they would otherwise be invisible in the SHARED=symlinks case. Don't install IPFILTER headers. Userland utilities fetch them directly, and they were not visible in the SHARED=symlinks case. Resurrect SHARED=symlinks in Makefile.inc1. PR: bin/28002 Prodded by: bde MFC after: 2 weeks 2002-03-26 16:05:14 +00:00			`.In sys/joystick.h`
Add joystick man page 1995-01-25 21:41:09 +00:00			`.Sh DESCRIPTION`
			`The joystick device driver allows applications to read the status of`
			`the PC joystick.`
			`.Pp`
			`This device may be opened by only one process at a time.`
			`.Pp`
Fix confusing sentence, the PR noticed the sentence, I rewrote the sentence. PR: docs/11257 Submitted by: Motomichi Matsuzaki <mzaki@e-mail.ne.jp> 1999-05-06 20:51:31 +00:00			`The joystick status is read from a structure via a read()`
Remove single-space hard sentence breaks. These degrade the quality of the typeset output, tend to make diffs harder to read and provide bad examples for new-comers to mdoc. 2000-03-03 14:05:08 +00:00			`call.`
			`The structure is defined in the header file as follows:`
Put the joystick status in a struct {int x, y, b1, b2;} rather than in a dummy array of 4 integers. Declare the struct in the header file and update the man page. 1995-02-22 23:34:58 +00:00			`.Bd -literal -offset indent`
			`struct joystick {`
			`int x; /* x position */`
			`int y; /* y position */`
			`int b1; /* button 1 status */`
			`int b2; /* button 2 status */`
			`};`
			`.Ed`
			`.Pp`
			`Positions are typically in the range 0-2000.`
Add joystick man page 1995-01-25 21:41:09 +00:00			`.Ss One line perl example:`
Avoid use of direct troff requests in mdoc(7) manual pages. 2000-11-10 17:46:15 +00:00			`.Bd -literal -compact`
Add joystick man page 1995-01-25 21:41:09 +00:00			`perl -e 'open(JOY,"/dev/joy0")\|\|die;while(1)`
			`{sysread(JOY,$x,16);@j=unpack("iiii",$x);print "@j\\n";sleep(1);}'`
Avoid use of direct troff requests in mdoc(7) manual pages. 2000-11-10 17:46:15 +00:00			`.Ed`
Add joystick man page 1995-01-25 21:41:09 +00:00			`.Ss ioctl calls`
Remove single-space hard sentence breaks. These degrade the quality of the typeset output, tend to make diffs harder to read and provide bad examples for new-comers to mdoc. 2000-03-03 14:05:08 +00:00			`Several ioctl() calls are also available.`
			`They take an argument of`
Add joystick man page 1995-01-25 21:41:09 +00:00			`type int *`
Removed whitespace at end-of-line; no content changes. I simply did cd src/share; find man[1-9] -type f\|xargs perl -pi -e 's/[ \t]+$//' BTW, what editors are the culprits? I'm using vim and it shows me whitespace at EOL in troff files with a thick blue block... Reviewed by: Silence from cvs diff -b MFC after: 7 days 2001-07-14 19:41:16 +00:00			`.Bl -tag -width JOY_SET_X_OFFSET`
ioctl() args are JOY_SETTIMEOUT and JOY_GETTIMEOUT (only 1 underscore) 1995-12-09 17:31:08 +00:00			`.It Dv JOY_SETTIMEOUT Fa int *limit`
Add joystick man page 1995-01-25 21:41:09 +00:00			`Set the time limit (in microseconds) for reading the joystick`
Remove single-space hard sentence breaks. These degrade the quality of the typeset output, tend to make diffs harder to read and provide bad examples for new-comers to mdoc. 2000-03-03 14:05:08 +00:00			`status.`
			`Setting a value`
Add joystick man page 1995-01-25 21:41:09 +00:00			`too small may prevent to get correct values for the positions (which`
			`are then set to -2147483648), however this can be useful if one is`
Removed whitespace at end-of-line; no content changes. I simply did cd src/share; find man[1-9] -type f\|xargs perl -pi -e 's/[ \t]+$//' BTW, what editors are the culprits? I'm using vim and it shows me whitespace at EOL in troff files with a thick blue block... Reviewed by: Silence from cvs diff -b MFC after: 7 days 2001-07-14 19:41:16 +00:00			`only interested by the buttons status.`
ioctl() args are JOY_SETTIMEOUT and JOY_GETTIMEOUT (only 1 underscore) 1995-12-09 17:31:08 +00:00			`.It Dv JOY_GETTIMEOUT Fa int *limit`
Add joystick man page 1995-01-25 21:41:09 +00:00			`Get the time limit (in microseconds) used for reading the joystick`
Removed whitespace at end-of-line; no content changes. I simply did cd src/share; find man[1-9] -type f\|xargs perl -pi -e 's/[ \t]+$//' BTW, what editors are the culprits? I'm using vim and it shows me whitespace at EOL in troff files with a thick blue block... Reviewed by: Silence from cvs diff -b MFC after: 7 days 2001-07-14 19:41:16 +00:00			`status.`
Add joystick man page 1995-01-25 21:41:09 +00:00			`.It Dv JOY_SET_X_OFFSET Fa int *offset`
Mechanically kill hard sentence breaks and double whitespaces. 2004-07-03 18:29:24 +00:00			`Set the value to be added to the X position when reading the joystick`
Removed whitespace at end-of-line; no content changes. I simply did cd src/share; find man[1-9] -type f\|xargs perl -pi -e 's/[ \t]+$//' BTW, what editors are the culprits? I'm using vim and it shows me whitespace at EOL in troff files with a thick blue block... Reviewed by: Silence from cvs diff -b MFC after: 7 days 2001-07-14 19:41:16 +00:00			`status.`
Add joystick man page 1995-01-25 21:41:09 +00:00			`.It Dv JOY_SET_Y_OFFSET Fa int *offset`
Mechanically kill hard sentence breaks and double whitespaces. 2004-07-03 18:29:24 +00:00			`Set the value to be added to the Y position when reading the joystick`
Removed whitespace at end-of-line; no content changes. I simply did cd src/share; find man[1-9] -type f\|xargs perl -pi -e 's/[ \t]+$//' BTW, what editors are the culprits? I'm using vim and it shows me whitespace at EOL in troff files with a thick blue block... Reviewed by: Silence from cvs diff -b MFC after: 7 days 2001-07-14 19:41:16 +00:00			`status.`
Add joystick man page 1995-01-25 21:41:09 +00:00			`.It Dv JOY_GET_X_OFFSET Fa int *offset`
Mechanically kill hard sentence breaks and double whitespaces. 2004-07-03 18:29:24 +00:00			`Get the value which is added to the X position when reading the joystick`
Removed whitespace at end-of-line; no content changes. I simply did cd src/share; find man[1-9] -type f\|xargs perl -pi -e 's/[ \t]+$//' BTW, what editors are the culprits? I'm using vim and it shows me whitespace at EOL in troff files with a thick blue block... Reviewed by: Silence from cvs diff -b MFC after: 7 days 2001-07-14 19:41:16 +00:00			`status.`
Add joystick man page 1995-01-25 21:41:09 +00:00			`.It Dv JOY_GET_Y_OFFSET Fa int *offset`
Mechanically kill hard sentence breaks and double whitespaces. 2004-07-03 18:29:24 +00:00			`Get the value which is added to the Y position when reading the joystick`
Removed whitespace at end-of-line; no content changes. I simply did cd src/share; find man[1-9] -type f\|xargs perl -pi -e 's/[ \t]+$//' BTW, what editors are the culprits? I'm using vim and it shows me whitespace at EOL in troff files with a thick blue block... Reviewed by: Silence from cvs diff -b MFC after: 7 days 2001-07-14 19:41:16 +00:00			`status.`
Prepare for mdoc(7)NG. 2000-12-29 09:18:45 +00:00			`.El`
Add technical specifications, and give the pinout of the game port Submitted by: Joe Greco <jgreco@brasil.moneng.mei.com> 1995-09-16 16:29:16 +00:00			`.Sh TECHNICAL SPECIFICATIONS`
			`The pinout of the DB-15 connector is as follow:`
mdoc(7) police: removed leading whitespaces that are not inside Bd/Ed; these hardly degrade the quality of the produced output. 2001-01-19 14:15:40 +00:00			`.Bd -literal`
Add technical specifications, and give the pinout of the game port Submitted by: Joe Greco <jgreco@brasil.moneng.mei.com> 1995-09-16 16:29:16 +00:00			`1 XY1 (+5v)`
			`2 Switch 1`
			`3 X1 (potentiometer #1)`
			`4 Switch 1 (GND)`
			`5 Switch 2 (GND)`
			`6 Y1 (potentiometer #2)`
			`7 Switch 2`
			`8 N.C.`
			`9 XY2 (+5v)`
			`10 Switch 4`
			`11 X2 (potentiometer #3)`
			`12 Switch 3&4 (GND)`
			`13 Y2 (potentiometer #4)`
			`14 Switch 3`
			`15 N.C.`
mdoc(7) police: removed leading whitespaces that are not inside Bd/Ed; these hardly degrade the quality of the produced output. 2001-01-19 14:15:40 +00:00			`.Ed`
Add technical specifications, and give the pinout of the game port Submitted by: Joe Greco <jgreco@brasil.moneng.mei.com> 1995-09-16 16:29:16 +00:00			`.Pp`
			`Pots are normally 0-150k variable resistors (0-100k sometimes), and`
Expand abbreviation. techref -> technical reference. 2006-12-14 16:37:11 +00:00			`according to the IBM technical reference, the time is given by`
Add technical specifications, and give the pinout of the game port Submitted by: Joe Greco <jgreco@brasil.moneng.mei.com> 1995-09-16 16:29:16 +00:00			`Time = 24.2e-6s + 0.011e-6s * R/Ohms`
Add joystick man page 1995-01-25 21:41:09 +00:00			`.Sh FILES`
			`.Bl -tag -width /dev/joy?`
			`.It Pa /dev/joy?`
			`joystick device files`
Prepare for mdoc(7)NG. 2000-12-29 09:18:45 +00:00			`.El`
Add joystick man page 1995-01-25 21:41:09 +00:00			`.Sh HISTORY`
- Use the standard section 4 SYNOPSIS - Utilize .Nm MFC after: 3 days 2007-02-09 17:21:23 +00:00			`The`
			`.Nm`
			`driver appeared in`
Update a bunch of man pages to use the .Fx macro to specify FreeBSD versions. 1996-08-21 22:01:49 +00:00			`.Fx 2.0.5 .`
Sort sections. 2005-01-21 08:36:40 +00:00			`.Sh AUTHORS`
use .Mt to mark up email addresses consistently (final part) PR: 191174 Submitted by: Franco Fichtner <franco at lastsummer.de> 2014-06-26 21:46:14 +00:00			`.An Jean-Marc Zucconi Aq Mt jmz@cabri.obs-besancon.fr`