1wofi(1) General Commands Manual wofi(1)
2
6 wofi - A rofi inspired launcher for wlroots compositors
7
10 wofi [options]
11
14 wofi is a rofi inspired menu program for wlroots compositors such as
15 sway. It is intended to be highly customizable and flexible with the
16 help of CSS styling and a dmenu mode that allows for endless script‐
17 ability. Wofi can be run cacheless in dmenu mode automatically by in‐
18 voking it as dmenu with symlink.
19 Wofi was designed specifically for wlroots and makes use of the
21 wlr-layer-shell protocol. If your compositor does not support this pro‐
22 tocol or if you are in a non-wayland environment then wofi must be run
23 with --normal-window or it will crash. If you wish to run wofi this way
24 you can also place normal_window=true in your config file to avoid
25 specifying the option on the command line.
26
29 -h, --help
30 Prints the help message and then exits.
31 -f, --fork
33 Forks the menu so the terminal running it can be closed.
34 -c, --conf=PATH
36 Specifies the config file to use.
37 -s, --style=PATH
39 Specifies the CSS file to use as the stylesheet.
40 -C, --color=PATH
42 Specifies the colors file to use.
43 -d, --dmenu
45 Runs wofi in dmenu mode.
46 -S, --show=MODE
48 Specifies the mode to run in. A list of modes can be found in
49 wofi(7).
50 -W, --width=WIDTH
52 Specifies the menu width in pixels or percent of screen size,
53 default is 50%. Pixels are used unless the number ends with a %.
54 -H, --height=HEIGHT
56 Specifies the menu height in pixels or percent of screen size,
57 default is 40%. Pixels are used unless the number ends with a %.
58 -p, --prompt=PROMPT
60 Sets the prompt to be display in the search box, default is the
61 name of the mode.
62 -x, --xoffset=OFFSET
64 Sets the x offset from the location in pixels, default is 0.
65 -y, --yoffset=OFFSET
67 Sets the y offset from the location in pixels, default is 0.
68 -n, --normal-window
70 Runs wofi in a normal window instead of using wlr-layer-shell.
71 -I, --allow-images
73 Allows image escape sequences to be processed and rendered.
74 -m, --allow-markup
76 Allows pango markup to be processed and rendered.
77 -k, --cache-file=PATH
79 Specifies the cache file to load/store cache, default is
80 $XDG_CACHE_HOME/wofi-<mode name> where <mode name> is the name
81 of the mode, if $XDG_CACHE_HOME is not specified ~/.cache is
82 used.
83 -t, --term=TERM
85 Specifies the term to use when running a program in a terminal.
86 This overrides the default terminal run order which is kitty,
87 termite, alacritty, foot, gnome-terminal, weston-terminal in
88 that order.
89 -P, --password [character]
91 Runs wofi in password mode with an optional password character
92 to use. If no character is specified * is used by default.
93 -e, --exec-search
95 Activiating a search with enter will execute the search not the
96 first result.
97 -b, --hide-scroll
99 Hides the scroll bars.
100 -M, --matching=MODE
102 Specifies the matching mode, it can be either contains, multi-
103 contains, or fuzzy, default is contains.
104 -i, --insensitive
106 Enables case insensitive search.
107 -q, --parse-search
109 Parses out image escapes and pango preventing them from being
110 used for searching.
111 -v, --version
113 Prints the version and then exits.
114 -l, --location=LOCATION
116 Specifies the location. See wofi(7) for more information, de‐
117 fault is center.
118 -a, --no-actions
120 Disables multiple actions for modes that support it.
121 -D, --define=KEY=VALUE
123 Sets a config option
124 -L, --lines=LINES
126 Specifies the height in number of lines instead of pixels.
127 -w, --columns=COLUMNS
129 Specifies the number of columns to display, default is 1.
130 -O, --sort-order=ORDER
132 Specifies the default sort order. There are currently two or‐
133 ders, default and alphabetical. See wofi(7) for details.
134 -G, --gtk-dark
136 Instructs wofi to use the dark variant of the current GTK theme,
137 if available.
138 -Q, --search
140 Specifies something to search for immediately on opening
141 -o, --monitor
143 Sets the monitor to open on
144 -r, --pre-display-cmd
146 If set, the selectable entry won't be displayed as-is, but will
147 instead be displayed based on the output of this command, which
148 can be anything. Suggested to use with "echo %s | some_cmd" or
149 "some_cmd %s", as the string gets replaced in a printf-like
150 fashion. This will not affect the output of wofi once a selec‐
151 tion has been done, allowing you to display something else than
152 the original output.
153
157 Wofi has 3 main files used for configuration. All files are completely
158 optional.
159 1. The config file which defaults to $XDG_CONFIG_HOME/wofi/config.
161 2. The CSS file which defaults to $XDG_CONFIG_HOME/wofi/style.css.
163 3. The colors file which defaults to the pywal cache
165 $XDG_CACHE_HOME/wal/colors.
166 All 3 of these paths can be manually specified using the respective
169 command line flag. In the case of the last 2 they can additionally be
170 specified in the config file.
171 In the event $XDG_CONFIG_HOME is not specified it defaults to ~/.config
173 likewise if $XDG_CACHE_HOME is not specified it defaults to ~/.cache.
174 Information about the formats for these files can be found in wofi(5).
176 wofi(1)