summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDave Davenport <qball@gmpclient.org>2017-11-05 15:28:17 +0100
committerDave Davenport <qball@gmpclient.org>2017-11-05 15:28:17 +0100
commit74106921f448854baa545a2bb188bf9c39cd4638 (patch)
tree16bafc2e51fb76152f69d6c5dd47f5b70fc1fbc0 /doc
parentac91da123cfcaf5e75c6d6e7547aeddb80253009 (diff)
Install rofi-theme-selector manpage.
Diffstat (limited to 'doc')
-rw-r--r--doc/meson.build1
-rw-r--r--doc/rofi-theme-selector.149
-rw-r--r--doc/rofi-theme-selector.1.markdown (renamed from doc/rofi-theme-selector.1.md)0
-rw-r--r--doc/rofi-theme.590
-rw-r--r--doc/rofi.116
5 files changed, 112 insertions, 44 deletions
diff --git a/doc/meson.build b/doc/meson.build
index f3c5443e..ef489afa 100644
--- a/doc/meson.build
+++ b/doc/meson.build
@@ -3,6 +3,7 @@ if ronn.found()
run_target('update-manpage',
command: [ ronn, '--roff', files(
'rofi.1.markdown',
+ 'rofi-theme-selector.1.markdown',
'rofi-theme.5.markdown',
)]
)
diff --git a/doc/rofi-theme-selector.1 b/doc/rofi-theme-selector.1
new file mode 100644
index 00000000..95499dd5
--- /dev/null
+++ b/doc/rofi-theme-selector.1
@@ -0,0 +1,49 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "ROFI\-THEME\-SELECTOR" "1" "November 2017" "" ""
+.
+.SH "NAME"
+\fBrofi\-theme\-selector\fR \- Preview and apply themes for \fBrofi\fR
+.
+.SH "DESCRIPTION"
+\fBrofi\-theme\-selector\fR is a bash/rofi script to preview and apply themes for \fBrofi\fR\. It\'s part of any installation of \fBrofi\fR\.
+.
+.SH "USAGE"
+.
+.SS "Running rofi\-theme\-selector"
+\fBrofi\-theme\-selector\fR shows a list of all available themes in a \fBrofi\fR window\. It lets you preview each theme with the Enter key and apply the theme to your \fBrofi\fR configuration file with Alt+a\.
+.
+.SH "Theme directories"
+\fBrofi\-theme\-selector\fR searches the following directories for themes:
+.
+.IP "\(bu" 4
+${PREFIX}/share/rofi/themes
+.
+.IP "\(bu" 4
+$XDG_CONFIG_HOME/rofi
+.
+.IP "\(bu" 4
+$XDG_DATA_HOME/share/rofi/themes
+.
+.IP "" 0
+.
+.P
+${PREFIX} reflects the install location of rofi\. In most cases this will be "/usr"\. $XDG_CONFIG_HOME is normally unset\. Default path is "$HOME/\.config"\. $XDG_DATA_HOME is normally unset\. Default path is "$HOME/\.local/share"\.
+.
+.P
+SEE ALSO rofi(1)
+.
+.P
+AUTHOR Qball Cow qball@gmpclient\.org
+.
+.IP "" 4
+.
+.nf
+
+ Rasmus Steinke rasi@xssn\.at
+.
+.fi
+.
+.IP "" 0
+
diff --git a/doc/rofi-theme-selector.1.md b/doc/rofi-theme-selector.1.markdown
index 985a9597..985a9597 100644
--- a/doc/rofi-theme-selector.1.md
+++ b/doc/rofi-theme-selector.1.markdown
diff --git a/doc/rofi-theme.5 b/doc/rofi-theme.5
index 747f532d..98172ba4 100644
--- a/doc/rofi-theme.5
+++ b/doc/rofi-theme.5
@@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
-.TH "ROFI\-THEME" "5" "October 2017" "" ""
+.TH "ROFI\-THEME" "5" "November 2017" "" ""
.
.SH "NAME"
\fBrofi\-theme\fR \- Rofi theme format files
@@ -106,10 +106,10 @@ It is advised to define the \fIglobal properties section\fR on top of the file t
}
/* Element theme section\. */
-#{element path} {
+{element path} {
// list of properties
}
-#{elements\.\.\. } {
+{elements\.\.\. } {
// list of properties
}
.
@@ -142,10 +142,10 @@ This is a valid element name:
.
.nf
-#element normal\.normal {
+element normal\.normal {
background\-color: blue;
}
-#button {
+button {
background\-color: blue;
}
.
@@ -160,7 +160,7 @@ And is identical to:
.
.nf
-#element normal normal, button {
+element normal normal, button {
background\-color: blue;
}
.
@@ -175,11 +175,11 @@ Each section inherits the global properties\. Properties can be explicitely inhe
.
.nf
-#window {
+window {
a: 1;
b: 2;
}
-#mainbox {
+mainbox {
a: inherit;
b: 4;
c: 8;
@@ -190,7 +190,7 @@ Each section inherits the global properties\. Properties can be explicitely inhe
.IP "" 0
.
.P
-The element \fB#mainbox\fR will have the following set of properties (if \fBmainbox\fR is a child of \fBwindow\fR):
+The element \fBmainbox\fR will have the following set of properties (if \fBmainbox\fR is a child of \fBwindow\fR):
.
.IP "" 4
.
@@ -649,6 +649,12 @@ south west | south | south east
.
.IP "" 0
.
+.SH "Visibility"
+It is possible to hide widgets:
+.
+.P
+inputbar { enabled: false; }
+.
.SH "Reference"
.
.IP "\(bu" 4
@@ -680,7 +686,7 @@ But this is:
myhigh: bold #FAA;
}
-#window {
+window {
highlight: @myhigh;
}
.
@@ -722,7 +728,7 @@ Inherits the property from its parent widget\.
.
.nf
-#mainbox {
+mainbox {
border\-color: inherit;
}
.
@@ -740,7 +746,7 @@ For example:
.
.nf
-#element selected {
+element selected {
}
.
.fi
@@ -748,7 +754,7 @@ For example:
.IP "" 0
.
.P
-Here \fB#element selected\fR is the name of the widget, \fBselected\fR is the state of the widget\.
+Here \fBelement selected\fR is the name of the widget, \fBselected\fR is the state of the widget\.
.
.P
The difference between dots and spaces is purely cosmetic\. These are all the same:
@@ -757,11 +763,11 @@ The difference between dots and spaces is purely cosmetic\. These are all the sa
.
.nf
-#element \.selected {
+element \.selected {
-#element\.selected {
+element\.selected {
}
-#element selected {
+element selected {
}
.
.fi
@@ -776,23 +782,23 @@ The current widgets available in \fBrofi\fR:
.IP "\(bu" 4
.
.IP "\(bu" 4
-\fB#overlay\fR: the overlay widget\.
+\fBoverlay\fR: the overlay widget\.
.
.IP "\(bu" 4
.
.IP "\(bu" 4
.
.IP "\(bu" 4
-\fB#box\fR: the horizontal @box packing the widgets
+\fBbox\fR: the horizontal @box packing the widgets
.
.IP "\(bu" 4
-\fB#case\-indicator\fR: the case/sort indicator @textbox
+\fBcase\-indicator\fR: the case/sort indicator @textbox
.
.IP "\(bu" 4
-\fB#prompt\fR: the prompt @textbox
+\fBprompt\fR: the prompt @textbox
.
.IP "\(bu" 4
-\fB#entry\fR: the main entry @textbox
+\fBentry\fR: the main entry @textbox
.
.IP "" 0
@@ -800,10 +806,10 @@ The current widgets available in \fBrofi\fR:
.IP "\(bu" 4
.
.IP "\(bu" 4
-\fB#scrollbar\fR: the listview scrollbar
+\fBscrollbar\fR: the listview scrollbar
.
.IP "\(bu" 4
-\fB#element\fR: the entries in the listview
+\fBelement\fR: the entries in the listview
.
.IP "" 0
@@ -811,7 +817,7 @@ The current widgets available in \fBrofi\fR:
.IP "\(bu" 4
.
.IP "\(bu" 4
-\fB#button\fR: the buttons @textbox for each mode
+\fBbutton\fR: the buttons @textbox for each mode
.
.IP "" 0
@@ -819,7 +825,7 @@ The current widgets available in \fBrofi\fR:
.IP "\(bu" 4
.
.IP "\(bu" 4
-\fB#textbox\fR: the message textbox
+\fBtextbox\fR: the message textbox
.
.IP "" 0
@@ -845,10 +851,10 @@ Optional flag(s) indicating state of the widget, used for theming\.
These are appended after the name or class of the widget\.
.
.SS "Example:"
-\fB#button selected\.normal { }\fR
+\fBbutton selected\.normal { }\fR
.
.P
-\fB#element selected\.urgent { }\fR
+\fBelement selected\.urgent { }\fR
.
.P
Currently only the entrybox and scrollbar have states:
@@ -872,7 +878,7 @@ Example:
.
.nf
-#nametotextbox selected\.active {
+nametotextbox selected\.active {
background\-color: #003642;
text\-color: #008ed4;
}
@@ -1045,29 +1051,29 @@ The current layout of \fBrofi\fR is structured as follows:
.nf
|\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-|
-| #window {BOX:vertical} |
+| window {BOX:vertical} |
| |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| |
-| | #mainbox {BOX:vertical} | |
+| | mainbox {BOX:vertical} | |
| | |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| | |
-| | | #inputbar {BOX:horizontal} | | |
+| | | inputbar {BOX:horizontal} | | |
| | | |\-\-\-\-\-\-\-\-\-| |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| |\-\-\-| | | |
-| | | | #prompt | | #entry | |#ci| | | |
+| | | | prompt | | entry | |ci | | | |
| | | |\-\-\-\-\-\-\-\-\-| |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| |\-\-\-| | | |
| | |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| | |
| | | |
| | |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| | |
-| | | #message | | |
+| | | message | | |
| | | |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| | | |
-| | | | #textbox | | | |
+| | | | textbox | | | |
| | | |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| | | |
| | |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| | |
| | | |
| | |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| |
-| | | #listview | |
+| | | listview | |
| | |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| |
| | | |
| | |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| | |
-| | | #sidebar {BOX:horizontal} | | |
+| | | sidebar {BOX:horizontal} | | |
| | | |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| |\-\-\-\-\-\-\-\-\-\-\-\-\-\-| |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| | | |
| | | | Button | | Button | | Button | | Button | | | |
| | | |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| |\-\-\-\-\-\-\-\-\-\-\-\-\-\-| |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| | | |
@@ -1146,7 +1152,7 @@ Below is an example of a theme emulating dmenu:
font: "Times New Roman 12";
}
-#window {
+window {
anchor: north;
location: north;
width: 100%;
@@ -1154,26 +1160,26 @@ Below is an example of a theme emulating dmenu:
children: [ horibox ];
}
-#horibox {
+horibox {
orientation: horizontal;
children: [ prompt, entry, listview ];
}
-#listview {
+listview {
layout: horizontal;
spacing: 5px;
lines: 10;
}
-#entry {
+entry {
expand: false;
width: 10em;
}
-#element {
+element {
padding: 0px 2px;
}
-#element selected {
+element selected {
background\-color: SteelBlue;
}
.
diff --git a/doc/rofi.1 b/doc/rofi.1
index 45411af0..a5026252 100644
--- a/doc/rofi.1
+++ b/doc/rofi.1
@@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
-.TH "ROFI" "1" "October 2017" "" ""
+.TH "ROFI" "1" "November 2017" "" ""
.
.SH "NAME"
\fBrofi\fR \- A window switcher, application launcher, ssh dialog and dmenu replacement
@@ -340,6 +340,18 @@ Disable plugin loading\.
.P
Specify the directory where \fBrofi\fR should look for plugins\.
.
+.P
+\fB\-show\-icons\fR
+.
+.P
+Show application icons in drun and window modes\.
+.
+.P
+\fB\-drun\-icon\-theme\fR
+.
+.P
+Specify icon theme to be used in drun mode if show\-icons setting is enabled\. If not specified default theme from DE is used, \fIAdwaita\fR and \fIgnome\fR themes act as fallback themes\.
+.
.SS "Matching"
\fB\-matching\fR \fImethod\fR
.
@@ -1572,7 +1584,7 @@ Please see this \fIhttps://github\.com/DaveDavenport/rofi/wiki/Debugging%20Rofi\
When creating an issue, please read this \fIhttps://github\.com/DaveDavenport/rofi/blob/master/\.github/CONTRIBUTING\.md\fR first\.
.
.SH "SEE ALSO"
-rofi\-sensible\-terminal(1), dmenu(1), rofi\-theme(5)
+rofi\-sensible\-terminal(1), dmenu(1), rofi\-theme(5), rofi\-theme\-selector(1)
.
.SH "AUTHOR"
Qball Cow \fIqball@gmpclient\.org\fR