summaryrefslogtreecommitdiffstats
path: root/doc/rofi.1.markdown
diff options
context:
space:
mode:
authorDave Davenport <qball@blame.services>2022-07-16 13:13:29 +0200
committerDave Davenport <qball@blame.services>2022-07-16 13:13:29 +0200
commit52f587a1918a69010e93b0a9c720728f02ed5f79 (patch)
tree45b31ed8297d06205a7b62c9cf582937451773b5 /doc/rofi.1.markdown
parent386877dd228adb4f4cdb6cb3d8a9900439582e64 (diff)
[IconFetcher] Add support for font rendering as icon.
Issue: #1132
Diffstat (limited to 'doc/rofi.1.markdown')
-rw-r--r--doc/rofi.1.markdown28
1 files changed, 28 insertions, 0 deletions
diff --git a/doc/rofi.1.markdown b/doc/rofi.1.markdown
index 91c844df..8c2c92f9 100644
--- a/doc/rofi.1.markdown
+++ b/doc/rofi.1.markdown
@@ -857,6 +857,34 @@ If no match, the input is handled by the first combined modes.
## FAQ
+### What icon formats are supported
+
+Rofi supports 3 ways of specifying an icon:
+
+* Filename
+* icon-name, this is looked up via the icon-theme.
+* Markup String. It renders a string as an icon.
+
+
+For the first two options, GdkPixbuf is used to open and render the icons.
+This in general gives support for most required image formats.
+For the string option it uses Pango to render the string. The string needs to
+start with a `<span` tag, that allows you to set color and font.
+
+Markup string:
+
+```bash
+echo -en "testing\0icon\x1f<span color='red'>⏻</span>" | ./rofi -dmenu
+```
+
+Getting supported icon formats:
+
+```bash
+G_MESSAGES_DEBUG=Helpers.IconFetcher rofi
+```
+This uses the debug framework and prints out a list of supported image file
+extensions.
+
### The text in the window switcher is not nicely aligned.
Try using a mono-space font.