openSUSE Build Service

Overview Repositories Revisions Requests Users Attributes Meta

File overview.html of Package fnfx

<html>
<head>
<title>FnFX :: Toshiba Fn-Keys/Hotkeys & Linux</title>

</head>

body,td         {FONT-SIZE: 10pt; COLOR: #444444; FONT-FAMILY: verdana;}
.mini           {FONT-SIZE: 10px; COLOR: #999999; FONT-FAMILY: verdana; TEXT-DECORATION: underline;}
A.mini          {FONT-SIZE: 10px; COLOR: #999999; FONT-FAMILY: verdana; TEXT-DECORATION: underline;}
A.mini:visited  {FONT-SIZE: 10px; COLOR: #999999; FONT-FAMILY: verdana; TEXT-DECORATION: underline;}
A.mini:hover    {TEXT-DECORATION: underline;}
A.mini:hover    {TEXT-DECORATION: underline;}
A               {TEXT-DECORATION: underline;}

.dottedtop  {border: 1pt solid black; margin-top: 2pt;margin-bottom: 2pt;FONT-SIZE: 11px; COLOR: #444444; FONT-FAMILY: arial; background: #FFFFFF; padding-right:5pt; padding-left:5pt; padding-top:0pt;  padding-bottom: 0pt; text-align:left;}

.dotted  {border: 1pt solid black; margin-left: 2pt;margin-right: 2pt;margin-top: 2pt;margin-bottom: 2pt;FONT-SIZE: 11px; COLOR: #444444; FONT-FAMILY: arial; background: #FFFFFF; padding-right:5pt; padding-left:5pt; padding-top:0pt;  padding-bottom: 0pt; text-align:left;}

.dottedbot  {border: 1pt solid black; margin-left: 2pt;margin-right: 2pt;margin-top: 0pt;margin-bottom: 2pt;FONT-SIZE: 11px; COLOR: #444444; FONT-FAMILY: arial; background: #FFFFFF; padding-right:5pt; padding-left:5pt; padding-top:2pt;  padding-bottom: 3pt; text-align:left;}

.table   {border: 1pt solid white; margin-left: 2pt;margin-right: 2pt;margin-top: 2pt;margin-bottom: 2pt;FONT-SIZE: 11px; COLOR: #444444; FONT-FAMILY: verdana; background: #f0f0f0; padding-right:3pt; padding-left:3pt; padding-top:2pt;  padding-bottom:pt; text-align:left;}
.smile   {border: 0pt solid white; margin-left: 0pt;margin-right: 0pt;margin-top: 0pt;margin-bottom: 0pt; padding-right:0pt; padding-left:0pt; padding-top:0pt;  padding-bottom:0pt; text-align:left;}
.content {border: 1pt solid black; margin-left: 2pt;margin-right: 2pt;margin-top: 2pt;margin-bottom: 2pt;FONT-SIZE: 11px; COLOR: #444444; FONT-FAMILY: verdana, arial; background: #f0f0f0; padding-right:5pt; padding-left:5pt; padding-top:5pt;  padding-bottom:pt; text-align:left;}
.menu    {margin-left: 2pt;margin-right: 2pt;margin-top: 2pt;margin-bottom: 2pt;FONT-SIZE: 11px; COLOR: #444444; FONT-FAMILY: arial; padding-left:5pt; padding-right:5pt; padding-top:0pt; padding-bottom: 0pt; text-align:left; }

</style>

<table class=dottedtop border=0 cellspacing=0 cellpadding=0 width=770>
<tr><td class=menu background=g/fnfx.png width=190 height=63></td><td class=menu background=g/fnfxbg.png width=150><a href=index.php?section=news><center>Home</center></a></td><td class=menu background=g/fnfxbg.png width=150><a href=index.php?section=files><center>Files</center></a></td><td class=menu background=g/fnfxbg.png width=150><a href=index.php?section=doc><center>Documentation</center></a></td><td class=menu background=g/fnfxbg.png width=150><a href=forum/index.php><center>Forum</center></a><td class=menu background=g/fnfxbg.png><td class=menu background=g/fnfxbg.png width=150><a href=index.php?section=about><center>About</center></a><td class=menu background=g/fnfxbg.png></td></td></td>
</tr>
</table>

</center>
<center>

<table border=0 width=774 cellpadding=0 cellspacing=0>
<tr>
 <td>
 <table border=0 width=100%>
 <tr>
 <td class=dottedbot width=100%>
	Quicklinks: <a href=?section=doc#models>Supported Laptops</a> || <a href=?section=doc#swreq>Kernel Requirements</a> || <a href=?section=files>Download Source and Packages</a>
 </td>
 
 </tr>
 </table>
 </td>
</tr>
</table>

</center>

Documentation

<a href=#fnfx>
1. FnFX 
</a>
<a href=#req>
2. Requirements 
</a>
<a href=#hwreq>
2.1 Hardware Requirements 
</a>
<a href=#swreq>
2.2 Software Requirements 
</a>
<a href=#info>
3. General Information 
</a>
<a href=#concept>
3.1 FnFX Concept 
</a>
<a href=#models>
3.2 Verified Toshiba Models 
</a>
<a href=#functions>
4. Functions 
</a>
<a href=#daemon>
4.1 Daemon Functions 
</a>
<a href=#client>
4.2 Client Functions 
</a>
<a href=#install>
5. Installation 
</a>
<a href=#compile>
5.1 Compilation 
</a>
<a href=#dconf>
5.2 Daemon Configuration 
</a>
<a href=#cconf>
5.3 Client Configuration 
</a>
<a href=#confex>
5.4 Configuration Examples 
</a>
<a href=#todo>
6. To-do 
</a>
<a href=#license>
7. License 
</a>
<a href=#contact>
8. Contact 
</a>
<a href=#thanks>
9. Thanks 
<a href=#ref>
10. References 
</a>
<hr>

&nbsp; &nbsp; &nbsp; FnFX enables owners of Toshiba laptops to change the LCD brightness,
control, the internal fan and use the special keys on their keyboard
(Fn-x combinations, hot-keys). The internal functions will give the
possibility to map the Fn-Keys to functions like volume up/down, mute,
suspend to disk, suspend to ram and switch LCD/CRT/TV-out. These
functions heavily depend on the system and/or kernel configuration.
You will need at least a kernel (v2.4.x, v2.5.x, v2.6.x) with ACPI and
Toshiba support (CONFIG_ACPI and CONFIG_ACPI_TOSHIBA).

<br 
<a name="req">
2. Requirements 
</a>
<a name="hwreq">
2.1 Hardware Requirements 
</a>
&nbsp; &nbsp; &nbsp; Any recent Toshiba model. Recent means: Every Toshiba laptop built
in 2002 and later will work with FnFX. A list with verified and
tested Toshiba laptops is found under 3.2.

<a name="swreq">
2.2 Software Requirements 
</a>
&nbsp; &nbsp; - Linux v2.4.x
 
&nbsp; &nbsp; - Linux v2.5.x
 
&nbsp; &nbsp; - Linux v2.6.x
 
&nbsp; &nbsp; &nbsp; All Linux v2.4.x kernels will need ACPI patches. All 'major'
distributions already roll out v2.4.x kernels with these patches. To
make it short: At least CONFIG_ACPI and CONFIG_ACPI_TOSHIBA must be
defined in the kernel config. More information on ACPI and Linux can
be found under [1].

&nbsp; &nbsp; &nbsp; All v2.5.x and v2.6.x kernels already have the required ACPI
drivers. Again: ACPI must be enabled. CONFIG_ACPI and
CONFIG_ACPI_TOSHIBA are your friends.
 
&nbsp; &nbsp; &nbsp; To check if ACPI and ACPI Toshiba support are enabled check the
following proc entries exists:
 
/proc/acpi 
/proc/acpi/toshiba
 
&nbsp; &nbsp; &nbsp; If they do exist, FnFX will work on that system. If they do not
exist try `modprobe toshiba_acpi' as root. If this throws errors
like 'FATAL: Module toshiba_acpi not found' the kernel is most
likely not compiled with CONFIG_ACPI and CONFIG_ACPI_TOSHIBA.
 
&nbsp; &nbsp; &nbsp; Please recompile your kernel with the ACPI drivers or have a
look for a precompiled kernel for your distribution which has ACPI
and ACPI Toshiba support.

<a name="info">
3. General Information 
</a>
<a name="concept">
3.1 FnFX Concept 
</a>
&nbsp; &nbsp; &nbsp; FnFX consists of two programs: The daemon `fnfxd` and the client
`fnfx`. Fnfxd has to be run as root. While running without fnfx,
the daemon reacts on Fn-x combinations and hot-keys which are defined in `/etc/fnfx/fnfxd.conf' ('/usr/local/etc/fnfx/fnfxd.conf'). If a instance of fnfx is running,
the received Fn-x/hot key events are passed to the client which reads
its configuration from '~/.fnfxrc'. While fnfxd only executes internal
commands, fnfx can also start arbitrary programs.
 
&nbsp; &nbsp; &nbsp; If you only want to use the internal commands (changing LCD brightness...),
there is no need to run the client fnfx. On the other side,
if you really want to map the Fn-x combinations/hot-keys to launch
programs, you will need to configure and start both -- the server and
client.

<a name="models">
3.2 Verified Toshiba Models 
</a>
&nbsp; &nbsp; &nbsp; The following Toshiba laptops have been tested by FnFX users. Note:
every new Toshiba laptop really should work just fine with FnFX.
 
- Toshiba Libretto L5W 
- Toshiba Portege 2000 
- Toshiba Portege 2010 
- Toshiba Portege R100 
- Toshiba Satellite 1410-604 
- Toshiba Satellite 2410-303 
- Toshiba Satellite 2450-401 
- Toshiba Satellite 5205 
- Toshiba Satellite 5100-201 
- Toshiba Satellite 5200-801 
- Toshiba Satellite 5205 
- Toshiba Satellite A10-S203 
- Toshiba Satellite Pro 490CDT 
- Toshiba Tecra 9000

<a name="functions">
4. Functions 
</a>
<a name="daemon">
4.1 Daemon Functions
</a>
 
&nbsp; &nbsp; &nbsp; The daemon can execute the following internal commands:

- brightness up -- increase LCD brightness 
- brightness down -- decrease LCD brightness 
- toggle fan -- switch fan on/off 
- toggle video -- toggle video: LCD -> LCD & CRT -> CRT 
- suspend to ram -- suspend to ram via ACPI 
- suspend to disk -- suspend to disk (hibernate) via ACPI 
- volume up -- increase mixer volume 
- volume down -- decrease mixer volume 
- mute -- toggle mute

Notes:

- "toggle video" is _not_ supposed to work on all systems. 
- "suspend to ram" and "suspend to disk" will only work, if the kernel
 was compiled with the corresponding power management and acpi drivers
 and if the system does support the sleep states (S3, S4).
 
&nbsp; &nbsp; &nbsp; The daemon configuration is made by changing the file
'/etc/fnfx/fnfxd.conf'. All valid Fn-x combinations and hot-keys can
be found in '/etc/fnfx/keymap'. If you have run `./configure` without parameters,
they're found in '/usr/local/etc/fnfx'.
 
&nbsp; &nbsp; &nbsp; Examples for the daemon configuration are found under 5.2.

<a name="client">
4.2 Client Functions
</a>
 
&nbsp; &nbsp; &nbsp; The client can execute the internal commands as well as any arbitrary
program. The client configuration '~/.fnfxrc' has to be copied to the
home directory of the user who executes the client. An example can be
found in '/etc/fnfx/fnfxrc_example'. If you have run `./configure` without parameters,
they're found in '/usr/local/etc/fnfx'.
 
&nbsp; &nbsp; &nbsp; Examples for the client configuration are found under 5.3.

<a name="install">
5. Installation
</a> 
<a name="compile">
5.1 Compilation 
</a>
&nbsp; &nbsp; &nbsp; The same as usual:
 
- ./configure 
- make 
- su - 
- make install 
 
&nbsp; &nbsp; &nbsp; Too quick? To compile FnFX, simply extract the file
`fnfx-0.2.tar.gz` by running `tar xfv fnfx-0.2.tar.gz`. Afterwards run
`./configure`. To compile FnFX run 'make'. If this worked, become root
and run 'make install'
 
&nbsp; &nbsp; &nbsp; If './configure' was run without any additional parameters, the
daemon is found in '/usr/local/sbin/fnfxd' and the client resides in
'/usr/local/bin/fnfx'. The configuration files are copied to
'/usr/local/etc/fnfx'.

<a name="dconf">
5.2 Daemon and Client Configuration 
</a>
&nbsp; &nbsp; &nbsp; If all steps from 5.1 went well, FnFX is ready to be configured.
The daemon configuration '/etc/fnfx/fnfxd.conf' ('/usr/local/etc/fnfx/fnfxd.conf') has a two sections.
 
&nbsp; &nbsp; &nbsp; All actions are defined in the section [actions] and are parsed
by the daemon on start up. An action entry has the following format:
 
action(key="FN-KEY";command="COMMAND")
 
&nbsp; &nbsp; &nbsp; Where FN-KEY is a Fn-x combination or hot-key. See
`/etc/fnfx/keymap' ('/usr/local/etc/fnfx/keymap') and COMMAND is one of the internal commands
listed under 4.1.
 
&nbsp; &nbsp; &nbsp; In the second section [mixer], the mixer can be defined which is
taken for the internal commands "volume up", "volume down" and "mute".
 
&nbsp; &nbsp; &nbsp; The format is quite easy:
 
mixer(device="MIXER")
 
&nbsp; &nbsp; &nbsp; Where MIXER is the mixer device. For example: /dev/mixer.

<a name="cconf">
5.3 Client Configuration 
</a>
&nbsp; &nbsp; &nbsp; The client configuration file is `.fnfxrc`, which first has to be
copied to the home directory of the user who is starting fnfx. See
4.2 and 5.4 for details.
 
&nbsp; &nbsp; &nbsp; The configuration file has the same structure like the one of
fnfxd. All actions are defined below [actions] and have the format:
 
action(key="FN-KEY";command="COMMAND")
 
&nbsp; &nbsp; &nbsp; While the daemon can only use the internal commands as command,
fnfx is able to run programs. See 5.4 for details.

<a name="confex">
5.4 Configuration Examples 
</a>
&nbsp; &nbsp; &nbsp; The following lines are examples for action commands.
 
action(key="Fn-Escape";command="mute") 
action(key="Fn-F6";command="brightness down") 
action(key="Fn-F7";command="brightness up") 
action(key="Fn-a";command="xmms") 
 
&nbsp; &nbsp; &nbsp; The first three examples don't need further explanation. The
forth line is only possible in the client configuration. Remember?
Only fnfx can start programs, in this case 'xmms' when hitting Fn-a.

<a name="todo">
6. To-do 
</a>
&nbsp; &nbsp; &nbsp; Yes, a X11 client is still missing. It's prio #1 and the next I
will code.

<a name="license">
7. License 
</a>
&nbsp; &nbsp; &nbsp; FnFX is released under the GPL.

<a name="contact">
8. Contact 
</a>
&nbsp; &nbsp; &nbsp; Comments, bugs and beer to: Timo Hoenig, thoenig at nouse dot net
 
&nbsp; &nbsp; &nbsp; Project home page is: <a href=http://fnfx.sf.net/ target=_extern>http://fnfx.sf.net/</a> 
&nbsp; &nbsp; &nbsp; Sourceforge home page is: <a href=http://sf.net/projects/fnfx target=_extern>http://sf.net/projects/fnfx</a>

<a name="thanks">
9. Thanks 
</a>
&nbsp; &nbsp; &nbsp; A very warm 'Thank You' goes to all people who tested the previous
version of FnFX:
 
&nbsp; &nbsp; &nbsp; Curtis, Alex James, Alexandre, Nicolas, Meiosis, Peter, Jay, Glenn,
Paul, Alejandro (great pic! :), Marc, Alberto, Free, Mantas, Bruno,
Johannes and Wissam.
 
&nbsp; &nbsp; &nbsp; And I am damn sure that I have forgotten someone. Sorry.

<a name="ref">
10. References 
</a>
[1] ACPI4Linux, 
&nbsp; &nbsp; &nbsp; <a href=http://acpi.sf.net target=_extern>http://acpi.sf.net</a>
 
 </td>
 </tr>
 </table>
 </td>
</tr>
</table>

</center>

<table border=0 width=774 cellpadding=0 cellspacing=0>
<tr>
 <td>
 <table border=0 width=100%>
 <tr><td class=dottedbot width=100%>
	FnFX &copy; <a href="mailto:thoenig at nouse dot net?subject=FnFX">Timo Hoenig</a> || FnFX SF Project Site: <a href=http://sf.net/projects/fnfx>http://sf.net/projects/fnfx</a>

</td>
 <td class=dottedbot>26.01.2004</td>
 </tr>

</table>
 </td>
</tr>
</table>

</center>

6520

</body>

</html>

Places

File overview.html of Package fnfx

Places