summaryrefslogtreecommitdiffstats
path: root/doc/rofi-theme.5
diff options
context:
space:
mode:
Diffstat (limited to 'doc/rofi-theme.5')
-rw-r--r--doc/rofi-theme.5457
1 files changed, 226 insertions, 231 deletions
diff --git a/doc/rofi-theme.5 b/doc/rofi-theme.5
index ad80f3ee..65dc8d6e 100644
--- a/doc/rofi-theme.5
+++ b/doc/rofi-theme.5
@@ -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 DEFAULT THEME LOADING
.PP
@@ -36,7 +37,7 @@ To see the default theme, run the following command:
.RS
.nf
-rofi \-no\-config \-dump\-theme
+rofi -no-config -dump-theme
.fi
.RE
@@ -46,12 +47,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
@@ -62,7 +63,7 @@ C and C++ file comments are supported.
.IP \(bu 2
Anything after \fB\fC//\fR and before a newline is considered a comment.
.IP \(bu 2
-Everything between \fB\fC/*\fR and \fB\fC*/\fR is a comment.
+Everything between \fB\fC/*\fR and \fB\fC*/\fR is a comment, this comment can span multiple lines.
.RE
@@ -133,7 +134,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 a 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
@@ -182,9 +183,9 @@ 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.
-The first element in the element path should always start with a \fB\fC#\fR\&.
-Multiple elements can be specified by a \fB\fC,\fR\&.
+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\&.
.PP
This is a valid element name:
@@ -194,10 +195,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
@@ -211,15 +212,15 @@ And is identical to:
.nf
element normal normal, button {
- background\-color: blue;
+ background-color: blue;
}
.fi
.RE
.PP
-Each section inherits the global properties. Properties can be explicitly inherited from their parent with the
-\fB\fCinherit\fR keyword.
+Each section inherits the global properties. Properties can be explicitly
+inherited from their parent with the \fB\fCinherit\fR keyword.
In the following example:
.PP
@@ -241,7 +242,8 @@ mainbox {
.RE
.PP
-The element \fB\fCmainbox\fR will have the following set of properties (if \fB\fCmainbox\fR is a child of \fB\fCwindow\fR):
+The element \fB\fCmainbox\fR will have the following set of properties (if \fB\fCmainbox\fR
+is a child of \fB\fCwindow\fR):
.PP
.RS
@@ -277,7 +279,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.
@@ -353,12 +355,26 @@ font: "Awasome 12";
.RE
.PP
-The string must be valid UTF\-8.
+The string must be valid UTF-8, special characters can be escaped:
+
+.PP
+.RS
+
+.nf
+text {
+ content: "Line one\\n\\tIndented line two";
+}
+
+.fi
+.RE
+
+.PP
+The following special characters can be escaped: \fB\fC\\b\fR, \fB\fC\\f\fR, \fB\fC\\n\fR, \fB\fC\\r\fR, \fB\fC\\t\fR, \fB\fC\\v\fR, \fB\fC\\\fR and \fB\fC"\fR\&.
.SH Integer
.RS
.IP \(bu 2
-Format: \fB\fC[\-+]?[:digit:]+\fR
+Format: \fB\fC[-+]?[:digit:]+\fR
.RE
@@ -380,7 +396,7 @@ lines: 12;
.SH Real
.RS
.IP \(bu 2
-Format: \fB\fC[\-+]?[:digit:]+(\\.[:digit:]+)?\fR
+Format: \fB\fC[-+]?[:digit:]+(\\.[:digit:]+)?\fR
.RE
@@ -400,7 +416,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
@@ -410,7 +426,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:
@@ -426,7 +442,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
@@ -435,12 +451,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
@@ -472,31 +488,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,
@@ -520,9 +532,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
@@ -534,8 +546,8 @@ or
.RS
.nf
-background\-color: transparent;
-text\-color: Black;
+background-color: transparent;
+text-color: Black;
.fi
.RE
@@ -623,7 +635,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
@@ -634,7 +646,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
@@ -646,17 +658,17 @@ 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
\fB\fC*\fR : Multiply
.IP \(bu 2
-\fB\fC%\fR : Multiply
+\fB\fC%\fR : Modulo
.IP \(bu 2
-\fB\fCmin\fR : Minimum of l or rvalue;
+\fB\fCmin\fR : Minimum of lvalue or rvalue;
.IP \(bu 2
-\fB\fCmax\fR : Maximum of l or rvalue;
+\fB\fCmax\fR : Maximum of lvalue or rvalue;
.IP \(bu 2
\fB\fCfloor\fR : Round down lvalue to the next multiple of rvalue
.IP \(bu 2
@@ -694,9 +706,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
@@ -734,6 +746,7 @@ style property.
.PP
When no unit is specified, pixels are assumed.
+
.RE
.SH Position
@@ -742,22 +755,14 @@ Indicate a place on the window/monitor.
.RS
.IP \(bu 2
-
-.PP
Format: \fB\fC(center|east|north|west|south|north east|north west|south west|south east)\fR
-.PP
-.RS
-
-.nf
-
+\fB\fC
north west | north | north east
-\-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\-
+-------------|-------------|------------
west | center | east
-\-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\-
+-------------|-------------|------------
south west | south | south east
-
-.fi
-.RE
+\fR
.RE
@@ -766,10 +771,16 @@ south west | south | south east
It is possible to hide widgets:
.PP
+.RS
+
+.nf
inputbar {
enabled: false;
}
+.fi
+.RE
+
.SH Reference
.RS
.IP \(bu 2
@@ -865,7 +876,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
@@ -876,7 +887,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
@@ -887,14 +898,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
@@ -908,7 +919,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
@@ -940,7 +951,7 @@ Inherits the property from its parent widget.
.nf
mainbox {
- border\-color: inherit;
+ border-color: inherit;
}
.fi
@@ -992,7 +1003,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.
@@ -1000,61 +1010,62 @@ 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.
.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.
+.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
@@ -1108,8 +1119,8 @@ Example:
.nf
nametotextbox selected.active {
- background\-color: #003642;
- text\-color: #008ed4;
+ background-color: #003642;
+ text-color: #008ed4;
}
.fi
@@ -1131,30 +1142,30 @@ The following properties are currently supported:
.SS all widgets:
.RS
.IP \(bu 2
-\fBenabled\fP: enable/disable rendering of the widget
+\fBenabled\fP: enable/disable rendering of the widget
.IP \(bu 2
-\fBpadding\fP: padding
+\fBpadding\fP: padding
Padding on the inside of the widget
.IP \(bu 2
-\fBmargin\fP: padding
+\fBmargin\fP: padding
Margin on the outside of the widget
.IP \(bu 2
-\fBborder\fP: border
+\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
+\fBcursor\fP: cursor
Type of mouse cursor that is set when the mouse pointer is hovered over the widget.
.RE
@@ -1162,47 +1173,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
@@ -1210,13 +1205,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
@@ -1226,7 +1221,7 @@ The offset of the window to the anchor point, allowing you to push the window le
\fBorientation\fP: orientation
Set the direction the elements are packed.
.IP \(bu 2
-\fBspacing\fP: distance
+\fBspacing\fP: distance
Distance between the packed elements.
.RE
@@ -1234,23 +1229,23 @@ 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: the string to display by this textbox (string).
+\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
\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
@@ -1258,13 +1253,13 @@ 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\-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).
@@ -1277,7 +1272,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
@@ -1286,7 +1281,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
@@ -1307,20 +1302,20 @@ 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.
.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:
@@ -1329,7 +1324,7 @@ To disable highlighting:
.RS
.nf
- element\-text {
+ element-text {
highlight: None;
}
@@ -1343,7 +1338,7 @@ To set to red underlined:
.RS
.nf
- element\-text {
+ element-text {
highlight: underline red;
}
@@ -1369,42 +1364,42 @@ The current layout of \fBrofi\fP is structured as follows:
.RS
.nf
-|\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-|
+|------------------------------------------------------------------------------------|
| window {BOX:vertical} |
-| |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| |
+| |-------------------------------------------------------------------------------| |
| | mainbox {BOX:vertical} | |
-| | |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| | |
+| | |---------------------------------------------------------------------------| | |
| | | inputbar {BOX:horizontal} | | |
-| | | |\-\-\-\-\-\-\-\-\-| |\-| |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-| |\-\-\-| |\-\-\-| |\-\-\-| | | |
+| | | |---------| |-| |---------------------------------|---| |---| |---| |---| | | |
| | | | prompt | |:| | entry |#fr| | / | |#ns| |ci | | | |
-| | | |\-\-\-\-\-\-\-\-\-| |\_| |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-| |\-\-\-| |\-\-\-| |\-\-\-| | | |
-| | |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| | |
+| | | |---------| |_| |---------------------------------|---| |---| |---| |---| | | |
+| | |---------------------------------------------------------------------------| | |
| | | |
-| | |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| | |
+| | |---------------------------------------------------------------------------| | |
| | | message | | |
-| | | |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| | | |
+| | | |-----------------------------------------------------------------------| | | |
| | | | textbox | | | |
-| | | |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| | | |
-| | |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| | |
+| | | |-----------------------------------------------------------------------| | | |
+| | |---------------------------------------------------------------------------| | |
| | | |
-| | |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| |
+| | |-----------------------------------------------------------------------------| |
| | | listview | |
-| | | |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-] | |
+| | | |------------------------------------------------------------------------] | |
| | | | element | | |
-| | | | |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-] | | |
-| | | | |element\-icon | |element\-text | | | |
-| | | | |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| | | |
-| | | |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-] | |
-| | |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| |
+| | | | |-----------------| |------------------------------------------------] | | |
+| | | | |element-icon | |element-text | | | |
+| | | | |-----------------| |------------------------------------------------| | | |
+| | | |------------------------------------------------------------------------] | |
+| | |-----------------------------------------------------------------------------| |
| | | |
-| | |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| | |
-| | | mode\-switcher {BOX:horizontal} | | |
-| | | |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| |\-\-\-\-\-\-\-\-\-\-\-\-\-\-| |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| | | |
+| | |---------------------------------------------------------------------------| | |
+| | | mode-switcher {BOX:horizontal} | | |
+| | | |---------------| |---------------| |--------------| |---------------| | | |
| | | | Button | | Button | | Button | | Button | | | |
-| | | |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| |\-\-\-\-\-\-\-\-\-\-\-\-\-\-| |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| | | |
-| | |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| | |
-| |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| |
-|\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-|
+| | | |---------------| |---------------| |--------------| |---------------| | | |
+| | |---------------------------------------------------------------------------| | |
+| |-------------------------------------------------------------------------------| |
+|------------------------------------------------------------------------------------|
@@ -1416,11 +1411,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
@@ -1431,15 +1426,15 @@ ns is the num\-rows
.RS
.nf
-|\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-|
+|-----------------------------------------------------------------------------------|
| window {BOX:vertical} |
-| |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| |
-| | error\-message {BOX:vertical} | |
-| | |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| | |
+| |------------------------------------------------------------------------------| |
+| | error-message {BOX:vertical} | |
+| | |-------------------------------------------------------------------------| | |
| | | textbox | | |
-| | |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| | |
-| |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| |
-|\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-|
+| | |-------------------------------------------------------------------------| | |
+| |------------------------------------------------------------------------------| |
+|-----------------------------------------------------------------------------------|
@@ -1461,17 +1456,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
@@ -1482,10 +1477,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
@@ -1497,7 +1492,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:
@@ -1506,7 +1501,7 @@ Example:
.RS
.nf
-textbox\-custom {
+textbox-custom {
expand: false;
content: "My Message";
}
@@ -1518,7 +1513,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.
@@ -1530,12 +1525,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
@@ -1545,17 +1540,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
@@ -1571,7 +1566,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
@@ -1588,9 +1583,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";
}
@@ -1622,7 +1617,7 @@ element {
padding: 0px 2px;
}
element selected {
- background\-color: SteelBlue;
+ background-color: SteelBlue;
}
.fi
@@ -1636,18 +1631,18 @@ Just like CSS, \fBrofi\fP uses the box model for each widget.
.RS
.nf
-|\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-|
+|-----------------------------------------