diff options
Diffstat (limited to 'share/man/man4/sysmouse.4')
| -rw-r--r-- | share/man/man4/sysmouse.4 | 80 |
1 files changed, 40 insertions, 40 deletions
diff --git a/share/man/man4/sysmouse.4 b/share/man/man4/sysmouse.4 index bc77dc0..0e9493a 100644 --- a/share/man/man4/sysmouse.4 +++ b/share/man/man4/sysmouse.4 @@ -47,7 +47,7 @@ This arrangement makes it possible for the console and the user process .Pq such as the Tn X\ Window System to share the mouse. .Pp -The user process which wants to utilize mouse operation simply opens +The user process which wants to utilize mouse operation simply opens .Pa /dev/sysmouse with a .Xr open 2 @@ -62,21 +62,21 @@ the mouse. .Ss Operation Levels The .Nm -driver has two levels of operation. +driver has two levels of operation. The current operation level can be referred to and changed via ioctl calls. .Pp -The level zero, the basic level, is the lowest level at which the driver -offers the basic service to user programs. +The level zero, the basic level, is the lowest level at which the driver +offers the basic service to user programs. The .Nm driver provides horizontal and vertical movement of the mouse -and state of up to three buttons in the -.Tn MouseSystems +and state of up to three buttons in the +.Tn MouseSystems format as follows. .Pp .Bl -tag -width Byte_1 -compact -.It Byte 1 +.It Byte 1 .Bl -tag -width bit_7 -compact .It bit 7 Always one. @@ -92,17 +92,17 @@ if the device does not have the middle button. Right button status; cleared if pressed, otherwise set. .El .It Byte 2 -The first half of horizontal movement count in two's complement; +The first half of horizontal movement count in two's complement; -128 through 127. .It Byte 3 -The first half of vertical movement count in two's complement; +The first half of vertical movement count in two's complement; -128 through 127. .It Byte 4 -The second half of the horizontal movement count in two's complement; +The second half of the horizontal movement count in two's complement; -128 through 127. To obtain the full horizontal movement count, add the byte 2 and 4. .It Byte 5 -The second half of the vertical movement count in two's complement; +The second half of the vertical movement count in two's complement; -128 through 127. To obtain the full vertical movement count, add the byte 3 and 5. .El @@ -110,21 +110,21 @@ the byte 3 and 5. At the level one, the extended level, mouse data is encoded in the standard format .Dv MOUSE_PROTO_SYSMOUSE -as defined in +as defined in .Xr mouse 4 . .\" .Ss Acceleration .\" The .\" .Nm .\" driver can somewhat `accelerate' the movement of the pointing device. -.\" The faster you move the device, the further the pointer -.\" travels on the screen. -.\" The driver has an internal variable which governs the effect of -.\" the acceleration. Its value can be modified via the driver flag +.\" The faster you move the device, the further the pointer +.\" travels on the screen. +.\" The driver has an internal variable which governs the effect of +.\" the acceleration. Its value can be modified via the driver flag .\" or via an ioctl call. .Sh IOCTLS -This section describes two classes of +This section describes two classes of .Xr ioctl 2 -commands: +commands: commands for the .Nm driver itself, and commands for the console and the console control drivers. @@ -142,7 +142,7 @@ driver. These commands manipulate the operation level of the mouse driver. .Pp .It Dv MOUSE_GETHWINFO Ar mousehw_t *hw -Returns the hardware information of the attached device in the following +Returns the hardware information of the attached device in the following structure. Only the .Dv iftype field is guaranteed to be filled with the correct value in the current @@ -180,12 +180,12 @@ or .Pp The .Dv model -is always +is always .Dv MOUSE_MODEL_GENERIC at the operation level 0. -It may be +It may be .Dv MOUSE_MODEL_GENERIC -or one of +or one of .Dv MOUSE_MODEL_XXX constants at higher operation levels. .Pp @@ -210,7 +210,7 @@ typedef struct mousemode { .Pp The .Dv protocol -field tells the format in which the device status is returned +field tells the format in which the device status is returned when the mouse data is read by the user program. It is .Dv MOUSE_PROTO_MSC @@ -260,7 +260,7 @@ The command changes the current operation parameters of the mouse driver as specified in .Ar mode . Only -.Dv level +.Dv level may be modifiable. Setting values in the other field does not generate error and has no effect. @@ -278,24 +278,24 @@ These commands are not supported by the driver. .Pp .It Dv MOUSE_GETSTATUS Ar mousestatus_t *status -The command returns the current state of buttons and +The command returns the current state of buttons and movement counts in the structure as defined in .Xr mouse 4 . .El .Ss Console and Consolectl Ioctls -The user process issues console +The user process issues console .Fn ioctl calls to the current virtual console in order to control the mouse pointer. The console -.Fn ioctl +.Fn ioctl also provides a method for the user process to receive a .Xr signal 3 when a button is pressed. .Pp The mouse daemon .Xr moused 8 -uses +uses .Fn ioctl calls to the console control device .Pa /dev/consolectl @@ -335,7 +335,7 @@ Adds position supplied in .Dv u.data to current position. .It Dv MOUSE_GETINFO -Returns current mouse position in the current virtual console +Returns current mouse position in the current virtual console and button status in .Dv u.data . .It Dv MOUSE_MODE @@ -347,8 +347,8 @@ The signal to be delivered is set in .El .Pp The above operations are for virtual consoles. -The operations defined -below are for the console control device and are used by +The operations defined +below are for the console control device and are used by .Xr moused 8 to pass mouse data to the console driver. .Pp @@ -363,17 +363,17 @@ driver if it is open. .Dv MOUSE_ACTION also processes button press actions and sends signal to the process if requested or performs cut and paste operations -if the current console is a text interface. +if the current console is a text interface. .It Dv MOUSE_BUTTONEVENT .Dv u.data specifies a button and its click count. The console driver will -use this information for signal delivery if requested or +use this information for signal delivery if requested or for cut and paste operations if the console is in text mode. .El .Pp .Dv MOUSE_MOTIONEVENT -and +and .Dv MOUSE_BUTTONEVENT are newer interface and are designed to be used together. They are intended to replace functions performed by @@ -395,14 +395,14 @@ struct mouse_data { .Ed .Pp .Dv x , -.Dv y +.Dv y and .Dv z represent movement of the mouse along respective directions. .Dv buttons tells the state of buttons. It encodes up to 31 buttons in the bit 0 though -the bit 30. If a button is held down, the corresponding bit is set. +the bit 30. If a button is held down, the corresponding bit is set. .Pp .It Dv mode .Bd -literal @@ -415,7 +415,7 @@ struct mouse_mode { The .Dv signal field specifies the signal to be delivered to the process. -It must be +It must be one of the values defined in .Ao Pa signal.h Ac . The @@ -432,7 +432,7 @@ struct mouse_event { .Pp The .Dv id -field specifies a button number as in +field specifies a button number as in .Dv u.data.buttons . Only one bit/button is set. The @@ -467,6 +467,6 @@ manual page example first appeared in .An -nosplit This manual page was written by -.An John-Mark Gurney Aq gurney_j@efn.org -and +.An John-Mark Gurney Aq gurney_j@efn.org +and .An Kazutaka Yokota Aq yokota@FreeBSD.org . |
