summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDave Davenport <qball@gmpclient.org>2017-04-04 08:38:21 +0200
committerDave Davenport <qball@gmpclient.org>2017-04-04 08:38:21 +0200
commitb8dff89b87860b121fe696e006990a2a773c6108 (patch)
tree6e8529906b98c544d22f9bd97cc8977bfb8670be /doc
parent358759e0ab43321bd250af3c731c629c94a91b06 (diff)
rofi-theme manpage updates
Diffstat (limited to 'doc')
-rw-r--r--doc/rofi-theme-manpage.markdown40
-rw-r--r--doc/rofi-theme.560
2 files changed, 99 insertions, 1 deletions
diff --git a/doc/rofi-theme-manpage.markdown b/doc/rofi-theme-manpage.markdown
index 1915f9e4..36c7ca3a 100644
--- a/doc/rofi-theme-manpage.markdown
+++ b/doc/rofi-theme-manpage.markdown
@@ -73,7 +73,7 @@ Each element has a section with defined properties. Properties can be inherited
to sub-sections. Global properties can be defined in section `* { }`.
Sub-section names begin with a hash symbol `#`.
-It is advised to define the *global properties section* on top of the file to
+It is advised to define the *global properties section* on top of the file to
make inheritance of properties clearer.
```
@@ -530,3 +530,41 @@ The following properties are currently supports:
Spacing between the elements (both vertical and horizontal)
* **lines**: integer
Number of rows to show in the list view.
+
+## 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
+
+Several examples are installed together with **rofi**. These can be found in `{prefix}/share/rofi/themes/` where
+`{prefix}` is the install path of **rofi**. When installed using a package manager this usually: `/usr/`.
+
+## SEE ALSO
+
+rofi(1)
+
diff --git a/doc/rofi-theme.5 b/doc/rofi-theme.5
index e26c98bd..eb6b1a11 100644
--- a/doc/rofi-theme.5
+++ b/doc/rofi-theme.5
@@ -849,4 +849,64 @@ The following properties are currently supports:
\fBlines\fR: integer Number of rows to show in the list view\.
.
.IP "" 0
+.
+.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"
+Several examples are installed together with \fBrofi\fR\. These can be found in \fB{prefix}/share/rofi/themes/\fR where \fB{prefix}\fR is the install path of \fBrofi\fR\. When installed using a package manager this usually: \fB/usr/\fR\.
+.
+.SH "SEE ALSO"
+rofi(1)