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

NAME

6       wofi - A rofi inspired launcher for wlroots compositors
7
8

SYNOPSIS

10       wofi [options]
11
12

DESCRIPTION

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
18       invoking it as dmenu with symlink.
19
20       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
27

OPTIONS

29       -h, --help
30              Prints the help message and then exits.
31
32       -f, --fork
33              Forks the menu so the terminal running it can be closed.
34
35       -c, --conf=PATH
36              Specifies the config file to use.
37
38       -s, --style=PATH
39              Specifies the CSS file to use as the stylesheet.
40
41       -C, --color=PATH
42              Specifies the colors file to use.
43
44       -d, --dmenu
45              Runs wofi in dmenu mode.
46
47       -S, --show=MODE
48              Specifies the mode to run in. A list of modes can  be  found  in
49              wofi(7).
50
51       -W, --width=WIDTH
52              Specifies the menu width in pixels, default is 1000.
53
54       -H, --height=HEIGHT
55              Specifies the menu height in pixels, default is 400.
56
57       -p, --prompt=PROMPT
58              Sets  the prompt to be display in the search box, default is the
59              name of the mode.
60
61       -x, --xoffset=OFFSET
62              Sets the x offset from the location in pixels, default is 0.
63
64       -y, --yoffset=OFFSET
65              Sets the y offset from the location in pixels, default is 0.
66
67       -n, --normal-window
68              Runs wofi in a normal window instead of using wlr-layer-shell.
69
70       -I, --allow-images
71              Allows image escape sequences to be processed and rendered.
72
73       -m, --allow-markup
74              Allows pango markup to be processed and rendered.
75
76       -k, --cache-file=PATH
77              Specifies  the  cache  file  to  load/store  cache,  default  is
78              $XDG_CACHE_HOME/wofi-<mode  name>  where <mode name> is the name
79              of the mode, if $XDG_CACHE_HOME is  not  specified  ~/.cache  is
80              used.
81
82       -t, --term=TERM
83              Specifies  the term to use when running a program in a terminal.
84              This overrides the default terminal run order  which  is  kitty,
85              termite, gnome-terminal, weston-terminal in that order.
86
87       -P, --password [character]
88              Runs  wofi  in password mode with an optional password character
89              to use. If no character is specified * is used by default.
90
91       -e, --exec-search
92              Activiating a seach with enter will execute the search  not  the
93              first result.
94
95       -b, --hide-scroll
96              Hides the scroll bars.
97
98       -M, --matching=MODE
99              Specifies the matching mode, it can be either contains or fuzzy,
100              default is contains.
101
102       -i, --insensitive
103              Enables case insensitive search.
104
105       -q, --parse-search
106              Parses out image escapes and pango preventing  them  from  being
107              used for searching.
108
109       -v, --version
110              Prints the version and then exits.
111
112       -l, --location=LOCATION
113              Specifies  the  location.  See  wofi(7)  for  more  information,
114              default is center.
115
116       -a, --no-actions
117              Disables multiple actions for modes that support it.
118
119       -D, --define=KEY=VALUE
120              Sets a config option
121
122       -L, --lines=LINES
123              Specifies the height in number of lines instead of pixels.
124
125       -w, --columns=COLUMNS
126              Specifies the number of columns to display, default is 1.
127
128       -O, --sort-order=ORDER
129              Specifies the  default  sort  order.  There  are  currently  two
130              orders, default and alphabetical. See wofi(7) for details.
131
132

CONFIGURATION

134       Wofi  has 3 main files used for configuration. All files are completely
135       optional.
136
137       1.  The config file which defaults to $XDG_CONFIG_HOME/wofi/config.
138
139       2.  The CSS file which defaults to $XDG_CONFIG_HOME/wofi/style.css.
140
141       3.  The   colors   file   which   defaults   to   the    pywal    cache
142           $XDG_CACHE_HOME/wal/colors.
143
144
145       All  3  of  these  paths can be manually specified using the respective
146       command line flag. In the case of the last 2 they can  additionally  be
147       specified in the config file.
148
149       In the event $XDG_CONFIG_HOME is not specified it defaults to ~/.config
150       likewise if $XDG_CACHE_HOME is not specified it defaults to ~/.cache.
151
152       Information about the formats for these files can be found in wofi(5).
153
154
155
156                                                                       wofi(1)
Impressum