summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDave Davenport <qball@blame.services>2022-07-16 13:33:13 +0200
committerDave Davenport <qball@blame.services>2022-07-16 13:33:13 +0200
commit59e9b77a2e96d765db74314f17c3b8265f5b62ae (patch)
treebcd37da1491fed87ee9db0d160d5416872cabda2
parent52f587a1918a69010e93b0a9c720728f02ed5f79 (diff)
[Doc] Update releasenotes, move section in manpage.
-rw-r--r--doc/rofi-theme.548
-rw-r--r--doc/rofi-theme.5.markdown28
-rw-r--r--doc/rofi.148
-rw-r--r--doc/rofi.1.markdown28
-rw-r--r--releasenotes/1.7.4/release-1.7.4.markdown9
5 files changed, 83 insertions, 78 deletions
diff --git a/doc/rofi-theme.5 b/doc/rofi-theme.5
index 12edc7fd..57ffaedb 100644
--- a/doc/rofi-theme.5
+++ b/doc/rofi-theme.5
@@ -2099,6 +2099,54 @@ FontAwesome 22
.fi
.RE
+.SH Icon Handling
+.PP
+Rofi supports 3 ways of specifying an icon:
+
+.RS
+.IP \(bu 2
+Filename
+.IP \(bu 2
+icon-name, this is looked up via the icon-theme.
+.IP \(bu 2
+Markup String. It renders a string as an icon.
+
+.RE
+
+.PP
+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 \fB\fC<span\fR tag, that allows you to set color and font.
+
+.PP
+Markup string:
+
+.PP
+.RS
+
+.nf
+echo -en "testing\\0icon\\x1f<span color='red'>⏻</span>" | ./rofi -dmenu
+
+.fi
+.RE
+
+.PP
+Getting supported icon formats:
+
+.PP
+.RS
+
+.nf
+G_MESSAGES_DEBUG=Helpers.IconFetcher rofi
+
+.fi
+.RE
+
+.PP
+This uses the debug framework and prints out a list of supported image file
+extensions.
+
.SH Multiple file handling
.PP
The rasi file format offers two methods of including other files.
diff --git a/doc/rofi-theme.5.markdown b/doc/rofi-theme.5.markdown
index fd8ff08b..50d215a7 100644
--- a/doc/rofi-theme.5.markdown
+++ b/doc/rofi-theme.5.markdown
@@ -1342,6 +1342,34 @@ Or
FontAwesome 22
```
+## Icon Handling
+
+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.
+
## Multiple file handling
The rasi file format offers two methods of including other files.
diff --git a/doc/rofi.1 b/doc/rofi.1
index d50c5cb3..32099941 100644
--- a/doc/rofi.1
+++ b/doc/rofi.1
@@ -1328,54 +1328,6 @@ modes are shown, even if the rest of the input text would match results from \fB
If no match, the input is handled by the first combined modes.
.SH FAQ
-.SS What icon formats are supported
-.PP
-Rofi supports 3 ways of specifying an icon:
-
-.RS
-.IP \(bu 2
-Filename
-.IP \(bu 2
-icon-name, this is looked up via the icon-theme.
-.IP \(bu 2
-Markup String. It renders a string as an icon.
-
-.RE
-
-.PP
-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 \fB\fC<span\fR tag, that allows you to set color and font.
-
-.PP
-Markup string:
-
-.PP
-.RS
-
-.nf
-echo -en "testing\\0icon\\x1f<span color='red'>⏻</span>" | ./rofi -dmenu
-
-.fi
-.RE
-
-.PP
-Getting supported icon formats:
-
-.PP
-.RS
-
-.nf
-G_MESSAGES_DEBUG=Helpers.IconFetcher rofi
-
-.fi
-.RE
-
-.PP
-This uses the debug framework and prints out a list of supported image file
-extensions.
-
.SS The text in the window switcher is not nicely aligned.
.PP
Try using a mono-space font.
diff --git a/doc/rofi.1.markdown b/doc/rofi.1.markdown
index 8c2c92f9..91c844df 100644
--- a/doc/rofi.1.markdown
+++ b/doc/rofi.1.markdown
@@ -857,34 +857,6 @@ 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.
diff --git a/releasenotes/1.7.4/release-1.7.4.markdown b/releasenotes/1.7.4/release-1.7.4.markdown
index fa8578ed..e1725f80 100644
--- a/releasenotes/1.7.4/release-1.7.4.markdown
+++ b/releasenotes/1.7.4/release-1.7.4.markdown
@@ -27,10 +27,13 @@ current selected item.
In dmenu mode (and script) you can now make (some) changes to the theme, for
example modifying the background color of the entry box.
-You can now put users scripts (for script mode) into
-`$XDG_CONFIG_HOME/rofi/scripts` directory and those are automatically available
+User scripts (for script mode) into
+`$XDG_CONFIG_HOME/rofi/scripts` directory are automatically available
in rofi.
+You can now render text as icons, this allows you to use glyphs icon fonts as
+icons.
+
Below is a more complete list of changes:
@@ -67,6 +70,8 @@ Below is a more complete list of changes:
* Change modi to modes to avoid confusion.
* [Theme] When links are unresolvable throw an error to the user.
* [DMenu] Document the `display-columns` and `display-column-separator` option.
+* [Theme] Media now supports `enabled` that supports an environment variable.
+* [IconFetcher] Support rendering fonts as icon.
# Thanks