« back to all changes in this revision
Viewing changes to README
- browse files at revision 1
- compare with another revision
- download diff
- download tarball
- view history from revision 1
- Committer: Bazaar Package Importer
- Author(s): Thom May
- Date: 2005-04-01 11:39:55 UTC
- Revision ID: james.westby@ubuntu.com-20050401113955-nnsv7bovk07obxa9
Tags: upstream-0.3
Import upstream version 0.3
- files added:
- etc
- src
added
removed
README
1
FnFX v0.3 (c) 2003, 2004 Timo Hoenig <thoenig at nouse dot net>
2
=======================================================================
3
4
Documentation
5
6
1. FnFX
7
2. Requirements
8
2.1 Hardware Requirements
9
2.2 Software Requirements
10
3. General Information
11
3.1 FnFX Concept
12
3.2 Verified Toshiba Models
13
3.3 Known Laptops Which Do Not Work (Phoenix BIOS)
14
4. Functions
15
4.1 Daemon Functions
16
4.2 Client Functions
17
5. Installation
18
5.1 Compilation
19
5.2 Daemon Configuration
20
5.3 Client Configuration
21
5.4 Configuration Examples
22
6. To-do
23
7. License
24
8. Contact
25
9. Thanks
26
10. References
27
28
=======================================================================
29
30
1. FnFX
31
32
FnFX enables owners of Toshiba laptops to change the LCD brightness,
33
control, the internal fan and use the special keys on their keyboard
34
(Fn-x combinations, hot-keys). The internal functions will give the
35
possibility to map the Fn-Keys to functions like volume up/down, mute,
36
suspend to disk, suspend to ram and switch LCD/CRT/TV-out. These
37
functions heavily depend on the system and/or kernel configuration.
38
You will need at least a kernel (v2.4.x, v2.5.x, v2.6.x) with ACPI and
39
Toshiba support (CONFIG_ACPI and CONFIG_ACPI_TOSHIBA).
40
41
42
2. Requirements
43
44
2.1 Hardware Requirements
45
46
Any recent Toshiba model. Recent means: Every Toshiba laptop built
47
in 2002 and later will work with FnFX. A list with verified and
48
tested Toshiba laptops is found under 3.2.
49
50
One exception: There are a few laptops which do not have a Toshiba
51
(e.g. Satellite P25-S520) but a Phoenix BIOS. These machines will
52
fail on loading the Toshiba ACPI driver and hence will not be supported
53
by FnFX.
54
55
2.2 Software Requirements
56
57
- Linux v2.4.x
58
- Linux v2.5.x
59
- Linux v2.6.x
60
61
All Linux v2.4.x kernels will need ACPI patches. All 'major' dis-
62
tributions already roll out v2.4.x kernels with these patches. To
63
make it short: At least CONFIG_ACPI and CONFIG_ACPI_TOSHIBA must be
64
defined in the kernel config. More information on ACPI and Linux can
65
be found under [1].
66
67
All v2.5.x and v2.6.x kernels already have the required ACPI
68
drivers. Again: ACPI must be enabled. CONFIG_ACPI and
69
CONFIG_ACPI_TOSHIBA are your friends.
70
71
To check if ACPI and ACPI Toshiba support are enabled check the
72
following proc entries exists:
73
74
/proc/acpi
75
/proc/acpi/toshiba
76
77
If they do exist, FnFX will work on that system. If they do not
78
exist try `modprobe toshiba_acpi' as root. If this throws errors
79
like 'FATAL: Module toshiba_acpi not found' the kernel is most
80
likely not compiled with CONFIG_ACPI and CONFIG_ACPI_TOSHIBA.
81
82
Please recompile your kernel with the ACPI drivers or have a
83
look for a precompiled kernel for your distribution which has ACPI
84
and ACPI Toshiba support.
85
86
87
3. General Information
88
89
3.1 FnFX Concept
90
91
FnFX consists of two programs: The daemon `fnfxd` and the client
92
`fnfx`. Fnfxd has to be run as root. While running without fnfx,
93
the daemon reacts on Fn-x combinations and hot-keys which are def-
94
ined in `/etc/fnfx/fnfxd.conf'. If a instance of fnfx is running,
95
the received Fn-x/hot key events are passed to the client which reads
96
its configuration from '~/.fnfxrc'. While fnfxd only executes internal
97
commands, fnfx can also start arbitrary programs.
98
99
If you only want to use the internal commands (changing LCD bright-
100
ness...), there is no need to run the client fnfx. On the other side,
101
if you really want to map the Fn-x combinations/hot-keys to launch
102
programs, you will need to configure and start both - the server and
103
client.
104
105
106
3.2 Verified Toshiba Models
107
108
The following Toshiba laptops have been tested by FnFX users. Note:
109
every new Toshiba laptop really should work just fine with FnFX.
110
111
- Toshiba Libretto L5W
112
- Toshiba Portege 2000
113
- Toshiba Portege 2010
114
- Toshiba Portege 3440CT
115
- Toshiba Portege 4000
116
- Toshiba Portege 7020ct
117
- Toshiba Portege R100
118
- Toshiba Satellite 1410-303
119
- Toshiba Satellite 1410-604
120
- Toshiba Satellite 1800-821
121
- Toshiba Satellite 2405
122
- Toshiba Satellite 2410-303
123
- Toshiba Satellite 2410-304S
124
- Toshiba Satellite 2410-514
125
- Toshiba Satellite 2450-401
126
- Toshiba Satellite 2450-S203
127
- Toshiba Satellite 5005-504
128
- Toshiba Satellite 5100-201
129
- Toshiba Satellite 5200-801
130
- Toshiba Satellite 5200-802
131
- Toshiba Satellite 5200-903
132
- Toshiba Satellite 5202-S503
133
- Toshiba Satellite 5205
134
- Toshiba Satellite 5205-S703
135
- Toshiba Satellite 5205-S705
136
- Toshiba Satellite A10-S100
137
- Toshiba Satellite A10-S203
138
- Toshiba Satellite A20-S103
139
- Toshiba Satellite A25-S207
140
- Toshiba Satellite A40-211
141
- Toshiba Satellite M30-164
142
- Toshiba Satellite M30-344
143
- Toshiba Satellite Pro 490CDT
144
- Toshiba Satellite Pro 6000
145
- Toshiba Satellite Pro 6100
146
- Toshiba Satellite Pro M10
147
- Toshiba Tecra 8100
148
- Toshiba Tecra 9000
149
- Toshiba Texra M1
150
- Toshiba Dynabook EX1/524CDET (Japanese)
151
152
3.3 Known Laptops Which Do Not Work (Phoenix BIOS)
153
154
- Toshiba Tecra S1
155
- Satellite P25-S520
156
157
4. Functions
158
159
4.1 Daemon Functions
160
161
The daemon can execute the following internal commands:
162
163
- brightness up -- increase LCD brightness
164
- brightness down -- decrease LCD brightness
165
- toggle bluetooth -- switch bluetooth on/off (need kernel patch)
166
- toggle cpu -- toggle ACPI high and low limit
167
- toggle fan -- switch fan on/off
168
- toggle video -- toggle video: LCD -> LCD & CRT -> CRT
169
- suspend to ram -- suspend to ram via ACPI
170
- suspend to disk -- suspend to disk (hibernate) via ACPI
171
- volume up -- increase mixer volume
172
- volume down -- decrease mixer volume
173
- mute -- toggle mute
174
175
Notes:
176
177
- "toggle video" is _not_ supposed to work on all systems.
178
- "toggle bluetooth" requires kernel patch. See
179
http://www.cwrose.de/toshiba/s5200.html#bluetooth for details.
180
- "toggle cpu" works on /proc/acpi/processor/CPU0/limit and hence
181
does not work on all systems. It does not cooperate with cpufreq.
182
- "suspend to ram" and "suspend to disk" will only work, if the kernel
183
was compiled with the corresponding power management and acpi drivers
184
and if the system does support the sleep states (S3, S4).
185
186
The daemon configuration is made by changing the file
187
'/etc/fnfx/fnfxd.conf'. All valid Fn-x combinations and hot-keys can
188
be found in '/etc/fnfx/keymap'
189
190
Examples for the configuration are found under 5.3.
191
192
193
4.2 Client Functions
194
195
The client can execute the internal commands as well as any arbitrary
196
program. The client configuration '~/.fnfxrc' has to be copied to the
197
home directory of the user who executes the client. An example can be
198
found in '/etc/fnfx/fnfxrc_example'.
199
200
Examples for the configuration are found under 5.3.
201
202
203
5. Installation
204
205
5.1 Compilation
206
207
The same as usual:
208
209
- ./configure
210
- make
211
- su -
212
- make install
213
214
Too quick? To compile FnFX, simply extract the file
215
`fnfx-0.3.tar.gz` by running `tar xfv fnfx-0.2.tar.gz`. Afterwards run
216
`./configure`. To compile FnFX run 'make'. If this worked, become root
217
and run 'make install'
218
219
If './configure' was run without any additional parameters, the
220
daemon is found in '/usr/local/sbin/fnfxd' and the client resides in
221
'/usr/local/bin/fnfx'. The configuration files are copied to
222
'/etc/fnfx'.
223
224
5.2 Daemon Configuration
225
226
If all steps from 5.1 went well, FnFX is ready to be configured.
227
The daemon configuration '/etc/fnfx/fnfxd.conf' has a two sections.
228
229
All actions are defined in the section [actions] and are parsed
230
by the daemon on start up. An action entry has the following format:
231
232
action(key="FN-KEY";command="COMMAND")
233
234
Where FN-KEY is a Fn-x combination or hot-key. See
235
`/etc/init.d/keymap' and COMMAND is one of the internal commands
236
listed under 4.1.
237
238
In the second section [mixer], the mixer can be defined which is
239
taken for the internal commands "volume up", "volume down" and "mute".
240
241
The format is quite easy:
242
243
mixer(device="MIXER")
244
245
Where MIXER is the mixer device. For example: /dev/mixer.
246
247
In the third section [defaults], defaults for daemon startup can
248
be configured. Currently this is only the display brightness.
249
250
defaults(brightness="<value from 0..7>")
251
252
5.3 Client Configuration
253
254
The client configuration file is `.fnfxrc`, which first has to be
255
copied to the home directory of the user who is starting fnfx. See
256
4.2 and 5.4 for details.
257
258
The configuration file has the same structure like the one of
259
fnfxd. All actions are defined below [actions] and have the format:
260
261
action(key="FN-KEY";command="COMMAND")
262
263
While the daemon can only use the internal commands as command,
264
fnfx is able to run programs. See 5.4 for details.
265
266
5.4 Configuration Examples
267
268
The following lines are examples for action commands.
269
270
action(key="Fn-Escape";command="mute")
271
action(key="Fn-F6";command="brightness down")
272
action(key="Fn-F7";command="brightness up")
273
action(key="Fn-a";command="xmms")
274
275
The first three examples don't need further explanation. The
276
forth line is only possible in the client configuration. Remember?
277
Only fnfx can start programs, in this case 'xmms' when hitting Fn-a.
278
279
280
6. To-do
281
282
Yes, a X11 client is still missing. It's prio #1 and the next I
283
will code.
284
285
7. License
286
287
FnFX is released under the GPL.
288
289
290
8. Contact
291
292
Comments, bugs and beer to: Timo Hoenig, <thoenig at nouse dot net>
293
294
Project home page is: http://fnfx.sf.net
295
Sourceforge home page is: http://sf.net/projects/fnfx
296
297
298
9. Thanks
299
300
A very warm 'Thank You' goes to all people who made patches, sent
301
feedback and supported laptops. I can't express how much I appreciate
302
it.
303
304
305
10. References
306
307
[1] ACPI4Linux,
308
http://acpi.sf.net
309
310
=======================================================================
Loggerhead is a web-based interface for Breezy
Version: 2.0.1