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

Update rofi-theme manpage

Browse source 
- Add orientation data type.
 - Add layout field to listview.
This commit is contained in:
Dave Davenport 2017-07-25 08:13:07 +02:00
parent 474e3b3d63
commit 89c6a0f00b
2 changed files with 115 additions and 85 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

129
doc/rofi-theme.5
View file

@ -260,6 +260,9 @@ a position\.
a reference\. a reference\.
. .
.IP "\(bu" 4 .IP "\(bu" 4
an orientation\.
.
.IP "\(bu" 4
a list of keywords\. a list of keywords\.
. .
.IP "" 0 .IP "" 0
@ -618,6 +621,16 @@ highlight: bold @pink;
. .
.IP "" 0 .IP "" 0
. .
.SH "Orientation"
.
.IP "\(bu" 4
Format: \fB(horizontal|vertical)\fR
.
.IP "" 0
.
.P
Specify an orientation of the widget\.
.
.SH "List of keywords" .SH "List of keywords"
. .
.IP "\(bu" 4 .IP "\(bu" 4
@ -872,6 +885,9 @@ The following properties are currently supports:
.SS "box:" .SS "box:"
. .
.IP "\(bu" 4 .IP "\(bu" 4
\fBorientation\fR: orientation Set the direction the elements are packed\.
.
.IP "\(bu" 4
\fBspacing\fR: distance Distance between the packed elements\. \fBspacing\fR: distance Distance between the packed elements\.
. .
.IP "" 0 .IP "" 0
@ -888,7 +904,7 @@ The following properties are currently supports:
\fBtext\fR: The text color to use (falls back to foreground if not set) \fBtext\fR: The text color to use (falls back to foreground if not set)
. .
.IP "\(bu" 4 .IP "\(bu" 4
\fBhighlight\fR: highlight {color} Color is optional, multiple highlight styles can be added like: bold underlinei italic #000000; \fBhighlight\fR: Text Style {color} Color is optional, multiple highlight styles can be added like: bold underline italic #000000;
. .
.IP "" 0 .IP "" 0
. .
@ -918,60 +934,8 @@ The following properties are currently supports:
.IP "\(bu" 4 .IP "\(bu" 4
\fBlines\fR: integer Number of rows to show in the list view\. \fBlines\fR: integer Number of rows to show in the list view\.
. .
.IP "" 0 .IP "\(bu" 4
. \fBlayout\fR: orientation Indicate how elements are stacked\. Horizontal implements the dmenu style\.
.SH "DEBUGGING"
To get debug information from the parser run rofi like:
.
.IP "" 4
.
.nf
G_MESSAGES_DEBUG=Parser rofi \-show run
.
.fi
.
.IP "" 0
.
.P
Syntax errors are shown in a popup and printed out to commandline with the above command\.
.
.P
To see the elements queried during running, run:
.
.IP "" 4
.
.nf
G_MESSAGES_DEBUG=Theme rofi \-show run
.
.fi
.
.IP "" 0
.
.P
To test minor changes, part of the theme can be passed on the commandline, for example to set it fullscreen:
.
.IP "" 4
.
.nf
rofi \-theme\-str \'#window { fullscreen:true;}\' \-show run
.
.fi
.
.IP "" 0
.
.P
To print the current theme run:
.
.IP "" 4
.
.nf
rofi \-dump\-theme
.
.fi
. .
.IP "" 0 .IP "" 0
. .
@ -1216,6 +1180,61 @@ More dynamic spacing can be achieved by adding dummy widgets, for example to get
.P .P
If both dummy widgets are set to expanding, \fBchild\fR will be centered\. Depending on the \fBexpand\fR flag of child the remaining space will be equally divided between both dummy and child widget (expand enabled), or both dummy widgets (expand disabled)\. If both dummy widgets are set to expanding, \fBchild\fR will be centered\. Depending on the \fBexpand\fR flag of child the remaining space will be equally divided between both dummy and child widget (expand enabled), or both dummy widgets (expand disabled)\.
. .
.SH "DEBUGGING"
To get debug information from the parser run rofi like:
.
.IP "" 4
.
.nf
G_MESSAGES_DEBUG=Parser rofi \-show run
.
.fi
.
.IP "" 0
.
.P
Syntax errors are shown in a popup and printed out to commandline with the above command\.
.
.P
To see the elements queried during running, run:
.
.IP "" 4
.
.nf
G_MESSAGES_DEBUG=Theme rofi \-show run
.
.fi
.
.IP "" 0
.
.P
To test minor changes, part of the theme can be passed on the commandline, for example to set it fullscreen:
.
.IP "" 4
.
.nf
rofi \-theme\-str \'#window { fullscreen:true;}\' \-show run
.
.fi
.
.IP "" 0
.
.P
To print the current theme run:
.
.IP "" 4
.
.nf
rofi \-dump\-theme
.
.fi
.
.IP "" 0
.
.SH "EXAMPLES" .SH "EXAMPLES"
Several examples are installed together with \fBrofi\fR\. These can be found in \fB{datadir}/rofi/themes/\fR where \fB{datadir}\fR is the install path of \fBrofi\fR data\. When installed using a package manager this is usually: \fB/usr/share/\fR\. Several examples are installed together with \fBrofi\fR\. These can be found in \fB{datadir}/rofi/themes/\fR where \fB{datadir}\fR is the install path of \fBrofi\fR data\. When installed using a package manager this is usually: \fB/usr/share/\fR\.
. .

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

@ -182,6 +182,7 @@ The current theme format support different type:
* a border. * a border.
* a position. * a position.
* a reference. * a reference.
* an orientation.
* a list of keywords. * a list of keywords.
Some of these types are a combination of other types. Some of these types are a combination of other types.
@ -379,6 +380,12 @@ e.g. this is not valid:
highlight: bold @pink; highlight: bold @pink;
``` ```
## Orientation
* Format: `(horizontal|vertical)`
Specify an orientation of the widget.
## List of keywords ## List of keywords
* Format: `[ keyword, keyword ]` * Format: `[ keyword, keyword ]`
@ -543,6 +550,8 @@ The following properties are currently supports:
### box: ### box:
* **orientation**: orientation
Set the direction the elements are packed.
* **spacing**: distance * **spacing**: distance
Distance between the packed elements. Distance between the packed elements.
@ -551,8 +560,8 @@ The following properties are currently supports:
* **background**: color * **background**: color
* **foreground**: color * **foreground**: color
* **text**: The text color to use (falls back to foreground if not set) * **text**: The text color to use (falls back to foreground if not set)
* **highlight**: highlight {color} * **highlight**: Text Style {color}
Color is optional, multiple highlight styles can be added like: bold underlinei italic #000000; Color is optional, multiple highlight styles can be added like: bold underline italic #000000;
### listview: ### listview:
* **columns**: integer * **columns**: integer
@ -571,34 +580,8 @@ The following properties are currently supports:
Spacing between the elements (both vertical and horizontal) Spacing between the elements (both vertical and horizontal)
* **lines**: integer * **lines**: integer
Number of rows to show in the list view. Number of rows to show in the list view.
* **layout**: orientation
## DEBUGGING Indicate how elements are stacked. Horizontal implements the dmenu style.
To get debug information from the parser run rofi like:
```
G_MESSAGES_DEBUG=Parser rofi -show run
```
Syntax errors are shown in a popup and printed out to commandline with the above command.
To see the elements queried during running, run:
```
G_MESSAGES_DEBUG=Theme rofi -show run
```
To test minor changes, part of the theme can be passed on the commandline, for example to set it fullscreen:
```
rofi -theme-str '#window { fullscreen:true;}' -show run
```
To print the current theme run:
```
rofi -dump-theme
```
## Layout ## Layout
@ -791,6 +774,34 @@ If both dummy widgets are set to expanding, `child` will be centered. Depending
remaining space will be equally divided between both dummy and child widget (expand enabled), or both dummy widgets remaining space will be equally divided between both dummy and child widget (expand enabled), or both dummy widgets
(expand disabled). (expand disabled).
## DEBUGGING
To get debug information from the parser run rofi like:
```
G_MESSAGES_DEBUG=Parser rofi -show run
```
Syntax errors are shown in a popup and printed out to commandline with the above command.
To see the elements queried during running, run:
```
G_MESSAGES_DEBUG=Theme rofi -show run
```
To test minor changes, part of the theme can be passed on the commandline, for example to set it fullscreen:
```
rofi -theme-str '#window { fullscreen:true;}' -show run
```
To print the current theme run:
```
rofi -dump-theme
```
## EXAMPLES ## EXAMPLES