1LINEAK_DEFAULTPLUGIN(1) LINEAK_DEFAULTPLUGIN(1)
2
6 lineak_defaultplugin - Macro plugin for the lineakd daemon
7
10 LinEAK, Linux support for Easy Access and Internet Keyboards, features
11 X11 support, windowmanager independence, ability to configure all keys
12 through GUI or .conf file, volume control and sound controls.
13 This plugin contains macros that can be used in a configuration file
15 that facilitate controlling of volume (through the pcm or standard
16 mixer), cdrom eject, etc. These macros use to be a part of the lineakd
17 daemon. However, since version 0.8 they have been separated out into
18 this plugin. The lineakd daemon no longer implicitly knows about con‐
19 figuration file macros.
20 lineakd is the daemon that runs in the background of an X session and
22 listens to incoming events from multimedia buttons.
23
26 The default plugin supports 11 Macros. Since lineakd 0.7 macros can
27 also take one or more arguments.
28 Macro definitions are as follows.
29 EAK_MUTE, EAK_PCM_MUTE
32 For the EAK_MUTE, EAK_PCM_MUTE macro. We have three forms that
34 are acceptible.
35 This is the default and original macro form. In this form you
37 require a directive in your config file in order for the macro
38 to know which mixer device to adjust.
39 e.g. MixerDevice = /dev/mixer
40 EAK_MUTE(X) EAK_PCM_MUTE(X)
42 Here X is a number. The number is a volume to mute to. Currently
44 this needs revisiting. If the number is too low it will merely
45 change the balance. I suggest a value around 10000. I will fix
46 this later so that it's a relative value from the minimum. In
47 this form you require a directive in your config file in order
48 for the macro to know which mixer device to adjust.
49 e.g. MixerDevice = /dev/mixer
50 EAK_MUTE(X,device,X2,device2,X3,device3,...)
52 EAK_PCM_MUTE(X,device,X2,device2,X3,device3,...)
53 X is a volume to mute to, and device is a string name of a mixer
55 device (e.g. "/dev/mixer" to mute to. As with the previous
56 macro, you will have to experiment with a good value.
57 EAK_VOLUP, EAK_PCM_UP, EAK_VOLDOWN, EAK_PCM_DOWN
60 For the EAK_VOLUP, EAK_PCM_UP and EAK_VOLDOWN, EAK_PCM_DOWN
62 macros. Each have the following three forms.
63 Increment or decrement the sound by the default amount. In this
65 form you require a directive in your config file such as: Mix‐
66 erDevice = /dev/mixer in order for the macro to know which mixer
67 device to adjust.
68 EAK_VOLUP(X)
70 EAK_PCM_UP(X) or EAK_VOLDOWN(X)
71 EAK_PCM_DOWN(X)
72 Increment or decrement the sound by X. This value is best used
74 between 1 and 5, and the sound modification code scales the
75 value, unlike the MUTE macro. In this form you require a direc‐
76 tive in your config file such as: MixerDevice = /dev/mixer in
77 order for the macro to know which mixer device to adjust.
78 EAK_VOLUP(X,device,X2,device2,X3,device3,...)
80 EAK_PCM_UP(X,device,X2,device2,X3,device3,...)
81 EAK_VOLDOWN(X,device,X2,device2,X3,device3,...)
82 EAK_PCM_DOWN(X,device,X2,device2,X3,device3,...)
83 X is the volume to adjust the following device by. Like the pre‐
85 vious form of this macro, a value of 1-5 is best.
86 EAK_OPEN_TRAY, EAK_OPEN_TRAY_SCSI, EAK_CLOSE_TRAY
89 For the EAK_OPEN_TRAY, EAK_OPEN_TRAY_SCSI and EAK_CLOSE_TRAY
91 macros. There are two forms for each. These are the default
92 macros. It will eject or close the device defined in your config
93 file as: CdromDevice = /dev/cdrom
94 EAK_OPEN_TRAY(device1,device2,device3,...)
96 EAK_OPEN_TRAY_SCSI(device1,device2,device3,...)
97 EAK_CLOSE_TRAY(device1,device2,device3,...)
98 This macro form allows you to choose the device to eject. You
101 can have a list of one or more devices separated by a comma.
102 EAK_SLEEP
106 The EAK_SLEEP macro currently does nothing. In the future I will
108 probably use it to invoke software suspend.
109 EAK_SCREEN_LOCK
113 For the EAK_SCREEN_LOCK macro. There is only one form.
115 EAK_SCREEN_LOCK(X) Where X is either KDE, GNOME or XSCREENSAVER
117 The values GNOME or XSCREENSAVER do the same thing. They invoke
118 the Xscreensaver program to lock the desktop.
119 EAK_MEDIADETECT(COMMAND)
123 This macro allows you to use the media detect plugin to run one
124 of the supported commands. This plugins requires that you have a
125 configuration file in your ~/.lineak directory called
126 media-detect.conf
127 Valid commands are:
129 PLAY
131 STOP
132 PAUSE
133 PLAYPAUSE
134 NEXT
135 PREVIOUS
136 See the media-detect.conf file in this source package for
138 detailed configuration information.
139 EAK_SENDKEYS("<options>")
143 <options> := <modifers>+<character>
144 <modifiers> := <modifier>[+<modifier>]
145 <character> := A single alphanumeric character, (i.e. 0-9 or
146 a-z) or
147 an arrow key (Right, Left, Up, Down) or other
148 printible character.
149 <modifier> := A modifier such as shift, control or alt.
150 For example: "shift+a" or "control+shift+f"
152 This macro allows you to send events to X. You can send a single
154 character, such as a,b or c, or you can send combinations of
155 keys. If you send key combinations, all of the previous keys
156 must be modifiers such as shift, control or alt. All modifiers
157 must precede the character you wish to send.
158 More Examples:
162 To send the '$' key, your options would be: shift+4
164 To and alt+tab combination, your options would be: alt+Tab
165 To send a capital a 'A', your options would be: shift+a
166
170 $HOME/.lineak/lineakd.conf
171 $HOME/.lineak/media-detect.conf
172 Personal configuration file.
173
176 lineakd(1), lineak_kdeplugins(1), lineak_xosdplugin(1).
177
180 lineakd was written by Sheldon Lee-Wen <leewsb@hotmail.com> and Mark
181 Smulders <Mark@PIRnet.nl>. This plugin package is a derivative of code
182 from the lineakd distribution.
183Sheldon Lee-Wen December 23, 2003 LINEAK_DEFAULTPLUGIN(1)