ThinkWiki - User contributions [en]

How to get special keys to work

2016-02-15T01:13:42Z

Dskrvk: /* Weblinks */ add category

==Overview==
The following table gives an overview over the special keys found on ThinkPads and what is needed to make them work.
{| {{prettytable}}
! key !! standard function{{footnote|1}} !! tools supporting key{{footnote|2}} !! configurability{{footnote|3}} !! remarks
|-
| {{key|Fn}} || - || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]] || full || on release without completed key combination
|-
| {{key|Fn}}{{key|F1}} || - || [[thinkpad-acpi]] || full ||
|-
| {{key|Fn}}{{key|F2}} || lock screen || [[thinkpad-acpi]] || full || in models from T/X/Z 60 onwards
|-
| {{key|Fn}}{{key|F3}} || blank screen || [[thinkpad-acpi]] || full ||
|-
| {{key|Fn}}{{key|F4}} || suspend to ram || [[thinkpad-acpi]] || full || may generate ACPI event when not enabled in the thinkpad-acpi hotkey mask
|-
| {{key|Fn}}{{key|F5}} || switch bluetooth || [[thinkpad-acpi]] || full || in models starting from 2002
|-
| {{key|Fn}}{{key|F6}} || Video conference || || || Starting with the T400s (icon of a camera and a headset)
|-
| {{key|Fn}}{{key|F7}} || toggle display || [[thinkpad-acpi]], [[#tpb configuration|tpb]] || additional actions || [[Sample Fn-F7 script]]
|-
| {{key|Fn}}{{key|F8}} || toggle trackpoint/touchpad || [[thinkpad-acpi]], [[#tpb configuration|tpb]] || additional actions ||
|-
| {{key|Fn}}{{key|F9}} || eject from dock || [[thinkpad-acpi]] || full ||
|-
| {{key|Fn}}{{key|F10}} || - || [[thinkpad-acpi]] || full ||
|-
| {{key|Fn}}{{key|F11}} || - || [[thinkpad-acpi]] || full ||
|-
| {{key|Fn}}{{key|F12}} || hibernate || [[thinkpad-acpi]] || full || may generate ACPI event when not enabled in the thinkpad-acpi hotkey mask
|-
| {{key|Fn}}{{key|Home}} / {{key|Fn}}{{key|Pos1}} || brightness up || [[thinkpad-acpi]], [[#tpb configuration|tpb]], [[KMilo]] || additional actions ||
|-
| {{key|Fn}}{{key|End}} || brightness down || [[thinkpad-acpi]], [[#tpb configuration|tpb]], [[KMilo]] || additional actions ||
|-
| {{key|Fn}}{{key|PageUp}} || toggle thinklight || [[thinkpad-acpi]], [[#tpb configuration|tpb]], [[KMilo]] || additional actions ||
|-
| {{key|Fn}}{{key|Space}} || toggle zoom || [[thinkpad-acpi]], [[#tpb configuration|tpb]], [[KMilo]] || full ||
|-
| {{key|Fn}}{{key|Ins}} || - || [[thinkpad-acpi]]|| full ||
|-
| {{key|Fn}}{{key|Del}} || - || [[thinkpad-acpi]] || full ||
|-
| {{key|Fn}}{{key|Backspace}} || - || [[thinkpad-acpi]] || full ||
|-
| {{key|NumLock}} || - || [[#xmodmap configuration|xmodmap]] || make working ||
|-
| {{key|Windows}} || - || [[#xmodmap configuration|xmodmap]] || remapping ||
|-
| {{ibmkey|Access IBM|#495988}} or {{ibmkey|ThinkPad|#494949}} or {{ibmkey|ThinkVantage|#495988}} || help application || [[thinkpad-acpi]],[[#tpb configuration|tpb]], [[KMilo]] || full ||
|-
| {{ibmkey|Home|#494949}} || open web browser || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]], [[KMilo]] || full || only {{A30}}, {{A30p}}, {{A31}}, {{A31p}} and ext. keyboards
|-
| {{ibmkey|Search|#494949}} || open search application || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]], [[KMilo]] || full || only {{A30}}, {{A30p}}, {{A31}}, {{A31p}} and ext. keyboards
|-
| {{ibmkey|Mail|#494949}} || open mail application || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]], [[KMilo]] || full || only {{A30}}, {{A30p}}, {{A31}}, {{A31p}} and ext. keyboards
|-
| {{ibmkey|Favorites|#494949}} || open favorites || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]] || full || only {{A30}}, {{A30p}}, {{A31}}, {{A31p}} and ext. keyboards
|-
| {{ibmkey|Reload|#494949}} || reload web page || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]] || full || only {{A30}}, {{A30p}}, {{A31}}, {{A31p}} and ext. keyboards
|-
| {{ibmkey|Abort|#494949}} || abort loading page || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]] || full || only {{A30}}, {{A30p}}, {{A31}}, {{A31p}} and ext. keyboards
|-
| {{ibmkey|Backward|#494949}} || previous page || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]] || full || ext. keyboards and ThinkPads starting from 2002
|-
| {{ibmkey|Forward|#494949}} || next page || [[#xmodmap configuration|xmodmap]], [[#tpb configuration|tpb]] || full || ext. keyboards and ThinkPads starting from 2002
|-
| {{ibmkey|Volume up|#494949}} || volume up || [[thinkpad-acpi]], [[#tpb configuration|tpb]], [[KMilo]] || additional actions ||
|-
| {{ibmkey|Volume down|#494949}} || volume down || [[thinkpad-acpi]], [[#tpb configuration|tpb]], [[KMilo]] || additional actions ||
|-
| {{ibmkey|Volume mute|#494949}} || mute volume || [[thinkpad-acpi]], [[#tpb configuration|tpb]], [[KMilo]] || additional actions ||
|-
| {{ibmkey|Microphone mute|#494949}} || Microphone volume || || || Starting with the T400s
|-
| {{ibmkey|Play/Pause|#494949}} || start/pause playback || [[#xmodmap configuration|xmodmap]] || full || {{X60s}} (Fn+Arrow Down)
|-
| {{ibmkey|Stop|#494949}} || stop playback || [[#xmodmap configuration|xmodmap]] || full || {{X60s}} (Fn+Arrow Up)
|-
| {{ibmkey|Next|#494949}} || play next || [[#xmodmap configuration|xmodmap]] || full || {{X60s}} (Fn+Arrow Right)
|-
| {{ibmkey|Previous|#494949}} || play previous || [[#xmodmap configuration|xmodmap]] || full || {{X60s}} (Fn+Arrow Left)
|-
| {{ibmkey|Power|#494949}} || shutdown || [[thinkpad-acpi]] || full || triggered on pressing 3secs, but notebook goes off on 5sec press
|-
| Display lid || blank screen || acpi video || full ||
|-
| Ultrabay eject || announce ultrabay change || acpi bay || full ||
|-
| Dock eject || eject from dock || acpi dock || full ||
|-
| {{ibmkey|Tablet power|#494949}} || shutdown || [[thinkpad-acpi]] || full || triggered on pressing 3secs, but notebook goes off on 5sec press
|-
| {{ibmkey|Tablet orientation|#494949}} || rotates screen || [[#Mapping keys with setkeycodes|setkeycodes]] || full ||
|-
| {{ibmkey|Tablet shortcut|#494949}} || shortcut menu || [[#Mapping keys with setkeycodes|setkeycodes]] || full ||
|-
| {{ibmkey|Tablet Esc|#494949}} || esc key || [[#Mapping keys with setkeycodes|setkeycodes]] || full ||
|-
| {{ibmkey|Tablet Enter|#494949}} || enter key || [[#mapping keys with setkeycodes|setkeycodes]] || full ||
|-
| {{ibmkey|Tablet Up|#494949}} || up key || [[#Mapping keys with setkeycodes|setkeycodes]] || full ||
|-
| {{ibmkey|Tablet Down|#494949}} || down key || [[#Mapping keys with setkeycodes|setkeycodes]] || full ||
|-
| {{ibmkey|Tablet (unlabeled)|#494949}} || down key || [[#Mapping keys with setkeycodes|setkeycodes]] || full ||
|}

For completeness, note that the WiFi enable/disable switch is located (on the X61 and other models that have it) just under the front edge of the base of the machine. You should see a small horizontal slider switch. Enable by sliding it rightwards, disable by sliding it leftwards.

Tablet buttons vary with model. See [[Tablet Hardware Buttons]].

==Triggering key events==

===thinkpad_acpi events===
The thinkpad_acpi driver should automatically select an appropriate mask for your machine.
But on a rare occasions you might need to change the hotkey mask for key events to happen. In that case,
read the recommended hotkey_mask from hotkey_recommended_mask, set the extra bits you need, and write
the result to hotkey_mask. These files (actually, "sysfs attributes") can be found on {{path|sys/devices/platform/thinkpad_acpi}}

These events can be used to configure HAL or [[How to configure acpid|acpid]].

{{WARN|The below list of ACPI key events seems to have been invalidated on some platforms by a recent update (March 2013) - for details, see [[Talk:Thinkpad-acpi#Problem_with_ACPI_key_event_codes_in_OpenSuse_12.3|Problem with ACPI key event codes in OpenSuse 12.3]].}}

{| {{prettytable}}
|+ events triggered by [[thinkpad-acpi]]. May vary on different models.
! key !! acpi event || IBM ThinkPad hal event || Lenovo ThinkPad hal event
|-
| {{key|Fn}}{{key|F1}} || ibm/hotkey HKEY 00000080 00001001 || ||
|-
| {{key|Fn}}{{key|F2}} || ibm/hotkey HKEY 00000080 00001002 || 0x01:battery || 0x01:screenlock
|-
| {{key|Fn}}{{key|F3}} || ibm/hotkey HKEY 00000080 00001003 || 0x02:screenlock || 0x02:battery
|-
| {{key|Fn}}{{key|F4}} || ibm/hotkey HKEY 00000080 00001004 || 0x03:sleep || 0x03:sleep
|-
| {{key|Fn}}{{key|F5}} || ibm/hotkey HKEY 00000080 00001005 || 0x04:radio || 0x04:radio
|-
| {{key|Fn}}{{key|F6}} || ibm/hotkey HKEY 00000080 00001006 || ||
|-
| {{key|Fn}}{{key|F7}} || ibm/hotkey HKEY 00000080 00001007 || 0x06:switchvideomode || 0x06:switchvideomode
|-
| {{key|Fn}}{{key|F8}} || ibm/hotkey HKEY 00000080 00001008 || 0x07:zoom || 0x07:f22
|-
| {{key|Fn}}{{key|F9}} || ibm/hotkey HKEY 00000080 00001009 || 0x08:f24 || 0x08:f24
|-
| {{key|Fn}}{{key|F10}} || ibm/hotkey HKEY 00000080 0000100a || ||
|-
| {{key|Fn}}{{key|F11}} || ibm/hotkey HKEY 00000080 0000100b || ||
|-
| {{key|Fn}}{{key|F12}} || ibm/hotkey HKEY 00000080 0000100c || 0x0b:suspend || 0x0b:suspend
|-
| {{key|Fn}}{{key|Backspace}} || ibm/hotkey HKEY 00000080 0000100d || ||
|-
| {{key|Fn}}{{key|Ins}} || ibm/hotkey HKEY 00000080 0000100e || ||
|-
| {{key|Fn}}{{key|Del}} || ibm/hotkey HKEY 00000080 0000100f || ||
|-
| {{key|Fn}}{{key|Home}}/{{key|Fn}}{{key|Pos1}} || ibm/hotkey HKEY 00000080 00001010 || 0x0f:brightnessup || 0x0f:brightnessup
|-
| {{key|Fn}}{{key|End}} || ibm/hotkey HKEY 00000080 00001011 || 0x10:brightnessdown || 0x10:brightnessdown
|-
| {{key|Fn}}{{key|PgUp}} || ibm/hotkey HKEY 00000080 00001012 || 0x11:kbdillumtoggle || 0x11:kbdillumtoggle
|-
| {{key|Fn}}{{key|Space}} || ibm/hotkey HKEY 00000080 00001014 || 0x13:zoom || 0x13:zoom
|-
| {{ibmkey|Volume up|#494949}}|| ibm/hotkey HKEY 00000080 00001015 || 0x14:volumeup || 0x14:volumeup
|-
| {{ibmkey|Volume down|#494949}} || ibm/hotkey HKEY 00000080 00001016 || 0x15:volumedown || 0x15:volumedown
|-
| {{ibmkey|Volume mute|#494949}} || ibm/hotkey HKEY 00000080 00001017 || 0x16:mute || 0x16:mute
|-
| {{ibmkey|Microphone mute|#494949}} || ibm/hotkey HKEY 00000080 0000101b || ||
|-
| {{ibmkey|Access IBM|#495988}} or {{ibmkey|ThinkPad|#494949}} or {{ibmkey|ThinkVantage|#495988}} || ibm/hotkey HKEY 00000080 00001018 || 0x17:prog1 || 0x17:prog1
|-
| Ultrabay eject || ibm/bay MSTR 00000003 00000000 || ||
|-
| Ultrabay inserted || ibm/bay MSTR 00000001 00000000 || ||
|-
| Dock eject || ibm/dock GDCK 00000003 00000001 || ||
|-
| Wireless switch || ibm/hotkey HKEY 00000080 00007000 || ||
|}

By disassembling and editing the DSDT, more events can be added. HKEY events are triggered by calls to the MKHQ function, e.g. <tt>\_SB.PCI0.LPC.EC.HKEY.MHKQ(0Ã—1007)</tt> will trigger "ibm/hotkey HKEY 00000080 00001007". Most of these can be found in <tt>_Qxx</tt> methods within the DSDT, which are executed on embedded controller events, e.g. _Q10 is triggered by pressing Fn-F7. You can add a call to MKHQ into an existing <tt>_Qxx</tt> method to get it recognized by thinkpad-acpi as well as creating new <tt>_Qxx</tt> methods, which if you're lucky will correspond to an EC event that IBM never used (e.g. A 770 will send Fn-Home/End/PgUp/PgDn to thinkpad-acpi if hacked in this fashion). For example, [http://www.wormnet.eu/ibm-g40/morebuttons.dsl this is a modified block of DSDT for a G40].

=== ACPI events from the <tt>button</tt> module===

A few keys can generate ACPI events that result from the <tt>button</tt> kernel module, as long as they are masked off in the <tt>thinkpad-acpi</tt> hotkey's mask or the hotkey function of the latter module is disabled.

If you want the ThinkPad's BIOS and ACPI methods to know about these keys being pressed, you probably want to leave them masked out from thinkpad-acpi, and use their non-HKEY events listed below, instead.

{| {{prettytable}}
|+ events triggered by ACPI when hotkey is masked out or disabled.
! key !! event !! T60 event
|-
| {{ibmkey|Power|#494949}} || button/power PWRF 00000080 xxxxxxxx || button/power PWRF 00000080 00000001
|-
| {{key|Fn}}{{key|F4}} || button/sleep SLPB 00000080 00000001 || button/sleep SLPB 00000080 00000001
|-
| Display lid || button/lid LID 00000080 xxxxxxxx || button/lid LID 00000080 00000001
|}

===Configuration using HAL===

Modern distributions like Ubuntu 8.10 and Fedora 10 use HAL to configure the kernel input devices. Xorg in turn gets these key events through the evdev driver and will no longer try to take control of the input devices away from the kernel.

But before you get started on this you should make sure you have all the updates applied from your distro vendor as both Ubuntu 8.10 and Fedora 10 require some additional fixes that you might need.
====Xorg problems====
You may find that by default some buttons will work in Xorg and others will not (e.g. Fn-Space). The reason for this is that Xorg is limited to 255 different key codes, and some keys are mapped to key codes that are out of range for Xorg. The Xorg developers are aware of this issue and plan to fix it in XKB2. Unfortunately support for XKB2 has slipped and is now planned for Xorg 1.8, sometime in 2010.

{{HINT|You can get Fn-Space working via ACPI events. Here is a practical [http://www.thinkwiki.org/wiki/Installing_Ubuntu_10.04_(Lucid_Lynx)_on_a_ThinkPad_Z61m#Make_Fn-Space_.28Screen_Magnify.29_work HOWTO] for Ubuntu 10.04 Lucid}}

Default HAL config files are located in {{path|/usr/share/hal/fdi}}. If you create any custom files you should instead place them in {{path|/etc/hal/fdi}} to prevent them from getting overwritten by the next hal-info package update of your distribution.

You can see for instance the mapping between {{path|/usr/share/hal/fdi/information/10freedesktop/30-keymap-module-thinkpad-acpi.fdi}} and that of the kernel [http://git.kernel.org/?p=linux/kernel/git/torvalds/linux-2.6.git;a=blob_plain;f=include/linux/input.h;hb=HEAD input.h] header file.

keyboard events defined in input.h in the 0x100 range and above will be ignored by current Xorg. If you want to work around this you can change the hal config file such that for instance the Fn-F5 key no longer maps to '''radio''' (0x181) but to '''wlan''' (238) or '''bluetooth''' (237).

Have a look at the HAL documentation for samples on how to configure your own events [http://hal.freedesktop.org/quirk/quirk-keymap-index.html].

To check if a key is being handled by Xorg, start xev and press the key. If you do not see any output from the keypress it is not handled. If it is handled you can configure the key in Gnome with gnome-keybinding-properties (kde??).

====bypassing Xorg====
Since the keys are handled by the kernel and passed through hal, we can bypass Xorg and have a key run a specific task.
This is useful if Xorg cannot handle the key (out of range, or X doesn't
matter this input key), or if your not running X. This can be done with the
'''halevt''' program (located at [http://www.nongnu.org/halevt|http://www.nongnu.org/halevt] ; for Debian systems, use a version >= 0.1.5-1). This program can react to some events detected by HAL such a special key press. For example, to run a custom script when Fn-F5 (Radio toggle) is pressed, you could put a stanza in halevt's configuration file ('''/etc/halevt/halevt.xml''', in XML format) :

<nowiki>
<halevt:Device match="hal.info.category = input">

<halevt:Condition name="ButtonPressed" value="wlan" exec="sudo /usr/local/sbin/toggle_wlan"/>
</halevt:Device>
</nowiki>

Here, '''sudo''' is used as the halevt daemon runs with its own user, which don't have required rights to do the work in the custom script ''/usr/local/sbin/toggle_wlan'', so in ''/etc/sudoers'', we have :

halevt ALL = NOPASSWD: /usr/local/sbin/toggle_wlan

Be careful when writing halevt configuration, as the daemon isn't very verbose about what it does or not : you don't get error messages when command run fails…

===inputlirc configuration===

An alternative to halevt is inputlirc [http://ajoute.org/wiki/doc/linux/inputlirc]. After installation of the packages inputlirc [http://packages.debian.org/search?keywords=inputlirc] and lirc, you can test it with the irw command. To run custom scripts you need a configuration for the irexec daemon ('''/etc/lirc/lircrc''') :

<nowiki>
begin
prog = irexec
button = KEY_RADIO
config = /etc/acpi/wireless.sh
end

begin
prog = irexec
button = KEY_SCREENLOCK
config = /etc/acpi/thinkpad-lockorbattery.sh
end
</nowiki>

===tpb configuration===
{| {{prettytable}}
|+ configuration keywords for [[tpb]] (to put in {{path|/etc/tpbrc}})
! key !! config keyword
|-
| {{ibmkey|Access IBM|#495988}} or {{ibmkey|ThinkPad|#494949}} || THINKPAD
|-
| {{ibmkey|Home|#494949}} || HOME
|-
| {{ibmkey|Search|#494949}} || SEARCH
|-
| {{ibmkey|Mail|#494949}} || MAIL
|-
| {{ibmkey|Favorites|#494949}} || FAVORITES
|-
| {{ibmkey|Reload|#494949}} || RELOAD
|-
| {{ibmkey|Abort|#494949}} || ABORT
|-
| {{ibmkey|Backward|#494949}} || BACKWARD
|-
| {{ibmkey|Forward|#494949}} || FORWARD
|-
| {{key|Fn}} || FN
|-
| {{key|Fn}}{{key|Space}} || CALLBACK (zoom on/off)
|-
| {{key|Fn}}{{key|PageUp}} || CALLBACK (thinklight on/off)
|-
| {{key|Fn}}{{key|F7}} || CALLBACK (display lcd/crt/both)
|-
| {{key|Fn}}{{key|F8}} || CALLBACK (expand on/off)
|-
| {{key|Fn}}{{key|Home}} / {{key|Fn}}{{key|Pos1}} || CALLBACK (brightness <percent>)
|-
| {{key|Fn}}{{key|End}} || CALLBACK (brightness <percent>)
|-
| {{ibmkey|Volume up|#494949}} || CALLBACK (volume <percent>)
|-
| {{ibmkey|Volume down|#494949}} || CALLBACK (volume <percent>)
|-
| {{ibmkey|Volume mute|#494949}} || CALLBACK (mute on/off)
|}

To all parameter keywords should be assigned the full path to the executables supposed to be started on key press.
The exectable provided for the CALLBACK keyword should take the parameters given in parentheses and act according to them.
If you want to use xmodmap for the HOME, SEARCH, MAIL, FAVORITES, RELOAD, ABORT, BACKWARD, FORWARD and FN keys you should
provide a <tt>XEVENTS OFF</tt> in your {{path|/etc/tpbrc}}.
You can use an appropriate executable to [[How to inject fake keystrokes|inject fake keystrokes]].

For Debian users, tpb is started from {{path|/etc/X11/Xsession.d/90tpb}}.

'''Sound Button configuration'''

''Note: Tested on T60p with Ubuntu 6.06 LTS''

Most Thinkpads have a hardware sound mixer, thus the volumes buttons should work without configuration. However, this change is not reflected in the software mixer. tpb has a switch to enable software mixer support via OSS. The manual recommends this only for devices without a hardware mixer, but it also works for other hadware mixer enabled devices, even with the ALSA system. Just put MIXER ON in your {{path|/etc/tpbrc}} file and you can see the effect immediately in any ALSA mixer (e.g. kmix). For this to work you need write permissions to {{path|/dev/nvram}}.

''Note: Tested on X21 with Ubuntu 6.06 LTS''

On the ThinkPad X21 (and maybe some other older models) ACPI causes problems with tpb. On an X21 using acpi the volume buttons would work occasionally, and the OSD for tpb functions would rarely work. If a volume buttons was pressed too often, sometimes the computer would enter a low power (unplugged state) and would require a reboot. The solution is to use APM instead of ACPI. Instructions can be found in [[How_to_make_APM_work]].

===KMilo configuration===
The programs to be executed by [[KMilo]] are configured via the KDE Control Center (<tt>kcontrol</tt>), under <tt>System Administration --> IBM Thinkpad Laptop</tt>. Note that you can use appropriate commands to [[How to inject fake keystrokes|inject fake keystrokes]].

===xmodmap configuration===
xmodmap enables you to edit the modifier map and keymap tables that are used to translate keycodes into keysyms.
Understood? Well, basically it allows you to give the X server a dictionary for the translation of keycodes like "97" into more human readable synonyms like "Home". This way xmodmap allows you to make the special keys of your keyboard known to X applications.

To discover the keycode that a certain keypress produces, use the tool {{cmduser|xev}}

Usually you should write your keycode-keysym associations into the file {{path|~/.Xmodmap}}. This file is usually read by the X session startup scripts of your system, so that the mappings automatically get included everytime you run the X server.

The {{path|~/.Xmodmap}} lines for our purpose are in the form of
keycode <keycode> = <keysym>

Load the assocation using the command

{{cmduser|xmodmap ~/.Xmodmap}}

(some configurations do this automatically upon X startup).

The following table shows the keycodes generated by the ThinkPad special keys and sensible keysyms to assign them to.
{| {{prettytable}}
|+ keycodes and recommended keysyms
! key !! keycode !! keysym
|-
| {{ibmkey|Access IBM|#495988}} or {{ibmkey|ThinkPad|#494949}} || 159 || XF86LaunchA
|-
| {{ibmkey|Backward|#494949}} || 234 || XF86Back or F19
|-
| {{ibmkey|Forward|#494949}} || 233 || XF86Forward or F20
|-
| {{ibmkey|Play/Pause|#494949}} || 162 || XF86AudioPlay
|-
| {{ibmkey|Stop|#494949}} || 164 || XF86AudioStop
|-
| {{ibmkey|Next|#494949}} || 153 || XF86AudioNext
|-
| {{ibmkey|Previous|#494949}} || 144 || XF86AudioPrev
|-

| {{ibmkey|Home|#494949}} || 178 || XF86HomePage
|-
| {{ibmkey|Search|#494949}} || 229 || XF86Search
|-
| {{ibmkey|Mail|#494949}} || 236 || XF86Mail
|-
| {{ibmkey|Favorites|#494949}} || 230 || XF86AddFavorite or XF86Favorites
|-
| {{ibmkey|Reload|#494949}} || 231 || XF86Reload
|-
| {{ibmkey|Abort|#494949}} || 232 || XF86Stop
|-
| {{key|Fn}} || 227 || F35
|}

Note: You can also use xkeycaps (an X tool to display and edit the X keyboard mapping) to generate proper .Xmodmap.

Note: if you are running [[tpb]] you might need to add the line <tt>XEVENTS=off</tt> into your tpbrc to stop it from grabbing the key events and allow them to get through to X instead. See [[http://www.thinkwiki.org/wiki/Tpb]] for more detailed instruction on how to use tpb and xmodmap.

Note: XF86Forward and XF86Back do not work correctly in Firefox. You may want to map them to F19 and F20 instead if you use Firefox.

Note: The "XF86AudioPlay" etc. just works with a few programs. To make it work with more multimedia programs you have map the key to use something like [http://www.kde-apps.org/content/show.php/ReMoot?content=63140 ReMoot]. ReMoot is a command line wrapper that control 18 of the most common multimedia applications.

=====Enabling the Windows and Menu Keys=====
On some systems the Windows and Menu keys may not be recognized. You can enable then by
making the following changes:

keycode 115 = F13
keycode 227 = F35

F13 and F35 are used for the Windows and and Menu keys respectively. Labelling keycpode 227 as "Menu" may conflict with the right-mouse-click event.

=====Using Caps Lock as Super L (Windows key)=====
You can easily use Caps Lock as Win key by adding the following in your ~/.Xmodmap:
! No Caps Lock
clear lock
! Caps Lock as Win key
add mod4 = Caps_Lock
=====NumLock=====
On the ThinkPad {{600}}, {{T20}}, {{T21}}, {{T22}}, {{T30}}, {{X20}}, {{X21}}, {{X31}}, {{X40}}, {{T42p}}, {{T43}}, {{R51}}, {{R52}} and possibly other models, X does not recognize the keycode for {{key|NumLk}} = {{key|Shift}}+{{key|ScrLk}}. To fix this, add the following to {{path|~/.Xmodmap}} in your home directory or {{path|/etc/X11/Xmodmap}} and run <tt>xmodmap</tt>, ex: <tt>xmodmap ~/.Xmodmap</tt>:
keycode 77 = Num_Lock

The following might work better for you:
keycode 77 = Num_Lock Num_Lock
because you will only get keycode 77 together with Shift (at least on the {{T43}})

This configuration also enables the respective LED.

Please note, pressing the {{key|Shift}}+{{key|ScrLk}} key combination, without first following the above configuration, will start an accessibility feature, which will allow the numeric keypad to maneuver the mouse pointer. Starting this accessibility feature and subsequently running xmodmap, as described above, results in the accessibility feature and the numeric lock LED functioning simultaneously. As such, the above configuration should be completed before the accessibility feature is started in order to produce numbers.
======T60 (and possibly others)======
It seems that on the T60, PrtSc, ScrLk and Pause all generate the correct keycodes, however Fn-PrtSc (labelled as SysRq) generates keycode 64 (Alt_L) followed by the expected 111 (Sys_Req) on down and the same thing in the opposite order on release. Fn-ScrLk (labelled as NmLk) does indeed toggle the Numlock, but only seems to register as an X event the first time it is engaged. The above solution does not appear to work. This is perhaps because the Numlock toggle is built into the firmware rather than controlled by the kernel. Finally, Fn-Pause (labelled as Break) generates keycode 37 (Control_L) followed by the expected keycode 110 (Break) on down and the same thing in reverse order on release.

=====NumPad (KeyPad) keys access by a key combination=====
The current state is that you have to switch NumLock '''on''' via {{key|Fn}}+{{key|ScrLk}} and then e.g. type {{key|u}} to get a {{key|KP_4}} (NumPad 4). To get back to normal keyboard, you have to type {{key|Fn}}+{{key|ScrLk}} again.

Some people (including me) are missing on recent Thinkpads the option to have Fn as a modifier key to access the NumPad instead, i.e. and e.g. {{key|Fn}}+{{key|u}} gives you {{key|KP_4}}.

There is currently no way to make this work in a simple way (pleeeease correct me if I am wrong!), though there is a work-around. Instead of using {{key|Fn}} for accessing the NumPad, {{key|CapsLock}} can get this function by being mapped as Mode_switch (the {{key|AltGr}} on international keyboards). The {{key|Fn}} can be remapped to be Caps_Lock - while at the same time retaining its function to access the special laptop functions (e.g. {{key|Fn}}+{{key|F4}} for sleep}}, by using .Xmodmap.

So on my {{R60}} running fvwm@{{Slackware}} 12.1 the .Xmodmap would look like this:

! Make the forward and back buttons work
keycode 233 = XF86Forward
keycode 234 = XF86Back
! Make the WIN key to Super modifier
keycode 115 = Super_L
! Set the Caps_Lock physical key to Mode_switch (like AltGr on intl. keyboards)
keycode 66 = Mode_switch
! Set the Fn key to work as Caps_Lock now. The special key combos like Fn-F4 for "sleep" still work then
keycode 227 = Caps_Lock
clear lock
add lock = Caps_Lock
! Now we activate those new keys. Find some free mod slots (xmodmap) and put them there.
clear mod4
clear mod5
add mod4 = Super_L
add mod3 = Mode_switch
! It's time to add the keypad keys to the third position of the key definition (pure shift mode_switch shift+mode_switch)
keycode 16 = 7 ampersand KP_7
keycode 17 = 8 asterisk KP_8
keycode 18 = 9 parenleft KP_9
keycode 19 = 0 parenright KP_Divide
keycode 30 = u U KP_4
keycode 31 = i I KP_5
keycode 32 = o O KP_6
keycode 33 = p P KP_Multiply
keycode 44 = j J KP_1
keycode 45 = k K KP_2
keycode 46 = l L KP_3
keycode 47 = semicolon colon KP_Subtract
keycode 58 = m M KP_0
! ... I have to use the coma key, too, on the keypad...so I set it to be F20 (which is not existing on normal keyboards and thus is free... check for side effects in programmes accepting F12+ keys!)
keycode 59 = comma less F20
keycode 60 = period greater KP_Decimal
keycode 61 = slash question KP_Add

{{WARN|Your keycodes might be different as well as your '''mod''#''''' settings.}}
Use {{cmduser|xmodmap}} and {{cmduser|xmodmap -pke}} to check your ModMap, and the tool {{cmduser|xev}} to obtain your exact key codes.

===Mapping keys with setkeycodes===
You can use the setkeycodes command to remap certain keys. I.e. you can use {{cmdroot|setkeycodes 6e 109 6d 104 69 28 6b 1}} to map the Tablets Up and Down keys to the standard PageUp and PageDown keys and Tablet Escape and Enter to their respective keys.

The following table shows the scancodes generated by the ThinkPad keys. They vary with model - see [[Tablet Hardware Buttons]].
{| {{prettytable}}
|+ scancodes
! key !! scancode
|-
| {{ibmkey|Tablet orientation|#494949}} || 0x6c
|-
| {{ibmkey|Tablet Shortcut|#494949}} || 0x68
|-
| {{ibmkey|Tablet Esc|#494949}} || 0x6b
|-
| {{ibmkey|Tablet Enter|#494949}} || 0x69
|-
| {{ibmkey|Tablet Up|#494949}} || 0x6d
|-
| {{ibmkey|Tablet Down|#494949}} || 0x6e
|-
| {{ibmkey|Tablet (unlabeled)|#494949}} || 0x67
|}

===acpi_fakekey===
You can turn acpi events into user-level xevents by putting <tt>acpi_fakekey</tt> commands into the acpi action scripts. There are several layers involved in using acpi keys in this way, so I'll go through the example of using the ThinkVantage button to open xmms.

My ThinkVantage button generates an '''acpi event''' "ibm/hotkey HKEY 00000080 00001018", so we have the event file <tt>/etc/acpi/events/ThinkVantage</tt> for it which executes the script <tt>/etc/acpi/actions/fakekey-macro.sh</tt>.
<pre>
event=ibm/hotkey HKEY 00000080 00001018
action=/etc/acpi/actions/fakekey-macro.sh
</pre>
In turn, the executable <tt>/etc/acpi/actions/fakekey-macro.sh</tt> script calls acpi_fakekey with the '''key number''' defined in <tt>/usr/share/acpi-support/key-constants</tt> as $KEY_MACRO which is 112 (you could just as well choose an other key number, just make sure that it doesn't belong to something else like the "j" key or something).
<pre>
#!/bin/sh
. /usr/share/acpi-support/key-constants
acpi_fakekey $KEY_MACRO
</pre>
I have no idea how this actually corresponds to which xevent is generated, so I can find out out by running the program <tt>xev</tt> and hitting the ThinkVantage button while the mouse is in the <tt>xev</tt> window (remember to <tt>/etc/init.d/acpid restart</tt> first if you just created the <tt>/etc/acpi/events/ThinkVantage</tt> file). I get something popping up in the terminal where I ran xev that looks like this:
<pre>
KeyPress event, serial 30, synthetic NO, window 0x2800001,
root 0x6a, subw 0x0, time 2000522842, (138,83), root:(781,500),
state 0x0, keycode 239 (keysym 0x0, NoSymbol), same_screen YES,
XLookupString gives 0 bytes:
XmbLookupString gives 0 bytes:
XFilterEvent returns: False

KeyRelease event, serial 30, synthetic NO, window 0x2800001,
root 0x6a, subw 0x0, time 2000522842, (138,83), root:(781,500),
state 0x0, keycode 239 (keysym 0x0, NoSymbol), same_screen YES,
XLookupString gives 0 bytes:
XFilterEvent returns: False
</pre>
This tells me that the <tt>acpi_fakekey 112</tt> as executed by hitting the ThinkVantage button generates KeyPress event followed by a KeyRelease event with '''keycode''' 239 and that this keycode has been assigned no corresponding '''keysym'''. Thus, I am free to assign the keycode to any keysym I want. You can find a list of available keysyms in <tt>/usr/share/X11/XKeysymDB</tt>. Again try and pick one that is not likely to have already been taken by something, such as <tt>XF86LaunchA</tt>. To assign this keysym to keycode 239, you can either edit ~/.Xmodmap on an individual user basis, or edit the systemwide <tt>/etc/X11/Xmodmap</tt> file to contain the line
<pre>
keycode 239 = XF86LaunchA
</pre>
If you choose to go with the former, you may need to run <tt>xmodmap ~/.Xmodmap</tt> for every login session in order to read in your ~/.Xmodmap file if your window manager does not do it for you. Regardless of which option you choose, you can run <tt>xmodmap <file></tt> to read in the updated Xmodmap file without logging out and logging back in.

You should now find that hitting the ThinkVantage button creates the following output from <tt>xev</tt>:
<pre>
KeyPress event, serial 55, synthetic NO, window 0x2800001,
root 0x6a, subw 0x0, time 2001286078, (0,106), root:(643,523),
state 0x0, keycode 239 (keysym 0x1008ff4a, XF86LaunchA), same_screen YES,
XLookupString gives 0 bytes:
XmbLookupString gives 0 bytes:
XFilterEvent returns: False

KeyRelease event, serial 55, synthetic NO, window 0x2800001,
root 0x6a, subw 0x0, time 2001286078, (0,106), root:(643,523),
state 0x0, keycode 239 (keysym 0x1008ff4a, XF86LaunchA), same_screen YES,
XLookupString gives 0 bytes:
XFilterEvent returns: False
</pre>
Note the change of <tt>(keysym 0x0, NoSymbol)</tt> to <tt>(keysym 0x1008ff4a, XF86LaunchA)</tt>.

You're now ready to map <tt>XF86LaunchA</tt> to executing xmms. This is highly dependent on what keygrabber you decide to use. For openbox, I edit my <tt>~/.config/openbox/rc.xml</tt> file and add the following entry in the <keyboard> section:
<pre>
<keybind key="XF86LaunchA">
<action name="Execute">
<startupnotify>
<enabled>true</enabled>
</startupnotify>
<command>
xmms
</command>
</action>
</keybind>
</pre>
After, right clicking on the desktop and selecting the "Reconfigure" menu option, you should then have xmms pop up when you hit the ThinkVantage key.

==Example Applications==
===Web Browsers===
====Firefox (<3.0)====

There are various ways to assign actions to the browser keys. The easiest way is to install [http://mozilla.dorando.at/keyconfig.xpi keyconfig.xpi] from http://mozilla.dorando.at, which adds a menu entry Tools->Keyconfig. Then you can assign any action you want to the F19/F20 keys (you still need to create {{path|~/.Xmodmap}} as explained above).

The remaining discussion gives you various more complicated ways to achieve the same thing.
To have firefox make use of the browser keys you need to modify one of its files{{footnote|4}}.
To do this you will first need to extract it from the {{path|browser.jar}} archive. Do...

Step 1: Edit .Xmodmap and add entries for F19 and F20 as explained above.

Step 2:

Note: <firefox-directory> is probably /usr/lib/firefox. Use your version so, if you have 3.0.1 or 3.0.2 use /usr/lib/firefox-3.0.1

:{{cmdroot|cd <firefox-directory>/chrome}} 
:{{cmdroot|unzip browser.jar}}

The file of interest is {{path|content/browser/browser.xul}}. Edit it {and don't forget to make a backup copy first}...
:{{cmdroot|vi content/browser/browser.xul}}

Look for the '''<keyset id="mainKeyset">''' section and add the following lines within...
<key id="goBackKb" keycode="VK_F19" command="Browser:Back" />
<key id="goForwardKb" keycode="VK_F20" command="Browser:Forward" />

The Command you need for Next Tab
<key id="goBackTabKb" keycode="VK_F19" oncommand="gBrowser.mTabContainer.advanceSelectedTab(-1)" />
For the Previous Tab
<key id="goForwardTabKb" keycode="VK_F20" oncommand="gBrowser.mTabContainer.advanceSelectedTab(1)" />

Now save the file and repackage the {{path|browser.jar}} archive...
:{{cmdroot|zip -rD0 browser.jar content/browser/}}

That's it.

Step 3: Restart Firefox.

{{HINT|Outdated: Another interesting Page on Firefox is http://dqd.com/~mayoff/notes/thinkpad/dqdnavkeys/ It uses different key mappings (F19 resp. F20) but a ready [http://dqd.com/~mayoff/notes/thinkpad/dqdnavkeys/dqdnavkeys-1.2.xpi .xpi] is provided which is pretty comfortable. However, this xpi file does not install on Firefox 1.5. or later.}}

{{HINT| You can also use the [http://extensionroom.mozdev.org/more-info/keyconfig keyconfig] extension to configure custom keys. This extension works with Firefox 1.5 and also with Firefox 2.0. The Command you need for Next Tab is gBrowser.mTabContainer.advanceSelectedTab(1,true); For Previous Tab its gBrowser.mTabContainer.advanceSelectedTab(-1,true); You can alternatively install the [http://www.pqrs.org/~tekezo/firefox/extensions/functions_for_keyconfig/index.html functions for keyconfig] and set the variable f4kc_NextTab to F20 and f4kc_PrevTab to F19.}}.

====Firefox 3.0====
Thankfully the people at Mozilla decided to include the expected functionality for the XF86Back and XF86Forward keysyms in the new release so all you need to do is
 <code># printf 'keycode 234 = XF86Back\nkeycode 233 = XF86Forward' >> /etc/X11/Xmodmap</code> 
And to make this take effect immediately (i.e., without having to log out and log in again), as a regular user run:
 {{cmduser|Xmodmap /etc/X11/Xmodmap}}

For Hardy Heron, the xmodmap command is all lowercase. Also, the /etc/X11/Xmodmap file is not being read on boot. I've added the command to my .bashrc to have it called on startup.

====Konqueror====
KDE allows you set key mappings for KDE applications (Go to KMenu > System > Control Center > Regional & Accessibility > Keyboard Shortcuts). By default (at least in KDE 3.5), XF86Back and XF86Forward are set as alternatives to Alt-Left and Alt-Right, and are mapped to KDE Back and Forward navigation actions.

If you use Konqueror as your only browser, you only need to set up {{path|~/.Xmodmap}} as described [[#xmodmap configuration|above]] to assign ThinkPad back/forward keys to the symbols XF86Back/XF86Forward. This also make these keys work for other KDE applications such as Quanta Plus, KPackage and so on (not all KDE applications honor this setting, e.g. KDE help system doesn't).

If you want to use Firefox, however, the above settings do not work. You will have to map ThinkPad back/forward keys to F19/F20 as described [[#Firefox|above]], and change KDE navigation key settings to use F19/F20 instead of the default.

====Opera====
However this isn't a simple configration file, you can set your browser manually. 
Go to Tool > Settings > Mouse and keyboard > Keyboard settings > Edit > Browser Window. There add F19 - Back and F20 - Forward. Now you can surf using your TP keys ;-)

====Epiphany====
By default, the back/forward keys, when bound to XF86Back/XF86Forward, successfully navigate through the history.

To get them switch through your tabs, you could use the extension from [http://crashman.homelinux.org/~andre/public/epiphany%20extensions/thinkpad%20browserkeys/ here]
You just need to edit your Xmodmap like described for Firefox < 3.0 (bind the keys on F19 and F20)

====W3M (under Emacs)====
I'm not sure that I want to use the back and forward keys all the time in Emacs, but while browsing the web it is useful to have them.

On my X61s running Fedora 13, I've found that by adding the following lines to my .emacs, I'm able to do just that:

<code>(eval-after-load "w3m" '(progn (define-key w3m-mode-map [XF86Back] 'w3m-view-previous-page) (define-key w3m-mode-map [XF86Forward] 'w3m-view-next-page)))</code>

===Open an application===

To configure the ThinkVantage button to open a terminal window in Gnome:

Step 1:
Use xev to find the keycode generated by the button on your machine. In my case is is 159.

Step 2:
Create an entry in .Xmodmap like so

keycode 159 = XF86LaunchA

replacing 159 by the keycode found in step 1. Load the map using

:{{cmd|xmodmap ~/.Xmodmap}}

Step 3:
Configure the required function (e.g. open terminal window) in System->Preferences->Keyboard shortcuts

===Window Managers===
====fvwm====
To get the {{ibmkey|Forward|#494949}} and {{ibmkey|Backward|#494949}} keys to cycle through pages in the virtual desktop, add this to your {{path|~/.fvwmrc}}:
Key XF86Back A A Scroll -100000 0
Key XF86Forward A A Scroll +100000 0
If you use multiple virtual desktops, you could instead use the keys to flip between them by using GotoDesk.

====fluxbox====
To get the keys to cycle through pages in the virtual desktop, add this to your {{path|~/.fluxbox/keys}}:
None F19 :PrevWorkspace
None F20 :NextWorkspace

====pekwm configuration====
You can make the two browser keys switch workspaces in pekwm, by adding the following two lines to the {{path|~/.pekwm/keys}} file:
KeyPress = "Mod1 XF86Back" { Actions = "GoToWorkspace prev" }
KeyPress = "Mod1 XF86Forward" { Actions = "GoToWorkspace next" }

====pwm====
Another example how to use these two keys to switch between pwm tabs. These two lines should be added to {{path|~/.pwm/keys-default.conf}} or {{path|/etc/pwm/keys-default.conf}}:
kbind "Back", "switch_rot", -1
kbind "Forward", "switch_rot", 1

====IceWM====
To make IceWM cycle workspaces using the {{ibmkey|Forward|#494949}} and {{ibmkey|Backward|#494949}} keys, change these two options in {{path|~/.icewm/preferences}} (Provided you assigned keysyms F19 and F20 with xmodmap):
# "Previous workspace" shortcut
KeySysWorkspacePrev="F19"
# "Next workspace" shortcut
KeySysWorkspaceNext="F20"

==== Gnome/metacity ====

On {{Debian}} Lenny, using Gnome 2.22.2, once the acpid and acpi-support packages are installed, most Fn keys do the right thing out of the box.

For more advanced configuration, follow the [https://wiki.ubuntu.com/Keybindings Ubuntu guide].

===Other Uses===
====Console tools configuraton====
To make the {{ibmkey|Forward|#494949}} and {{ibmkey|Backward|#494949}} keys useful in console, add this to your keymap ({{path|/etc/console/boottime.kmap.gz}} in {{Debian}}):
keycode 158 = Decr_Console
keycode 159 = Incr_Console

Alternatively you can load this script (perhaps on system startup) to enable Backward/Forward button console (VT) switch:

#!/bin/sh
echo keycode 158 = Decr_Console | loadkeys
echo keycode 159 = Incr_Console | loadkeys

It should work with any distro.

====Cycling through tabs====
In Gnome and Xfce4, Ctrl-PageUp/Ctrl-PageDown move to the previous/following open tab in all applications that have tabbed user interfaces (terminal emulator, web browser, ...). To make use of the {{ibmkey|Forward|#494949}} and {{ibmkey|Backward|#494949}} keys for this task, there're two possibilities.

For both ways, you should map the keycodes 233 and 234 to XF86Back and XF86Forward as described in [[#xmodmap_configuration|xmodmap configuration]].

=====Using xautomation=====
xautomation can be found [http://hoopajoo.net/projects/xautomation.html here].

Create two files with permissions 755:

{{path|/usr/local/bin/tp_back}}:
<bash>
#!/bin/bash
/usr/bin/xte 'keydown Control_L' 'keydown Page_Up' 'keyup Page_Up' 'keyup Control_L'
</bash>

{{path|/usr/local/bin/tp_forward}}:
<bash>
#!/bin/bash
/usr/bin/xte 'keydown Control_L' 'keydown Page_Down' 'keyup Page_Down' 'keyup Control_L'
</bash>

Use your desktop's keyboard shortcut editor to assign XF86Back as a shortcut for tp_back and XF86Forward as a shortcut for tp_forward.

This should work in all distros and with all window managers (you might have to use other key combinations than Ctrl-PageUp and Ctrl-PageDown).

=====Redirecting XF86Back/XF86Forward=====
Create {{path|/etc/X11/xkb/compat/thinkpad}}:
<pre>
// $XFree86$
// XFree86 special keysyms
default partial xkb_compatibility "basic" {
interpret.repeat= True;

interpret XF86Back {
action = Redirect(Key=<PGUP>, modifiers=Control);
};
interpret XF86Forward {
action = Redirect(Key=<PGDN>, modifiers=Control);
};
};
</pre>

Edit {{path|/etc/X11/xkb/compat/complete}} and add <tt>'''augment "thinkpad"'''</tt> so that it looks similar to the following:
<pre>
// $XKeyboardConfig: xkbdesc/compat/complete,v 1.3 2005/10/17 00:42:11 svu Exp $
// $Xorg: complete,v 1.3 2000/08/17 19:54:34 cpqbld Exp $
default xkb_compatibility "complete" {
include "basic"
augment "iso9995"
augment "mousekeys"
augment "accessx(full)"
augment "misc"
augment "xfree86"
augment "level5"
augment "thinkpad"
};
</pre>

==External Sources==
*[http://www-307.ibm.com/pc/support/site.wss/document.do?lndocid=MIGR-51537 IBMs page on configuring the ThinkPad buttons (ThinkPad, Access IBM, Mail, Search, and Home buttons) under Linux]
*[http://dqd.com/~mayoff/notes/thinkpad/dqdnavkeys/ Rob Mayoffs page on using IBM Keyboard Navigation Keys in Linux Mozilla and Firefox]
*[http://snarfed.org/space/thinkpad+keys+in+firefox Ryan Barretts blog article about using the browser keys in Firefox]
*[http://chaotika.org/~bluesceada/?page=soft&sub=thinkpad#acpibutn DennisG's help to get the ibm-acpi buttons do useful things] on a {{Z61e}} and possibly {{Z61m}}, {{Z61t}} and {{Z61p}}
*[https://help.ubuntu.com/community/KeyboardShortcuts/#Replacing%20keys%20with%20other%20keys using xbindkeys and xmacro to override key bindings]
{{footnotes|
#Note that the associated functionality for Fn-F* key combinations is not consistent amongst all ThinkPads. We are maintaining [[Default meanings of special keys|a table of associated meanings]].
#if there are more than one tool listed, one is sufficient
#'full' means you can completely reassign any action to be triggered by the key, 'additional actions' means you can trigger actions in addition to the standard function of the key, which can not be changed.
#Thanks go to Ryan Barrett for writing the [http://snarfed.org/space/thinkpad+keys+in+firefox little howto] on [http://snarfed.org/space/start his blog].
}}

== Weblinks ==
* http://www.freedesktop.org/wiki/Software/XKeyboardConfig

[[Category:HOWTOs]]

Example of an update on a drive with unsupported firmware

2016-01-09T23:58:39Z

Dskrvk: /* Helpful Links (source of the information) */

== Download the files ==
To be able to flash with the new firmware, you need to download the [http://www-307.ibm.com/pc/support/site.wss/document.do?lndocid=MIGR-62282 iso from IBM]. You will also need the appropriate [http://www-307.ibm.com/pc/support/site.wss/document.do?lndocid=MIGR-41008 floppy disk file]. Yes, this is done using a floppy disk!

I had a 60GB Hitatchi TravelStar HTS548060M9AT00, which is listed as HTS5480xxM9AT00 on the IBM pages, so I downloaded the Floppy disk FWHD3413.exe. Then I burned the iso and I executed FWHD3413.exe to get a bootable floppy disk. Upon booting from the CD, it showed me that I had Firmware revision MGBOA53A and that there was no new firmware.

== Prepare the files ==

Next, I took the floppy with the idea I could update the files on it to get the newest firmware, so I copied over FW.exe and FW.PRO from the CD.

=== FW.PRO ===

Now I only needed my firmware update tool and the according Firmware. So I opened FW.PRO and I searched for the according section which looked like this:

; HGST : HTS5480**M9AT00
;
; HTS548040M9AT00 40.0GB
"HTS548040M9AT00","MG2OA50A","MG2OA5PA","MG2IA5PA.bin","hfui12L.exe","IA5PA","/u MRLA5PA.tbl"
"HTS548040M9AT00","MG2OA55A","MG2OA5PA","MG2IA5PA.bin","hfui12L.exe","IA5PA","/u MRLA5PA.tbl"
"HTS548040M9AT00","MG2OA5BA","MG2OA5PA","MG2IA5PA.bin","hfui12L.exe","IA5PA","/u MRLA5PA.tbl"
"HTS548040M9AT00","MG2OA5DA","MG2OA5PA","MG2IA5PA.bin","hfui12L.exe","IA5PA","/u MRLA5PA.tbl"
"HTS548040M9AT00","MG2OA5HA","MG2OA5PA","MG2IA5PA.bin","hfui12L.exe","IA5PA","/u MRLA5PA.tbl"
;
; HTS548060M9AT00 60.0GB
"HTS548060M9AT00","MGBOA50A","MGBOA5PA","MGBIA5PA.bin","hfui12L.exe","IA5PA","/u MRLA5PA.tbl"
"HTS548060M9AT00","MGBOA55A","MGBOA5PA","MGBIA5PA.bin","hfui12L.exe","IA5PA","/u MRLA5PA.tbl"
"HTS548060M9AT00","MGBOA5BA","MGBOA5PA","MGBIA5PA.bin","hfui12L.exe","IA5PA","/u MRLA5PA.tbl"
"HTS548060M9AT00","MGBOA5DA","MGBOA5PA","MGBIA5PA.bin","hfui12L.exe","IA5PA","/u MRLA5PA.tbl"
"HTS548060M9AT00","MGBOA5HA","MGBOA5PA","MGBIA5PA.bin","hfui12L.exe","IA5PA","/u MRLA5PA.tbl"
;

There wasn't any section for my MGBOA53A firmware, so I created it. I just copied the line above it and changed it a little bit. I changed the firmware revision to my revision and /u to /f to force the update:

"HTS548060M9AT00","MGBOA53A","MGBOA5PA","MGBIA5PA.bin","hfui12L.exe","OA5PA","/f MRLA5PA.tbl"

After having done this, I saved the file and I copied all mentioned files in the above section from the CD to the floppy. These were MGBIA5PA.bin, hfui12L.exe and MRLA5PA.tbl

=== SOMETHING.tbl ===

Next, I had to change MRLA5PA.tbl because the firmware update exe look for the correct information inside of it. My firmware revision was missing too and I needed a correct checksum so that hfui12L.exe would update my drive's firmware. This is the original file:

;*****************************************************************************
; Revup parameter table for Moraga-LP Family
; 2008/03/14
; Rev A5?A->A5PA
;*****************************************************************************
;
#Parameter Table
;(Format: Table name, Offset[hex], Length[dec])
A50A -> A5PA RAM
ZONE Offset 0 Length 912
SRVM Offset 0 Length 1536
CHNL Offset 0 Length 200
CHNL Offset C9 Length 3895
;
A55A -> A5PA RAM
ZONE Offset 0 Length 912
SRVM Offset 0 Length 1536
CHNL Offset 0 Length 4096
;
A5BA -> A5PA RAM
ZONE Offset 0 Length 912
SRVM Offset 0 Length 1536
CHNL Offset 0 Length 4096
;
A5DA -> A5PA RAM
ZONE Offset 0 Length 912
SRVM Offset 0 Length 1536
CHNL Offset 0 Length 4096
;
A5HA -> A5PA RAM
ZONE Offset 0 Length 912
SRVM Offset 0 Length 1536
CHNL Offset 0 Length 4096
;
#Checksum Table
; BIN checksum
;moB?axxx.br
;moA?axxx.br
;mo4?axxx.br
;mo3?axxx.br
;mo2?axxx.br
;mo1?axxx.br
;-----------------------------------------------------------------------------
; Apple model
;-----------------------------------------------------------------------------
; BIN checksum
00000000
00000000
00000000
00000000
00000000
00000000
;-----------------------------------------------------------------------------
; IBM model
;-----------------------------------------------------------------------------
; BIN checksum
FA29DE0D
F76F94DE
7DF5F7B7
FD2BFC0E
E26DB1B2
0C33B80A
;-----------------------------------------------------------------------------
; OEM generic model
;-----------------------------------------------------------------------------
; BIN checksum
00000000
00000000
00000000
00000000
00000000
00000000

Again, I had to add a section for my firmware revision. Because it was exactly the same for all revisions except for one I took one of those and put it between A50A and A55A. This is a copy of A55A with only the revision number changed:

A53A -> A5PA RAM
ZONE Offset 0 Length 912
SRVM Offset 0 Length 1536
CHNL Offset 0 Length 4096
;

Then, hfui12L.exe checks the checksum and the firmware we want to upload doesn't match the OEM checksum, right? So I copied the checksum from the IBM to the OEM section:

;-----------------------------------------------------------------------------
; IBM model
;-----------------------------------------------------------------------------
; BIN checksum
FA29DE0D
F76F94DE
7DF5F7B7
FD2BFC0E
E26DB1B2
0C33B80A
;-----------------------------------------------------------------------------
; OEM generic model
;-----------------------------------------------------------------------------
; BIN checksum
FA29DE0D
F76F94DE
7DF5F7B7
FD2BFC0E
E26DB1B2
0C33B80A

== Update the firmware ==

After all this I booted from the floppy and I updated the firmware. I got some error code and this:

Updating Drive 0
...reading microcode
...downloading microcode
!!!!! FAIL !!!!!

So I thought it had failed, I rebooted and the 2010 Error was gone. Everything works perfectly!

== Helpful Links (source of the information) ==

[http://hdsurvivor.blogspot.com/2007/08/lenovo-hard-drive-upgrade-and-error.html This guy] did it a little bit differently, he didn't have to change all the firmware codes to get it working.

I found another part of the answer in the [http://forum.thinkpads.com/viewtopic.php?p=83225#p83225 forum.thinkpads.com] and a link to another successful flash on [http://www.notebookforums.com/post753388.html#post753388 notebookforums.com].

I hope this helps you.

[[Category:HOWTOs]]

How to enable the integrated fingerprint reader

2015-12-02T14:10:16Z

Dskrvk: fix ThinkFinger link

Sub-howtos for enabling the [[integrated fingerprint reader]] on ThinkPads:

* [[How to enable integrated fingerprint reader with fprint]] <- Try this first
* [[How to enable the integrated fingerprint reader with ThinkFinger]]
* [[How to enable integrated fingerprint reader with BioAPI]]

==Free software==

===fprint===
The most current effort to support fingerprint readers is the [http://reactivated.net/fprint/wiki/Main_Page fprint project]. The fprint software comprises the libraries <tt>libfprint</tt> and <tt>libpam-fprint</tt> (which provides authentication via PAM) and the daemon <tt>fprintd</tt>.

It seems that lately this project has stalled; no support for newer chips has emerged for some time.

====Fingerprint GUI====
Makes use of libfprint.

Feb 2011: The following works as smoothly on Ubuntu and T410s: https://launchpad.net/~fingerprint/+archive/fingerprint-gui

Be aware the above packages (and the Fingerprint GUI project) include non-free drivers as indicated on [http://www.n-view.net/Appliance/fingerprint/about.php the project About page].

===ThinkFinger===
An earlier effort was the [http://thinkfinger.sourceforge.net ThinkFinger project]. It only supports the first-generation reader and has not been updated since 2007. See the [[How to enable the integrated fingerprint reader with ThinkFinger]] for detailed instructions. It was included in Debian Lenny but has since been removed from Debian.

== Non-free software ==
A closed source driver for the UPEK device is available. It interfaces to the hardware as a user-space USB driver through {{path|/proc/bus/usb|}} and provides a BioAPI 1.10 device, which can then be interfaced to pam for authentication by user programs. The driver can be downloaded from [http://www.upek.com/support/downloads/linux/ http://www.upek.com/support/downloads/linux/]. It however tends to be less stable than the above open-source drivers.

==Links==
* [http://biomark.org.ru/en/ A (Russian) project that provides support for a (different model) of fingerprint scanner] (also a USB device, though)
* [http://www.qrivy.net/~michael/blua/ A branch of the BioAPI reference implementation]
* [http://www.pdfserver.net/fingerprint A GUI using the BioAPI driver on thinkpads. Windows-like GDM login]
* [http://www.n-view.net/Appliance/fingerprint/ Fingerprint GUI Project. Allows to use the fingerprint scanner for Login (GDM) and authentication in (sudo, su). Seems to work with T410 and Ubuntu 10.04]

[[Category:HOWTOs]]

How to enable the integrated fingerprint reader with ThinkFinger

2015-12-02T14:08:34Z

Dskrvk: /* Using init scripts */ add category

'''NB:''' ThinkFinger has been inactive for two years. It was [http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=546005 removed from Debian] because of this.

See [[How to enable the integrated fingerprint reader]] for up-to-date instructions on using the fingerprint reader on ThinkPads.

This page deals with an (apparently dead) project called [http://thinkfinger.sourceforge.net ThinkFinger] which had similar goals to [[fprint]] and [[BioAPI]].

N.B.: The fingerprint reader is not a very secure device and may give a false sense of security. There has been quite a bit of research by a hacker named Starbug, a member of the Chaos Computer Club, Berlin, Germany. He outlined in two very good talks how to forge each and every available fingerprint sensor available at the cost of a few euros, using materials from your local hardware store, a digicam and a laser printer! Here are some links:
* [http://www.ccc.de/updates/2007/umsonst-im-supermarkt?language=en Fingerprint recognition in supermarkets]
* [ftp://ftp.ccc.de/pub/documentation/Fingerabdruck_Hack/fingerabdruck.mpg Video tutorial for forging fingerprints]

== Installing ThinkFinger ==

=== From source ===
Download <tt>thinkfinger-0.3.tar.gz</tt> from the [http://thinkfinger.sourceforge.net/ homepage] and unpack it somewhere, make sure you have the gcc compiler, libtool, pkg-config, libusb-dev and libpam0g-dev installed, then:

{{cmduser|cd thinkfinger-0.3}}

<code style="white-space:nowrap;color:#495988;background-color:white;"><nowiki>$</nowiki> ./configure --prefix=/usr --sysconfdir=/etc --with-securedir=/lib/security --with-birdir=/etc/pam_thinkfinger</code>

{{cmduser|make}}

{{cmdroot|make install}}

{{NOTE|/lib/security is the directory, where PAM assumes its modules on Debian and openSUSE, it may vary for your distro!}}

"make install" doesn't create the birdir we specified (where ThinkFinger will store users' biometric info), so create it:

{{cmdroot|mkdir /etc/pam_thinkfinger}}

If everything went OK assert that you find pam_thinkfinger.so in /lib/security typing:

{{cmduser|ls /lib/security}}

=== From package ===

==== Debian ====
[http://packages.debian.org/source/experimental/thinkfinger Packages] arrived in Debian experimental on Aug 2nd, 2007 (cf. [http://bugs.debian.org/409563 bug #409563]). To access the experimental packages via apt, add the following lines to your sources.list:
<pre>
# experimental
deb ftp://mirrors.kernel.org/debian/ experimental main contrib non-free
deb-src ftp://mirrors.kernel.org/debian/ experimental main contrib non-free
</pre>
where of course you may replace mirrors.kernel.org with your mirror of choice. Just make sure that it hosts the experimental repositories.

{{cmdroot|aptitude update}}

{{cmdroot|aptitude install libthinkfinger0 libpam-thinkfinger thinkfinger-tools}}

should then get you up and running.

To make everything work you'll have to have permission to work the device ({{cmduser|sudo adduser myself plugdev}} worked for me), and you'll also have to follow instructions below about adding the device to your PAM methods.

==== Ubuntu ====

===== Gutsy =====

From https://wiki.ubuntu.com/ThinkFinger

Add PPA repositories to your sources.list:
<pre>
deb http://ppa.launchpad.net/jldugger/ubuntu gutsy main restricted universe multiverse
deb-src http://ppa.launchpad.net/jldugger/ubuntu gutsy main restricted universe multiverse
</pre>

Install necessary packages:

{{cmduser|sudo apt-get install thinkfinger-tools libpam-thinkfinger}}

===== Hardy =====

Hardy includes the latest thinkfinger and it is up to date with subversion. Install packages:

{{cmduser|sudo apt-get install thinkfinger-tools libpam-thinkfinger}}

Update the pam configuration files:

{{cmduser|sudo /usr/lib/pam-thinkfinger/pam-thinkfinger-enable}}

Enroll your fingerprint (creates $HOME/.thinkfinger.bir). If this gives an error about claiming the USB device then a reboot was claimed to work, but in fact it may just be a permissions problem. {{NOTE|Do not try to enroll using 'sudo' - it will cause hidden permission problems}}

{{cmduser|tf-tool --acquire}}

Check fingerprint enrollment

{{cmduser|tf-tool --verify}}

You can expect everything to work correctly. Note that you still have to enter your username if prompted but will be able
to swipe your finger instead of the password. The prompt will usually be "Password or swipe finger"

* Graphical login
* Text console login
* sudo
* screen lock/screen saver
* Administrative password prompt (eg for update or package managers). (Note no "or swipe finger" in prompt).

===== Intrepid =====
After installing from the normal repositories coming with Ubuntu 8.10, you would have to press enter after sweeping finger. (This bug: [https://bugs.launchpad.net/ubuntu/+source/thinkfinger/+bug/256429 https://bugs.launchpad.net/ubuntu/+source/thinkfinger/+bug/256429])
Therefore Jon Oberheide made an update that can be found here:
[https://launchpad.net/~jon-oberheide/+archive https://launchpad.net/~jon-oberheide/+archive]
(As of 2/3/09, this no longer seems to be the case. Just proceed to the install step.)

Add the PPA repositories to your source.list (/etc/apt/source.list):
<pre>
deb http://ppa.launchpad.net/jon-oberheide/ubuntu intrepid main
deb-src http://ppa.launchpad.net/jon-oberheide/ubuntu intrepid main
</pre>

Update installer:

{{cmduser|sudo apt-get update}}

And install:

{{cmduser|sudo apt-get install thinkfinger-tools}}

===== Jaunty =====

The same package by Jon Oberheide is necessary, as with Intrepid, though the package thinkfinger-tools is installed by default.

Add key:

{{cmduser|sudo apt-key adv --recv-keys --keyserver keyserver.ubuntu.com F2A12FABE936A7BBDC4EA33351DB180D1323E149}}

Add the PPA repositories to your source.list (/etc/apt/source.list):

<pre>
deb http://ppa.launchpad.net/jon-oberheide/ppa/ubuntu jaunty main
deb-src http://ppa.launchpad.net/jon-oberheide/ppa/ubuntu jaunty main
</pre>

Update installer:

{{cmduser|sudo apt-get update}}

And install:

{{cmduser|sudo apt-get install thinkfinger-tools libpam-thinkfinger}}

===== Karmic =====

The syntax of udev rules is changed due to Karmic's new udev package. The correct rules should be:

<pre>
# SGS Thomson Microelectronics Fingerprint Reader
ENV{ID_VENDOR_ID}=="0483", ENV{ID_MODEL_ID}=="2016", SYMLINK+="input/thinkfinger-%k", MODE="0660", GROUP="fingerprint", ENV{GENERATED}="1"

# the also-needed uinput device
KERNEL=="uinput", MODE="0660", GROUP="fingerprint"
</pre>

Otherwise udev would accidentally change the ownership of /dev/null so that gdm would fail to start.

===== Lucid =====

From a working Karmic, upgrade to Lucid gave me a somewhat broken ThinkFinger.

The scanner still works, but (in X windows) you need to hit "Enter" after doing a scan.
The scanner works fine while in terminal mode.

This is almost definitely because of the xorg version, see this message with no response for more info:
http://article.gmane.org/gmane.linux.drivers.thinkfinger/567

{{HINT|There is a PPA with working ThinkFinger for Lucid. At least it works fine on my Z61m. [http://www.thinkwiki.org/wiki/Installing_Ubuntu_10.04_(Lucid_Lynx)_on_a_ThinkPad_Z61m#Setup_Fingerprint_Reader See here] }}

{{HINT|ThinkFinger can be installed through Ubuntu Software Centre/Synaptic Package Manager/Terminal without special repositories enabled in Lucid. Search "ThinkFinger and install thinkfinger-tools (Synaptic/Software Centre), or type "sudo apt-get install thinkfinger-tools" (Terminal). }}

==== Fedora/Fedora Core ====
{{cmdroot|yum install thinkfinger}}

==== Gentoo ====
{{cmdroot|emerge sys-auth/thinkfinger}}

==== OpenSUSE ====
openSUSE 10.2 includes the package "libthinkfinger" (version 0.1-7) - you will find newer packages [http://beta1.suse.com/private/thoenig/10.2/thinkfinger/ here].

== Testing the driver ==

Now the driver is installed and should be working. You can try it (as root) with

{{cmdroot|tf-tool --acquire}}

and

{{cmdroot|tf-tool --verify}}

This will ask you to swipe your finger three times, save the fingerprint to /tmp/test.bir and then verify your fingerprint with the bir-file.

== Configuring PAM to use ThinkFinger ==
Now you can configure PAM to use ThinkFinger:

Open {{path|/etc/pam.d/common-auth}} (In FC6, F7, and Gentoo, this file is {{path|/etc/pam.d/system-auth}}):

{{cmdroot|nano -w /etc/pam.d/common-auth}}

Add this line before any pam_unix or pam_unix2 directives:
auth sufficient pam_thinkfinger.so

If your PAM uses the pam_unix and not the pam_unix2 module, you need to pass a specific argument in
the /etc/pam.d/common-auth directive to make it consider the password entered at the pam_thinkfinger prompt.
auth required pam_unix.so try_first_pass

For instance, {{path|/etc/pam.d/common-auth}} looks like this:
auth sufficient pam_thinkfinger.so
auth required pam_unix.so nullok_secure try_first_pass

On openSUSE 10.2, it looks like this now:
auth required pam_env.so
auth sufficient pam_thinkfinger.so
auth required pam_unix2.so

On Ubuntu 8.10 - Intrepid Ibex you should just add the following line the the /etc/pam.d/common-auth file so it looks like this:
<pre>
....
# here are the per-package modules (the "Primary" block)
auth sufficient pam_thinkfinger.so
auth [success=1 default=ignore] pam_unix.so try_first_pass nullok_secure
# here's the fallback if no module succeeds
....
</pre>

On Ubuntu 9.04, you don't need to edit manually, just type:

{{cmdroot|sudo /usr/lib/pam-thinkfinger/pam-thinkfinger-enable}}

Now we are ready to add users to thinkfinger. You can add a fingerprint for a user with:

{{cmdroot|tf-tool --acquire $USERNAME}}

{{NOTE|This may not work for you. Please read the Intrepid Ibex point in the discussion to this page.}}

Now the user should be able to login with his finger instead of the password.

If you would like to use thinkfinger for su, you have to enroll the fingerprint for root user with:

{{cmdroot|tf-tool --acquire root}}

{{NOTE|You should see the "Password or swipe finger:" prompt when trying to sudo or su. If you don't, you probably do not have the "User level driver support" compiled into your kernel or the "uinput" module loaded!}}

== xscreensaver/gnome-screensaver ==
{{NOTE|In Fedora 7, the package has been modified in such a way as to make doing this unnecessary.}}

If you'd like to be able to unlock your screen using the fingerprint reader, you must have current versions of xscreesaver (>~5.03) or gnome-screensaver (>~2.18.2). Then you must give yourself access to the fingerprint reader and your bir-file, because unlike login/gdm/su/sudo, both gnome-screensaver and xscreensaver do not run as root. The following procedure will make the fingerprint reader accessible to members of the "fingerprint" group.

Make the group: {{cmdroot|groupadd fingerprint}}

Save the following as {{path|/etc/udev/rules.d/60-thinkfinger.rules}} and run {{cmdroot|sudo /sbin/udevtrigger}}. If you are using a Debian-based distribution, it is likely you are affected by the following [http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=489831 bug] where you need to replace {{path|udevtrigger}} with {{path|udevadm trigger}} (with the space!) in order for the following to work. You may need to reboot for this to take effect.
#
# udev rules file for the thinkfinger fingerprint scanner
#
# gives access to the fingerprint reader to those in the "fingerprint" group
#
# Taken from:
# http://www.thinkwiki.org/wiki/How_to_enable_the_fingerprint_reader_with_ThinkFinger
# which was taken and modified from:
# http://article.gmane.org/gmane.linux.drivers.thinkfinger/329
#

# SGS Thomson Microelectronics Fingerprint Reader
SYSFS{idVendor}=="0483", SYSFS{idProduct}=="2016", SYMLINK+="input/thinkfinger-%k", MODE="0660", GROUP="fingerprint"

# the also-needed uinput device
KERNEL=="uinput", MODE="0660", GROUP="fingerprint"

Finally, add the following lines at the end of {{path|/etc/pam.d/gnome-screensaver}}:
auth sufficient pam_thinkfinger.so
auth required pam_unix.so try_first_pass nullok_secure

Per user:

# Add him to the group: {{cmdroot|gpasswd -a $USERNAME fingerprint}}
{{NOTE|The following steps do not need to be done in Ubuntu Intrepid as the bir files are handled differently.}}
# Make him owner of his bir-file: {{cmdroot|chown $USERNAME:root /etc/pam_thinkfinger/$USERNAME.bir}}
# Give him read-only access to his bir-file: {{cmdroot|chmod 400 /etc/pam_thinkfinger/$USERNAME.bir}}
# Give "execute only" access to everyone for the /etc/pam_thinkfinger/ directory: {{cmdroot|chmod o+x /etc/pam_thinkfinger}} (WARNING: this opens up security a little).

== GNOME ==

{{NOTE|1=This problem should be solved if you're using sudo >= 1.6.9p9. Links: [http://savannah.nongnu.org/bugs/?19132], [http://www.sudo.ws/bugs/show_bug.cgi?id=180], [https://bugs.launchpad.net/ubuntu/+source/gksu/+bug/86843]}}

gksu/gksudo doesn't work correctly. It just stays invisible. When starting a su privileged application such as synaptics you will not get prompted for the password. Nevertheless you can swipe your finger and it should authenticate you. Starting synaptics twice makes gksudo visible.

There are two possibilities to solve it:
* Changing the string "Password or swipe finger:" to a plain "Password:" (like sudo normally would do) in the file pam/pam_thinkfinger.c of the thinkfinger source directory. Of course, in the console you will then only see a "Password:" instead of "Password or swipe finger:" but this is still more usefull than having gksu/gksudo crashing everytime.
* Patching libgksu with the following patch. This is also a nasty hack until a better solution is implemented.
<pre>
--- libgksu-2.0.3/libgksu/libgksu.c.orig 2007-06-17 16:00:24.000000000 +0200
+++ libgksu-2.0.3/libgksu/libgksu.c 2007-06-17 16:00:47.000000000 +0200
@@ -2663,7 +2663,7 @@
*/
for (counter = 0; counter < 50; counter++)
{
- if (strncmp (buffer, "GNOME_SUDO_PASS", 15) == 0)
+ if (strncmp (buffer, "GNOME_SUDO_PASS", 15) == 0 || strncmp (buffer, "Password or swi", 15) == 0)
break;

read_line (parent_pipe[0], buffer, 256);
@@ -2675,7 +2675,7 @@
if (context->debug)
fprintf (stderr, "brute force GNOME_SUDO_PASS ended...\n");

- if (strncmp(buffer, "GNOME_SUDO_PASS", 15) == 0)
+ if (strncmp(buffer, "GNOME_SUDO_PASS", 15) == 0 || strncmp(buffer, "Password or swi", 15) == 0)
{
gchar *password = NULL;
gboolean prompt_grab;
</pre>

== KDE ==

Integration in KDE and kdm seems not to be easily possible now. There is a filed [https://bugs.kde.org/show_bug.cgi?id=116682 bug] at kde.org where you can vote for this.

Moreover, kdm in openSUSE 10.3 and in Kubuntu 8.10 crashes when pam_thinkfinger is enabled. A possible "workaround" is downgrading to thinkfinger 0.2.2.

Another workaround is to use Fprint from [http://www.reactivated.net/fprint/wiki/Main_Page] which works quite nicely on my X61s and Kubuntu Hardy.

This Howto was copied from [[Installing Ubuntu 6.06 on a ThinkPad T43#Fingerprint_Reader]] and then slightly modified.

== Fix for the fingerprint reader getting too hot ==

If you notice that your fingerprint reader occasionally gets very hot then you might be interested in this section. Thanks to Tino Keitelon the linux-thinkpad mailing list for the solution.

=== Collect info ===
First we need to determine if the reader is not on autosuspend mode.
Open a terminal and run:

for i in `find /sys/devices/*/*/usb* -name level` ; do echo -n "$i: " ; cat $i ; done

We care about the devices that are with "on" state and we need to determine if one of those is the reader. So for each of those run something like:

cat /sys/devices/pci0000\:00/0000\:00\:1a.0/usb1/1-2/idVendor
0483

cat /sys/devices/pci0000\:00/0000\:00\:1a.0/usb1/1-2/idProduct
2016

Use the corresponding path of the devices that you got with "on" state and then compare the output with the output of the lsusb command. An example:

lsusb output: Bus 001 Device 004: ID 0483:2016 SGS Thomson Microelectronics Fingerprint Reader

Which matches the output above (0483:2016).

=== Enable autosuspend ===
Once you have determined the path of your reader then become root with su - and:

echo "auto" > /sys/<path-to-device>/power/level

Alternatively, if you're using Ubuntu:

echo auto | sudo tee /sys/<path-to-device>/power/level

After this, the fingerprint reader should be in "autosuspend" and will not get hot anymore. And it will still work as normal.

=== Making the changes permanent ===
The above will only work for the current session (until the next reboot). If you want to make the change persistent, do one of the following:

==== Using udev (recommended) ====
The simplest way to do this is to create a udev rule (requires no additional tools):

Put the following in {{path|/etc/udev/rules.d/69-fingerprint-sleep.rules}}

ATTR{idVendor}=="0483", ATTR{idProduct}=="2016", SUBSYSTEMS=="usb", ACTION=="add", ATTR{power/level}="auto"

(exchange 0483 and 2016 with what you found above if the numbers are different)

==== Using sysfsutils ====
Alternatively, if you have [http://linux-diag.sourceforge.net/Sysfsutils.html sysfsutils] installed, edit the file {{path|/etc/sysfs.conf}} and add the line

<path-to-device>/power/level = auto

Following the above example, that would be

devices/pci0000\:00/0000\:00\:1a.0/usb1/1-2/power/level = auto

==== Using init scripts ====
If, for some reason, neither of the two above methods don't work, you can install an init script:

sudo gedit /etc/init.d/ReaderNoMoreHot

Paste the following into it:

#!/bin/bash
#
echo "auto" > /sys/<path-to-device>/power/level

Save and close. Then:

sudo chmod 755 /etc/init.d/ReaderNoMoreHot
sudo update-rc.d ReaderNoMoreHot defaults 90

--[[User:Lunatico|Lunatico]] 19:19, 1 August 2008 (CEST), extended by --[[User:Michaelthomas h|Michaelthomas h]] 23:36, 9 August 2008 (CEST)

For the init script above, you can use the following more elaborate script, which does all the work for you of identifying the <path-to-device>. This can be useful since the USB device id can change under various circumstances (kernel upgrade etc).

<pre>
#!/bin/bash

# find the fingerprint reader and change its power level to autosuspend

usbname="SGS Thomson Microelectronics Fingerprint Reader"
usbid=$(lsusb |grep "$usbname" |cut -d' ' -f6);
[[ -z $usbid ]] && echo "USB Device \"$usbname\" not found" && exit 1

unset failed_bool
find /sys/devices/*/*/usb* -name idVendor -print | (
while read vfile; do
dir=$(dirname $vfile);
vendor=$(<$vfile);
product=$(<$dir/idProduct);
if [[ $vendor:$product = $usbid ]]; then
plevel_file=$dir/power/level
old_level=$(<$plevel_file);
[[ $old_level = auto ]] || echo auto >$plevel_file || failed_bool=1
break;
fi;
done
if [[ $failed_bool ]]; then
echo "Failed to set the fingerprint reader's power level to 'auto'."
exit 1
fi
)
</pre>

Here is an alternate script. The code is cleaner and it's about 20x faster (updated for jaunty):
<pre>
#!/bin/bash

# find the fingerprint reader and change its power level to autosuspend

find_manuf=STMicroelectronics
find_prod="Biometric Coprocessor"

for devdir in /sys/class/usb_*/*/device; do
[[ -r $devdir/manufacturer ]] || continue
manuf=$(<$devdir/manufacturer)
[[ $manuf = $find_manuf ]] || continue;
prod=$(<$devdir/product)
[[ $prod = $find_prod ]] || continue;
# if we get here then we have the right device!
plevel_file=$devdir/power/level
old_level=$(<$plevel_file);
# if it is already set properly then exit silently:
[[ $old_level = auto ]] && exit 0
# if we successfully change it then exit silently:
echo auto >$plevel_file && exit 0
echo "Failed to set the fingerprint reader's power level to 'auto'."
exit 1
done

# if we make it through the for loop without exiting, the search failed
echo "Could not find the $find_manuf $find_prod (fingerprint reader)"
exit 1
</pre>

[[Category:HOWTOs]]

How to enable integrated fingerprint reader with BioAPI

2015-12-02T14:07:12Z

Dskrvk: /* Bioapi error #3 */ add category

{| width="100%"
|style="vertical-align:top;padding-right:20px;width:10px;white-space:nowrap;" | __TOC__
|style="vertical-align:top" |
This page describes the process of getting the [[Integrated Fingerprint Reader|integrated fingerprint reader]] to work under Linux using [[BioAPI]] and binary-only drivers. It is based on experiences in {{Ubuntu}} on a T43. The same works on {{Fedora}} 4 and 5, RHEL4, SuSE 9.3, SuSE 10, and {{Gentoo}}. Note that experimental open-source driver is available, see [[How to enable the integrated fingerprint reader with ThinkFinger|the apropriate page]] for details.
|}

==Basic installation==
===Installing the bioapi framework===
====Automated installation script====
The [[Script for enabling the fingerprint reader with BioAPI]] automates the installation of most components (bioapi framework, driver, pam_bioapi, pam setup, device permissions, pamtester and enrolling), for some Linux distributions.

====Binary packages====

Note that these packages only take care of this one section. If you can use one, you should do so and then proceed to the section entitled, Installing and Configuring the Driver.

=====Debian/ Ubuntu Dapper=====
*If you're using {{Debian}} Sid (the unstable branch) or {{Ubuntu}} Dapper Drake 6.06 LTS you can try the packages from Michael R. Crusoe's site, either [http://www.qrivy.net/~michael/temp/ version 1.2.3] (recommended) or [http://www.qrivy.net/~michael/debs/unstable/ older versions] which might not work with the steps in this howto.

{{HINT|Ignore the warning about not finding ''/usr/lib/libqtpwbsp.so'', it's not fatal.}}

=====Gentoo=====
Gentoo now includes needed ebuilds. Just run

''ACCEPT_KEYWORDS=~x86 emerge pam_bioapi''

You can also grab the [http://www.qrivy.net/~michael/blua/bioapi/bioapi-1.2.2.ebuild.tar.bz2 ebuild], or use the source-install procedure below.

Also see [http://toe.ch/~tsa/ibm-fingerprint/ http://toe.ch/~tsa/ibm-fingerprint/] for alternative documentation on installing on Gentoo including ebuilds for all the packages used.

=====Fedora Core=====
RPM packages for Fedora Core and installation instructions are available [[Installing Fedora Core 5 on a ThinkPad X41 Tablet#Fingerprint_Reader|here]]

====Installing from source====
{{HINT|
For Ubuntu you'll need at least these packages, or building will fail:
* build-essential
* automake
* libqt3-headers
}}
* Get the bioapi source and extract the files to a directory of your choice:
:{{cmduser|wget http://bioapi-linux.googlecode.com/files/bioapi_1.2.3.tar.gz}}
:{{cmduser|tar xzf bioapi_1.2.3.tar.gz}}
* Edit the configure file to patch a bug. At line 25975, change
:<code>bnv_qt_LIBS="-l$bnv_qt_lib_dir $LIBS"</code>
:to
:<code>bnv_qt_LIBS="-L$bnv_qt_lib_dir $LIBS"</code>
* There is a bug in <code>framework/mds_util_api/mds_app_util.c</code>. At line 31, change <code>#elif</code> to <code>#else</code>.
* Optional: By default, bioapi will install several files in {{path|/usr/local/bin}}, including files with "self-explanatory" names such as {{path|/usr/local/bin/Sample}}. To prevent this pollution:
:Create a dedicated directory, for example {{path|/opt/bioapi}} .
:Append <tt>--prefix=/opt/bioapi</tt> to the above <tt>./configure</tt> command.
:Append {{path|/opt/bioapi/bin}} to <tt>$PATH</tt> and {{path|/opt/bioapi/lib}} to <tt>$LD_LIBRARY_PATH</tt>.
:When installing the driver (below), tell it the new install path: {{cmdroot|sh install.sh /opt/bioapi/lib}}
* Compile bioapi:
:{{cmduser|cd bioapi-1.2.3}}
:{{cmduser|1=./configure}}
:{{cmduser|make}}
:and then as root
:{{cmdroot|make install}}
* If configure fails when checking the Qt installation, you may need to manually specify the Qt lib directory and Qt lib name. For example:
:{{cmduser|1=./configure --with-Qt-lib-dir=/usr/lib/qt3 --with-Qt-lib=qt-mt}}
:or you can compile without the graphical Qt tools:
:{{cmduser|1=./configure --with-Qt-dir=no}}
* If make install fails, be sure you're root and then:
:{{cmdroot|1=export LD_LIBRARY_PATH=/usr/local/lib}}
:{{cmdroot|make install}}
:and if you want to compile [http://code.google.com/p/pam-bioapi/ pam_bioapi] for auth later
:{{cmdroot|cp include/bioapi_util.h include/installdefs.h imports/cdsa/v2_0/inc/cssmtype.h /usr/include}}
:Be aware that checkinstall will not work!

====Adjusting ldconfigs library search path====
At least on {{Fedora}} or {{Aurox}} 11, you may need to add {{path|/usr/local/lib}} to the library path so that the libraries referenced from <tt>pam_bioapi.so</tt> get picked up properly. The usual way to do this is adding it to the ldconfig configuration:
:{{cmdroot|echo '/usr/local/lib' > /etc/ld.so.conf.d/bioapi.conf}}
:{{cmdroot|ldconfig}}
Alternatively you can add it to the LD_LIBRARY variable.

If you see bioapi libs in the output of
:{{cmdroot|ldconfig -p | grep bioapi}}
then it should work.

===Installing and configuring the driver===
====Installing the driver====
*Download {{path|TFMESS_BSP_LIN_1.0.zip}} from the [http://www.upek.com/solutions/pc_and_networking/sdks/linux/DownloadBSP.asp UPEK support site] and unzip it into a seperate folder, as it will not create one.
*Change to that folder and do as root:
:{{cmdroot|sh install.sh}}
:If you're running Gentoo, Debian or Ubuntu Dapper, use
:{{cmdroot|sh install.sh /usr/lib}}
{{HINT|
For me it didn't work this way, but following did:
:sh install.sh /usr/local/lib
greetings, tec}}
{{HINT|On my debian install I had to "cp libtfmessbsp.so /usr/lib" to avoid a errormessage during "sh install.sh /usr/lib": "Could not find file:/usr/lib/libtfmessbsp.so"}}
:If that fails, it may be that make install failed up above -- try setting LD_LIBRARY_PATH, do the make install again, and come back here and try this again. You also need {{cmd|mod_install|}} from bioapi in your PATH.
:May there still occures and error, which means mod_install: command not found.
:Then login as root - not su!
:Do this:
:{{cmdroot|sh install.sh}}
:again. It should work. SU to root does not work since then the /usr/local/bin directory is not used per default.

====Configuring permissions for non-root use====
If you want to use PAM-aware applications like xscreensaver that are NOT running with root permissions (as opposed to login, gdm or other authentication mechanisms), you may need to do all or at least some of the things in this section. More details on what is necessary on which distributions would be greately appreciated.
*Create two groups, one for access to BioAPI files and the other for access to the usb files. (This is done for full generality; i.e., you may have other USB devices which you want accessable to other users, without exposing your BioAPI configuration to them). Add your normal user (the one you wish to use PAM-aware applications with) to both of these groups.
On {{Debian}} this is done with
:{{cmdroot|addgroup --system bioapi}}
:{{cmdroot|addgroup --system usbfs}}
:{{cmdroot|adduser yournormaluser bioapi}}
:{{cmdroot|adduser yournormaluser usbfs}}
On {{SUSE}} this is done with
:{{cmdroot|groupadd --system bioapi}}
:{{cmdroot|groupadd --system usbfs}}
:{{cmdroot|groupmod -A yournormaluser bioapi}}
:{{cmdroot|groupmod -A yournormaluser usbfs}}
On {{Mandriva}} this is done with
:{{cmdroot|groupadd -r bioapi}}
:{{cmdroot|groupadd -r usbfs}}
:{{cmdroot|usermod -G bioapi,usbfs yournormaluser}}
On {{Fedora}} this is done with
:{{cmdroot|groupadd bioapi}}
:{{cmdroot|groupadd usbfs}}
:{{cmdroot|usermod -G bioapi,usbfs yournormaluser}}

:(where {{cmd|yournormaluser|}} is your normal user name). You will need to log out and log back in for this to take effect.
*Set permissions on the BioAPI config/registry directory:
:{{cmdroot|chown -R root:bioapi /usr/local/var/bioapi/}}
:{{cmdroot|chmod -R 770 /usr/local/var/bioapi/}}
:(change this path if you used an alternate BioAPI install directory above)
*Set permissions on the files in {{path|/proc/bus/usb}}:
:{{cmdroot|chown -R root:usbfs /proc/bus/usb}}
:{{cmdroot|chmod -R g+X /proc/bus/usb}}
:{{cmdroot|chown root:usbfs /proc/bus/usb/`lsusb <nowiki>|</nowiki> sed -ne "/0483:2016/s/Bus\ $.*$\ Device\ $.*$:\ .*/\1\/\2/p"`}}
:{{cmdroot|chmod 660 /proc/bus/usb/`lsusb <nowiki>|</nowiki> sed -ne "/0483:2016/s/Bus\ $.*$\ Device\ $.*$:\ .*/\1\/\2/p"`}}
:You may need to replace {{cmd|lsusb|}} with its full path, which is something like {{cmd|/sbin/lsusb|}} or {{cmd|/usr/bin/lsusb|}} depending on your distro. It might be necessary to put these lines into a script which is run at startup and resume from suspend/hibernate.
In {{Fedora}} {{cmd|lsusb|}} is not installed by default. To intall it just type:
:{{cmdroot|yum install usbutils}}

*As an alternative to the {{cmd|chown|}}/{{cmd|chmod|}} commands above, you can set mount options for usbfs with a line in {{path|/etc/fstab|}}; an example would be
none /proc/bus/usb usbfs defaults,devgid=108,devmode=0660,busgid=108,busmode=0770,listgid=108,listmode=0660 0 0
:where 108 is replaced with the numerical group ID of the usbfs group (you can determine this with something like {{cmd|cat /etc/group <nowiki>|</nowiki> grep usbfs <nowiki>|</nowiki> cut -d':' -f 3|}}). Make sure you only have one {{path|/proc/bus/usb}} entry in {{path|/etc/fstab}}. See the {{cmd|mount(8)|}} manpage for more information on these options. This is "cleaner" but seems to have a few weird issues -- see the talk page for details.
*You may also have files in {{path|/dev/bus/usb}}, which the driver will try before {{path|/proc/bus/usb}}. If this is another usbfs mount point ({{cmd|mount|}} shows a line containing {{cmdresult|/dev/bus/usb type usbfs}}), then simply follow the above instructions with {{path|/dev/bus/usb}} rather than {{path|/proc/bus/usb}}. Otherwise, you may be running a new kernel (i.e. 2.6.15) that makes usbfs-like files available through {{path|/dev/bus/usb}}.
*On systems running udev these files are dynamically created; you can configure their permissions by editing a udev config file. On Debian this is done by changing the <tt>usb_device</tt> line of {{path|/etc/udev/permissions.rules}} to read
SUBSYSTEM=="usb_device", MODE="0660", GROUP="usbfs"
*For the beta versions only, there is a logfile, which needs to exist with the proper permissions:
:{{cmdroot|touch /var/log/BSP.log && chown root:bioapi /var/log/BSP.log && chmod 660 /var/log/BSP.log}}

====Miscellaneous configuration====
* To increase the security level (minimize false accept rate), set this in {{path|/etc/tfmessbsp.cfg}}:
security-level="5"
{{WARN|Please see discussion section Security Level!}}

===Testing the driver and enrolling a fingerprint===
To test the driver and generate the file containing your fingerprint information, you need a sample program included with the driver. The compilation steps below were discovered by trial and error; if they don't work for you, try the binary {{cmd|Sample|}} utility that came with the beta versions of the driver (i.e., {{path|TFMESS_BSP_LIN_1.0beta2.zip}} as mentioned above).
Go to the folder where you extracted {{path|TFMESS_BSP_LIN_1.0.zip}} and do:
:{{cmdroot|cd NonGUI_Sample}}
:Edit {{path|main.c|}} and remove (or comment out) the line
#include "port/bioapi_port.h"
:then add the line
#include <stdlib.h>
:{{cmdroot|gcc -o Sample main.c -L/usr/local/lib -lbioapi100 -DUNIX -DLITTLE_ENDIAN}}
:{{cmdroot|./Sample}}
:Note that Sample may only run as root, unless you've already configured the usbfs file permissions.
:You can try to "e"nroll (to record a fingerprint for an account) and then "v"erify (to test a fingerprint against the one it expects for an account).
:You'll save a step later if you use your own login username as the username to enroll here.
:If running {{cmd |./Sample|}} produces the error message 'BioAPI_ModuleLoad failed, BioAPI Error Code: 6477 (0x194d)'
:then uncommenting the line
://BioAPI_SetGUICallbacks(gModuleHandle, NULL, NULL,TextGuiCallback, NULL);
:in {{path|main.c|}} can help.

==Login via pam_bioapi==

The following explains how to add fingerprint authentiation to programs that use the PAM (Pluggable Authentication Modules) framework, such as Gnome's GDM and KDE's KDM and screensaver.

===Getting required libs & tools===
====Installing pam_bioapi====
*Prerequisites
:On SuSE 10, I needed to install the pam-devel RPM
:In general, you will need pam itself (standard for most distros) as well as the pam development files (probably an optional package for your distro).
*Get and compile the pam_bioapi module.
{{HINT|A new version, pam_bioapi 0.3.0, with multi-finger and identification support can be found [http://www.nax.cz/pub/bioapi/pam_bioapi/pam-bioapi_0.3.0.tar.gz here].
There's work in progress. pam_bioapi and biometrics-manager can be downloaded [http://download.savannah.gnu.org/releases/pam-bioapi/ here].}}
:{{cmduser|wget http://www.qrivy.net/~michael/blua/pam_bioapi/pam_bioapi-latest.tar.bz2}}
:{{cmduser|tar xjf pam_bioapi-latest.tar.bz2}}
:{{cmduser|cd pam_bioapi-0.2.1}}
:{{cmduser|wget http://badcode.de/downloads/fingerprint.patch}}
:{{cmduser|patch -p0 < fingerprint.patch}}
:If you want to, review the patch. In general you should review all code you download and compile, if possible.
:{{cmduser|<nowiki>./configure --libdir=/lib && make </nowiki>}}
:and as root
:{{cmdroot| make install}}
{{NOTE|If you get a 'rpl_malloc' error in /var/log/auth.log when trying to use the fingerprint reader, redo these steps and remove the related term from Makefile after running ./configure. (FC3, Debian etch)}}
*If you get 'configure: error: cannot find required header: security/_pam_macros.h' and are on a Debian-like system, do "apt-get install libpam0g-dev" and try again. If you are using a Mandriva distribution, do "urpmi libpam0-devel" instead.
*If you get 'configure: error: cannot find required header: security/pam_modules.h' and are on a Debian-like system, do "apt-get install libpam0g-dev" and try again.
*If you get 'configure: error: cannot find required header: sqlite3.h' and are on a Debian-like system, do "apt-get install libsqlite3-dev" and try again.
*If you get 'make: msgfmt: command not found' and are on a Debian-like system, do "apt-get install gettext" and try again.
*If you get 'PAM [dlerror: /lib/security/pam_bioapi.so: undefined symbol: BioAPIMemoryFuncs]' error in your syslog, replace 'LIBS = ' line in {{path|libpam_bioapi/makefile}} with the following (of course, replace {{path|/opt/bioapi/}} with the path where you installed bioapi):
LIBS = -L/opt/bioapi/lib -lbioapi100 -lbioapi_mds300 -lmds_util
*Use the sample tool from the fingerprint reader to create {{path|<username>.bir}} (<tt><username></tt> '''must''' be the username you want to login with. gdm will probably break for any login name that has no .bir file).
*As root do:
:{{cmdroot|SERIAL<nowiki>=`BioAPITest | sed -ne "/Fingerprint/{n;n;s/^.*: $.\{9\}$$.\{4\}$$.\{4\}$$.\{4\}$$.*$/\1-\2-\3-\4-\5/gp}"` </nowiki>}}
:{{cmdroot|echo $SERIAL}} should print something like {{cmdresult|<nowiki>{5550454b-2054-464d-2f45-535320425350}</nowiki>}} now.
:If it does, do:
:{{cmdroot|mkdir -p /etc/bioapi/pam/$SERIAL}}
:{{cmdroot|cp <username>.bir /etc/bioapi/pam/$SERIAL}}
:If not, you might just try
:{{cmdroot|SERIAL<nowiki>={5550454b-2054-464d-2f45-535320425350}</nowiki>}}
:as this value is hardcoded into the UPEK docs.

===Configuring pam===
The following part is distribution specific. On {{Ubuntu}} or {{SUSE}} you can modify {{path|/etc/pam.d/common-auth}} (on {{Gentoo}} and {{Fedora}} it is {{path|/etc/pam.d/system-auth}}) to look like this:

#
# /etc/pam.d/common-auth - authentication settings common to all services
#
# This file is included from other service-specific PAM config files,
# and should contain a list of the authentication modules that define
# the central authentication scheme for use on the system
# (e.g., /etc/shadow, LDAP, Kerberos, etc.). The default is to use the
# traditional Unix authentication mechanisms.
#
auth sufficient pam_bioapi.so {5550454b-2054-464d-2f45-535320425350} /etc/bioapi/pam/
password sufficient pam_bioapi.so {5550454b-2054-464d-2f45-535320425350} /etc/bioapi/pam/
auth required pam_unix.so nullok_secure

----
For '''Gentoo'''-Users - this allows you to attempt a password first. If you simply press enter, it then prompts for a fingerprints. Create a file named {{path|/etc/pam.d/bioapi}}. This also means that remote services, such as SSH keep working:

auth required pam_env.so
auth sufficient pam_unix.so likeauth nullok
auth sufficient pam_bioapi.so {5550454b-2054-464d-2f45-535320425350} /etc/bioapi/pam/
auth required pam_deny.so

account required pam_unix.so

session required pam_limits.so
session required pam_unix.so

----

Now, simply replace "auth include system-auth" in all services that you wish to use fingerprint for with "auth include bioapi". For example, {{path|/etc/pam.d/kde}} by default contains

auth include system-auth
auth required pam_nologin.so

account include system-auth

password include system-auth

session include system-auth

Simply replace the first "system-auth" with bioapi and you can also get rid of KDE desktop lock with a fingerprint. If you do not wish to allow for "password fallback" then remove

auth sufficient pam_unix.so likeauth nullok

from {{path|/etc/pam.d/bioapi}}.

{{WARN|If su/sudo expects to receive the root password (SuSE 10), you need to have fingerprint settings for root (that is, copy in a root.bir as well as a your-username.bir). Otherwise, they get a segmentation fault. Which is a little unfortunate, given that you need to su or sudo to change your settings... }}
{{WARN|Not only SuSE 10 requires root.bir to be available for su to work. Just make sure you have root.bir when su is not working with your fingerprint reader but other applications are...}}
Note that sshd may pick up the fingerprint settings from {{path|/etc/pam.d/common-auth}}. I didn't want that, so I removed the "auth include common-auth" line from {{path|/etc/pam.d/sshd}} and replaced it with the lines that were originally in my {{path|/etc/pam.d/common-auth}}. That way most local services use the fingerprint reader, but sshd does not.

{{NOTE|su/sudo will call for your fingerprint even if you are remote via ssh. Pressing *CTLR-c* (or closing graphic window) will allow you the desired password option.}}

Another way to do this is to create a file ({{path|/etc/pam.d/bioapi|}} for example) which contains the {{cmd|pam_bioapi.so|}} lines, and explicitly {{cmd|@include|}} this '''before''' {{path|/etc/pam.d/common-auth|}} in the files for services which should use the fingerprint reader. In this case you should leave {{path|/etc/pam.d/common-auth|}} alone.

{{NOTE|This was discovered through trial and success, if it is plain wrong, wikorrect it, please.}}

In {{Fedora}} the original 'session' terms in {{path|/etc/pam.d/system-auth}} need to be kept.

{{HINT|The setup described above will/could affect remote ssh logins to also use biometric logins, which is a bit silly (who wants to remote ssh to the laptop, and then have to walk over to it and swipe your finger) To avoid that you can copy the default <tt>/etc/pam.d/system-auth</tt> to <tt>/etc/pam.d/sshd</tt> which will allow the sshd service to use the standard authentication procedure.}}

----

To enable normal password authorization to work with remote SSH in {{SUSE}} 10.3, edit the <tt>/etc/pam.d/sshd</tt> file. Remove all entries and replace them with:

auth required pam_env.so
auth required pam_unix2.so
auth required pam_nologin.so
account required pam_unix2.so
password required pam_pwcheck.so nullok
password required pam_unix2.so nullok use_first_pass use_authtok
session required pam_limits.so
session required pam_unix2.so

{{NOTE|These entries are what common-auth normally does. Since we've changed common-auth around for bioapi, these need to be specified manually. -Ransak}}

----

You can do some useful testing with [http://pamtester.sourceforge.net/ {{cmd|pamtester|}}], which calls the pam modules as if it were a program of your choice. Examples:
:{{cmdroot|pamtester xdm yourusername authenticate}}
:{{cmduser|pamtester xscreensaver yourusername authenticate}}
where {{cmd|yourusername|}} is your username. Note that {{cmd|pamtester|}} should run as root if and only if the program in question does.

===Application support===
The implementation of fingerprint scanning support in the relevant applications varies.

Here is the behaviour of the most common ones:
* In gdm enter your username and there should pop up an (ugly) image to swipe your finger and... magic - you can login without a password.
* kdm doesn't give any visual indication, other than that the cursor stops blinking. Just swipe your finger and hope it lets you log in.
* In xdm, enter your username and a blank password, then swipe (there is no popup as well). Identification support for xdm can be achieved with [http://www.nax.cz/pub/bioapi/2005/xdm/xdm_bio.patch this patch].
* The KDE screen saver in SUSE 10 requires you to enter an empty password (or select the correct user and then enter an empty password) in order to get the fingerprint prompt.
* For Fedora users, the redhat-config tools will crash if no root.bir presents. Also, there won't be any visual idication unless X server is properly configured for root to access. Just swipe your finger when the HDD stopped blinking or issue the following command in advance:
:{{cmduser|xhost +local:}}
* For RHEL4 users gdm, console (virtual terminal) logins and the xscreensaver all work

===kdm support===
To add graphical popup to kdm, you need following:
* Patch for pam_bioapi. This patch adds third parameter to {{path|pam_bioapi.so}} module, which is a name of file with additional environment variables that will be supplied to the UPEK driver.
:{{cmdroot|wget http://upir.cz/linux/patches/pam_bioapi-0.2.1-alter-environ.patch}}
:{{cmdroot|patch -p1 < pam_bioapi-0.2.1-alter-environ.patch}}
* Edit your {{path|Xsetup}} file (on SUSE 10 it's {{path|/etc/X11/xdm/Xsetup}}) and add these lines:
echo "XAUTHORITY=$XAUTHORITY" > /var/lib/xdm/kdm_env
echo "DISPLAY=$DISPLAY" >> /var/lib/xdm/kdm_env
* In {{path|/etc/pam.d/xdm}} file, add {{path|/var/lib/xdm/kdm_env}} as a third parameter for {{path|pam_bioapi.so}} module:
auth sufficient pam_bioapi.so {5550454b-2054-464d-2f45-535320425350} /etc/bioapi/pam/ /var/lib/xdm/kdm_env
* On Ubuntu simply do:
echo "DISPLAY=$DISPLAY" >> /var/lib/kdm/kdm_env
* If you have created /etc/pam.d/bioapi then modify:
auth sufficient pam_bioapi.so {5550454b-2054-464d-2f45-535320425350} /etc/bioapi/pam/ /var/lib/kdm/kdm_env

Please note, that this won't work if you have more than one Xserver.

==Make xscreensaver use the scanner==
If you are using Gentoo, you can get a portage overlay with the necessary patches here: http://dl.getdropbox.com/u/869/xscreensaver-fingerprint-overlay.tar.gz
*Get the needed xscreensaver sources:
:{{cmduser|wget http://www.jwz.org/xscreensaver/xscreensaver-4.23.tar.gz}}
:{{cmduser|tar xzf xscreensaver-4.23.tar.gz}}
:{{cmduser|cd xscreensaver-4.23}}
:{{cmduser|wget http://www.nax.cz/pub/bioapi/2005/xscreensaver/xscreensaver-4.22_alternativeAuth.diff mirror: http://zepan.org/files/xscreensaver-4.22_alternativeAuth.diff For xscreensaver 5.00, you can get a patch here: http://dl.getdropbox.com/u/869/xscreensaver-5.00-alternativeauth.patch}}
*After reviewing the patch (it's small and straightforward), do
:{{cmduser|patch -p1 < xscreensaver-4.22_alternativeAuth.diff}} The patch prevents xscreensaver from opening an authentification window and dispatches the authentification request to another program, in our case <tt>pam</tt> and <tt>pam_bioapi</tt>. It should apply with some offset, don't mind that. If it says something about rejected though, then there's a problem.
*Compile with
:{{cmduser|./configure --with-pam && make}} 
*If you receive an error like "Couldn't find X11 headers/libs" and are running a Debian-like system, try "apt-get install xlibs-dev"
*If you receive an error like "undefined reference to `XmuPrintDefaultErrorMessage'" then install the libxmu-dev package and run the previous line again and then install as root with
:{{cmduser|su -c make install}} .
*Make sure that the newly compiled xscreensaver is used:
:{{cmduser|which xscreensaver}} should return
:{{cmdresult|/usr/local/bin/xscreensaver}} .
*In case it doesn't, try adjusting your PATH.

==Common problems==
===Bioapi error #3===
This is sometimes caused by improper permissions. The full error message is "BioAPI Error Code: 3 (0x3)".

However, at least on Gentoo, recent upgrades to glibc and gcc 4.1.1 caused Bioapi to break down due to some sort of incompatibility with bioapi registry. Reinstalling does '''not''' repair the issue automatically. However, you can still fix the issue manually, by removing /var/bioapi. You need to reinstall tfm-fingerprint driver after reinstalling bioapi so that the driver is properly re-registered. As root, type

:{{cmdroot|emerge -C bioapi}}
:{{cmdroot|rm -rf /var/bioapi}}
:{{cmdroot|emerge -av1 bioapi tfm-fingerprint}}

[[Category:HOWTOs]]

How to enable integrated fingerprint reader with fprint

2015-12-02T14:05:12Z

Dskrvk: /* Ubuntu 12.04 LTS */ add category

== Is your fingerprint reader recognized? ==

Log in to the desktop. Open a terminal. In the terminal run
<pre>
lsusb
</pre>
and look for the "Upek Biometric ... Fingerprint Sensor" device.

== Configuration ==

=== Ubuntu 12.04 LTS ===

Install the needed software.

Note that the <tt>libpam-fprint</tt> package shipped with Ubuntu 12.04 is deprecated. Use <tt>libpam-fprintd</tt> instead.

<pre>
sudo add-apt-repository ppa:fingerprint/fprint
sudo apt-get install libpam-fprintd
</pre>

The needed lines in <tt>common-auth</tt> should now be present.
<pre>
$ grep fprint /etc/pam.d/common-auth
auth [success=2 default=ignore] pam_fprintd.so
</pre>

Now run
<pre>
fprintd-enroll
</pre>
and swipe your right index finger five times as instructed.
Now you should be able to authenticate by swiping your right index finger.

If you have an encrypted home directory then logging in from GDM by fingerprint does not work: the home directory cannot be decrypted. The solution is to log in from GDM with a password. (You encrypted your home directory so that even if someone has physical access to your computer, and it's turned off, then she can't read your files without taking it to the NSA. But if she's a bit clever and handy she can fool the fingerprint reader using a fingerprint lifted from the computer case.)
The problem is that GDM follows the default authentication procedure which starts with an attempt to read a fingerprint. Only once this fails or times out is a password requested. That is not convenient.

To eliminate fingerprint authentication from the display manager login do the following.

<pre>
sudo cp /etc/pam.d/common-auth /etc/pam.d/common-auth-nofinger
</pre>

Edit <tt>/etc/pam.d/common-auth-nofinger</tt>.
Remove the line "<tt>auth [success=3 default=ignore] pam_fprintd.so</tt>"; save and quit.

Edit <tt>/etc/pam.d/lightdm</tt> (or <tt>/etc/pam.d/gdm</tt>, if that's what you're using) so that it "@includes" <tt>/etc/pam.d/common-auth-nofinger</tt> rather than <tt>/etc/pam.d/common-auth</tt>.

[[Category: Ubuntu 12.04]]
[[Category:HOWTOs]]

How to enable the integrated fingerprint reader

2015-12-02T14:02:16Z

Dskrvk: /* Links */ add category

Sub-howtos for enabling the [[integrated fingerprint reader]] on ThinkPads:

* [[How to enable integrated fingerprint reader with fprint]] <- Try this first
* [[How to enable integrated fingerprint reader with ThinkFinger]]
* [[How to enable integrated fingerprint reader with BioAPI]]

==Free software==

===fprint===
The most current effort to support fingerprint readers is the [http://reactivated.net/fprint/wiki/Main_Page fprint project]. The fprint software comprises the libraries <tt>libfprint</tt> and <tt>libpam-fprint</tt> (which provides authentication via PAM) and the daemon <tt>fprintd</tt>.

It seems that lately this project has stalled; no support for newer chips has emerged for some time.

====Fingerprint GUI====
Makes use of libfprint.

Feb 2011: The following works as smoothly on Ubuntu and T410s: https://launchpad.net/~fingerprint/+archive/fingerprint-gui

Be aware the above packages (and the Fingerprint GUI project) include non-free drivers as indicated on [http://www.n-view.net/Appliance/fingerprint/about.php the project About page].

===ThinkFinger===
An earlier effort was the [http://thinkfinger.sourceforge.net ThinkFinger project]. It only supports the first-generation reader and has not been updated since 2007. See the [[How to enable the integrated fingerprint reader with ThinkFinger]] for detailed instructions. It was included in Debian Lenny but has since been removed from Debian.

== Non-free software ==
A closed source driver for the UPEK device is available. It interfaces to the hardware as a user-space USB driver through {{path|/proc/bus/usb|}} and provides a BioAPI 1.10 device, which can then be interfaced to pam for authentication by user programs. The driver can be downloaded from [http://www.upek.com/support/downloads/linux/ http://www.upek.com/support/downloads/linux/]. It however tends to be less stable than the above open-source drivers.

==Links==
* [http://biomark.org.ru/en/ A (Russian) project that provides support for a (different model) of fingerprint scanner] (also a USB device, though)
* [http://www.qrivy.net/~michael/blua/ A branch of the BioAPI reference implementation]
* [http://www.pdfserver.net/fingerprint A GUI using the BioAPI driver on thinkpads. Windows-like GDM login]
* [http://www.n-view.net/Appliance/fingerprint/ Fingerprint GUI Project. Allows to use the fingerprint scanner for Login (GDM) and authentication in (sudo, su). Seems to work with T410 and Ubuntu 10.04]

[[Category:HOWTOs]]

DisplayPort

2015-11-17T17:58:19Z

Dskrvk: /* Audio Support */ add W520, formatting

__NOTOC__
{| width="100%"
<div style="margin: 0; margin-right:10px; border: 1px solid #dfdfdf; padding: 0em 1em 1em 1em; background-color:#F8F8FF; align:right;">
DisplayPort is a digital video connector, available on select ThinkPads

</div>
|}

* [[Wikipedia:DisplayPort| Wikipedia article on DisplayPort]]

==ThinkPads featuring this technology==
* Full size DisplayPort (DP) connector
** {{L412}}, {{L512}}
** {{R500}}
** {{T400s}}, {{T410}}, {{T410i}}, {{T410s}}, {{T410si}}, {{T420}}, {{T420s}}, {{T500}}, {{T510}}, {{T510i}}, {{T520}}
** {{W500}}, {{W510}}, {{W520}}, {{W700}}, {{W700ds}}, {{W701}}, {{W701ds}}
** {{X301}},{{X220}}
* Mini DisplayPort (mDP) connector
** {{T430}}, {{T430s}}, {{T431}}, {{T440}}, {{T440s}}, {{T530}}
** {{X230}}, {{X230s}}, {{X240}}

==Port Replicators and Docks featuring this technology==
Note, some have multiple Displayports
* [[ThinkPad Mini Dock Series 3]]
* [[ThinkPad Mini Dock Plus Series 3 - 170W]]
* [[ThinkPad Mini Dock Plus Series 3 - 135W]]
* [[ThinkPad Mini Dock Plus Series 3 - 90W]]
* [[X200 UltraBase]]
* [[W700 Mini Dock]]
* [[W700 Mini Dock 2.0]]

== DVI Pass-through ==

Certain ThinkPad models have a DisplayPort connection which offers DVI pass-through.

Check [http://www-307.ibm.com/pc/support/site.wss/MIGR-72148.html ThinkPad Digital Video Interface (DVI) and DVI Pass-Through] for more information, and to see if a specific model and configuration is supported.

== Audio Support ==

There are reports that DisplayPort on some (possibly all) current thinkpads does not support audio. While there are adapters to convert DisplayPort to HDMI, the lack of audio makes it impossible to, for example, watch a DVD or Blu-Ray on an HDTV using the DisplayPort. [http://forums.lenovo.com/t5/W-Series-ThinkPad-Laptops/Displayport-to-HDMI-with-audio/td-p/68575 See this thread for more information]

Audio over DisplayPort when used in conjunction with a DisplayPort to HDMI conversion cable is [http://forums.lenovo.com/t5/T400-T500-and-newer-T-series/T410-T510-DisplayPort-features-audio/td-p/191530/page/3 confirmed] to work on T410 and T510 both on integrated and discrete graphics options on Windows systems.

Audio support works out of the box on T410 and others when configured properly. A few minutes configuring the digital audio and or dolby 5.1 audio to use the dislplay port and it works. [[User:Lathama|Lathama]] ([[User talk:Lathama|talk]]) 22:46, 30 August 2013 (CEST)

=== T410s ===

The T410s supports audio pass-through via DisplayPort on recent Linux systems.

With the Intel HD Audio modul selected recent linux kernels detect the DisplayPort
audio as a separate output device:

On 2.6.36-rc1 the following devices can be found in {{path|/proc/asound/*}}

Codec: Intel IbexPeak HDMI
Device: name="INTEL HDMI 0", type="HDMI", device=3
Device: name="INTEL HDMI 1", type="HDMI", device=7

If you want to pass Audio via DisplayPort you just have to switch to the Intel HDMI audio output device
for the application in PulseAudio (didn't test with pure ALSA).

=== W510 ===

The more recent versions of the W510 with the Quadro FX 880M support audio and video out through DisplayPort. Tested with a DisplayPort to HDMI with Audio converter. Used alsa (no PulseAudio) and mplayer, 2.6.35-ARCH, using <code>mplayer -afm hwdts,hwac3 -ao alsa:noblock:device=hw=1.7</code> and nvidia driver version 256.53. Had to unmute with <code>alsamixer -c1</code>.

=== W520 ===

Verified audio is working with a port adapter, nvidia driver version 352.41, alsa, PulseAudio (possibly unnecessary). The BIOS setting for graphics is "Discrete graphics".

=== X220 ===

Pulseaudio detects and and stream audio out of the DisplayPort. Tested talking to a DisplayPort monitor, just needed to select one of the HDMI profiles in pavucontrol (Pulseaudio Volume Control) on the Configuration tab.

== Problems ==

=== T420s and T520 ===
The BIOS for the {{T420s}} (and presumably also the {{T420}}) settings for _Graphics Device_ default to '''NVIDIA Optimus''' and the '''OS Detection for NVIDIA Optimus''' is set to '''Disabled''' which is not a good set of defaults for Linux since Optimus is only supported by Windows 7. To get the NVidia drivers working for Linux I had to set the '''Graphics Device''' to '''Discrete Graphics'''. This was as of 2011-11-26 using '''driver version 290.10'''. Then run '''sudo nvidia-xconfig'''. Both TwinView and Xinerama worked fine.

The T520 also requires '''Discrete Graphics''' to use DisplayPort.

=== Twinview using Displayport and DVI broken ===
On my T410 mini-dock series 3, the displayport works unless I try to use it while using the DVI out as well.
DVI+VGA works, but nvidia-settings dies horribly. Tried with 195.* and 260* drivers.

I am using a displayport -> DVI adapter (displayport++ allows this).

 FIX:
Using Nouveau drivers instead of the nvidia binary blob allows my displayport to work in concert with the DVI out of my dock.
This allows dual digital external displays. Attempting to activate the laptop monitor as well leads to problems.

 ANOTHER FIX: 
Version 275* from the nvidia website allows me to use Displayport and DVI at the same time as well.

== External Sources ==
* [http://www-307.ibm.com/pc/support/site.wss/MIGR-72148.html ThinkPad Digital Video Interface (DVI) and DVI Pass-Through]
* [http://www-307.ibm.com/pc/support/site.wss/MIGR-70321.html DisplayPort Monitor Cables - Overview]

Maintenance

2015-11-17T17:43:04Z

Dskrvk: /* External Sources */ add HOWTOs category

{| width="100%"
|style="vertical-align:top;padding-right:20px;width:10px;white-space:nowrap;" | __TOC__
|style="vertical-align:top" |
Here you can find general hints about keeping your ThinkPad in good shape. Look at your [[:Category:Models|models category page]] for IBMs official maintenance guide for that model.
|}
==Assembly/Disassembly instructions==
Lenovo has a website dedicated to servicing ThinkPads, but it only covers the more recent models. For older models check the HMM (Hardware Maintenance Manual) for your ThinkPad.
* http://www.lenovoservicetraining.com/

==Battery treatment==
{| border=1 cellspacing=0 cellpadding=2 style="vertical-align:top;"
|+Battery life expanding guide
|- style="background:#efefef;white-space:nowrap;"
! style="background:#ffdead;" | Battery Type !! NiCd !! NiMH !! Lithium ion
|- style="vertical-align:top;"
! style="background:#ffdead;" | General
|
*always do complete discharge/charge cycles
*avoid exposing the battery (or notebook) to excessive heat
|
*always do complete discharge/charge cycles
*avoid exposing the battery (or notebook) to excessive heat
|
*avoid deep discharges except when resetting fuel gauge or reconditioning a battery; partial dis-/recharges are better for the battery lifetime (note: fuel gauge will slowly get inaccurate over time)
*remove battery when on AC (due to heat)
*avoid exposing the battery (or notebook) to excessive heat
|- style="vertical-align:top;"
! style="background:#ffdead;" | Charging
|
*discharge before charging
|
*discharge before charging
|
*avoid charging if battery is nearly full, unless you will need its full capacity soon; keep it on the 30%-85% charged range
*keep notebook off while charging due to heat
*fully discharge, then fully charge battery when needed to recalibrate fuel gauge; newer battery pack models require this less often, old ones might need it as often as every 30 cycles
|- style="vertical-align:top;"
! style="background:#ffdead;" | Storage
|
*almost discharged
*cool and dry
|
*almost discharged
*cool and dry
|
*never fully charged or discharged, ideally at about 40%
*cool and dry, but '''do not freeze''' them: 10-15C is recommended
|}

===Battery health===
Batteries, especially of the modern Li-Ion type, wear out quicker when they hold a large charge or are subject to higher temperatures (see above).

If you use your laptop at a desk, reduce battery wear by maintaining an appropriate charge level. When possible, remove Li-ion batteries while operating from AC as the notebook gets hot enough inside for that to damage the battery in the long run, even if charging is stopped.

On recent ThinkPads, charging thresholds can be configured in the bundled software. Under Linux, this is supported on recent models by the [[tp_smapi]] driver (and even without <tt>tp_smapi</tt>, if you have a dual-boot setup, you can set the thresholds under Windows and they will be remembered as long as you don't power off your machine with AC disconnected; suspend to RAM is OK). Have a look at [[How to use UltraBay batteries]].

If you have spare Li-ion battery packs, store them at 40% charge in a cool place (15C being a recommended temperature, do not let the batteries freeze). If storing inside a refrigerator, beware of humidity, and be careful with cold spots that can easily freeze the battery if anything goes wrong.

===The problem with 600 series batteries===
ThinkPad 600 power management causes batteries to die before they should. Read more about this on the [[Problem with ThinkPad 600 batteries|associated problem page]].

===Reviving batteries===
Some people experience sudden drops in their batteries capacity. A way to get these batteries back to full capacity is to run the "Battery Rundown" function of IBMs "PC Doctor for DOS". The program is downloadable from IBMs support site as three floppy disk images. Make sure you get the specific version of program made for your ThinkPad model. For those who do not have a floppy, David Smith prepared a [http://www.mypchelp.com/~dsmith/ibmutil/ibm_t22_pcdiag.iso bootable CD image] (dead link, a copy is also available [http://server6.org/~marker/software/ibm_t22_pcdiag.iso here]) from the T22 floppy images. For newer ThinkPads there is an official [http://www-307.ibm.com/pc/support/site.wss/document.do?sitestyle=lenovo&lndocid=MIGR-56222 bootable CD image]. (Although the instructions on this page (as of May 2008) include details for Linux and refer to a CD image, it is actually provided as a Windows executable. On Linux systems, [http://winehq.org Wine] can execute this file and extract the CD image.) Once extracted, you must mount the iso as a loop device (as root) like so:

:{{cmdroot|mount -o loop 1ety48ww.iso /mnt/floppy}}

Then copy the .IMA file out of that mounted iso:

:{{cmdroot|cd /mnt/floppy}}
:{{cmdroot|cp 1ETY48WW.IMA /boot}}

(Or to some other suitable directory.) After this, you can follow the same directions that apply for [[BIOS Upgrade|BIOS upgrade]]s.

{{NOTE|This will do nothing to improve the performance of a dying battery. It serves only to recalibrate the battery charge controller. The "Battery Rundown" function of IBMs "PC Doctor for DOS" has no intelligence. It merely runs a series of dumb operations to consume battery power, and it cannot detect whether a battery is present or not. If you leave the mains connected while running "Battery Rundown", it will have no effect, as the battery will simply keep charging. The [[tp_smapi]] module, if installed, will report the number of charge cycles the battery has had since it was manufactured. If that number is high, the battery's poor performance is almost certainly due to its age.}}

I have recently made an interesting discovery, I have an R40 with two main batteries, both of them have aproximately about under 200 cycles and are nowadays 4 years old, projected capacity for R40/R32 main battery is 57Wh, and both my batteries were about 30Wh, then I left my notebook with one of them about a day in a standby mode, as long as it powered off itself because of low battery power, when I turned it on I saw the battery capacity at about 42Wh, then, I did this too for the second battery and I got even about 46Wh, I think I could go even higher with letting the battery discharge completely from 100% in standby, I think this has something to do with low power consumption in standby mode, it may work for you too.

===See also===
* [[Battery safety]]

===External sources===
* [http://www-307.ibm.com/pc/support/site.wss/document.do?lndocid=PFAN-3QNQJN IBM Support - Extending battery life]
* [http://www-307.ibm.com/pc/support/site.wss/document.do?sitestyle=ibm&lndocid=MIGR-51038 IBM Support - Battery troubleshooting]
* [http://www.pc.ibm.com/ww/thinkpad/batterylife/ IBM Benchmark]
* [http://batteryuniversity.com Battery University]
* [http://www.batteryuniversity.com/parttwo-34.htm Battery University's info about prolonging lithium ion batteries]
* [http://www.buchmann.ca/Chap10-page6.asp prolonging lithium ion batteries in Buchmanns Battery FAQ]
* [http://www.electronics-lab.com/articles/Li_Ion_reconstruct Electronics Labs information about lithium ion batteries]

==Cleaning the Display==
If you discover markings that look like they originate from the TrackPoint or keyboard, or for information on how to avoid these, look at [[Problem with key and trackpoint markings on the display|this page]].

===External Sources===
* [http://www-307.ibm.com/pc/support/site.wss/document.do?sitestyle=lenovo&lndocid=MIGR-4A2P54 Lenovo Support - LCD care and cleaning instructions]
* [http://www-307.ibm.com/pc/support/site.wss/document.do?sitestyle=lenovo&lndocid=MIGR-52190 Lenovo Support - System cleaning instructions]

==Cleaning the Interior==
{{WARN|The following instructions are not appropriate for all ThinkPad models. Please consult the hardware maintenance guide or on-line disassembly instructions for your model.}}
Most ThinkPad models (particularly the A-series and the T-series) tend to accumulate a lot of interior dust which they draw from their ventilation fan. A good dusting every few months is advised. The procedure is as follows.

===ThinkPad T4x series===
See IBM's keyboard removal [http://www-307.ibm.com/pc/support/site.wss/document.do?sitestyle=lenovo&lndocid=MIGR-46515 instructions] and [http://www-307.ibm.com/pc/support/site.wss/document.do?sitestyle=lenovo&lndocid=MIGR-50227 movie].

===ThinkPad T6x series===
See IBM's keyboard removal
[http://www-307.ibm.com/pc/support/site.wss/document.do?sitestyle=lenovo&lndocid=MIGR-62800 instructions] and
[http://www-307.ibm.com/pc/support/site.wss/document.do?sitestyle=lenovo&lndocid=MIGR-63912 movie].

===Other models (which?)===
#Unplug the computer.
#Remove the battery.
#Turn the ThinkPad over and find two to three screws with upraised double-arrows pointing to them.
#Unscrew these screws and set them aside.
#Press the silver area underneath where the battery used to be. The front of the keyboard will pop up.
#Turn the ThinkPad right side up and gently remove the keyboard, pulling it toward you.
#There is one connector between the ThinkPad and the keyboard. Disconnect it, and set the keyboard aside.
#If there is a small black plastic separator under the keyboard, remove it and set it aside.
#The fan should be visible in the upper left. That entire area will likely be dusty. With a can of compressed air (and ''only'' with a can of compressed air), dust that area and the surrounding area.
#Replace the small black plastic separator, then reconnect the keyboard.
#Slide the keyboard back into place, then press down on the Fn and right-arrow keys until it pops into place.
#Replace the keyboard screws and battery.

==Dealing with spilling accidents==
#Don't panic.
#Don't flip or tilt the computer to prevent the liquid from spreading all over the inside of the case.
#Shut down the OS and turn off the power:
##Unplug the computer.
##Remove the battery.
#Tilt the computer so that everything that leaked into the case can flow out the same way.
#Allow the computer to dry before switching it on again.
#For minor accidents this might already be sufficient. For major flooding you should either bring the computer to a dealer who knows how to open and clean it from inside. Or you can read the Hardware Maintenance Manual, open, clean, and dry the computer yourself.

See also [http://www.moneysense.ca/spending/technology/columnist.jsp?content=986628 Act quickly, carefully if you spill on laptops] on MoneySense.ca (link broken as of 2006-09-18, the article is still available via [http://web.archive.org/web/20050221034011/http://www.moneysense.ca/spending/technology/columnist.jsp?content=986628 web.archive.org]).

==Harddisk Backup / Upgrade==
*[[How to copy a Linux installation]]
*[[Harddrive Upgrade|How to upgrade your Thinkpad hard drive]]
*[[How to copy a Windows installation]]
===External Sources===
*[http://gamma.nic.fi/~point/win2copy.htm Guide on copying Windows 2000/XP to another partition]

==Recovering BIOS passwords.==
Password recovery procedure for IBM ThinkPads using R24RF08 and IBMpass.

(Note: An updated tutorial can always be found [http://www.allservice.ro/forum/viewtopic.php?t=47&start=0 HERE])

'''1. Introduction.'''

The IBM ThinkPad uses a small eeprom ([[AT24RF08|ATMEL 24RF08]]) to store different OEM
issues like serial number, UUID, etc. The supervisor password (SVP) is also stored in this eeprom.
The 24RF08 is not an ordinary eeprom: it features read protection, which the BIOS uses to lock down
access to the eeprom contents. Also, the password is written in a special scan code, which needs to
be translated to ASCII to be of any use.

To recover the password, one can use two different programs: R24RF08 (eeprom reader) and IBMpass
(password revealer) available at [http://www.allservice.ro/store/utils http://www.allservice.ro/store/utils]. Diagrams are included in the reader kit.

Models for which R24RF08 and IBMpass are enough to recover the password: 240, 240X, 390E, 390X, 570, 570E,
600e, 600X, 770Z, A20m, A21e, A21m, a22m, A30, A30p, A31, A31p, G40, G41, R30, R31, R32, R40, R50, R51,
Transnote, T20, T21, T22, T23, T30, T40, T40p, T41, T41p, T42, T42p, X20, X21, X22, X23, X24, X30, X31, X40, X41, X61.

ThinkPads featuring TPCA technology (i.e. a [[Tpm|TPM trusted platform module chip]]), especially T4x, X3x, X4x, X61 and X61T need the W24RF08 eeprom writer program to complete the password recovery procedure, if the passphrase function is enabled in BIOS setup.

Other models such as the 380XD or 600 use 24C01 or 93C46 eeproms, which can be read without special tools.
The method is the same like for the models based on 24RF08, only the software to dump the eeprom is different.

Newer T43/T43p, R52, R60, T60/p, X60 and Z60 ThinkPads can be unlocked using PC8394 programming tools that consist in RPC8394 and WPC8394 (reader and writer for TPM chips).
The software is available as well at [http://www.allservice.ro/forum/viewtopic.php?p=1061#1061 www.allservice.ro]. IBMpass 2.0 works for any TP model without exceptions.

'''2. Locating the ATMEL 24RF08 eeprom. Soldering.'''

No need to unsolder the 24RF08 eeprom, just solder 3 wires to SDA, SCL and GND pins of the
eeprom. There are two eeprom layouts (see interface schematics described bellow), corresponding to 8 pin or 14 pin eeproms. Locate the eeprom first according to your model (E.g. T20-23 and T30 have the eeprom underneath TP, and can be accessed by removing the RAM modules cover, no need to dismantle the laptop.) and solder the wires using a soldering iron with a fine tip. Also, you can use 0.15 -0.20 mm enamel coated wires or similar small diameter insulated wires. These wires will be connected later to the interface.
Tip: You can use clips to connect the wires or you can solder on the PCB traces leading to the
eeprom pins. Once again, be careful and double, triple check the soldering if necessary till you are positively sure you have done the right job. In case of applying too much solder, use flux-impregnated copper-braid "desoldering wick" - this works exceptionally well.

'''3. Choose and build the interface.'''

Since version 2.0, R24RF08 and W24RF08 (eeprom writer) are compatible with a wide range of eeprom programmers. By default, both programs set the COM port signals to use direct logic level to access I2C bus. We provide here 2 schematics that are relevant for direct logic signals and for inverse logic signals (simple-i2cprog.pdf and driven-i2cprog.pdf). Also, depending of the interface you build, you can invert the logics for SDA-In, SDA-Out, and SCL COM port signals by some command line parameters described later in this document.
a) The file simple-i2cprog.pdf contains the schematic diagram of a simple interface (known as SIPROG)based on 2 zeners and 2 resistors. This is a classic, easy to build circuit and works with soldered or unsoldered eeproms. The purpose of the 2 zeners is to convert RS232 levels (+/- 5V) to TTL levels, needed by the eeprom. It uses direct logic signals to I2C eeprom and is powered by the COM port. However, this interface works with in-system eeproms but is dependant on COM port current and eeprom bus impedance. R24RF08 works natively with this circuit, no need to change the lines signals with command line parameters. This circuit works pretty well with almost all ThinkPads series.
b) The second interface is described in driven-i2cprog.pdf. The circuit uses MAX 232 as a RS232 to TTL driver and its main purpose is to work with soldered eeproms. The advantage of MAX232 is the TTL outputs that are more reliable and more powerful when work with soldered, in-system eeproms (dependency free from the COM port current). Due of the internal inverters of MAX232 the interface responds to an inverse signal logic level. R24RF08 needs /x, /d, /i switches to be specified in the command line.

What these switches mean:
/x - invert serial clock, also known as SCL;
/d - invert serial data output, also known as SDA-Out;
/i - invert serial data input, also known as SDA-In.
All those can be used in any combination to meet any interface specification.

Note that the "standard" serial port programmer probably won't work with a USB-Serial adapter, but requires the full nominal voltage of a hardware serial port. [Example: the A22p's serial port works fine here.]

'''4. Dump the EEPROM:'''

Prepare your technician PC by connecting the interface to the COM1 port (donâ€™t connect the wires to eeprom yet). Turn on the ThinkPad and press F1 to enter BIOS Setup. When you are prompted for the password and thereâ€™s no other activity like HDD access or so, connect the wires (GND first!, SDA, SCL) to the corresponding wires from the interface (attached before to COM1) and execute R24RF08:

-for SI-PROG interface (as described in 3.a above):
r24rf08.exe <filename.ext>. where filename.ext is the file where eeprom content will be stored.
Example: r24rf08 mytp.bin

-for MAX232 driven I2C interface (as described in 3.b above):
r24rf08.exe <filename.ext> /x /d /i. where /x /d /i are command line parameters (switches) for this kind of interface.
Example: r24rf08 mytp2.bin /x /d /i

Use exactly the instructed switches to avoid possible damages to your eeprom data!
The file should be created in the same folder. Finally, disconnect the wires (GND last!) and turn off the ThinkPad by pressing on/off switch.

Dump the EEPROM data at least twice, and do a bytewise compare with `cmp`. Both files should be identical, and 1024 bytes long. Otherwise, you probably have a serial port problem.

Note: the r24rf08.exe program automatically sets the serial port parameters. It also works fine with Wine under Linux - provided that a symlink (com1) exists in the .wine/dos_devices directory, and points to the /dev/ttySX for the actual serial port.

'''5. Reveal the password.'''

Now, you have the .bin file but you need to dump in scan code to retrieve the password. IBMpass 2.1 Lite is a free tool that will do the job. Just open the eeprom dump youâ€™ve created before and search for 0x330, 0x340 lines. The password is located on 0x338 (and 0x340 depending on model) in scan code. For 24C01 eeproms the password is located at 0x38, 0x40. If the password won't work for the very first time then your eeprom may use newer IBM scancodes. In this case switch to alternate scan codes to find it. For those who want quick answers the recommended version is IBMpass 1.1. Usage for IBMpass 1.1 (command line only):

ibmpass mytp.bin â€“ use â€œ/aâ€ switch to see in alternate scan code if needed:
ibmpass mytp.bin /a

For some old models like 570 or 770Z you need to execute the eeprom patcher first. This will reset the read protection on the password offset. To do that just execute patcher.exe before the reading operation, without rebooting the laptop:

-for SI-PROG:
patcher.exe , then immediately
r24rf08.exe <filename.ext>

-for Driven-I2C (Max232) you must insert the switches:
patcher.exe /x /d /i, then immediately
r24rf08.exe <filename.ext> /x /d /i

W24RF08, the writer version, has included the complete APP reset operation you donâ€™t need to use patcher.

Moreover, there are a new encrypting algos used with some new security chips (AT97SC3201, AT97SC3203) that are very secured. The password is not in scancode and in some cases not even in the eeprom. To unlock the machine, the dump should suffer some changes and the eeprom must be reprogrammed using W24RF08. This operation works for all IBM TCG/TCPA secured laptops w/o exceptions.

Remember, use 3 wires from the interface and 3 wires from eeprom! Connect them after your
ThinkPad is powered and disconnect them right after you read the content, before you switch off the laptop.

'''6. Password format'''

The thinkpad power-on/supervisor passwords are a maximum of 7 characters, and are NOT case-sensitive. The allowed characters are restricted to A-Z, 0-9, semicolon, _, - (and perhaps a few others).
If PassPhrase is enabled then the password can be longer than 7 characters.
Models like T43/R52/T60/R60/T60/X60/Z60/Z61 need the TPM chip dumped with [http://www.allservice.ro/forum/viewtopic.php?p=1061#1061 PC8394 programming tools] in order to find password/reset the TCPA lock.

===External Sources===
* [http://www.allservice.ro/forum R24RF08/W24RF08, PC8394 programming tools & IBMpass author's forums]
* [http://www-307.ibm.com/pc/support/site.wss/document.do?sitestyle=ibm&lndocid=MIGR-59377 IBM Support - Lost or forgotten password]
* [http://www.allservice.ro/forum/viewforum.php?f=12 Full Service of all ThinkPad models including free password recovery]
* [http://sodoityourself.com/hacking-ibm-thinkpad-bios-password/ A tutorial on how to do this]

[[Category:HOWTOs]]