diff options
author | Dave Davenport <qball@gmpclient.org> | 2020-01-02 12:00:44 +0100 |
---|---|---|
committer | Dave Davenport <qball@gmpclient.org> | 2020-01-02 12:00:44 +0100 |
commit | b44b5e8d16b673e473cd9cb4f59618676aedea7a (patch) | |
tree | a1bfb5984ccb1da83bccdc3336381c0fb16c13ec /doc | |
parent | 7650ed5d7a8ea2d8b048691183f7f0ef5d8b2513 (diff) |
Add -upgrade-config option.
* Print warning when old-style configuration is used.
* Add -upgrade-config option.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/rofi-theme-selector.1 | 2 | ||||
-rw-r--r-- | doc/rofi-theme.5 | 2453 | ||||
-rw-r--r-- | doc/rofi.1 | 6 | ||||
-rw-r--r-- | doc/rofi.1.markdown | 3 |
4 files changed, 1214 insertions, 1250 deletions
diff --git a/doc/rofi-theme-selector.1 b/doc/rofi-theme-selector.1 index 47d0bff7..b97550ce 100644 --- a/doc/rofi-theme-selector.1 +++ b/doc/rofi-theme-selector.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "ROFI\-THEME\-SELECTOR" "1" "January 2018" "" "" +.TH "ROFI\-THEME\-SELECTOR" "1" "December 2019" "" "" . .SH "NAME" \fBrofi\-theme\-selector\fR \- Preview and apply themes for \fBrofi\fR diff --git a/doc/rofi-theme.5 b/doc/rofi-theme.5 index 567dd5f3..43a22c78 100644 --- a/doc/rofi-theme.5 +++ b/doc/rofi-theme.5 @@ -1,193 +1,180 @@ -.TH ROFI\-THEME 5 rofi\-theme -.SH NAME -.PP -\fBrofi\-theme\fP \- Rofi theme format files - -.SH DESCRIPTION -.PP -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. Therefor, 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 -preferred. - -.SH Comments -.PP -C and C++ file comments are supported. - -.RS -.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. - -.RE - -.PP -Comments can be nested and the C comments can be inline. - -.PP +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "ROFI\-THEME" "5" "January 2020" "" "" +. +.SH "NAME" +\fBrofi\-theme\fR \- Rofi theme format files +. +.SH "DESCRIPTION" +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\. Therefor, a new file format has been created, replacing the old one\. +. +.SH "FORMAT SPECIFICATION" +. +.SH "Encoding" +The encoding of the file is utf\-8\. Both unix (\fB\en\fR) and windows (\fB\er\en\fR) newlines format are supported\. But unix is preferred\. +. +.SH "Comments" +C and C++ file comments are supported\. +. +.IP "\(bu" 4 +Anything after \fB//\fR and before a newline is considered a comment\. +. +.IP "\(bu" 4 +Everything between \fB/*\fR and \fB*/\fR is a comment\. +. +.IP "" 0 +. +.P +Comments can be nested and the C comments can be inline\. +. +.P The following is valid: - -.PP -.RS - +. +.IP "" 4 +. .nf -// Magic comment. -property: /* comment */ value; +// Magic comment\. +property: /* comment */ value; +. .fi -.RE - -.PP +. +.IP "" 0 +. +.P However, this is not: - -.PP -.RS - +. +.IP "" 4 +. .nf -prop/*comment*/erty: value; +prop/*comment*/erty: value; +. .fi -.RE - -.SH White space -.PP -White space and newlines, like comments, are ignored by the parser. - -.PP +. +.IP "" 0 +. +.SH "White space" +White space and newlines, like comments, are ignored by the parser\. +. +.P This: - -.PP -.RS - +. +.IP "" 4 +. .nf -property: name; +property: name; +. .fi -.RE - -.PP +. +.IP "" 0 +. +.P Is identical to: - -.PP -.RS - +. +.IP "" 4 +. .nf + property : name ; - +. .fi -.RE - -.SH File extension -.PP -The preferred file extension for the new theme format is \fBrasi\fP\&. This is an -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\&. - -.PP -It is advised to define the \fIglobal properties section\fP on top of the file to -make inheritance of properties clearer. - -.PP -.RS - +. +.IP "" 0 +. +.SH "File extension" +The preferred file extension for the new theme format is \fBrasi\fR\. This is an abbreviation for \fBr\fRofi \fBa\fRdvanced \fBs\fRtyle \fBi\fRnformation\. +. +.SH "Basic Structure" +Each element has a section with defined properties\. Global properties can be defined in section \fB* { }\fR\. Sub\-section names begin with a hash symbol \fB#\fR\. +. +.P +It is advised to define the \fIglobal properties section\fR on top of the file to make inheritance of properties clearer\. +. +.IP "" 4 +. .nf + /* Global properties section */ * { // list of properties } -/* Element theme section. */ +/* Element theme section\. */ {element path} { // list of properties } -{elements... } { +{elements\.\.\. } { // list of properties } - +. .fi -.RE - -.PP -If there are multiple sections with the same name, they are merged. Duplicate properties are overwritten and the last -parsed entry kept. - -.SH Global properties section -.PP -A theme can have one or more global properties sections. If there is more than one, -they will be merged. - -.PP -The global properties section denotes the defaults for each element. -Each property of this section can be referenced with \fB\fC@{identifier}\fR -(See Properties section) - -.PP -A global properties section is indicated with a \fB\fC*\fR as element path. - -.SH Element theme section -.PP -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\&. - -.PP +. +.IP "" 0 +. +.P +If there are multiple sections with the same name, they are merged\. Duplicate properties are overwritten and the last parsed entry kept\. +. +.SH "Global properties section" +A theme can have one or more global properties sections\. If there is more than one, they will be merged\. +. +.P +The global properties section denotes the defaults for each element\. Each property of this section can be referenced with \fB@{identifier}\fR (See Properties section) +. +.P +A global properties section is indicated with a \fB*\fR as element path\. +. +.SH "Element theme section" +A theme can have multiple element theme sections\. +. +.P +The element path can consist of multiple names separated by whitespace or dots\. Each element may contain any number of letters, numbers and \fB\-\fR\'s\. The first element in the element path should always start with a \fB#\fR\. Multiple elements can be specified by a \fB,\fR\. +. +.P This is a valid element name: - -.PP -.RS - +. +.IP "" 4 +. .nf -element normal.normal { + +element normal\.normal { background\-color: blue; } button { background\-color: blue; } - +. .fi -.RE - -.PP +. +.IP "" 0 +. +.P And is identical to: - -.PP -.RS - +. +.IP "" 4 +. .nf + element normal normal, button { 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. -In the following example: - -.PP -.RS - +. +.IP "" 0 +. +.P +Each section inherits the global properties\. Properties can be explicitly inherited from their parent with the \fBinherit\fR keyword\. In the following example: +. +.IP "" 4 +. .nf + window { a: 1; b: 2; @@ -198,500 +185,507 @@ mainbox { b: 4; c: 8; } - +. .fi -.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): - -.PP -.RS - +. +.IP "" 0 +. +.P +The element \fBmainbox\fR will have the following set of properties (if \fBmainbox\fR is a child of \fBwindow\fR): +. +.IP "" 4 +. .nf + a: 1; b: 4; c: 8; - +. .fi -.RE - -.PP -If multiple sections are defined with the same name, they are merged by the -parser. If multiple properties with the same name are defined in one section, -the last encountered property is used. - -.SH Properties Format -.PP +. +.IP "" 0 +. +.P +If multiple sections are defined with the same name, they are merged by the parser\. If multiple properties with the same name are defined in one section, the last encountered property is used\. +. +.SH "Properties Format" The properties in a section consist of: - -.PP -.RS - +. +.IP "" 4 +. .nf -{identifier}: {value}; +{identifier}: {value}; +. .fi -.RE - -.PP -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. -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. - -.PP +. +.IP "" 0 +. +.P +Both fields are mandatory for a property\. +. +.P +The \fBidentifier\fR names the specified property\. Identifiers can consist of any combination of numbers, letters and \'\-\'\. It must not contain any whitespace\. The structure of the \fBvalue\fR defines the type of the property\. The current parser does not define or enforce a certain type of a particular \fBidentifier\fR\. When used, values with the wrong type that cannot be converted are ignored\. +. +.P The current theme format supports different types: - -.RS -.IP \(bu 2 +. +.IP "\(bu" 4 a string -.IP \(bu 2 +. +.IP "\(bu" 4 an integer number -.IP \(bu 2 +. +.IP "\(bu" 4 a fractional number -.IP \(bu 2 +. +.IP "\(bu" 4 a boolean value -.IP \(bu 2 +. +.IP "\(bu" 4 a color -.IP \(bu 2 +. +.IP "\(bu" 4 text style -.IP \(bu 2 +. +.IP "\(bu" 4 line style -.IP \(bu 2 +. +.IP "\(bu" 4 a distance -.IP \(bu 2 +. +.IP "\(bu" 4 a padding -.IP \(bu 2 +. +.IP "\(bu" 4 a border -.IP \(bu 2 +. +.IP "\(bu" 4 a position -.IP \(bu 2 +. +.IP "\(bu" 4 a reference -.IP \(bu 2 +. +.IP "\(bu" 4 an orientation -.IP \(bu 2 +. +.IP "\(bu" 4 a list of keywords -.IP \(bu 2 +. +.IP "\(bu" 4 an environment variable -.IP \(bu 2 +. +.IP "\(bu" 4 Inherit - -.RE - -.PP -Some of these types are a combination of other types. - -.SH String -.RS -.IP \(bu 2 -Format: \fB\fC"[:print:]+"\fR - -.RE - -.PP -A string is always surrounded by double quotes (\fB\fC"\fR). Between the quotes there can be any printable character. - -.PP +. +.IP "" 0 +. +.P +Some of these types are a combination of other types\. +. +.SH "String" +. +.IP "\(bu" 4 +Format: \fB"[:print:]+"\fR +. +.IP "" 0 +. +.P +A string is always surrounded by double quotes (\fB"\fR)\. Between the quotes there can be any printable character\. +. +.P For example: - -.PP -.RS - +. +.IP "" 4 +. .nf -font: "Awasome 12"; +font: "Awasome 12"; +. .fi -.RE - -.PP -The string must be valid UTF\-8. - -.SH Integer -.RS -.IP \(bu 2 -Format: \fB\fC[\-+]?[:digit:]+\fR - -.RE - -.PP -An integer may contain any number. - -.PP +. +.IP "" 0 +. +.P +The string must be valid UTF\-8\. +. +.SH "Integer" +. +.IP "\(bu" 4 +Format: \fB[\-+]?[:digit:]+\fR +. +.IP "" 0 +. +.P +An integer may contain any number\. +. +.P For examples: - -.PP -.RS - +. +.IP "" 4 +. .nf -lines: 12; +lines: 12; +. .fi -.RE - -.SH Real -.RS -.IP \(bu 2 -Format: \fB\fC[\-+]?[:digit:]+(\\.[:digit:]+)?\fR - -.RE - -.PP -A real is an integer with an optional fraction. - -.PP +. +.IP "" 0 +. +.SH "Real" +. +.IP "\(bu" 4 +Format: \fB[\-+]?[:digit:]+(\e\.[:digit:]+)?\fR +. +.IP "" 0 +. +.P +A real is an integer with an optional fraction\. +. +.P For example: - -.PP -.RS - +. +.IP "" 4 +. .nf -real: 3.4; +real: 3\.4; +. .fi -.RE - -.PP -The following is not valid: \fB\fC\&.3\fR, \fB\fC3.\fR or scientific notation: \fB\fC3.4e\-3\fR\&. - -.SH Boolean -.RS -.IP \(bu 2 -Format: \fB\fC(true|false)\fR - -.RE - -.PP -Boolean value is either \fB\fCtrue\fR or \fB\fCfalse\fR\&. This is case\-\&sensitive. - -.PP +. +.IP "" 0 +. +.P +The following is not valid: \fB\.3\fR, \fB3\.\fR or scientific notation: \fB3\.4e\-3\fR\. +. +.SH "Boolean" +. +.IP "\(bu" 4 +Format: \fB(true|false)\fR +. +.IP "" 0 +. +.P +Boolean value is either \fBtrue\fR or \fBfalse\fR\. This is case\-sensitive\. +. +.P For example: - -.PP -.RS - +. +.IP "" 4 +. .nf -dynamic: false; +dynamic: false; +. .fi -.RE - -.SH Color -.PP -\fBrofi\fP supports the color formats as specified in the CSS standard (1,2,3 and some of CSS 4) - -.RS -.IP \(bu 2 -Format: \fB\fC#{HEX}{3}\fR (rgb) -.IP \(bu 2 -Format: \fB\fC#{HEX}{4}\fR (rgba) -.IP \(bu 2 -Format: \fB\fC#{HEX}{6}\fR (rrggbb) -.IP \(bu 2 -Format: \fB\fC#{HEX}{8}\fR (rrggbbaa) -.IP \(bu 2 -Format: \fB\fCrgb[a]({INTEGER},{INTEGER},{INTEGER}[, {PERCENTAGE}])\fR -.IP \(bu 2 -Format: \fB\fCrgb[a]({INTEGER}%,{INTEGER}%,{INTEGER}%[, {PERCENTAGE}])\fR -.IP \(bu 2 -Format: \fB\fChsl[a]( {ANGLE}, {PERCENTAGE}, {PERCENTAGE} [, {PERCENTAGE}])\fR -.IP \(bu 2 -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 - -.RE - -.PP -The white\-space format proposed in CSS4 is also supported. - -.PP +. +.IP "" 0 +. +.SH "Color" +\fBrofi\fR supports the color formats as specified in the CSS standard (1,2,3 and some of CSS 4) +. +.IP "\(bu" 4 +Format: \fB#{HEX}{3}\fR (rgb) +. +.IP "\(bu" 4 +Format: \fB#{HEX}{4}\fR (rgba) +. +.IP "\(bu" 4 +Format: \fB#{HEX}{6}\fR (rrggbb) +. +.IP "\(bu" 4 +Format: \fB#{HEX}{8}\fR (rrggbbaa) +. +.IP "\(bu" 4 +Format: \fBrgb[a]({INTEGER},{INTEGER},{INTEGER}[, {PERCENTAGE}])\fR +. +.IP "\(bu" 4 +Format: \fBrgb[a]({INTEGER}%,{INTEGER}%,{INTEGER}%[, {PERCENTAGE}])\fR +. +.IP "\(bu" 4 +Format: \fBhsl[a]( {ANGLE}, {PERCENTAGE}, {PERCENTAGE} [, {PERCENTAGE}])\fR +. +.IP "\(bu" 4 +Format: \fBhwb[a]( {ANGLE}, {PERCENTAGE}, {PERCENTAGE} [, {PERCENTAGE}])\fR +. +.IP "\(bu" 4 +Format: \fBcmyk( {PERCENTAGE}, {PERCENTAGE}, {PERCENTAGE}, {PERCENTAGE} [, {PERCENTAGE} ])\fR +. +.IP "\(bu" 4 +Format: \fB{named\-color} [ / {PERCENTAGE} ]\fR +. +.IP "" 0 +. +.P +The white\-space format proposed in CSS4 is also supported\. +. +.P The different values are: - -.RS -.IP \(bu 2 -\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. -.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% -.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, -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, -DimGray, DimGrey, DodgerBlue, FireBrick, FloralWhite, ForestGreen, Fuchsia, Gainsboro, GhostWhite, Gold, GoldenRod, -Gray, Grey, Green, GreenYellow, HoneyDew, HotPink, IndianRed, Indigo, Ivory, Khaki, Lavender, LavenderBlush, LawnGreen, -LemonChiffon, LightBlue, LightCoral, LightCyan, LightGoldenRodYellow, LightGray, LightGrey, LightGreen, LightPink, -LightSalmon, LightSeaGreen, LightSkyBlue, LightSlateGray, LightSlateGrey, LightSteelBlue, LightYellow, Lime, LimeGreen, -Linen, Magenta, Maroon, MediumAquaMarine, MediumBlue, MediumOrchid, MediumPurple, MediumSeaGreen, MediumSlateBlue, -MediumSpringGreen, MediumTurquoise, MediumVioletRed, MidnightBlue, MintCream, MistyRose, Moccasin, NavajoWhite, Navy, -OldLace, Olive, OliveDrab, Orange, OrangeRed, Orchid, PaleGoldenRod, PaleGreen, PaleTurquoise, PaleVioletRed, -PapayaWhip, PeachPuff, Peru, Pink, Plum, PowderBlue, Purple, RebeccaPurple, Red, RosyBrown, RoyalBlue, SaddleBrown, -Salmon, SandyBrown, SeaGreen, SeaShell, Sienna, Silver, SkyBlue, SlateBlue, SlateGray, SlateGrey, Snow, SpringGreen, -SteelBlue, Tan, Teal, Thistle, Tomato, Turquoise, Violet, Wheat, White, WhiteSmoke, Yellow, YellowGreen,transparent - -.RE - -.PP +. +.IP "\(bu" 4 +\fB{HEX}\fR is a hexadecimal number (\'0\-9a\-f\' case insensitive)\. +. +.IP "\(bu" 4 +\fB{INTEGER}\fR value can be between 0 and 255 or 0\-100 when representing percentage\. +. +.IP "\(bu" 4 +\fB{ANGLE}\fR is the angle on the color wheel, can be in \fBdeg\fR, \fBrad\fR, \fBgrad\fR or \fBturn\fR\. When no unit is specified, degrees is assumed\. +. +.IP "\(bu" 4 +\fB{PERCENTAGE}\fR can be between 0\-1\.0, or 0%\-100% +. +.IP "\(bu" 4 +\fB{named\-color}\fR is one of the following colors: +. +.IP +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, DimGray, DimGrey, DodgerBlue, FireBrick, FloralWhite, ForestGreen, Fuchsia, Gainsboro, GhostWhite, Gold, GoldenRod, Gray, Grey, Green, GreenYellow, HoneyDew, HotPink, IndianRed, Indigo, Ivory, Khaki, Lavender, LavenderBlush, LawnGreen, LemonChiffon, LightBlue, LightCoral, LightCyan, LightGoldenRodYellow, LightGray, LightGrey, LightGreen, LightPink, LightSalmon, LightSeaGreen, LightSkyBlue, LightSlateGray, LightSlateGrey, LightSteelBlue, LightYellow, Lime, LimeGreen, Linen, Magenta, Maroon, MediumAquaMarine, MediumBlue, MediumOrchid, MediumPurple, MediumSeaGreen, MediumSlateBlue, MediumSpringGreen, MediumTurquoise, MediumVioletRed, MidnightBlue, MintCream, MistyRose, Moccasin, NavajoWhite, Navy, OldLace, Olive, OliveDrab, Orange, OrangeRed, Orchid, PaleGoldenRod, PaleGreen, PaleTurquoise, PaleVioletRed, PapayaWhip, PeachPuff, Peru, Pink, Plum, PowderBlue, Purple, RebeccaPurple, Red, RosyBrown, RoyalBlue, SaddleBrown, Salmon, SandyBrown, SeaGreen, SeaShell, Sienna, Silver, SkyBlue, SlateBlue, SlateGray, SlateGrey, Snow, SpringGreen, SteelBlue, Tan, Teal, Thistle, Tomato, Turquoise, Violet, Wheat, White, WhiteSmoke, Yellow, YellowGreen,transparent +. +.IP "" 0 +. +.P For example: - -.PP -.RS - +. +.IP "" 4 +. .nf + background\-color: #FF0000; -border\-color: rgba(0,0,1, 0.5); +border\-color: rgba(0,0,1, 0\.5); text\-color: SeaGreen; - +. .fi -.RE - -.PP +. +.IP "" 0 +. +.P or - -.PP -.RS - +. +.IP "" 4 +. .nf + background\-color: transparent; text\-color: Black; - +. .fi -.RE - -.SH Text style -.RS -.IP \(bu 2 -Format: \fB\fC(bold|italic|underline|strikethrough|none)\fR - -.RE - -.PP -Text style indicates how the highlighted text is emphasized. \fB\fCNone\fR indicates that no emphasis -should be applied. - -.RS -.IP \(bu 2 -\fB\fCbold\fR: make the text thicker then the surrounding text. -.IP \(bu 2 -\fB\fCitalic\fR: put the highlighted text in script type (slanted). -.IP \(bu 2 -\fB\fCunderline\fR: put a line under the highlighted text. -.IP \(bu 2 -\fB\fCstrikethrough\fR: put a line through the highlighted text. -.IP \(bu 2 -\fB\fCsmall caps\fR: emphasise the text using capitalization. - -.RE - -.PP -.RS - -.PP -For some reason \fB\fCsmall caps\fR does not work on some systems. -.RE - -.SH Line style -.RS -.IP \(bu 2 -Format: \fB\fC(dash|solid)\fR - -.RE - -.PP -Indicates how a line should be drawn. -It currently supports: - * \fB\fCdash\fR: a dashed line, where the gap is the same width as the dash - * \fB\fCsolid\fR: a solid line - -.SH Distance -.RS -.IP \(bu 2 -Format: \fB\fC{Integer}px\fR -.IP \(bu 2 -Format: \fB\fC{Real}em\fR -.IP \(bu 2 -Format: \fB\fC{Real}ch\fR -.IP \(bu 2 -Format: \fB\fC{Real}%\fR - -.RE - -.PP +. +.IP "" 0 +. +.SH "Text style" +. +.IP "\(bu" 4 +Format: \fB(bold|italic|underline|strikethrough|none)\fR +. +.IP "" 0 +. +.P +Text style indicates how the highlighted text is emphasized\. \fBNone\fR indicates that no emphasis should be applied\. +. +.IP "\(bu" 4 +\fBbold\fR: make the text thicker then the surrounding text\. +. +.IP "\(bu" 4 +\fBitalic\fR: put the highlighted text in script type (slanted)\. +. +.IP "\(bu" 4 +\fBunderline\fR: put a line under the highlighted text\. +. +.IP "\(bu" 4 +\fBstrikethrough\fR: put a line through the highlighted text\. +. +.IP "\(bu" 4 +\fBsmall caps\fR: emphasise the text using capitalization\. +. +.IP "" 0 +. +.SH "Line style" +. +.IP "\(bu" 4 +Format: \fB(dash|solid)\fR +. +.IP "" 0 +. +.P +Indicates how a line should be drawn\. It currently supports: * \fBdash\fR: a dashed line, where the gap is the same width as the dash * \fBsolid\fR: a solid line +. +.SH "Distance" +. +.IP "\(bu" 4 +Format: \fB{Integer}px\fR +. +.IP "\(bu" 4 +Format: \fB{Real}em\fR +. +.IP "\(bu" 4 +Format: \fB{Real}ch\fR +. +.IP "\(bu" 4 +Format: \fB{Real}%\fR +. +.IP "" 0 +. +.P A distance can be specified in 3 different units: - -.RS -.IP \(bu 2 -\fB\fCpx\fR: Screen pixels. -.IP \(bu 2 -\fB\fCem\fR: Relative to text height. -.IP \(bu 2 -\fB\fCch\fR: Relative to width of a single number. -.IP \(bu 2 -\fB\fC%\fR: Percentage of the \fBmonitor\fP size. - -.RE - -.PP -Distances used in the horizontal direction use the monitor width. Distances in -the vertical direction use the monitor height. -For example: - -.PP -.RS - +. +.IP "\(bu" 4 +\fBpx\fR: Screen pixels\. +. +.IP "\(bu" 4 +\fBem\fR: Relative to text height\. +. +.IP "\(bu" 4 +\fBch\fR: Relative to width of a single number\. +. +.IP "\(bu" 4 +\fB%\fR: Percentage of the \fBmonitor\fR size\. +. +.IP "" 0 +. +.P +Distances used in the horizontal direction use the monitor width\. Distances in the vertical direction use the monitor height\. For example: +. +.IP "" 4 +. .nf - padding: 10%; + padding: 10%; +. .fi -.RE - -.PP -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. - -.SH Padding -.RS -.IP \(bu 2 -Format: \fB\fC{Integer}\fR -.IP \(bu 2 -Format: \fB\fC{Distance}\fR -.IP \(bu 2 -Format: \fB\fC{Distance} {Distance}\fR -.IP \(bu 2 -Format: \fB\fC{Distance} {Distance} {Distance}\fR -.IP \(bu 2 -Format: \fB\fC{Distance} {Distance} {Distance} {Distance}\fR - -.RE - -.PP -If no unit is specified, pixels are assumed. - -.PP +. +.IP "" 0 +. +.P +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\. +. +.SH "Padding" +. +.IP "\(bu" 4 +Format: \fB{Integer}\fR +. +.IP "\(bu" 4 +Format: \fB{Distance}\fR +. +.IP "\(bu" 4 +Format: \fB{Distance} {Distance}\fR +. +.IP "\(bu" 4 +Format: \fB{Distance} {Distance} {Distance}\fR +. +.IP "\(bu" 4 +Format: \fB{Distance} {Distance} {Distance} {Distance}\fR +. +.IP "" 0 +. +.P +If no unit is specified, pixels are assumed\. +. +.P The different number of fields in the formats are parsed like: - -.RS -.IP \(bu 2 -1 field: \fB\fCall\fR -.IP \(bu 2 -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 -.IP \(bu 2 -4 fields: \fB\fCtop\fR, \fB\fCright\fR, \fB\fCbottom\fR, \fB\fCleft\fR - -.RE - -.SH Border -.RS -.IP \(bu 2 -Format: \fB\fC{Integer}\fR -.IP \(bu 2 -Format: \fB\fC{Distance}\fR -.IP \(bu 2 -Format: \fB\fC{Distance} {Distance}\fR -.IP \(bu 2 -Format: \fB\fC{Distance} {Distance} {Distance}\fR -.IP \(bu 2 -Format: \fB\fC{Distance} {Distance} {Distance} {Distance}\fR -.IP \(bu 2 -Format: \fB\fC{Distance} {Line style}\fR -.IP \(bu 2 -Format: \fB\fC{Distance} {Line style} {Distance} {Line style}\fR -.IP \(bu 2 -Format: \fB\fC{Distance} {Line style} {Distance} {Line style} {Distance} {Line style}\fR -.IP \(bu 2 -Format: \fB\fC{Distance} {Line style} {Distance} {Line style} {Distance} {Line style} {Distance} {Line style}\fR - -.RE - -.PP -Borders are identical to padding, except that each distance field has a line -style property. - -.PP -.RS - -.PP -When no unit is specified, pixels are assumed. -.RE - -.SH Position -.PP -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 - +. +.IP "\(bu" 4 +1 field: \fBall\fR +. +.IP "\(bu" 4 +2 fields: \fBtop&bottom\fR \fBleft&right\fR +. +.IP "\(bu" 4 +3 fields: \fBtop\fR, \fBleft&right\fR, \fBbottom\fR +. +.IP "\(bu" 4 +4 fields: \fBtop\fR, \fBright\fR, \fBbottom\fR, \fBleft\fR +. +.IP "" 0 +. +.SH "Border" +. +.IP "\(bu" 4 +Format: \fB{Integer}\fR +. +.IP "\(bu" 4 +Format: \fB{Distance}\fR +. +.IP "\(bu" 4 +Format: \fB{Distance} {Distance}\fR +. +.IP "\(bu" 4 +Format: \fB{Distance} {Distance} {Distance}\fR +. +.IP "\(bu" 4 +Format: \fB{Distance} {Distance} {Distance} {Distance}\fR +. +.IP "\(bu" 4 +Format: \fB{Distance} {Line style}\fR +. +.IP "\(bu" 4 +Format: \fB{Distance} {Line style} {Distance} {Line style}\fR +. +.IP "\(bu" 4 +Format: \fB{Distance} {Line style} {Distance} {Line style} {Distance} {Line style}\fR +. +.IP "\(bu" 4 +Format: \fB{Distance} {Line style} {Distance} {Line style} {Distance} {Line style} {Distance} {Line style}\fR +. +.IP "" 0 +. +.P +Borders are identical to padding, except that each distance field has a line style property\. +. +.SH "Position" +Indicate a place on the window/monitor\. +. +.IP "\(bu" 4 +Format: \fB(center|east|north|west|south|north east|north west|south west|south east)\fR +. +.IP "" 0 +. +.IP "" 4 +. .nf + north west | north | north east \-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\- - west | center | east + west | center | east \-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\- south west | south | south east - +. .fi -.RE - -.RE - -.SH Visibility -.PP +. +.IP "" 0 +. +.SH "Visibility" It is possible to hide widgets: - -.PP -inputbar { - enabled: false; -} - -.SH Reference -.RS -.IP \(bu 2 -Format: \fB\fC@{PROPERTY NAME}\fR - -.RE - -.PP -A reference can point to another reference. Currently, the maximum number of redirects is 20. -A property always refers to another property. It cannot be used for a subpart of the property. -For example, this is not valid: - -.PP -.RS - +. +.P +inputbar { enabled: false; } +. +.SH "Reference" +. +.IP "\(bu" 4 +Format: \fB@{PROPERTY NAME}\fR +. +.IP "" 0 +. +.P +A reference can point to another reference\. Currently, the maximum number of redirects is 20\. A property always refers to another property\. It cannot be used for a subpart of the property\. For example, this is not valid: +. +.IP "" 4 +. .nf -highlight: bold @pink; +highlight: bold @pink; +. .fi -.RE - -.PP +. < |