summaryrefslogtreecommitdiff
path: root/doc/tofi.1.md
blob: 0a3cd538bceee25473bf2bd3f9b6ef01c404517b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
## NAME

tofi - Tiny dynamic menu for Wayland, inspired by **rofi**(1) and
**dmenu**(1).

## SYNOPSIS

**tofi** \[options...\]

**tofi-run** \[options...\]

**tofi-drun** \[options...\]

**dmenu** \[dmenu-options ... \]

## DESCRIPTION

**tofi** is a tiny dynamic menu for Wayland compositors supporting the
layer-shell protocol. It reads newline-separated items from stdin, and
displays a graphical selection menu. When a selection is made, it is
printed to stdout.

When invoked via the name **tofi-run**, **tofi** will not accept items
on stdin, instead presenting a list of executables in the user's \$PATH.

When invoked via the name **tofi-drun**, **tofi** will not accept items
on stdin, and will generate a list of applications from desktop files as
described in the Desktop Entry Specification.

When invoked via the name **dmenu**, **tofi** will only use the flags in
DMENU-OPTIONS.

## OPTIONS

**-h, --help**

> Print help and exit.

**-d, --dmenu**

> Turns on dmenu compatibility flags. All flags after are treated like
> DMENU-OPTIONS.

**-c, --config** \<path\>

> Specify path to custom config file.

All config file options described in **tofi**(5) are also accepted, in
the form **--key=value**.

## DMENU-OPTIONS

**-b**

> Anchor to the bottom of the screen.

**-f, -i**

> Ignored, included for dmenu compatibility.

**-r**

> Require a match to complete.

**-v**

> Prints the version and exits.

**-P**

> Hide the input text.

**-p**

> Prompt text.

**-m**

> Sets the output to display tofi on.

## KEYS

\<Up\> \| \<Left\> \| \<Ctrl\>-k \| \<Ctrl\>-p \| \<Ctrl\>-b \|
\<Alt\>-k \| \<Alt\>-p \| \<Alt\>-h \| \<Shift\>-\<Tab\>

> Move the selection back one entry.

\<Down\> \| \<Right\> \| \<Ctrl\>-j \| \<Ctrl\>-n \| \<Ctrl\>-f \|
\<Alt\>-j \| \<Alt\>-n \| \<Alt\>-l \| \<Tab\>

> Move the selection forward one entry.

\<Page Up\>

> Move the selection back one page.

\<Page Down\>

> Move the selection forward one page.

\<Backspace\> \| \<Ctrl\>-h

> Delete character.

\<Ctrl\>-u

> Delete line.

\<Ctrl\>-w \| \<Ctrl\>-\<Backspace\>

> Delete word.

\<Enter\> \| \<Ctrl\>-m

> Confirm the current selection and quit.

\<Escape\> \| \<Ctrl\>-c \| \<Ctrl\>-g \| \<Ctrl\>-\[

> Quit without making a selection.

## FILES

*/etc/xdg/tofi/config*

> Example configuration file.

*\$XDG_CONFIG_HOME/tofi/config*

> The default configuration file location.

*\$XDG_CACHE_HOME/tofi-compgen*

> Cached list of executables under \$PATH, regenerated as necessary.

*\$XDG_CACHE_HOME/tofi-drun*

> Cached list of desktop applications, regenerated as necessary.

*\$XDG_STATE_HOME/tofi-history*

> Numeric count of commands selected in **tofi-run**, to enable sorting
> results by run count.

*\$XDG_STATE_HOME/tofi-drun-history*

> Numeric count of commands selected in **tofi-drun**, to enable sorting
> results by run count.

## EXIT STATUS

**tofi** exits with one of the following values:

0

> Success; a selection was made, or **tofi** was invoked with the **-h**
> option.

1

> An error occurred, or the user exited without making a selection.

## AUTHORS

Philip Jones \<<philj56@gmail.com>\>

## SEE ALSO

**tofi**(5), **dmenu**(1), **rofi**(1)