irexec(1)

1IREXEC(1)                        User Commands                       IREXEC(1)
2
3
4

NAME

6       irexec - run programs with one button press
7

SYNOPSIS

9       irexec [options] [config_file]
10

DESCRIPTION

12       irexec  executes  commands  on  an IR signal decoded by lircd, the LIRC
13       daemon. It uses an lircrc config file where the  config =  entries  are
14       executed. E. g., given the following config file snippet
15           begin
16               prog   = irexec
17               button = KEY_RED
18               config = echo "KEY_RED"
19           end
20
21       irexec  will echo KEY_RED on the terminal when the corresponding button
22       is pushed on a remote. The command is an arbitrary shell  command  exe‐
23       cuted asynchronously - irexec does not wait for it to complete.
24

ARGUMENTS

26       config_file
27           lircrc  configuration  file.  irexec  only uses entries with prog =
28           irexec. The path defaults to ~/.config/lircrc.
29

OPTIONS

31       -h, --help
32           Display usage summary
33
34       -v, --version
35           Display version
36
37       -d, --daemon
38           Make irexec fork to background. In this case a config  file  should
39           be  given  on  the command line as irexec won't be able to find any
40           home directory.
41
42       -D, --loglevel [level]
43           Determine the amount of logging information. [level] can be a  sym‐
44           bolic  syslog  level:  error,  warning, info, notice or debug. lirc
45           also defines three additional levels trace, trace and trace2  which
46           gives  even  more  messages (trace2 bringing the most). However, in
47           the log these messages are marked as debug. By default, no  logging
48           is done.
49
50       -n, --name <name>
51           Use  this  program name instead of the default irexec as identifier
52           in the lircd.conf file.
53

ENVIRONMENT

55       LIRC_SOCKET_PATH
56           Path  to  the  lircd  socket  irexec  reads   from,   defaults   to
57           /var/run/lirc/lircd.
58

FILES

60       ~/.config/lircrc
61           Default config file
62
63       /etc/lirc/lircrc
64           Config file used by the systemd irexec service.
65
66       ~/.cache/irexec.log
67           Debug  log.  Setting  the XDG_CACHE_HOME environment variable relo‐
68           cates this file to $XDG_CACHE_HOME/irexec.log
69

NOTES

71       For versions up to 0.9.1 irexec used to  wait until the  executed  pro‐
72       gram  terminated.  Old  configuration  files thus often includes a  '&'
73       appended to the command string to avoid being  stuck  in  the  command.
74       This  is  not  required in 0.9.2+ which cannot wait for command comple‐
75       tion.
76
77       irexec should run as a service. The contrib directory contains a .desk‐
78       top file which could be dropped in ~/.local/autostart. Doing so creates
79       a service which can  be  handled  by  regular  desktop  tools  such  as
80       gnome-tweak-tool  on all major desktops. If running restricted commands
81       such as powering off the machine is required, sudo(8) can  be  used  to
82       allow regular users to run such commands.
83
84       An  alternative is to use the irexec.service systemd service which runs
85       as root (and can run in parallel with the desktop service).  Running as
86       root  has severe security implications.  See the Configuration Guide in
87       the html documentation.
88