summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDave Davenport <qball@gmpclient.org>2019-12-29 17:30:53 +0100
committerDave Davenport <qball@gmpclient.org>2019-12-29 17:30:53 +0100
commitafda9cbb13c34d04cf2f32d24cc4fda00b8fb292 (patch)
tree2b04c7719fb0fd34a2d566c1916fe74f96059343 /doc
parent0a4426af294dfdc22cd58ad27157b19894656476 (diff)
[Doc] Update theme manpage with import.
Diffstat (limited to 'doc')
-rw-r--r--doc/rofi-theme.547
-rw-r--r--doc/rofi-theme.5.markdown25
2 files changed, 72 insertions, 0 deletions
diff --git a/doc/rofi-theme.5 b/doc/rofi-theme.5
index 55f585cf..0a9229dc 100644
--- a/doc/rofi-theme.5
+++ b/doc/rofi-theme.5
@@ -1511,6 +1511,53 @@ It supports the following keys as constraint:
.RE
+.SH Multiple file handling
+.PP
+The rasi file format offers two methods of including other files.
+This can be used to modify existing themes, or have multiple variations on a theme.
+
+.RS
+.IP \(bu 2
+import: Import and parse a second file.
+.IP \(bu 2
+theme: Discard theme, and load file as a fresh theme.
+
+.RE
+
+.PP
+Syntax:
+
+.PP
+.RS
+
+.nf
+@import "myfile"
+@theme "mytheme"
+
+.fi
+.RE
+
+.PP
+The specified file can either by \fIname\fP, \fIfilename\fP,\fIfull path\fP\&.
+
+.PP
+If a filename is provided, it will try to resolve it in the following order:
+
+.RS
+.IP \(bu 2
+\fB\fC${XDG\_CONFIG\_HOME}/rofi/themes/\fR
+.IP \(bu 2
+\fB\fC${XDG\_CONFIG\_HOME}/rofi/\fR
+.IP \(bu 2
+\fB\fC${XDG\_DATA\_HOME}/rofi/themes/\fR
+.IP \(bu 2
+\fB\fC${INSTALL PREFIX}/share/rofi/themes/\fR
+
+.RE
+
+.PP
+A name is resolved as a filename by appending the \fB\fC\&.rasi\fR extension.
+
.SH EXAMPLES
.PP
Several examples are installed together with \fBrofi\fP\&. These can be found in \fB\fC{datadir}/rofi/themes/\fR, where
diff --git a/doc/rofi-theme.5.markdown b/doc/rofi-theme.5.markdown
index c1f05e20..7512c11a 100644
--- a/doc/rofi-theme.5.markdown
+++ b/doc/rofi-theme.5.markdown
@@ -956,6 +956,31 @@ It supports the following keys as constraint:
* `monitor-id`: The monitor id, see rofi -help for id's.
+## Multiple file handling
+
+The rasi file format offers two methods of including other files.
+This can be used to modify existing themes, or have multiple variations on a theme.
+
+ * import: Import and parse a second file.
+ * theme: Discard theme, and load file as a fresh theme.
+
+Syntax:
+
+```
+@import "myfile"
+@theme "mytheme"
+```
+
+The specified file can either by *name*, *filename*,*full path*.
+
+If a filename is provided, it will try to resolve it in the following order:
+
+ * `${XDG_CONFIG_HOME}/rofi/themes/`
+ * `${XDG_CONFIG_HOME}/rofi/`
+ * `${XDG_DATA_HOME}/rofi/themes/`
+ * `${INSTALL PREFIX}/share/rofi/themes/`
+
+A name is resolved as a filename by appending the `.rasi` extension.