Chapter 3. Usage

Table of Contents

Controls
Keyboard
Joystick
Actions
Standard actions
User actions
Remote controls
Command line options
Configuration file
Available settings
Example

Controls

Keyboard

Listed below are the default keyboard controls. You can change them to your liking by editing the file ~/.eboxy/keys. This file contains entries consisting of the key name and action to be performed, separated by tab(s) or space(s), one entry per line. Not all actions have to be bound, and neither do all keys.

Table 3.1. Default keyboard key assignments

KeyDefault function
Shift+TabPrevious widget
TabNext widget
Up Arrow / Left ArrowPrevious list item
Down Arrow / Right ArrowNext list item
Page UpPrevious list page
Page DownNext list page
HomeFirst list item
EndLast list item
EnterPress selected button/choose selected list item
BackspaceCancel (cancel user action)
EscapeQuit

The keyboard key names used in the keys file are as follows:

Table 3.2. Key names

Key nameKey
backspaceBackspace
tabTab
enterEnter
pausePause
escapeEscape
spaceSpace bar
quoteQuote '
commaComma ,
minusMinus -
dotFull stop .
slashForward slash /
0 to 9Number keys (not the keypad)
semicolonSemi-colon ;
equalsEquals =
leftbracketLeft bracket (
backslashBackslash \
rightbracketRight bracket )
backquoteBackquote `
a to zAlphabetic keys a-z
deleteDelete
keypad0 to keypad9Keypad number keys
keypaddotKeypad .
keypadslashKeypad /
keypadstarKeypad *
keypadminusKeypad -
keypadplusKeypad +
keypadenterKeypad enter
keypadequalsKeypad =
uparrowUp cursor key
downarrowDown cursor key
rightarrowRight cursor key
leftarrowLeft cursor key
insertInsert
homeHome
endEnd
pageupPage Up
pagedownPage Down
f1 to f15Function keys F1-F15
numlockNum Lock
capslockCaps Lock
scrolllockScroll Lock
rshiftRight Shift
lshiftLeft Shift
rctrlRight Control
lctrlLeft Control
raltRight Alt
laltLeft Alt
lwinLeft Windows key
rwinRight Windows key
menuContext menu key
printscreenPrint Screen

In addition, you can use the following modifier key prefixes:

Table 3.3. Key modifiers

Modifier nameModifier key
lshiftLeft Shift
rshiftRight Shift
shiftShift (left or right)
lctrlLeft Ctrl
rctrlRight Ctrl
ctrlCtrl (left or right)
laltLeft Alt
raltRight Alt
altAlt (left or right)

To use these modifiers, just prefix your keys with one or more of them, separating keys and modifiers with plus signs, eg.:

alt+x              exit
shift+ctrl+enter   accept

Note: when entering text in a textfield widget, eboxy will pass through normal letter, number and punctuation keys as normal. If you don't want this to happen (ie, you want to remap the keyboard completely) you will need to pass the --nokeypassthrough command line option to eboxy when you run it.

Joystick

Joystick events are handled in the same way as key presses. The following "key names" are used for joystick events (the bracketed button names only apply to some joysticks and gamepads, yours may be different):

Table 3.4. Joystick key names

Key nameJoystick event
joystickbutton1Joystick Button 1 (A)
joystickbutton2Joystick Button 2 (B)
joystickbutton3Joystick Button 3 (X)
joystickbutton4Joystick Button 4 (Y)
joystickbutton5Joystick Button 5 (left trigger)
joystickbutton6Joystick Button 6 (right trigger)
joystickbutton7Joystick Button 7
joystickbutton8Joystick Button 8
joystickbutton9Joystick Button 9
joystickupJoystick Up
joystickdownJoystick Down
joystickleftJoystick Left
joystickrightJoystick Right
joystickhatupJoystick Hat Up
joystickhatdownJoystick Hat Down
joystickhatleftJoystick Hat Left
joystickhatrightJoystick Hat Right