1devilspie(1)                General Commands Manual               devilspie(1)
2
3
4

NAME

6       devilspie - perform actions on windows as they are created
7
8

SYNOPSIS

10       devilspie [OPTION]...  configuration-files...
11
12

DESCRIPTION

14       devilspie  is  a  program which can detect windows as they are created,
15       and perform actions on them if they match as set of criteria.
16
17       The configuration files are a set of s-expressions.
18
19       Command-lines options:
20
21       -a --apply-to-existing
22              Apply to all existing windows instead of just new windows.
23
24       -d --debug
25              Output debug information
26
27       -l --list-symbols
28              List available symbols supported in input files.
29
30       -s symname --symbol-doc=symname
31               Get detailed help on symbol symname ('all' for all symbols).
32
33

ALLOWED SYMBOLS

35       In the input files, the following symbols are known by devilspie:
36
37       is     String equality, (is a b) means a is the same as b.
38
39       contains
40              Substring, (contains haystack needle)  means  haystack  contains
41              needle.
42
43       matches
44              Regexp  matches,  (matches str pattern) means the regexp pattern
45              matches str.
46
47       window_name
48              Return the title of the current window (String).
49
50       window_role
51              Return the role (as determined by the  WM_WINDOW_ROLE  hint)  of
52              the current window (String).
53
54       window_class
55              Return the class of the current window (String).
56
57       window_xid
58              Return the X11 window id of the current window (Integer).
59
60       application_name
61              Return  the  application  name (as determined by libwnck) of the
62              current window (String).
63
64       window_property
65              Returns  the  given  property   of   the   window,   e.g.   pass
66              "_NET_WM_STATE" (String).
67
68       window_workspace
69              Returns the workspace a window is on (Integer).
70
71       debug  Debugging  function,  outputs  the current window's title, name,
72              role and geometry (Returns TRUE).
73
74       print  Print args (without trailing 0 returns boolean).
75
76       println
77              Print args (with trailing 0 returns boolean).
78
79       str    Transform parameters into strings and concat them.
80
81       hex    Transform the integer parameter  into  an  unsigned  hexadecimal
82              string (with 0x prefix).
83
84       geometry
85              Set  position + size (as tring) of current window (returns bool‐
86              ean).
87
88       fullscreen
89              Make the current window fullscreen (returns TRUE).
90
91       focus  Focus the current window (returns TRUE).
92
93       center Center position of current window (returns boolean).
94
95       maximize
96              Maximise the current window (returns TRUE).
97
98       maximize_vertically
99              Maximise vertically the current window (returns TRUE).
100
101       maximize_horizontally
102              Maximise horizontally the current window (returns TRUE).
103
104       unmaximize
105              Un-maximise the current window (returns TRUE).
106
107       minimize
108              Minimise the current window (returns TRUE).
109
110       unminimize
111              Un-minimise the current window (returns TRUE).
112
113       shade  Shade ("roll up") the current window (returns TRUE).
114
115       unshade
116              Un-shade ("roll down") the current window (returns TRUE).
117
118       close  Close the current window (returns TRUE).
119
120       pin    Pin the current window to all workspaces (returns TRUE).
121
122       unpin  Unpin the current window from all workspaces (returns TRUE).
123
124       stick  Make the current window stick to all viewports (returns TRUE).
125
126       unstick
127              Unstick the window from viewports (returns TRUE).
128
129       set_workspace
130              Move the window to a specific workspace number, counting from  1
131              (returns boolean).
132
133       set_viewport
134              Move  the  window to a specific viewport number, counting from 1
135              (returns boolean).
136
137       skip_pager
138              Remove the current window from the window list (returns TRUE).
139
140       skip_tasklist
141              Remove the current window from the pager (returns TRUE).
142
143       above  Set the current window to be above all normal  windows  (returns
144              TRUE).
145
146       below  Set  the  current window to be below all normal windows (returns
147              TRUE).
148
149       decorate
150              Add  the  window  manager  decorations  to  the  current  window
151              (returns boolean).
152
153       undecorate
154              Remove  the  window  manager decorations from the current window
155              (returns boolean).
156
157       wintype
158              Set the window type of the  current  window  (returns  boolean).
159              Accepted  values  are:  normal,  dialog,  menu, toolbar, splash‐
160              screen, utility, dock, desktop.
161
162       opacity
163              Change the opacity level (as integer in 0..100) of  the  current
164              window (returns boolean).
165
166       spawn_async
167              Execute  a  command in the background (returns boolean). Command
168              is given as a single string, or as a series of strings  (similar
169              to execl).
170
171       spawn_sync
172              Execute  a  command in the foreground (returns command output as
173              string, or FALSE on error). Command is given as a single string,
174              or as a series of strings (similar to execl).
175
176

BUGS

178       This manpage is almost useless, as it was thrown together on a train.
179
180

AUTHOR

182       This manual page was written by Ross Burton <ross@burtonini.com>.
183
184
185
186                                                                  devilspie(1)