usr.sbin/wsmoused/wsmoused.conf.5

   1 .\" $NetBSD: wsmoused.conf.5,v 1.7 2004/01/05 12:16:25 jmmv Exp $
   2 .\"
   3 .\" Copyright (c) 2003, 2004 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by Julio M. Merino Vidal.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Neither the name of The NetBSD Foundation nor the names of its
  15 .\"    contributors may be used to endorse or promote products derived
  16 .\"    from this software without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .Dd January 5, 2004
  31 .Dt WSMOUSED.CONF 5
  32 .Os
  33 .Sh NAME
  34 .Nm wsmoused.conf
  35 .Nd multipurpose mouse daemon configuration
  36 .Sh SYNOPSIS
  37 .Nm
  38 .Sh DESCRIPTION
  39 The
  40 .Nm
  41 file configures all the features provided by the
  42 .Xr wsmoused 8
  43 daemon.
  44 It is composed by a series of
  45 .Em blocks ,
  46 each of which defines a group of
  47 .Em properties .
  48 The file format is free-form: new line markers are ignored as well as
  49 indentation.
  50 Comments start with the
  51 .Sq #
  52 sign and extend until the end of line.
  53 .Pp
  54 A
  55 .Em property
  56 is like a variable assignment.
  57 It has a name, which goes to the left of the equal sign, and a value,
  58 which goes to the right.
  59 The assignment ends with a semicolon.
  60 It looks like:
  61 .Pp
  62 .Dl name = value;
  63 .Pp
  64 There is no difference between string or integer values when defining them.
  65 The value must be surrounded by double quotes if it contains whitespace.
  66 Booleans are specified as integers, where
  67 .Sq 0
  68 means false and
  69 .Sq 1
  70 stands for true.
  71 Even though, the program cares about this and will emit a warning if you
  72 have done an incorrect assignment.
  73 Note that it will not accept unrecognized names.
  74 .Pp
  75 A
  76 .Em mode
  77 is a type of block that defines how the program behaves when run in a
  78 specific mode.
  79 A mode inherits properties defined in the global scope.
  80 It has the following syntax:
  81 .Bd -literal -offset indent
  82 mode mode_name {
  83         property1 = value1;
  84         ...
  85         propertyN = valueN;
  86 }
  87 .Ed
  88 .Pp
  89 There are two recognized modes,
  90 .Ql action
  91 and
  92 .Ql selection .
  93 .Xr wsmoused 8
  94 describes what they do in detail.
  95 .Ss Properties common to all modes
  96 The following properties can be defined in the global scope, thus
  97 affecting all modes, or inside the mode definition, to override global
  98 values.
  99 .Bl -tag -width indent
 100 .It device = pathname;
 101 The
 102 .Xr wsmouse 4
 103 device name to use.
 104 Defaults to
 105 .Pa /dev/wsmouse .
 106 .It fifo = pathname;
 107 Specify an optional fifo where to redirect all mouse events, no matter
 108 if they have been processed.
 109 By default, no fifo is used.
 110 .It modes = string;
 111 Whitespace separated list of modes to be activated when running.
 112 Defaults to
 113 .Sq selection .
 114 .It nodaemon = boolean;
 115 Set to 1 to not fork in the background.
 116 .It pidfile = basename;
 117 The basename of the pidfile used to control the process.
 118 Pidfiles are always created under
 119 .Pa /var/run ,
 120 and have the
 121 .Sq .pid
 122 extension automatically added.
 123 By default it is set to daemon's program name.
 124 .It ttystat = pathname;
 125 .Xr wsdisplay 4 Ns 's
 126 notification device.
 127 Defaults to
 128 .Pa /dev/ttyEstat .
 129 You will not want to change this.
 130 .It xconsole = integer;
 131 Virtual console number which holds the X server (if any).
 132 The argument specifies the console number (the same found in
 133 .Pa /dev/ttyE? ) .
 134 Unset by default.
 135 .It xconsole_delay = integer;
 136 Number of seconds to wait before reactivating the mouse when returning
 137 from the X console (specified by the
 138 .Sq xconsole
 139 property).
 140 Defaults to 5.
 141 .El
 142 .Ss Properties specific to the action mode
 143 The following properties are only useful when running in the
 144 .Em action
 145 mode:
 146 .Bl -tag -width indent
 147 .It button_<number>_<status> = "command";
 148 Assigns a command to a button, which will be executed using the
 149 .Xr system 3
 150 call.
 151 The
 152 .Sq number
 153 part selects a button to which the command is assigned; the first button
 154 is numbered
 155 .Sq 0
 156 and the maximum depends on the mouse type.
 157 The
 158 .Sq status
 159 part can be either
 160 .Sq down
 161 or
 162 .Sq up ,
 163 representing the events emitted when the button is pressed and released,
 164 respectively.
 165 .El
 166 .Ss Properties specific to the selection mode
 167 The following properties are only useful when running in the
 168 .Em selection
 169 mode:
 170 .Bl -tag -width indent
 171 .It lefthanded = boolean;
 172 Set to 1 to swap mouse buttons, specially useful for left handed users.
 173 .It slowdown_x = integer;
 174 X axis slowdown.
 175 This positive integer specifies how many events in
 176 the vertical direction should be ignored before changing the current
 177 column.
 178 It defaults to 0.
 179 .It slowdown_y = integer;
 180 Y axis slowdown.
 181 This positive integer specifies how many events in
 182 the horizontal direction should be ignored before changing the current row.
 183 It defaults to 3.
 184 .El
 185 .Sh FILES
 186 .Bl -tag -width /usr/share/examples/wsmoused/ -compact
 187 .It Pa /etc/wsmoused.conf
 188 Default configuration file.
 189 .It Pa /usr/share/examples/wsmoused/
 190 Location of sample files.
 191 .El
 192 .Sh SEE ALSO
 193 .Xr system 3 ,
 194 .Xr wsdisplay 4 ,
 195 .Xr wsmouse 4 ,
 196 .Xr wsmoused 8
 197 .Sh HISTORY
 198 The
 199 .Nm
 200 configuration file first appeared in
 201 .Nx 2.0 .