diff options
| -rw-r--r-- | doc/tofi.1.md | 79 | ||||
| -rw-r--r-- | doc/tofi.5.md | 241 |
2 files changed, 320 insertions, 0 deletions
diff --git a/doc/tofi.1.md b/doc/tofi.1.md new file mode 100644 index 0000000..6177b2d --- /dev/null +++ b/doc/tofi.1.md @@ -0,0 +1,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) diff --git a/doc/tofi.5.md b/doc/tofi.5.md new file mode 100644 index 0000000..24b14e9 --- /dev/null +++ b/doc/tofi.5.md @@ -0,0 +1,241 @@ +# NAME + +tofi - configuration file + +# DESCRIPTION + +The config file format is basic .ini/.cfg style. Options are set one per +line, with the syntax: + +> option = value + +Whitespace is ignored. Values starting or ending with whitespace can be +given by enclosing them in double quotes like so: + +> option = " value " + +Lines beginning with \# or ; are treated as comments. Section headers of +the form \[header\] are currently ignored. All options and values are +case-insensitive, except where not possible (e.g. paths). Later options +override earlier options, and command line options override config file +options. + +# OPTIONS + +**font-name**=*font* + +> Font to use. If *font* is a path to a font file, **tofi** will not +> have to use Pango or Fontconfig. This greatly speeds up startup, but +> any characters not in the chosen font will fail to render. +> +> If a path is not given, *font* is interpreted as a font name in Pango +> format. +> +> Default: "Sans" + +**font-size**=*pt* + +> Point size of text. +> +> Default: 24 + +**background-color**=*color* + +> Color of the background. See **COLORS** for more information. +> +> Default: \#1B1D1E + +**outline-width**=*px* + +> Width of the border outlines. +> +> Default: 4 + +**outline-color**=*color* + +> Color of the border outlines. See **COLORS** for more information. +> +> Default: \#080800 + +**border-width**=*px* + +> Width of the border. +> +> Default: 12 + +**border-color**=*color* + +> Color of the border. See **COLORS** for more information. +> +> Default: \#F92672 + +**text-color**=*color* + +> Color of text. See **COLORS** for more information. +> +> Default: \#FFFFFF + +**prompt-text**=*string* + +> Prompt text. +> +> Default: "run: " + +**num-results**=*n* + +> Maximum number of results to display. +> +> Default: 5 + +**selection-color**=*color* + +> Color of selected result. See **COLORS** for more information. +> +> Default: \#F92672 + +**result-spacing**=*px* + +> Spacing between results. Can be negative. +> +> Default: 0 + +**min-input-width**=*px* + +> Minimum width of input in horizontal mode. +> +> Default: 0 + +**width**=*px\|%* + +> Width of the window. See **PERCENTAGE VALUES** for more information. +> +> Default: 1280 + +**height**=*px\|%* + +> Height of the window. See **PERCENTAGE VALUES** for more information. +> +> Default: 720 + +**corner-radius**=*px* + +> Radius of the window corners. +> +> Default: 0 + +**anchor**=*position* + +> Location on screen to anchor the window. Supported values are +> *top-left*, *top*, *top-right*, *right*, *bottom-right*, *bottom*, +> *bottom-left*, *left*, and *center*. +> +> Default: center + +**margin-top**=*px\|%* + +> Offset from top of screen. See **PERCENTAGE VALUES** for more +> information. Only has an effect when anchored to the top of the +> screen. +> +> Default: 0 + +**margin-bottom**=*px\|%* + +> Offset from bottom of screen. See **PERCENTAGE VALUES** for more +> information. Only has an effect when anchored to the bottom of the +> screen. +> +> Default: 0 + +**margin-left**=*px\|%* + +> Offset from left of screen. See **PERCENTAGE VALUES** for more +> information. Only has an effect when anchored to the left of the +> screen. +> +> Default: 0 + +**margin-right**=*px\|%* + +> Offset from right of screen. See **PERCENTAGE VALUES** for more +> information. Only has an effect when anchored to the right of the +> screen. +> +> Default: 0 + +**padding-top**=*px\|%* + +> Padding between top border and text. See **PERCENTAGE VALUES** for +> more information. +> +> Default: 8 + +**padding-bottom**=*px\|%* + +> Padding between bottom border and text. See **PERCENTAGE VALUES** for +> more information. +> +> Default: 8 + +**padding-left**=*px\|%* + +> Padding between left border and text. See **PERCENTAGE VALUES** for +> more information. +> +> Default: 8 + +**padding-right**=*px\|%* + +> Padding between right border and text. See **PERCENTAGE VALUES** for +> more information. +> +> Default: 8 + +**hide-cursor**=*true\|false* + +> Hide the cursor. +> +> Default: false + +**horizontal**=*true\|false* + +> List results horizontally. +> +> Default: false + +**history**=*true\|false* + +> Sort results by number of usages. +> +> Default: true + +**hint-font**=*true\|false* + +> Perform font hinting. Only applies when a path to a font has been +> specified via **font-name**. Disabling font hinting speeds up text +> rendering appreciably, but will likely look poor at small font pixel +> sizes. +> +> Default: true + +# COLORS + +Colors can be specified in the form *RGB*, *RGBA*, *RRGGBB* or +*RRGGBBAA*, optionally prefixed with a hash (#). + +# PERCENTAGE VALUES + +Some pixel values can optionally have a % suffix, like so: + +> width = 50% + +This will be interpreted as a percentage of the screen resolution in the +relevant direction. + +# AUTHORS + +Philip Jones \<philj56@gmail.com\> + +# SEE ALSO + +**tofi**(5), **dmenu**(1) **rofi**(1) |