summaryrefslogtreecommitdiff
path: root/doc/tofi.1.md
blob: 6177b2d8b8e9e96bd323aedf4560fd79cf90e1fe (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
# NAME

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

# SYNOPSIS

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

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

**tofi-compgen**

# 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.

**tofi-compgen** just prints the list of executables used by
**tofi-run**.

# OPTIONS

**-h, --help**

> Print help and exit.

**-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**.

# KEYS

\<Up\> \| \<Left\>

> Move the selection back one entry.

\<Down\> \| \<Right\>

> Move the selection back forward entry.

\<Enter\>

> Confirm the current selection and quit.

\<Escape\>

> Quit without making a selection.

# FILES

*$XDG_CONFIG_HOME/tofi/config*

> The default configuration file.

*$XDG_CACHE_HOME/tofi-compgen*

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

*$XDG_STATE_HOME/tofi-history*

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

# AUTHORS

Philip Jones \<philj56@gmail.com\>

# SEE ALSO

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