devilspie2.1

.\"
.\" Copyright © 2011-2017 Andreas Rönnquist.
.\" Copyright © 2021-2025 Darren Salt.
.\" This file is distributed under the same license
.\" as the devilspie2 package, see COPYING file.
.\"
.TH devilspie2 1 "" ""
.SH NAME
devilspie2 \- perform scripted actions on windows when certain events occur
.SH Description
.P
.B Devil's Pie 2
is a program that detects windows as they are created, gain or lose focus or
have their titles changed, and performs scripted actions on them. The
scripts are written in \fILua\fR, allowing a great deal of customisation.

.SH Options
.TP
\fB\-v\fR, \fB\-\-version
Displays the version of Devil's Pie 2.
.TP
\fB\-f \fIfolder\fR, \fB\-\-folder \fIfolder
Sets the folder where the Lua scripts are loaded from.
.TP
\fB\-d\fR, \fB\-\-debug
Shows debug information from the Lua scripts. If \fIdebug_print\fR is used
in the Lua scripts, it will output to stdout.
.TP
\fB\-D\fR, \fB\-\-debug\-fifo
Copy stdout & send debug info to a FIFO. If \fIdebug_print\fR is used in
the Lua scripts, it will output to the FIFO. This is intended for running
dæmonised while allowing access to debug text etc. at need.

Nothing is output to the FIFO if nothing is reading it.
You can read it using a program such as \fBcat\fR.

\fB\-\-debug\fR and \fB\-\-debug\-fifo\fR may be used together.
.TP
\fB\-P\fR, \fB\-\-print\-fifo
Print the FIFO's file name then exit. This may be used as follows:
.EX
cat "$(devilspie2 \-\-print\-fifo)"
.EE
.TP
\fB\-e\fR, \fB\-\-emulate
Emulation mode. This prevents windows from being affected by the scripts,
but window positions etc. can still be read.
.TP
\fB\-w\fR, \fB\-\-wnck\-version
Show the version of libwnck in use. (Only available on GTK3 or later.)
.TP
\fB\-l\fR, \fB\-\-lua\-version
Show the version of Lua in use.
.SH Script Commands
.P
See
.I /usr/share/doc/devilspie2/README.md
for a detailed description of the commands recognised in Lua scripts.

.SH Files
.TP
.B $XDG_RUNTIME_DIR/devilspie2\-$DISPLAY
.TP
.B $TMPDIR/devilspie2\-$DISPLAY
.TP
.B /tmp/devilspie2\-$DISPLAY
These are the possible locations of the FIFO which is created if
\fB\-\-debug\-fifo\fR is used. The first one for which the referenced
environment variables are set is used.

.SH Author
.P
.B Devil's Pie 2
is maintained by 
.MT devspam@moreofthesa.me.uk
Darren Salt
.ME . It was written by
.MT andreas@ronnquist.net
Andreas Rönnquist
.ME , and is based on Devil's Pie by Ross
Burton.