From bb1fd3afd7efee76db3774e04012171c98a1bcf7 Mon Sep 17 00:00:00 2001 From: Dave Davenport Date: Thu, 7 Apr 2022 21:02:55 +0200 Subject: [PATCH] [DOC] Small fixes to rofi-theme manpage. --- doc/rofi-theme.5 | 42 ++++++++++++++++++++++++++++++--------- doc/rofi-theme.5.markdown | 35 +++++++++++++++++++++++--------- 2 files changed, 59 insertions(+), 18 deletions(-) diff --git a/doc/rofi-theme.5 b/doc/rofi-theme.5 index b62af973..78a3dd02 100644 --- a/doc/rofi-theme.5 +++ b/doc/rofi-theme.5 @@ -4,15 +4,38 @@ .PP \fBrofi-theme\fP - Rofi theme format files -.SH GETTING STARTED +.SH GETTING STARTED WITH THEMING .PP The easiest way to get started theming rofi is by modifying your existing theme. -Themes can be modified/tweaked by adding theming elements to the end of your -config file. The default location of this file is \fB\fC~/.config/rofi/config.ras\fR, + +.PP +Themes can be modified/tweaked by adding theming elements to the end of the +.br +config file. The default location of this file is \fB\fC~/.config/rofi/config.rasi\fR, if the file does not exists, you can create it. .PP -For example if we want to change the \fB\fCType to filter\fR text in the entry box: +A basic config: + +.PP +.RS + +.nf +configuration { + modes: [ combi ]; + combi-modes: [ window, drun, run ]; +} + +@theme "gruvbox-light" + +/* Insert theme modifications after this */ + +.fi +.RE + +.PP +For example if we want to change the \fB\fCType to filter\fR text in the entry box we +append the following: .PP .RS @@ -26,7 +49,7 @@ entry { .RE .PP -In the above statement, \fB\fCentry\fR indicates the widget, \fB\fCplaceholder\fR is the +In the above section, \fB\fCentry\fR indicates the widget, \fB\fCplaceholder\fR is the property we want to modify and we set it to the string \fB\fC"Type here"\fR\&. To find the commonly available widgets in rofi, see the 'Basic structure' section. @@ -82,10 +105,11 @@ Resulting in the following packing: .RE .PP -The \fB\fCelement\fR (container) widget hold each entry in the \fB\fClistview\fR, we add the two -pre-defined children in the order we want to show them. -We also specify the packing direction (\fB\fCorientation\fR) and the spacing between the children (\fB\fCspacing\fR). -We specify the space between the two children in absolute pixels (\fB\fCpx\fR). +The \fB\fCelement\fR (container) widget hold each entry in the \fB\fClistview\fR, we add the +two pre-defined children in the order we want to show. We also specify the +packing direction (\fB\fCorientation\fR) and the spacing between the children +(\fB\fCspacing\fR). We specify the space between the two children in absolute pixels +(\fB\fCpx\fR). .PP To increase the icon-size, we need to modify the \fB\fCelement-icon\fR widget. diff --git a/doc/rofi-theme.5.markdown b/doc/rofi-theme.5.markdown index c854134b..a108a870 100644 --- a/doc/rofi-theme.5.markdown +++ b/doc/rofi-theme.5.markdown @@ -4,14 +4,30 @@ **rofi-theme** - Rofi theme format files -## GETTING STARTED +## GETTING STARTED WITH THEMING The easiest way to get started theming rofi is by modifying your existing theme. -Themes can be modified/tweaked by adding theming elements to the end of your -config file. The default location of this file is `~/.config/rofi/config.ras`, + +Themes can be modified/tweaked by adding theming elements to the end of the +config file. The default location of this file is `~/.config/rofi/config.rasi`, if the file does not exists, you can create it. -For example if we want to change the `Type to filter` text in the entry box: +A basic config: + +```css +configuration { + modes: [ combi ]; + combi-modes: [ window, drun, run ]; +} + +@theme "gruvbox-light" + +/* Insert theme modifications after this */ +``` + + +For example if we want to change the `Type to filter` text in the entry box we +append the following: ```css entry { @@ -19,7 +35,7 @@ entry { } ``` -In the above statement, `entry` indicates the widget, `placeholder` is the +In the above section, `entry` indicates the widget, `placeholder` is the property we want to modify and we set it to the string `"Type here"`. To find the commonly available widgets in rofi, see the 'Basic structure' section. @@ -56,10 +72,11 @@ Resulting in the following packing: └─────────────────────────────────────────────────────────────────────┘ ``` -The `element` (container) widget hold each entry in the `listview`, we add the two -pre-defined children in the order we want to show them. -We also specify the packing direction (`orientation`) and the spacing between the children (`spacing`). -We specify the space between the two children in absolute pixels (`px`). +The `element` (container) widget hold each entry in the `listview`, we add the +two pre-defined children in the order we want to show. We also specify the +packing direction (`orientation`) and the spacing between the children +(`spacing`). We specify the space between the two children in absolute pixels +(`px`). To increase the icon-size, we need to modify the `element-icon` widget.