mirror of https://github.com/davatorium/rofi.git
Improvements to rofi-theme manpage.
This commit is contained in:
Dave Davenport
parent
0c2c7972e9
commit
c4530f97ce
|
|
@ -117,6 +117,9 @@ It is advised to define the \fIglobal properties section\fR on top of the file t
|
|||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
If there are mulitple 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)
|
||||
.
|
||||
|
|
@ -218,7 +221,7 @@ The properties in a section consist of:
|
|||
Both fields are manditory 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 \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 support different type:
|
||||
|
|
@ -293,6 +296,9 @@ font: "Awasome 12";
|
|||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
The string must be valid utf\-8\.
|
||||
.
|
||||
.SH "Integer"
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
|
|
@ -387,10 +393,10 @@ Format: \fBrgb[a]({INTEGER},{INTEGER},{INTEGER}[, {PERCENTAGE}])\fR
|
|||
Format: \fBrgb[a]({INTEGER}%,{INTEGER}%,{INTEGER}%[, {PERCENTAGE}])\fR
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
Format: \fBhsl[a]( {ANGLE}, {PERCENTAGE}, {PERCENTAGE} [{PERCENTAGE}])\fR
|
||||
Format: \fBhsl[a]( {ANGLE}, {PERCENTAGE}, {PERCENTAGE} [, {PERCENTAGE}])\fR
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
Format: \fBhwb[a]( {ANGLE}, {PERCENTAGE}, {PERCENTAGE} [{PERCENTAGE}])\fR
|
||||
Format: \fBhwb[a]( {ANGLE}, {PERCENTAGE}, {PERCENTAGE} [, {PERCENTAGE}])\fR
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
Format: \fBcmyk( {PERCENTAGE}, {PERCENTAGE}, {PERCENTAGE}, {PERCENTAGE} [, {PERCENTAGE} ])\fR
|
||||
|
|
@ -595,9 +601,25 @@ Format: \fB{Distance} {Line style} {Distance} {Line style} {Distance} {Line styl
|
|||
Border 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|northeast|northweast|south|southwest|southeast)\fR
|
||||
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
|
||||
\-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\-
|
||||
south west | south | south east
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
|
|
@ -621,6 +643,25 @@ highlight: bold @pink;
|
|||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
But this is:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
* {
|
||||
myhigh: bold #FAA;
|
||||
}
|
||||
|
||||
#window {
|
||||
highlight: @myhigh;
|
||||
}
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.SH "Orientation"
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ to create their own rofi themes without the need to learn a new markup language.
|
|||
|
||||
## Encoding
|
||||
|
||||
The encoding of the file is utf-8. Both unix (`\n`) and windows (`\r\n`) newlines format are supported. But unix is
|
||||
The encoding of the file is utf-8. Both unix (`\n`) and windows (`\r\n`) newlines format are supported. But unix is
|
||||
preferred.
|
||||
|
||||
## Comments
|
||||
|
|
@ -91,6 +91,9 @@ make inheritance of properties clearer.
|
|||
}
|
||||
```
|
||||
|
||||
If there are mulitple sections with the same name, they are merged. Duplicate properties are overwritten and the last
|
||||
parsed entry kept.
|
||||
|
||||
## Global properties section
|
||||
|
||||
A theme can have one or more global properties sections (If there is more than one
|
||||
|
|
@ -166,7 +169,9 @@ Both fields are manditory for a property.
|
|||
|
||||
The `identifier` names the specified property. Identifiers can consist of any
|
||||
combination of numbers, letters and '-'. It must not contain any whitespace.
|
||||
The structure of the `value` defines the type of the property.
|
||||
The structure of the `value` defines the type of the property. The current
|
||||
parser does not define or enforce a certain type of a particular `identifier`.
|
||||
When used, values with the wrong type that cannot be converted, are ignored.
|
||||
|
||||
The current theme format support different type:
|
||||
|
||||
|
|
@ -199,6 +204,8 @@ For example:
|
|||
font: "Awasome 12";
|
||||
```
|
||||
|
||||
The string must be valid utf-8.
|
||||
|
||||
## Integer
|
||||
|
||||
* Format: `[-+]?[:digit:]+`
|
||||
|
|
@ -248,8 +255,8 @@ dynamic: false;
|
|||
* Format: `#{HEX}{8}` (rrggbbaa)
|
||||
* Format: `rgb[a]({INTEGER},{INTEGER},{INTEGER}[, {PERCENTAGE}])`
|
||||
* Format: `rgb[a]({INTEGER}%,{INTEGER}%,{INTEGER}%[, {PERCENTAGE}])`
|
||||
* Format: `hsl[a]( {ANGLE}, {PERCENTAGE}, {PERCENTAGE} [{PERCENTAGE}])`
|
||||
* Format: `hwb[a]( {ANGLE}, {PERCENTAGE}, {PERCENTAGE} [{PERCENTAGE}])`
|
||||
* Format: `hsl[a]( {ANGLE}, {PERCENTAGE}, {PERCENTAGE} [, {PERCENTAGE}])`
|
||||
* Format: `hwb[a]( {ANGLE}, {PERCENTAGE}, {PERCENTAGE} [, {PERCENTAGE}])`
|
||||
* Format: `cmyk( {PERCENTAGE}, {PERCENTAGE}, {PERCENTAGE}, {PERCENTAGE} [, {PERCENTAGE} ])`
|
||||
* Format: `{named-color} [ / {PERCENTAGE} ]`
|
||||
|
||||
|
|
@ -300,6 +307,8 @@ should be applied.
|
|||
* `strikethrough`: put a line through the highlighted text.
|
||||
* `small caps`: emphasise the text using capitalization.
|
||||
|
||||
> For some reason `small caps` is not working on some systems.
|
||||
|
||||
## Line style
|
||||
|
||||
* Format: `(dash|solid)`
|
||||
|
|
@ -366,7 +375,18 @@ style property.
|
|||
|
||||
## Position
|
||||
|
||||
* Format: `(center|east|north|west|northeast|northweast|south|southwest|southeast)`
|
||||
Indicate a place on the window/monitor.
|
||||
|
||||
* Format: `(center|east|north|west|south|north east|north west|south west|south east)`
|
||||
|
||||
```
|
||||
|
||||
north west | north | north east
|
||||
-------------|-------------|------------
|
||||
west | center | east
|
||||
-------------|-------------|------------
|
||||
south west | south | south east
|
||||
```
|
||||
|
||||
## Reference
|
||||
|
||||
|
|
@ -380,6 +400,18 @@ e.g. this is not valid:
|
|||
highlight: bold @pink;
|
||||
```
|
||||
|
||||
But this is:
|
||||
|
||||
```
|
||||
* {
|
||||
myhigh: bold #FAA;
|
||||
}
|
||||
|
||||
#window {
|
||||
highlight: @myhigh;
|
||||
}
|
||||
```
|
||||
|
||||
## Orientation
|
||||
|
||||
* Format: `(horizontal|vertical)`
|
||||
|
|
|
|||
Loading…
Reference in New Issue