PolytreeDE/rofi
1
0
Fork 0
mirror of https://github.com/davatorium/rofi.git synced 2024-11-25 13:55:34 -05:00
Code Releases Activity

[DOC] Small fixes to rofi-theme manpage.

Browse source
This commit is contained in:
Dave Davenport 2022-04-07 21:02:55 +02:00
parent 2cc21909f5
commit bb1fd3afd7
2 changed files with 59 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
doc/rofi-theme.5
View file

@ -4,15 +4,38 @@
.PP .PP
\fBrofi-theme\fP - Rofi theme format files \fBrofi-theme\fP - Rofi theme format files
.SH GETTING STARTED .SH GETTING STARTED WITH THEMING
.PP .PP
The easiest way to get started theming rofi is by modifying your existing theme. 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. if the file does not exists, you can create it.
.PP .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 .PP
.RS .RS
@ -26,7 +49,7 @@ entry {
.RE .RE
.PP .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\&. 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. To find the commonly available widgets in rofi, see the 'Basic structure' section.
@ -82,10 +105,11 @@ Resulting in the following packing:
.RE .RE
.PP .PP
The \fB\fCelement\fR (container) widget hold each entry in the \fB\fClistview\fR, we add the two The \fB\fCelement\fR (container) widget hold each entry in the \fB\fClistview\fR, we add the
pre-defined children in the order we want to show them. two pre-defined children in the order we want to show. We also specify the
We also specify the packing direction (\fB\fCorientation\fR) and the spacing between the children (\fB\fCspacing\fR). packing direction (\fB\fCorientation\fR) and the spacing between the children
We specify the space between the two children in absolute pixels (\fB\fCpx\fR). (\fB\fCspacing\fR). We specify the space between the two children in absolute pixels
(\fB\fCpx\fR).
.PP .PP
To increase the icon-size, we need to modify the \fB\fCelement-icon\fR widget. To increase the icon-size, we need to modify the \fB\fCelement-icon\fR widget.

35
doc/rofi-theme.5.markdown
View file

@ -4,14 +4,30 @@
**rofi-theme** - Rofi theme format files **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. 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. 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 ```css
entry { 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"`. 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. 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 The `element` (container) widget hold each entry in the `listview`, we add the
pre-defined children in the order we want to show them. two pre-defined children in the order we want to show. We also specify the
We also specify the packing direction (`orientation`) and the spacing between the children (`spacing`). packing direction (`orientation`) and the spacing between the children
We specify the space between the two children in absolute pixels (`px`). (`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. To increase the icon-size, we need to modify the `element-icon` widget.