1wofi(7)                Miscellaneous Information Manual                wofi(7)
2
3
4

NAME

6       wofi - Built in modes and other features
7
8

DESCRIPTION

10       Wofi contains several built in modes as well as a lot of other features
11       including combi which are documented here.
12
13

MODES

15       Currently wofi has 3 built in modes
16
17       1.  run - searches $PATH for executables and allows them to be  run  by
18           selecting them.
19
20       2.  drun      -      searches      $XDG_DATA_HOME/applications      and
21           $XDG_DATA_DIRS/applications for desktop files and allows them to be
22           run by selecting them.
23
24       3.  dmenu  -  reads from stdin and displays options which when selected
25           will be output to stdout.
26
27
28       In  the  event  $XDG_DATA_HOME  is  not  specified   it   defaults   to
29       ~/.local/share.  If  $XDG_DATA_DIRS  is  not  specified  it defaults to
30       /usr/local/share:/usr/share.
31
32       Combi is not a mode however it does exist as a feature. You can use  it
33       by doing --show mode1,mode2,mode3,etc. You can mix and match any number
34       of modes however each mode can only be loaded once so  doing  something
35       like  --show  run,drun,run  is  not supported although I'm not sure why
36       you'd do that in the first place.
37
38

DMENU CONFIG OPTIONS

40       parse_action=BOOL
41              If true the result returned by dmenu will be stripped  of  image
42              escape sequences and pango markup, default is false.
43
44       separator=CHAR
45              The character used to separate dmenu entries, default is \n.
46
47       print_line_num=BOOL
48              When  an  entry is selected the number of the line the entry was
49              on is printed instead of the entry itself. This disables caching
50              as it's fundamentally incompatible with it.
51
52

RUN CONFIG OPTIONS

54       always_parse_args=BOOL
55              If  true  spaces  will  not be treated as part of the executable
56              name but rather as an argument separator equivalent  to  holding
57              control while pressing enter, default is false.
58
59       show_all=BOOL
60              If  true  shows  all the entries in path, this will show entries
61              that have the same executable name, for  example  /bin/bash  and
62              /usr/bin/bash will be shown separately as bash instead of having
63              one bash entry for the first one encountered, default is true.
64
65

DRUN CONFIG OPTIONS

67       print_command=BOOL
68              If true the command used to launch  the  desktop  file  will  be
69              printed to stdout instead of invoking it, default is false.
70
71

DRUN

73       When images are enabled drun mode will pull icon themes however being a
74       GTK app it's possible you'll need to run gtk-update-icon-cache  to  get
75       them to apply.
76
77

LOCATIONS

79       There are 9 possible locations which can be specified either by name or
80       by number, the number scheme is the same as in rofi and the correspond‐
81       ing number is listed next to the names below, the default is center.
82
83       1.  center 0
84
85       2.  top_left 1
86
87       3.  top 2
88
89       4.  top_right 3
90
91       5.  right 4
92
93       6.  bottom_right 5
94
95       7.  bottom 6
96
97       8.  bottom_left 7
98
99       9.  left 8
100
101
102       The  x  and  y  offsets  are applied based on layer-shell anchors which
103       means an x offset can only be applied if wofi  is  anchored  on  the  x
104       axis,  i.e.  you can only use an x offset with the top_left, top_right,
105       right, bottom_right, bottom_left, and left locations. center, top,  and
106       bottom  can't  have  x  offsets  as they're not anchored on the x axis.
107       Likewise y offsets can only be applied  to  top_left,  top,  top_right,
108       bottom_right,  bottom,  and  bottom_left  locations.  center, left, and
109       right can't have y offsets because they're not anchored to the y  axis.
110       Since  center  can't have offsets on either as it's not anchored to any
111       axis any x or y offset applied while using  center  will  override  the
112       location  to  top_left for backwards compatiblity reasons seeing as not
113       doing so would simply ignore the offsets anyway.
114
115

ORDER

117       There are 2 order options currently, default and alphabetical.  Default
118       means  the  entries  are  displayed  in the order they are added by the
119       mode, for all built in modes this is cached items  first,  followed  by
120       other  entries  in  no  specific  order. Alphabetical means entries are
121       alphabetical sorted period. These orders only affect the order when  no
122       search  has  been  entered.  Once  a search is entered the order is re-
123       arranged based on the current matching preference  and  this  order  is
124       ignored.
125
126

CACHING

128       Caching  cannot  be  disabled  however  the  cache  file  can be set to
129       /dev/null to effectively disable it.
130
131

WIDGET LAYOUT

133       This section is for advanced CSS which  needs  more  control  than  the
134       built  in  wofi CSS names/classes allow for. This widget layout is sub‐
135       ject to change at any time and without warning so your CSS  might  very
136       well  break if you rely on this. Widgets have their corresponding names
137       next to them if they have one.
138
139       window - #window
140           box - #outer-box
141               entry - #input
142
143               scrolledwindow - #scroll
144                   viewport
145                       box
146                           flowbox - #inner-box
147                               flowboxchild - #entry
148
149                                   .entry - #unselected or #selected
150                                   This only exists if there's ONLY 1  action.
151                                   This  is a WofiPropertyBox which has no CSS
152                                   node and should probably not be  used,  the
153                                   name  is  dependent  on  whether or not the
154                                   entry is selected. See wofi(5) on #selected
155                                   and #unselected for info.
156
157                                       image
158                                       This  is  only  present  if an image is
159                                       present in the entry  and  might  occur
160                                       multiple  times  if multiple images are
161                                       present.
162
163                                       label
164                                       This is only present if text is present
165                                       in  the  entry and might occur multiple
166                                       times  if  there  are   multiple   text
167                                       objects in a single entry.
168
169                                   expander
170                                   This  and  its children only exist if there
171                                   are multiple actions on the entry
172
173                                       .entry - #unselected or #selected
174                                       The main action. This is a  WofiProper‐
175                                       tyBox  which has no CSS node and should
176                                       probably  not  be  used,  the  name  is
177                                       dependent  on  whether or not the entry
178                                       is selected. See wofi(5)  on  #selected
179                                       and #unselected for info.
180
181                                           image
182                                           This is only present if an image is
183                                           present  in  the  entry  and  might
184                                           occur  multiple  times  if multiple
185                                           images are present.
186
187                                           label
188                                           This is only  present  if  text  is
189                                           present  in  the  entry  and  might
190                                           occur multiple times if  there  are
191                                           multiple  text  objects in a single
192                                           entry.
193
194                                       list
195                                       This contains all the secondary actions
196                                           row - #entry
197                                               .entry   -    #unselected    or
198                                               #selected
199                                               This is a WofiPropertyBox which
200                                               has  no  CSS  node  and  should
201                                               probably  not be used, the name
202                                               is dependent on whether or  not
203                                               the   entry  is  selected.  See
204                                               wofi(5) on #selected and #unse‐
205                                               lected for info.
206
207                                                   image
208                                                   This  is only present if an
209                                                   image  is  present  in  the
210                                                   entry  and might occur mul‐
211                                                   tiple  times  if   multiple
212                                                   images are present.
213
214                                                   label
215                                                   This  is  only  present  if
216                                                   text  is  present  in   the
217                                                   entry  and might occur mul‐
218                                                   tiple times  if  there  are
219                                                   multiple  text objects in a
220                                                   single entry.
221                   scrollbar
222
223
224
225                                                                       wofi(7)
Impressum