colin/rofi
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[Window] Add -window-prefer-icon-theme option.

Browse Source 
Fixes: #1702
This commit is contained in:
Dave Davenport
2022-10-22 11:03:11 +02:00
parent baba41cbd2
commit 96a69a54c3
12 changed files with 858 additions and 784 deletions
Download Patch File Download Diff File Expand all files Collapse all files

350
doc/rofi-theme.5
View File

@@ -1,7 +1,8 @@
.TH ROFI\-THEME 5 rofi\-theme
.nh
.TH ROFI-THEME 5 rofi-theme
.SH NAME
.PP
\fBrofi\-theme\fP \- Rofi theme format files
\fBrofi-theme\fP - Rofi theme format files
.SH GETTING STARTED WITH THEMING
.PP
@@ -10,7 +11,7 @@ The easiest way to get started theming rofi is by modifying your existing theme.
.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,
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
@@ -22,10 +23,10 @@ A basic config:
.nf
configuration {
modes: [ combi ];
combi\-modes: [ window, drun, run ];
combi-modes: [ window, drun, run ];
}
@theme "gruvbox\-light"
@theme "gruvbox-light"
/* Insert theme modifications after this */
@@ -78,7 +79,7 @@ increase the size. First we start by modifying the \fB\fCelement\fR widget:
element {
orientation: horizontal;
children: [ element\-text, element\-icon ];
children: [ element-text, element-icon ];
spacing: 5px;
}
@@ -105,19 +106,19 @@ Resulting in the following packing:
.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. We also specify 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.
To increase the icon-size, we need to modify the \fB\fCelement-icon\fR widget.
.PP
.RS
.nf
element\-icon {
element-icon {
size: 2.5em;
}
@@ -145,23 +146,23 @@ In this example we specify the size in the em
\[la]https://www.w3.org/Style/LieBos3e/em\[ra] unit.
.PP
Now lets change the text color of both the \fB\fCentry\fR and the \fB\fCelement\-text\fR widget to red and background to blue.
Now lets change the text color of both the \fB\fCentry\fR and the \fB\fCelement-text\fR widget to red and background to blue.
.PP
.RS
.nf
entry, element\-text {
text\-color: red;
background\-color: rgb(0,0,255);
entry, element-text {
text-color: red;
background-color: rgb(0,0,255);
}
.fi
.RE
.PP
Here we use two different methods of writing down the color, for \fB\fCtext\-color\fR
we used a named color, for \fB\fCbackground\-color\fR we specify it in \fB\fCrgb\fR\&.
Here we use two different methods of writing down the color, for \fB\fCtext-color\fR
we used a named color, for \fB\fCbackground-color\fR we specify it in \fB\fCrgb\fR\&.
We also specify the property for multiple widgets by passing a comma separated
list of widget names.
@@ -172,8 +173,8 @@ If you want to center the text relative to the icon, we can set this:
.RS
.nf
element\-text {
vertical\-align: 0.5;
element-text {
vertical-align: 0.5;
}
.fi
@@ -187,7 +188,7 @@ element\-text {
│ element │
│ ┌─────────────────────────────────────────────┐ ┌─────────────────┐ │
│ │ │ │ element │ │
│ │element\-text │ │ ─ │ │
│ │element-text │ │ ─ │ │
│ │ │ │ icon │ │
│ └─────────────────────────────────────────────┘ └─────────────────┘ │
└─────────────────────────────────────────────────────────────────────┘
@@ -202,7 +203,7 @@ If you want to see the complete theme, including the modification you can run:
.RS
.nf
rofi \-dump\-theme
rofi -dump-theme
.fi
.RE
@@ -240,7 +241,7 @@ To see the default theme, run the following command:
.RS
.nf
rofi \-no\-config \-dump\-theme
rofi -no-config -dump-theme
.fi
.RE
@@ -250,12 +251,12 @@ rofi \-no\-config \-dump\-theme
The need for a new theme format was motivated by the fact that the way rofi handled widgets has changed. From a very
static drawing of lines and text to a nice structured form of packing widgets. This change made it possible to provide a
more flexible theme framework. The old theme format and config file are not flexible enough to expose these options in a
user\-friendly way. Therefore, a new file format has been created, replacing the old one.
user-friendly way. Therefore, a new file format has been created, replacing the old one.
.SH FORMAT SPECIFICATION
.SH Encoding
.PP
The encoding of the file is UTF\-8. Both unix (\fB\fC\\n\fR) and windows (\fB\fC\\r\\n\fR) newlines format are supported. But unix is
The encoding of the file is UTF-8. Both unix (\fB\fC\\n\fR) and windows (\fB\fC\\r\\n\fR) newlines format are supported. But unix is
preferred.
.SH Comments
@@ -337,7 +338,7 @@ abbreviation for \fBr\fPofi \fBa\fPdvanced \fBs\fPtyle \fBi\fPnformation.
.SH Basic Structure
.PP
Each element has a section with defined properties. Global properties can be defined in section \fB\fC* { }\fR\&.
Sub\-section names begin with an optional hash symbol \fB\fC#\fR\&.
Sub-section names begin with an optional hash symbol \fB\fC#\fR\&.
.PP
It is advised to define the \fIglobal properties section\fP on top of the file to
@@ -386,7 +387,7 @@ A theme can have multiple element theme sections.
.PP
The element path can consist of multiple names separated by whitespace or dots.
Each element may contain any number of letters, numbers and \fB\fC\-\fR\&'s.
Each element may contain any number of letters, numbers and \fB\fC-\fR\&'s.
The first element in the element path can optionally start with a \fB\fC#\fR (for
historic reasons). Multiple elements can be specified by a \fB\fC,\fR\&.
@@ -398,10 +399,10 @@ This is a valid element name:
.nf
element normal.normal {
background\-color: blue;
background-color: blue;
}
button {
background\-color: blue;
background-color: blue;
}
.fi
@@ -415,7 +416,7 @@ And is identical to:
.nf
element normal normal, button {
background\-color: blue;
background-color: blue;
}
.fi
@@ -482,7 +483,7 @@ Both fields are mandatory for a property.
.PP
The \fB\fCidentifier\fR names the specified property. Identifiers can consist of any
combination of numbers, letters and '\-'. It must not contain any whitespace.
combination of numbers, letters and '-'. It must not contain any whitespace.
The structure of the \fB\fCvalue\fR defines the type of the property. The current
parser does not define or enforce a certain type of a particular \fB\fCidentifier\fR\&.
When used, values with the wrong type that cannot be converted are ignored.
@@ -558,7 +559,7 @@ font: "Awasome 12";
.RE
.PP
The string must be valid UTF\-8, special characters can be escaped:
The string must be valid UTF-8, special characters can be escaped:
.PP
.RS
@@ -577,7 +578,7 @@ The following special characters can be escaped: \fB\fC\\b\fR, \fB\fC\\f\fR, \fB
.SH Integer
.RS
.IP \(bu 2
Format: \fB\fC[\-+]?[:digit:]+\fR
Format: \fB\fC[-+]?[:digit:]+\fR
.RE
@@ -599,7 +600,7 @@ lines: 12;
.SH Real
.RS
.IP \(bu 2
Format: \fB\fC[\-+]?[:digit:]+(\\.[:digit:]+)?\fR
Format: \fB\fC[-+]?[:digit:]+(\\.[:digit:]+)?\fR
.RE
@@ -619,7 +620,7 @@ real: 3.4;
.RE
.PP
The following is not valid: \fB\fC\&.3\fR, \fB\fC3.\fR or scientific notation: \fB\fC3.4e\-3\fR\&.
The following is not valid: \fB\fC\&.3\fR, \fB\fC3.\fR or scientific notation: \fB\fC3.4e-3\fR\&.
.SH Boolean
.RS
@@ -629,7 +630,7 @@ Format: \fB\fC(true|false)\fR
.RE
.PP
Boolean value is either \fB\fCtrue\fR or \fB\fCfalse\fR\&. This is case\-\&sensitive.
Boolean value is either \fB\fCtrue\fR or \fB\fCfalse\fR\&. This is case-sensitive.
.PP
For example:
@@ -645,7 +646,7 @@ dynamic: false;
.SH Image
.PP
\fBrofi\fP support a limited set of background\-image formats.
\fBrofi\fP support a limited set of background-image formats.
.RS
.IP \(bu 2
@@ -654,12 +655,12 @@ Format: url("path to image");
Format: url("path to image", scale);
where scale is: none, both, width, height
.IP \(bu 2
Format: linear\-gradient(stop color,stop1, color, stop2 color, ...);
Format: linear-gradient(stop color,stop1, color, stop2 color, ...);
.IP \(bu 2
Format: linear\-gradient(to direction, stop color,stop1, color, stop2 color, ...);
Format: linear-gradient(to direction, stop color,stop1, color, stop2 color, ...);
where direction is: top,left,right,bottom.
.IP \(bu 2
Format: linear\-gradient(angle, stop color,stop1, color, stop2 color, ...);
Format: linear-gradient(angle, stop color,stop1, color, stop2 color, ...);
Angle in deg,rad,grad (as used in color).
.RE
@@ -691,31 +692,27 @@ Format: \fB\fChwb[a]( {ANGLE}, {PERCENTAGE}, {PERCENTAGE} [, {PERCENTAGE}])\fR
.IP \(bu 2
Format: \fB\fCcmyk( {PERCENTAGE}, {PERCENTAGE}, {PERCENTAGE}, {PERCENTAGE} [, {PERCENTAGE} ])\fR
.IP \(bu 2
Format: \fB\fC{named\-color} [ / {PERCENTAGE} ]\fR
Format: \fB\fC{named-color} [ / {PERCENTAGE} ]\fR
.RE
.PP
The white\-space format proposed in CSS4 is also supported.
The white-space format proposed in CSS4 is also supported.
.PP
The different values are:
.RS
.IP \(bu 2
\fB\fC{HEX}\fR is a hexadecimal number ('0\-9a\-f' case insensitive).
\fB\fC{HEX}\fR is a hexadecimal number ('0-9a-f' case insensitive).
.IP \(bu 2
\fB\fC{INTEGER}\fR value can be between 0 and 255 or 0\-100 when representing percentage.
\fB\fC{INTEGER}\fR value can be between 0 and 255 or 0-100 when representing percentage.
.IP \(bu 2
\fB\fC{ANGLE}\fR is the angle on the color wheel, can be in \fB\fCdeg\fR, \fB\fCrad\fR, \fB\fCgrad\fR or \fB\fCturn\fR\&. When no unit is specified, degrees is assumed.
.IP \(bu 2
\fB\fC{PERCENTAGE}\fR can be between 0\-1.0, or 0%\-100%
\fB\fC{PERCENTAGE}\fR can be between 0-1.0, or 0%-100%
.IP \(bu 2
.PP
\fB\fC{named\-color}\fR is one of the following colors:
.PP
AliceBlue, AntiqueWhite, Aqua, Aquamarine, Azure, Beige, Bisque, Black, BlanchedAlmond, Blue, BlueViolet, Brown,
\fB\fC{named-color}\fR is one of the following colors:AliceBlue, AntiqueWhite, Aqua, Aquamarine, Azure, Beige, Bisque, Black, BlanchedAlmond, Blue, BlueViolet, Brown,
BurlyWood, CadetBlue, Chartreuse, Chocolate, Coral, CornflowerBlue, Cornsilk, Crimson, Cyan, DarkBlue, DarkCyan,
DarkGoldenRod, DarkGray, DarkGrey, DarkGreen, DarkKhaki, DarkMagenta, DarkOliveGreen, DarkOrange, DarkOrchid, DarkRed,
DarkSalmon, DarkSeaGreen, DarkSlateBlue, DarkSlateGray, DarkSlateGrey, DarkTurquoise, DarkViolet, DeepPink, DeepSkyBlue,
@@ -739,9 +736,9 @@ For example:
.RS
.nf
background\-color: #FF0000;
border\-color: rgba(0,0,1, 0.5);
text\-color: SeaGreen;
background-color: #FF0000;
border-color: rgba(0,0,1, 0.5);
text-color: SeaGreen;
.fi
.RE
@@ -753,8 +750,8 @@ or
.RS
.nf
background\-color: transparent;
text\-color: Black;
background-color: transparent;
text-color: Black;
.fi
.RE
@@ -795,7 +792,7 @@ The following options are available on pango 1.50.0 and up:
.PP
The following option is disabled as pango crashes on this if there is eel
upsizing or wrapping. This will be re\-enabled once fixed:
upsizing or wrapping. This will be re-enabled once fixed:
.RS
.IP \(bu 2
@@ -863,7 +860,7 @@ For example:
.RE
.PP
On a full\-HD (1920x1080) monitor, it defines a padding of 192 pixels on the left
On a full-HD (1920x1080) monitor, it defines a padding of 192 pixels on the left
and right side and 108 pixels on the top and bottom.
.SS Calculating sizes
@@ -874,7 +871,7 @@ Rofi supports some maths in calculating sizes. For this it uses the CSS syntax:
.RS
.nf
width: calc( 100% \- 37px );
width: calc( 100% - 37px );
.fi
.RE
@@ -895,7 +892,7 @@ It supports the following operations:
.IP \(bu 2
\fB\fC+\fR : Add
.IP \(bu 2
\fB\fC\-\fR : Subtract
\fB\fC-\fR : Subtract
.IP \(bu 2
\fB\fC/\fR : Divide
.IP \(bu 2
@@ -943,9 +940,9 @@ The different number of fields in the formats are parsed like:
.IP \(bu 2
1 field: \fB\fCall\fR
.IP \(bu 2
2 fields: \fB\fCtop\&bottom\fR \fB\fCleft\&right\fR
2 fields: \fB\fCtop&bottom\fR \fB\fCleft&right\fR
.IP \(bu 2
3 fields: \fB\fCtop\fR, \fB\fCleft\&right\fR, \fB\fCbottom\fR
3 fields: \fB\fCtop\fR, \fB\fCleft&right\fR, \fB\fCbottom\fR
.IP \(bu 2
4 fields: \fB\fCtop\fR, \fB\fCright\fR, \fB\fCbottom\fR, \fB\fCleft\fR
@@ -983,6 +980,7 @@ style property.
.PP
When no unit is specified, pixels are assumed.
.RE
.SH Position
@@ -1120,7 +1118,7 @@ Format: \fB\fC[ keyword, keyword ]\fR
.RE
.PP
A list starts with a '[' and ends with a ']'. The entries in the list are comma\-separated.
A list starts with a '[' and ends with a ']'. The entries in the list are comma-separated.
The \fB\fCkeyword\fR in the list refers to an widget name.
.SH List of values
@@ -1131,7 +1129,7 @@ Format: \fB\fC[ value, value, ... ]\fR
.RE
.PP
An list starts with a '[' and ends with a ']'. The entries in the list are comma\-separated.
An list starts with a '[' and ends with a ']'. The entries in the list are comma-separated.
.SH Environment variable
.RS
@@ -1142,14 +1140,14 @@ Format: \fB\fC${:alnum:}\fR
.PP
This will parse the environment variable as the property value. (that then can be any of the above types).
The environment variable should be an alphanumeric string without white\-space.
The environment variable should be an alphanumeric string without white-space.
.PP
.RS
.nf
* {
background\-color: ${BG};
background-color: ${BG};
}
.fi
@@ -1163,7 +1161,7 @@ Format: \fB\fCenv(ENVIRONMENT, default)\fR
.PP
This will parse the environment variable as the property value. (that then can be any of the above types).
The environment variable should be an alphanumeric string without white\-space.
The environment variable should be an alphanumeric string without white-space.
If the environment value is not found, the default value is used.
.PP
@@ -1195,7 +1193,7 @@ Inherits the property from its parent widget.
.nf
mainbox {
border\-color: inherit;
border-color: inherit;
}
.fi
@@ -1247,7 +1245,6 @@ The current widgets available in \fBrofi\fP:
.RS
.IP \(bu 2
\fB\fCwindow\fR
.RS
.IP \(bu 2
\fB\fCoverlay\fR: the overlay widget.
@@ -1255,65 +1252,66 @@ The current widgets available in \fBrofi\fP:
\fB\fCmainbox\fR: The mainbox box.
.IP \(bu 2
\fB\fCinputbar\fR: The input bar box.
.RS
.IP \(bu 2
\fB\fCbox\fR: the horizontal @box packing the widgets
.IP \(bu 2
\fB\fCcase\-indicator\fR: the case/sort indicator @textbox
\fB\fCcase-indicator\fR: the case/sort indicator @textbox
.IP \(bu 2
\fB\fCprompt\fR: the prompt @textbox
.IP \(bu 2
\fB\fCentry\fR: the main entry @textbox
.IP \(bu 2
\fB\fCnum\-rows\fR: Shows the total number of rows.
\fB\fCnum-rows\fR: Shows the total number of rows.
.IP \(bu 2
\fB\fCnum\-filtered\-rows\fR: Shows the total number of rows after filtering.
\fB\fCnum-filtered-rows\fR: Shows the total number of rows after filtering.
.IP \(bu 2
\fB\fCtextbox\-current\-entry\fR: Shows the text of the currently selected entry.
\fB\fCtextbox-current-entry\fR: Shows the text of the currently selected entry.
.IP \(bu 2
\fB\fCicon\-current\-entry\fR: Shows the icon of the currently selected entry.
\fB\fCicon-current-entry\fR: Shows the icon of the currently selected entry.
.RE
.IP \(bu 2
\fB\fClistview\fR: The listview.
.RS
.IP \(bu 2
\fB\fCscrollbar\fR: the listview scrollbar
.IP \(bu 2
\fB\fCelement\fR: a box in the listview holding the entries
.RS
.IP \(bu 2
\fB\fCelement\-icon\fR: the widget in the listview's entry showing the (optional) icon
\fB\fCelement-icon\fR: the widget in the listview's entry showing the (optional) icon
.IP \(bu 2
\fB\fCelement\-index\fR: the widget in the listview's entry keybindable index (1,2,3..0)
\fB\fCelement-index\fR: the widget in the listview's entry keybindable index (1,2,3..0)
.IP \(bu 2
\fB\fCelement\-text\fR: the widget in the listview's entry showing the text.
\fB\fCelement-text\fR: the widget in the listview's entry showing the text.
.RE
.RE
.IP \(bu 2
\fB\fCmode\-switcher\fR: the main horizontal @box packing the buttons.
.RE
.IP \(bu 2
\fB\fCmode-switcher\fR: the main horizontal @box packing the buttons.
.RS
.IP \(bu 2
\fB\fCbutton\fR: the buttons @textbox for each mode
.RE
.IP \(bu 2
\fB\fCmessage\fR: The container holding the textbox.
.RS
.IP \(bu 2
\fB\fCtextbox\fR: the message textbox
.RE
.RE
.RE
.PP
@@ -1367,8 +1365,8 @@ Example:
.nf
nametotextbox selected.active {
background\-color: #003642;
text\-color: #008ed4;
background-color: #003642;
text-color: #008ed4;
}
.fi
@@ -1401,16 +1399,16 @@ Margin on the outside of the widget
\fBborder\fP: border
Border around the widget (between padding and margin)/
.IP \(bu 2
\fBborder\-radius\fP: padding
\fBborder-radius\fP: padding
Sets a radius on the corners of the borders.
.IP \(bu 2
\fBbackground\-color\fP: color
\fBbackground-color\fP: color
Background color
.IP \(bu 2
\fBbackground\-image\fP: image
\fBbackground-image\fP: image
Background image
.IP \(bu 2
\fBborder\-color\fP: color
\fBborder-color\fP: color
Color of the border
.IP \(bu 2
\fBcursor\fP: cursor
@@ -1421,47 +1419,31 @@ Type of mouse cursor that is set when the mouse pointer is hovered over the widg
.SS window:
.RS
.IP \(bu 2
.PP
\fBfont\fP: string
The font used in the window
.IP \(bu 2
.PP
\fBtransparency\fP: string
Indicating if transparency should be used and what type:
\fBreal\fP \- True transparency. Only works with a compositor.
\fBbackground\fP \- Take a screenshot of the background image and use that.
\fBscreenshot\fP \- Take a screenshot of the screen and use that.
\fBPath\fP to png file \- Use an image.
\fBreal\fP - True transparency. Only works with a compositor.
\fBbackground\fP - Take a screenshot of the background image and use that.
\fBscreenshot\fP - Take a screenshot of the screen and use that.
\fBPath\fP to png file - Use an image.
.IP \(bu 2
.PP
\fBlocation\fP: position
The place of the anchor on the monitor
.IP \(bu 2
.PP
\fBanchor\fP: anchor
The anchor position on the window
.IP \(bu 2
.PP
\fBfullscreen\fP: boolean
Window is fullscreen.
.IP \(bu 2
.PP
\fBwidth\fP: distance
The width of the window
.IP \(bu 2
.PP
\fBx\-offset\fP: distance
\fBx-offset\fP: distance
.IP \(bu 2
.PP
\fBy\-offset\fP: distance
\fBy-offset\fP: distance
The offset of the window to the anchor point, allowing you to push the window left/right/up/down
.RE
@@ -1469,13 +1451,13 @@ The offset of the window to the anchor point, allowing you to push the window le
.SS scrollbar:
.RS
.IP \(bu 2
\fBbackground\-color\fP: color
\fBbackground-color\fP: color
.IP \(bu 2
\fBhandle\-width\fP: distance
\fBhandle-width\fP: distance
.IP \(bu 2
\fBhandle\-color\fP: color
\fBhandle-color\fP: color
.IP \(bu 2
\fBborder\-color\fP: color
\fBborder-color\fP: color
.RE
@@ -1493,25 +1475,25 @@ The offset of the window to the anchor point, allowing you to push the window le
.SS textbox:
.RS
.IP \(bu 2
\fBbackground\-color\fP: color
\fBbackground-color\fP: color
.IP \(bu 2
\fBborder\-color\fP: the color used for the border around the widget.
\fBborder-color\fP: the color used for the border around the widget.
.IP \(bu 2
\fBfont\fP: the font used by this textbox (string).
.IP \(bu 2
\fBstr\fP/\fBcontent\fP: the string to display by this textbox (string).
.IP \(bu 2
\fBvertical\-align\fP: Vertical alignment of the text. A number between 0 (top) and 1 (bottom).
\fBvertical-align\fP: Vertical alignment of the text. A number between 0 (top) and 1 (bottom).
.IP \(bu 2
\fBhorizontal\-align\fP: Horizontal alignment of the text. A number between 0 (left) and 1 (right).
\fBhorizontal-align\fP: Horizontal alignment of the text. A number between 0 (left) and 1 (right).
.IP \(bu 2
\fBtext\-color\fP: the text color to use.
\fBtext-color\fP: the text color to use.
.IP \(bu 2
\fBtext\-transform\fP: text style {color} for the whole text.
\fBtext-transform\fP: text style {color} for the whole text.
.IP \(bu 2
\fBhighlight\fP: text style {color}.
color is optional, multiple highlight styles can be added like: bold underline italic #000000;
This option is only available on the \fB\fCelement\-text\fR widget.
This option is only available on the \fB\fCelement-text\fR widget.
.IP \(bu 2
\fBwidth\fP: override the desired width for the textbox.
.IP \(bu 2
@@ -1519,15 +1501,15 @@ This option is only available on the \fB\fCelement\-text\fR widget.
.IP \(bu 2
\fBplaceholder\fP: Set the displayed text (String) when nothing is entered.
.IP \(bu 2
\fBplaceholder\-markup\fP: If true, placeholder text supports pango markup for stylizing.
\fBplaceholder-markup\fP: If true, placeholder text supports pango markup for stylizing.
.IP \(bu 2
\fBplaceholder\-color\fP: Color of the placeholder text.
\fBplaceholder-color\fP: Color of the placeholder text.
.IP \(bu 2
\fBblink\fP: Enable/Disable blinking on an input textbox (Boolean).
.IP \(bu 2
\fBmarkup\fP: Force markup on, beware that only valid pango markup strings are shown.
.IP \(bu 2
\fBtab\-stops\fP: array of distances
\fBtab-stops\fP: array of distances
Set the location of tab stops by their distance from the beginning of the line.
Each distance should be greater than the previous one.
The text appears to the right of the tab stop position (other alignments are not supported yet).
@@ -1540,7 +1522,7 @@ The text appears to the right of the tab stop position (other alignments are not
\fBcolumns\fP: integer
Number of columns to show (at least 1)
.IP \(bu 2
\fBfixed\-height\fP: boolean
\fBfixed-height\fP: boolean
Always show \fB\fClines\fR rows, even if fewer elements are available.
.IP \(bu 2
\fBdynamic\fP: boolean
@@ -1549,7 +1531,7 @@ Always show \fB\fClines\fR rows, even if fewer elements are available.
\fBscrollbar\fP: boolean
If the scrollbar should be enabled/disabled.
.IP \(bu 2
\fBscrollbar\-width\fP: distance
\fBscrollbar-width\fP: distance
Width of the scrollbar
.IP \(bu 2
\fBcycle\fP: boolean
@@ -1570,23 +1552,23 @@ Reverse the ordering (top down to bottom up).
\fBflow\fP: orientation
The order the elements are layed out. Vertical is the original 'column' view.
.IP \(bu 2
\fBfixed\-columns\fP: boolean
\fBfixed-columns\fP: boolean
Do not reduce the number of columns shown when number of visible elements is not enough to fill them all.
.IP \(bu 2
\fBrequire\-input\fP: boolean
\fBrequire-input\fP: boolean
Listview requires user input to show up.
.RE
.PP
Each element is a \fB\fCbox\fR called \fB\fCelement\fR\&. Each \fB\fCelement\fR can contain an \fB\fCelement\-icon\fR and \fB\fCelement\-text\fR\&.
Each element is a \fB\fCbox\fR called \fB\fCelement\fR\&. Each \fB\fCelement\fR can contain an \fB\fCelement-icon\fR and \fB\fCelement-text\fR\&.
.SS listview text highlight:
.PP
The \fB\fCelement\-text\fR widget in the \fB\fClistview\fR is the one used to show the text.
The \fB\fCelement-text\fR widget in the \fB\fClistview\fR is the one used to show the text.
On this widget set the \fB\fChighlight\fR property (only place this property is used) to change
the style of highlighting.
The \fB\fChighlight\fR property consist of the \fB\fCtext\-style\fR property and a color.
The \fB\fChighlight\fR property consist of the \fB\fCtext-style\fR property and a color.
.PP
To disable highlighting:
@@ -1595,7 +1577,7 @@ To disable highlighting:
.RS
.nf
element\-text {
element-text {
highlight: None;
}
@@ -1609,7 +1591,7 @@ To set to red underlined:
.RS
.nf
element\-text {
element-text {
highlight: underline red;
}
@@ -1682,11 +1664,11 @@ The current layout of \fBrofi\fP is structured as follows:
.RS
.IP \(bu 2
ci is the case\-indicator
ci is the case-indicator
.IP \(bu 2
fr is the num\-filtered\-rows
fr is the num-filtered-rows
.IP \(bu 2
ns is the num\-rows
ns is the num-rows
.RE
@@ -1726,17 +1708,17 @@ entry
.IP \(bu 2
overlay
.IP \(bu 2
case\-indicator
case-indicator
.IP \(bu 2
message
.IP \(bu 2
listview
.IP \(bu 2
mode\-switcher
mode-switcher
.IP \(bu 2
num\-rows
num-rows
.IP \(bu 2
num\-filtered\-rows
num-filtered-rows
.RE
@@ -1747,10 +1729,10 @@ These are used in the default theme as depicted in the figure above.
.RS
.IP \(bu 2
mainbox
Packs: \fB\fCinputbar, message, listview, mode\-switcher\fR
Packs: \fB\fCinputbar, message, listview, mode-switcher\fR
.IP \(bu 2
inputbar
Packs: \fB\fCprompt,entry,case\-indicator\fR
Packs: \fB\fCprompt,entry,case-indicator\fR
.RE
@@ -1762,7 +1744,7 @@ There are several special widgets that can be used by prefixing the name of the
.SS textbox
.PP
This is a read\-only textbox widget. The displayed string can be set with \fB\fCcontent\fR\&.
This is a read-only textbox widget. The displayed string can be set with \fB\fCcontent\fR\&.
.PP
Example:
@@ -1771,7 +1753,7 @@ Example:
.RS
.nf
textbox\-custom {
textbox-custom {
expand: false;
content: "My Message";
}
@@ -1783,7 +1765,7 @@ textbox\-custom {
.PP
This is an icon widget. The displayed icon can be set with \fB\fCfilename\fR and size with \fB\fCsize\fR\&.
If the property \fB\fCaction\fR is set, it acts as a button.
\fB\fCaction\fR can be set to a keybinding name and completes that action. (see rofi \-show keys for a list).
\fB\fCaction\fR can be set to a keybinding name and completes that action. (see rofi -show keys for a list).
.PP
If the \fB\fCsquared\fR property is set to \fBfalse\fP the widget height and width are not forced to be equal.
@@ -1795,12 +1777,12 @@ Example:
.RS
.nf
icon\-paste {
icon-paste {
expand: false;
filename: "gtk\-paste";
filename: "gtk-paste";
size: 24;
vertical\-align: 0.5;
action: "kb\-primary\-paste";
vertical-align: 0.5;
action: "kb-primary-paste";
}
.fi
@@ -1810,17 +1792,17 @@ icon\-paste {
.PP
This is a textbox widget that can have a 'clickable' action.
The \fB\fCaction\fR can be set to:
\fB\fCkeybinding\fR: accepts a keybinding name and completes that action. (see rofi \-show keys for a list).
\fB\fCkeybinding\fR: accepts a keybinding name and completes that action. (see rofi -show keys for a list).
.PP
.RS
.nf
button\-paste {
button-paste {
expand: false;
content: "My Clickable Message";
vertical\-align: 0.5;
action: "kb\-primary\-paste";
vertical-align: 0.5;
action: "kb-primary-paste";
}
.fi
@@ -1836,7 +1818,7 @@ property (this always happens on the \fB\fCbox\fR child, see example below):
.nf
inputbar {
children: [prompt,entry,overlay,case\-indicator];
children: [prompt,entry,overlay,case-indicator];
}
.fi
@@ -1853,9 +1835,9 @@ Below is an example of a theme emulating dmenu:
.nf
* {
background\-color: Black;
text\-color: White;
border\-color: White;
background-color: Black;
text-color: White;
border-color: White;
font: "Times New Roman 12";
}
@@ -1887,7 +1869,7 @@ element {
padding: 0px 2px;
}
element selected {
background\-color: SteelBlue;
background-color: SteelBlue;
}
.fi
@@ -1922,15 +1904,15 @@ Explanation of the different parts:
.RS
.IP \(bu 2
Content \- The content of the widget.
Content - The content of the widget.
.IP \(bu 2
Padding \- Clears an area around the widget.
Padding - Clears an area around the widget.
The padding shows the background color of the widget.
.IP \(bu 2
Border \- A border that goes around the padding and content.
The border use the border\-color of the widget.
Border - A border that goes around the padding and content.
The border use the border-color of the widget.
.IP \(bu 2
Margin \- Clears an area outside the border.
Margin - Clears an area outside the border.
The margin is transparent.
.RE
@@ -1998,7 +1980,7 @@ To get debug information from the parser, run rofi like:
.RS
.nf
G\_MESSAGES\_DEBUG=Parser rofi \-show run
G_MESSAGES_DEBUG=Parser rofi -show run
.fi
.RE
@@ -2013,19 +1995,19 @@ To see the elements queried during running, run:
.RS
.nf
G\_MESSAGES\_DEBUG=Theme rofi \-show run
G_MESSAGES_DEBUG=Theme rofi -show run
.fi
.RE
.PP
To test minor changes, part of the theme can be passed on the command line, for example to set it to full\-screen:
To test minor changes, part of the theme can be passed on the command line, for example to set it to full-screen:
.PP
.RS
.nf
rofi \-theme\-str 'window { fullscreen:true;}' \-show run
rofi -theme-str 'window { fullscreen:true;}' -show run
.fi
.RE
@@ -2037,7 +2019,7 @@ Another syntax to modify theme properties is:
.RS
.nf
rofi \-theme+window+fullscreen true \-show run
rofi -theme+window+fullscreen true -show run
.fi
.RE
@@ -2049,7 +2031,7 @@ To print the current theme, run:
.RS
.nf
rofi \-dump\-theme
rofi -dump-theme
.fi
.RE
@@ -2062,7 +2044,7 @@ Parts of the theme can be conditionally loaded, like the CSS \fB\fC@media\fR opt
.RS
.nf
@media ( min\-width: 120 ) {
@media ( min-width: 120 ) {
}
@@ -2074,19 +2056,19 @@ It supports the following keys as constraint:
.RS
.IP \(bu 2
\fB\fCmin\-width\fR: load when width is bigger or equal then value.
\fB\fCmin-width\fR: load when width is bigger or equal then value.
.IP \(bu 2
\fB\fCmax\-width\fR: load when width is smaller then value.
\fB\fCmax-width\fR: load when width is smaller then value.
.IP \(bu 2
\fB\fCmin\-height\fR: load when height is bigger or equal then value.
\fB\fCmin-height\fR: load when height is bigger or equal then value.
.IP \(bu 2
\fB\fCmax\-height\fR: load when height is smaller then value.
\fB\fCmax-height\fR: load when height is smaller then value.
.IP \(bu 2
\fB\fCmin\-aspect\-ratio\fR load when aspect ratio is over value.
\fB\fCmin-aspect-ratio\fR load when aspect ratio is over value.
.IP \(bu 2
\fB\fCmax\-aspect\-ratio\fR: load when aspect ratio is under value.
\fB\fCmax-aspect-ratio\fR: load when aspect ratio is under value.
.IP \(bu 2
\fB\fCmonitor\-id\fR: The monitor id, see rofi \-help for id's.
\fB\fCmonitor-id\fR: The monitor id, see rofi -help for id's.
.IP \(bu 2
\fB\fCenabled\fR: Boolean option to enable. Supports environment variable.
@@ -2099,7 +2081,7 @@ It supports the following keys as constraint:
.RS
.nf
@media ( min\-width: 120 px ) {
@media ( min-width: 120 px ) {
}
@@ -2110,7 +2092,7 @@ It supports the following keys as constraint:
.RS
.nf
@media ( enabled: env(DO\_LIGHT, false ) {
@media ( enabled: env(DO_LIGHT, false ) {
}
@@ -2153,7 +2135,7 @@ Rofi supports 3 ways of specifying an icon:
.IP \(bu 2
Filename
.IP \(bu 2
icon\-name, this is looked up via the icon\-theme.
icon-name, this is looked up via the icon-theme.
.IP \(bu 2
Markup String. It renders a string as an icon.
@@ -2172,7 +2154,7 @@ Markup string:
.RS
.nf
echo \-en "testing\\0icon\\x1f<span color='red'>⏻</span>" | ./rofi \-dmenu
echo -en "testing\\0icon\\x1f<span color='red'>⏻</span>" | ./rofi -dmenu
.fi
.RE
@@ -2184,7 +2166,7 @@ Getting supported icon formats:
.RS
.nf
G\_MESSAGES\_DEBUG=Helpers.IconFetcher rofi
G_MESSAGES_DEBUG=Helpers.IconFetcher rofi
.fi
.RE
@@ -2227,11 +2209,11 @@ If a filename is provided, it will try to resolve it in the following order:
.RS
.IP \(bu 2
\fB\fC${XDG\_CONFIG\_HOME}/rofi/themes/\fR
\fB\fC${XDG_CONFIG_HOME}/rofi/themes/\fR
.IP \(bu 2
\fB\fC${XDG\_CONFIG\_HOME}/rofi/\fR
\fB\fC${XDG_CONFIG_HOME}/rofi/\fR
.IP \(bu 2
\fB\fC${XDG\_DATA\_HOME}/rofi/themes/\fR
\fB\fC${XDG_DATA_HOME}/rofi/themes/\fR
.IP \(bu 2
\fB\fC${INSTALL PREFIX}/share/rofi/themes/\fR
@@ -2247,4 +2229,4 @@ Several examples are installed together with \fBrofi\fP\&. These can be found in
.SH SEE ALSO
.PP
rofi(1), rofi\-script(5), rofi\-theme\-selector(1)
rofi(1), rofi-script(5), rofi-theme-selector(1)