Custom hot key programming with acpid
Key In
A little research from the command line and a short script bends your keyboard to your will.
Linux support for laptops has improved by leaps and bounds in the last decade. At this point, if you buy a laptop from any of the major manufacturers and load a Linux distro with a reasonably recent kernel version, things pretty much "just work" – problems with proprietary display drivers aside.
What can sometimes not work, however, are some of the vendor-specific hot keys on the keyboard. For example, I do a lot of presentations, and I'd like the hot key that's supposed to switch between my laptop display and an external monitor (Fn+F7 on my ThinkPad) to work under Linux. In this article, I describe my solution for this problem and offer some pointers for customizing hot key events.
Getting to Know acpid
Most Linux systems support ACPI (Advanced Configuration and Power Interface [1]), a popular standard for device configuration and power management. The ACPI standard specifies a structure for defining and customizing hardware events. In Linux, the acpid daemon [2] listens for ACPI events and maps each event to an action. Hot key events are typically handled by acpid.
The trick to customizing your hot key configuration is getting acpid to divulge exactly which event numbers are occurring when you press a particular button. The easiest way to do this is to put acpid into debugging mode with the -d switch. To do this, you need to kill the current acpid process and restart it, as shown in Listing 1.
Listing 1
Kill acpid and Restart in Debug Mode
Note that I'm being careful to use the same command-line options that were used in the original acpid invocation; then I add the -d flag to capture the debugging output. At this point, quite a bit of output is directed to your terminal as acpid starts up. Once that output settles down, you can go ahead and hit the hot key you're interested in programming. When I hit Fn+F7 on my laptop, I get a report similar to the output shown in Listing 2.
The relevant bit here is the event identifier, "ibm/hotkey HKEY 00000080 00001007", because you will need this string when you are programming custom events into acpid. The acpid daemon stores the different event actions in configuration files that go into the /etc/acpi/events directory. To see whether a configuration file related to your Fn+F7 events already exists, enter the following code:
# grep -l "ibm/hotkey HKEY 00000080 00001007" /etc/acpi/events/* /etc/acpi/events/ibm-videobtn # cat /etc/acpi/events/ibm-videobtn # /etc/acpi/events/ibm-videobtn # This is called when the user presses the video button. It is # currently a placeholder. event=ibm/hotkey HKEY 00000080 00001007 action=/bin/true
As you can see, a configuration file is related to this event, but the final line, action=/bin/true, tells you that pressing this hot key does not switch the monitor. (Note that a close reading of the acpid debugging output In Listing 2 would lead you to the same conclusion.) To get this hot key working, you'll need a little script.
Listing 2
acpid Output for Function Keys
Fun with xrandr
To create a script, you'll need a command-line method for controlling the internal and external displays. Happily, modern Linux distributions come with xrandr (short for "X Rotate AND Resize"), which has all the necessary functionality. For example, to discover the current display settings, enter xrandr -q (Listing 3).
Listing 3
Show Current Display Settings
In Listing 3, VGA is the external monitor and LVDS is the internal laptop video display. For each display, xrandr lists the various screen resolutions supported and marks the currently active screen(s) with an asterisk (*). In the example shown in Listing 3, the external monitor is running at the maximum resolution of 1920x1200, and the laptop display is currently shut off. Additionally, you can use xrandr to change your video settings (Listing 4).
The xrandr command has a lot of other tricks up its sleeve, including the ability to create a single virtual display out of multiple screens, the ability to rotate screens between portrait and landscape mode, and so on. However, the basic commands I have presented here are sufficient for the needs of this simple example.
Listing 4
Changing Video Settings with xrandr
Getting Your Script On
When I press Fn+F7, I want to rotate through three possible video modes corresponding to the xrandr commands in Listing 4. Those modes are:
- both displays on and showing the same screen
- laptop display only
- external monitor only.
Although I could have added additional options, I figured these modes were the basics of what I needed when giving presentations. If I needed to, I could always just run xrandr from the command line for any additional options.
I freely admit I cribbed a lot of good ideas for this script from an article on the ThinkWiki site [3] (which is a hugely useful site, by the way, even if you are not using a ThinkPad). One of the most critical tricks in this particular situation is to remember that acpid is going to be running your script with root privileges, but the display is owned by the user on the console of the machine. For your script to use xrandr effectively, it needs to run all commands through su to get access to the display as the console user.
My sample Perl script is shown in Listing 5. The ThinkWiki article provides alternative Bash and Python scripts. The first block of code is devoted to figuring out which user is currently on the console. Then the script runs xrandr -q and parses out the configuration of the currently active displays.
Finally, a big if block figures out which state the system is currently in and chooses the appropriate xrandr command to move to the next screen mode.
Listing 5
Sample video-switch Script
Buy Linux Magazine
Subscribe to our Linux Newsletters
Find Linux and Open Source Jobs
Subscribe to our ADMIN Newsletters
Support Our Work
Linux Magazine content is made possible with support from readers like you. Please consider contributing when you’ve found an article to be beneficial.
News
-
TUXEDO Computers Unveils Linux Laptop Featuring AMD Ryzen CPU
This latest release is the first laptop to include the new CPU from Ryzen and Linux preinstalled.
-
XZ Gets the All-Clear
The back door xz vulnerability has been officially reverted for Fedora 40 and versions 38 and 39 were never affected.
-
Canonical Collaborates with Qualcomm on New Venture
This new joint effort is geared toward bringing Ubuntu and Ubuntu Core to Qualcomm-powered devices.
-
Kodi 21.0 Open-Source Entertainment Hub Released
After a year of development, the award-winning Kodi cross-platform, media center software is now available with many new additions and improvements.
-
Linux Usage Increases in Two Key Areas
If market share is your thing, you'll be happy to know that Linux is on the rise in two areas that, if they keep climbing, could have serious meaning for Linux's future.
-
Vulnerability Discovered in xz Libraries
An urgent alert for Fedora 40 has been posted and users should pay attention.
-
Canonical Bumps LTS Support to 12 years
If you're worried that your Ubuntu LTS release won't be supported long enough to last, Canonical has a surprise for you in the form of 12 years of security coverage.
-
Fedora 40 Beta Released Soon
With the official release of Fedora 40 coming in April, it's almost time to download the beta and see what's new.
-
New Pentesting Distribution to Compete with Kali Linux
SnoopGod is now available for your testing needs
-
Juno Computers Launches Another Linux Laptop
If you're looking for a powerhouse laptop that runs Ubuntu, the Juno Computers Neptune 17 v6 should be on your radar.