diff options
Diffstat (limited to 'doc/tofi.1.scd')
| -rw-r--r-- | doc/tofi.1.scd | 114 |
1 files changed, 36 insertions, 78 deletions
diff --git a/doc/tofi.1.scd b/doc/tofi.1.scd index 4e58a56..961a0bc 100644 --- a/doc/tofi.1.scd +++ b/doc/tofi.1.scd @@ -1,104 +1,62 @@ -greetd-mini-wl-greeter(1) +tofi(1) # NAME -greetd-mini-wl-greeter - An extremely simple raw Wayland greeter for greetd +tofi - Tiny dynamic menu for Wayland, inspired by *rofi*(1) and *dmenu*(1). # SYNOPSIS -*greetd-mini-wl-greeter* -u user -c command [-bBCeEfFhHnoOrRw] +*tofi* [options...] +*tofi-run* [options...] +*tofi-compgen* # DESCRIPTION -greetd-mini-wl-greeter is a raw Wayland greeter for greetd, designed for a -single user. It requires a Wayland compositor to run, such as *cage*(1) or -*sway*(1). +*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. -# OPTIONS - -All options which take a color expect a 3- or 6-digit hex code, e.g. F9A733. - -*-u, --user* <username> - The user to login as. - -*-c, --command* <command> - The command to run on login. - -*-b, --background-image* <image> - An image to use as the background. Currently only PNG images are supported. - -*-B, --background-color* <color> - Color of the background in the absence of an image. - -*-o, --outline-width* <value> - Width of the outlines around the border, in pixels. - -*-O, --outline-color* <color> - Color of the outlines around the border. - -*-r, --border-width* <value> - Width of the border in pixels. +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. -*-R, --border-color* <color> - Color of the border. +*tofi-compgen* just prints the list of executables used by *tofi-run*. -*-e, --entry-padding* <value> - Padding around the password text in pixels. - -*-E, --entry-color* <color> - Color of the password entry box. - -*-f, --font-name* <name> - Font to use for the password entry. - -*-F, --font-size* <value> - Point size of the password text. - -*-T, --text-color* <value> - Color of the password text. +# OPTIONS -*-C, --password-character* <character> - Character to use to hide the password. Defaults to full-stop. +*-h, --help* + Print help and exit. -*-n, --width-characters* <value> - Make the password entry box big enough to fit this many characters. +*-c, --config* <path> + Specify path to custom config file. -*-w, --wide-layout* - By default, the password entry box will be shrunk vertically to exactly fit - the specified password character. Use this option if you'd rather that it got - laid out like normal text, i.e. the box remains one full character tall. +All config file options described in *tofi(5)* are also accepted, in the form +*--key=value*. -*-H, --hide-cursor* - Hide the cursor. +# KEYS -*-h, --help* - Print help and exit. +<Up> | <Left> + Move the selection back one entry. -# EXAMPLES +<Down> | <Right> + Move the selection back forward entry. -greetd-mini-wl-greeter aims to be as fast and simple as possible by default. If -none of the *-f*, *-C* or *-w* options are given, a simple circle will be used -for the password character, avoiding the need to use Pango, thus lowering -startup time. This is only likely noticeable on very slow machines however. +<Enter> + Confirm the current selection and quit. -When using sway as the compositor for greetd-mini-greeter, something like the -following sway config lines produce a nice look: +<Escape> + Quit without making a selection. -``` -# Remove any window borders -default_border none -hide_edge_borders both +# FILES -# Add a background image, to avoid a flicker of default background color -output * background /path/to/image fill +_$XDG_CONFIG_HOME/tofi/config_ + The default configuration file. -# Use the same background image for the greeter -exec greetd-mini-wl-greeter -u username -c command -b /path/to/image -``` +_$XDG_CACHE_HOME/tofi-compgen_ + Cached list of executables under $PATH, regenerated as necessary. -Fun can be had with the *-C* option, as it should support any character from -your locale, which is probably a UTF-8 one. For example, the Unicode "Combining -Dot Below" character ( ̣) produces a nice effect. +_$XDG_STATE_HOME/tofi-history_ + Numeric count of commands selected in *tofi-run*, to enable sorting + results by run count. # AUTHORS @@ -106,4 +64,4 @@ Philip Jones <philj56@gmail.com> # SEE ALSO -*greetd*(1) +*tofi*(5), *dmenu*(1) *rofi*(1) |