Mirrors/rofi
2
0
Fork 0
mirror of https://github.com/lbonn/rofi synced 2024-11-22 20:03:03 +00:00
Code Issues Projects Releases Packages Wiki Activity

[Doc] Update theme manpage with remark-lint hints.

Browse source
This commit is contained in:
Dave Davenport 2023-03-27 18:45:44 +02:00
parent 586980aeaf
commit 0133697fd2
8 changed files with 1014 additions and 782 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
doc/rofi-debugging.5
View file

@ -5,14 +5,15 @@
Debugging rofi.
.PP
When reporting an issue with rofi crashing, or misbehaving. It helps to do some small test
to help pin-point the problem.
When reporting an issue with rofi crashing, or misbehaving. It helps to do some
small test to help pin-point the problem.
.PP
First try disabling your custom configuration: \fB\fC-no-config\fR
.PP
This disables the parsing of the configuration files. This runs rofi in \fIstock\fP mode.
This disables the parsing of the configuration files. This runs rofi in \fIstock\fP
mode.
.PP
If you run custom C plugins, you can disable the plugins using: \fB\fC-no-plugins\fR
@ -33,8 +34,8 @@ rofi -dump-theme
.RE
.PP
\fB\fCrofi -help\fR provides us with the configuration files parsed, the exact version, monitor layout
and more useful information.
\fB\fCrofi -help\fR provides us with the configuration files parsed, the exact
version, monitor layout and more useful information.
.PP
The \fB\fCrofi -dump-config\fR and \fB\fCrofi -dump-theme\fR output gives us \fB\fCrofi\fR
@ -57,8 +58,8 @@ G_MESSAGES_DEBUG=Timings rofi -show drun
.RE
.PP
It will show a trace with (useful) timing information at relevant points during the execution.
This will help debugging when rofi is slow to start.
It will show a trace with (useful) timing information at relevant points during
the execution. This will help debugging when rofi is slow to start.
.PP
Example trace:
@ -123,9 +124,11 @@ Example trace:
.SH Debug domains
.PP
To further debug the plugin, you can get a trace with (lots of) debug information. This debug output can be enabled for
multiple parts in rofi using the glib debug framework. Debug domains can be enabled by setting the G_MESSAGES_DEBUG
environment variable. At the time of creation of this page, the following debug domains exist:
To further debug the plugin, you can get a trace with (lots of) debug
information. This debug output can be enabled for multiple parts in rofi using
the glib debug framework. Debug domains can be enabled by setting the
G_MESSAGES_DEBUG environment variable. At the time of creation of this page,
the following debug domains exist:
.RS
.IP \(bu 2
@ -173,7 +176,8 @@ Helpers.IconFetcher: Information about icon lookup.
For full list see \fB\fCman rofi\fR\&.
.PP
Example: \fB\fCG_MESSAGES_DEBUG=Dialogs.DRun rofi -show drun\fR To get specific output from the Desktop file run dialog.
Example: \fB\fCG_MESSAGES_DEBUG=Dialogs.DRun rofi -show drun\fR To get specific output
from the Desktop file run dialog.
.PP
To redirect the debug output to a file (\fB\fC~/rofi.log\fR) add:
@ -191,7 +195,7 @@ rofi -show drun -log ~/rofi.log
Specifying the logfile automatically enabled all log domains.
This can be useful when rofi is launched from a window manager.
.SH Creating a backtrace.
.SH Creating a backtrace
.PP
First make sure you compile \fBrofi\fP with debug symbols:
@ -205,10 +209,10 @@ make CFLAGS="-O0 -g3" clean rofi
.RE
.PP
Getting a backtrace using GDB is not very handy. Because if rofi get stuck, it grabs keyboard and
mouse. So if it crashes in GDB you are stuck.
The best way to go is to enable core file. (ulimit -c unlimited in bash) then make rofi crash. You
can then load the core in GDB.
Getting a backtrace using GDB is not very handy. Because if rofi get stuck, it
grabs keyboard and mouse. So if it crashes in GDB you are stuck. The best way
to go is to enable core file. (ulimit -c unlimited in bash) then make rofi
crash. You can then load the core in GDB.
.PP
.RS
@ -235,11 +239,13 @@ thread apply all bt
The output trace is useful when reporting crashes.
.PP
Some distribution have \fB\fCsystemd-coredump\fR, this way you can easily get a backtrace via \fB\fCcoredumpctl\fR\&.
Some distribution have \fB\fCsystemd-coredump\fR, this way you can easily get a
backtrace via \fB\fCcoredumpctl\fR\&.
.SH SEE ALSO
.PP
\fBrofi-sensible-terminal(1)\fP, \fBdmenu(1)\fP, \fBrofi-debugging(5)\fP, \fBrofi-theme(5)\fP, \fBrofi-script(5)\fP, \fBrofi-keys(5)\fP,\fBrofi-theme-selector(1)\fP
rofi-sensible-terminal(1), dmenu(1), rofi-debugging(5), rofi-theme(5),
rofi-script(5), rofi-keys(5),rofi-theme-selector(1)
.SH AUTHOR
.RS

91
doc/rofi-debugging.5.markdown
View file

@ -4,16 +4,16 @@
Debugging rofi.
When reporting an issue with rofi crashing, or misbehaving. It helps to do some small test
to help pin-point the problem.
When reporting an issue with rofi crashing, or misbehaving. It helps to do some
small test to help pin-point the problem.
First try disabling your custom configuration: `-no-config`
This disables the parsing of the configuration files. This runs rofi in *stock* mode.
This disables the parsing of the configuration files. This runs rofi in *stock*
mode.
If you run custom C plugins, you can disable the plugins using: `-no-plugins`
## Get the relevant information for an issue
Please pastebin the output of the following commands:
@ -24,15 +24,14 @@ rofi -dump-config
rofi -dump-theme
```
`rofi -help` provides us with the configuration files parsed, the exact version, monitor layout
and more useful information.
`rofi -help` provides us with the configuration files parsed, the exact
version, monitor layout and more useful information.
The `rofi -dump-config` and `rofi -dump-theme` output gives us `rofi`
interpretation of your configuration and theme.
Please check the output for identifiable information and remove this.
## Timing traces
To get a timing trace, enable the **Timings** debug domain.
@ -40,13 +39,12 @@ To get a timing trace, enable the **Timings** debug domain.
```bash
G_MESSAGES_DEBUG=Timings rofi -show drun
```
It will show a trace with (useful) timing information at relevant points during the execution.
This will help debugging when rofi is slow to start.
It will show a trace with (useful) timing information at relevant points during
the execution. This will help debugging when rofi is slow to start.
Example trace:
```
```text
(process:14942): Timings-DEBUG: 13:47:39.335: 0.000000 (0.000000): Started
(process:14942): Timings-DEBUG: 13:47:39.335: 0.000126 (0.000126): ../source/rofi.c:main:786
(process:14942): Timings-DEBUG: 13:47:39.335: 0.000163 (0.000037): ../source/rofi.c:main:819
@ -99,48 +97,49 @@ Example trace:
(process:14942): Timings-DEBUG: 13:47:39.428: 0.092864 (0.006741): ../source/view.c:rofi_view_update:1008 widgets
```
## Debug domains
To further debug the plugin, you can get a trace with (lots of) debug information. This debug output can be enabled for
multiple parts in rofi using the glib debug framework. Debug domains can be enabled by setting the G\_MESSAGES\_DEBUG
environment variable. At the time of creation of this page, the following debug domains exist:
To further debug the plugin, you can get a trace with (lots of) debug
information. This debug output can be enabled for multiple parts in rofi using
the glib debug framework. Debug domains can be enabled by setting the
G\_MESSAGES\_DEBUG environment variable. At the time of creation of this page,
the following debug domains exist:
* all: Show debug information from all domains.
* X11Helper: The X11 Helper functions.
* View: The main window view functions.
* Widgets.Box: The Box widget.
* Modes.DMenu: The dmenu mode.
* Modes.Run: The run mode.
* Modes.DRun: The desktop file run mode.
* Modes.Window: The window mode.
* Modes.Script: The script mode.
* Modes.Combi: The script mode.
* Modes.Ssh: The ssh mode.
* Rofi: The main application.
* Timings: Get timing output.
* Theme: Theme engine debug output. (warning lots of output).
* Widgets.Icon: The Icon widget.
* Widgets.Box: The box widget.
* Widgets.Container: The container widget.
* Widgets.Window: The window widget.
* Helpers.IconFetcher: Information about icon lookup.
- all: Show debug information from all domains.
- X11Helper: The X11 Helper functions.
- View: The main window view functions.
- Widgets.Box: The Box widget.
- Modes.DMenu: The dmenu mode.
- Modes.Run: The run mode.
- Modes.DRun: The desktop file run mode.
- Modes.Window: The window mode.
- Modes.Script: The script mode.
- Modes.Combi: The script mode.
- Modes.Ssh: The ssh mode.
- Rofi: The main application.
- Timings: Get timing output.
- Theme: Theme engine debug output. (warning lots of output).
- Widgets.Icon: The Icon widget.
- Widgets.Box: The box widget.
- Widgets.Container: The container widget.
- Widgets.Window: The window widget.
- Helpers.IconFetcher: Information about icon lookup.
For full list see `man rofi`.
Example: `G_MESSAGES_DEBUG=Dialogs.DRun rofi -show drun` To get specific output from the Desktop file run dialog.
Example: `G_MESSAGES_DEBUG=Dialogs.DRun rofi -show drun` To get specific output
from the Desktop file run dialog.
To redirect the debug output to a file (`~/rofi.log`) add:
```
```bash
rofi -show drun -log ~/rofi.log
```
Specifying the logfile automatically enabled all log domains.
This can be useful when rofi is launched from a window manager.
## Creating a backtrace.
## Creating a backtrace
First make sure you compile **rofi** with debug symbols:
@ -148,10 +147,10 @@ First make sure you compile **rofi** with debug symbols:
make CFLAGS="-O0 -g3" clean rofi
```
Getting a backtrace using GDB is not very handy. Because if rofi get stuck, it grabs keyboard and
mouse. So if it crashes in GDB you are stuck.
The best way to go is to enable core file. (ulimit -c unlimited in bash) then make rofi crash. You
can then load the core in GDB.
Getting a backtrace using GDB is not very handy. Because if rofi get stuck, it
grabs keyboard and mouse. So if it crashes in GDB you are stuck. The best way
to go is to enable core file. (ulimit -c unlimited in bash) then make rofi
crash. You can then load the core in GDB.
```bash
gdb rofi core
@ -159,17 +158,19 @@ gdb rofi core
Then type inside gdb:
```
```bash
thread apply all bt
```
The output trace is useful when reporting crashes.
Some distribution have `systemd-coredump`, this way you can easily get a backtrace via `coredumpctl`.
Some distribution have `systemd-coredump`, this way you can easily get a
backtrace via `coredumpctl`.
## SEE ALSO
**rofi-sensible-terminal(1)**, **dmenu(1)**, **rofi-debugging(5)**, **rofi-theme(5)**, **rofi-script(5)**, **rofi-keys(5)**,**rofi-theme-selector(1)**
rofi-sensible-terminal(1), dmenu(1), rofi-debugging(5), rofi-theme(5),
rofi-script(5), rofi-keys(5),rofi-theme-selector(1)
## AUTHOR

66
doc/rofi-dmenu.5
View file

@ -14,22 +14,25 @@ The website for \fB\fCdmenu\fR can be found here
\[la]http://tools.suckless.org/dmenu/\[ra]\&.
.PP
\fBrofi\fP does not aim to be 100% compatible with \fB\fCdmenu\fR\&. There are simply too many flavors of \fB\fCdmenu\fR\&.
The idea is that the basic usage command-line flags are obeyed, theme-related flags are not.
Besides, \fBrofi\fP offers some extended features (like multi-select, highlighting, message bar, extra key bindings).
\fBrofi\fP does not aim to be 100% compatible with \fB\fCdmenu\fR\&. There are simply too
many flavors of \fB\fCdmenu\fR\&. The idea is that the basic usage command-line flags
are obeyed, theme-related flags are not. Besides, \fBrofi\fP offers some extended
features (like multi-select, highlighting, message bar, extra key bindings).
.SH BASIC CONCEPT
.PP
In \fB\fCdmenu\fR mode, \fBrofi\fP reads data from standard in, splits them into separate entries and displays them.
If the user selects an row, this is printed out to standard out, allow the script to process it further.
In \fB\fCdmenu\fR mode, \fBrofi\fP reads data from standard in, splits them into
separate entries and displays them. If the user selects an row, this is printed
out to standard out, allow the script to process it further.
.PP
By default separation of rows is done on new lines, making it easy to pipe the output a one application into
\fBrofi\fP and the output of rofi into the next.
By default separation of rows is done on new lines, making it easy to pipe the
output a one application into \fBrofi\fP and the output of rofi into the next.
.SH USAGE
.PP
By launching \fBrofi\fP with the \fB\fC-dmenu\fR flag it will go into dmenu emulation mode.
By launching \fBrofi\fP with the \fB\fC-dmenu\fR flag it will go into dmenu emulation
mode.
.PP
.RS
@ -43,7 +46,8 @@ ls | rofi -dmenu
.SS DMENU DROP-IN REPLACEMENT
.PP
If \fB\fCargv[0]\fR (calling command) is dmenu, \fBrofi\fP will start in dmenu mode.
This way, it can be used as a drop-in replacement for dmenu. Just copy or symlink \fBrofi\fP to dmenu in \fB\fC$PATH\fR\&.
This way, it can be used as a drop-in replacement for dmenu. Just copy or
symlink \fBrofi\fP to dmenu in \fB\fC$PATH\fR\&.
.PP
.RS
@ -57,18 +61,20 @@ ln -s /usr/bin/rofi /usr/bin/dmenu
.SS DMENU VS SCRIPT MODE
.PP
Script mode is used to extend \fBrofi\fP, dmenu mode is used to extend a script.
The two do share much of the same input format. Please see the \fBrofi-script(5)\fP manpage for more information.
The two do share much of the same input format. Please see the
\fBrofi-script(5)\fP manpage for more information.
.SS DMENU SPECIFIC COMMANDLINE FLAGS
.PP
A lot of these options can also be modified by the script using special input. See the \fBrofi-script(5)\fP manpage
for more information about this syntax.
A lot of these options can also be modified by the script using special input.
See the \fBrofi-script(5)\fP manpage for more information about this syntax.
.PP
\fB\fC-sep\fR \fIseparator\fP
.PP
Separator for \fB\fCdmenu\fR\&. Example: To show a list of 'a' to 'e' with '|' as a separator:
Separator for \fB\fCdmenu\fR\&. Example: To show a list of 'a' to 'e' with '|' as a
separator:
.PP
.RS
@ -83,7 +89,8 @@ echo "a|b|c|d|e" | rofi -sep '|' -dmenu
\fB\fC-p\fR \fIprompt\fP
.PP
Specify the prompt to show in \fB\fCdmenu\fR mode. For example, select 'monkey', a,b,c,d, or e.
Specify the prompt to show in \fB\fCdmenu\fR mode. For example, select 'monkey',
a,b,c,d, or e.
.PP
.RS
@ -125,7 +132,10 @@ Makes \fB\fCdmenu\fR searches case-insensitive
\fB\fC-a\fR \fIX\fP
.PP
Active row, mark \fIX\fP as active. Where \fIX\fP is a comma-separated list of python(1)-style indices and ranges, e.g. indices start at 0, -1 refers to the last row with -2 preceding it, ranges are left-open and right-close, and so on. You can specify:
Active row, mark \fIX\fP as active. Where \fIX\fP is a comma-separated list of
python(1)-style indices and ranges, e.g. indices start at 0, -1 refers to the
last row with -2 preceding it, ranges are left-open and right-close, and so on.
You can specify:
.RS
.IP \(bu 2
@ -166,7 +176,8 @@ This mode returns directly when no entries given.
\fB\fC-format\fR \fIformat\fP
.PP
Allows the output of dmenu to be customized (N is the total number of input entries):
Allows the output of dmenu to be customized (N is the total number of input
entries):
.RS
.IP \(bu 2
@ -199,8 +210,9 @@ Select first line that matches the given string
\fB\fC-mesg\fR \fIstring\fP
.PP
Add a message line below the filter entry box. Supports Pango markup.
For more information on supported markup, see here
Add a message line below the filter entry box. Supports Pango markup. For more
information on supported markup, see
here
\[la]https://docs.gtk.org/Pango/pango_markup.html\[ra]
.PP
@ -229,22 +241,26 @@ Hide the input text. This should not be considered secure!
.PP
Tell \fBrofi\fP that DMenu input is Pango markup encoded, and should be rendered.
See here
\[la]https://developer.gnome.org/pygtk/stable/pango-markup-language.html\[ra] for details about Pango markup.
\[la]https://developer.gnome.org/pygtk/stable/pango-markup-language.html\[ra]
for details about Pango markup.
.PP
\fB\fC-multi-select\fR
.PP
Allow multiple lines to be selected. Adds a small selection indicator to the left of each entry.
Allow multiple lines to be selected. Adds a small selection indicator to the
left of each entry.
.PP
\fB\fC-sync\fR
.PP
Force \fBrofi\fP mode to first read all data from stdin before showing the selection window. This is original dmenu behavior.
Force \fBrofi\fP mode to first read all data from stdin before showing the
selection window. This is original dmenu behavior.
.PP
Note: the default asynchronous mode will also be automatically disabled if used with conflicting options,
Note: the default asynchronous mode will also be automatically disabled if used
with conflicting options,
such as \fB\fC-dump\fR, \fB\fC-only-match\fR or \fB\fC-auto-select\fR\&.
.PP
@ -309,7 +325,8 @@ Set ellipsize mode on the listview.
.SH PARSING ROW OPTIONS
.PP
Extra options for individual rows can be also set. See the \fBrofi-script(5)\fP manpage for details; the syntax and supported features are identical.
Extra options for individual rows can be also set. See the \fBrofi-script(5)\fP
manpage for details; the syntax and supported features are identical.
.SH RETURN VALUE
.RS
@ -324,7 +341,8 @@ Extra options for individual rows can be also set. See the \fBrofi-script(5)\fP
.SH SEE ALSO
.PP
rofi(1), rofi-sensible-terminal(1), dmenu(1), rofi-theme(5), rofi-script(5), rofi-theme-selector(1), ascii(7)
rofi(1), rofi-sensible-terminal(1), dmenu(1), rofi-theme(5), rofi-script(5),
rofi-theme-selector(1), ascii(7)
.SH AUTHOR
.PP

120
doc/rofi-dmenu.5.markdown
View file

@ -4,7 +4,6 @@
**rofi dmenu mode** - Rofi dmenu emulation
## DESCRIPTION
To integrate **rofi** into scripts as simple selection dialogs,
@ -12,58 +11,67 @@ To integrate **rofi** into scripts as simple selection dialogs,
The website for `dmenu` can be found [here](http://tools.suckless.org/dmenu/).
**rofi** does not aim to be 100% compatible with `dmenu`. There are simply too many flavors of `dmenu`.
The idea is that the basic usage command-line flags are obeyed, theme-related flags are not.
Besides, **rofi** offers some extended features (like multi-select, highlighting, message bar, extra key bindings).
**rofi** does not aim to be 100% compatible with `dmenu`. There are simply too
many flavors of `dmenu`. The idea is that the basic usage command-line flags
are obeyed, theme-related flags are not. Besides, **rofi** offers some extended
features (like multi-select, highlighting, message bar, extra key bindings).
## BASIC CONCEPT
In `dmenu` mode, **rofi** reads data from standard in, splits them into separate entries and displays them.
If the user selects an row, this is printed out to standard out, allow the script to process it further.
In `dmenu` mode, **rofi** reads data from standard in, splits them into
separate entries and displays them. If the user selects an row, this is printed
out to standard out, allow the script to process it further.
By default separation of rows is done on new lines, making it easy to pipe the output a one application into
**rofi** and the output of rofi into the next.
By default separation of rows is done on new lines, making it easy to pipe the
output a one application into **rofi** and the output of rofi into the next.
## USAGE
By launching **rofi** with the `-dmenu` flag it will go into dmenu emulation mode.
By launching **rofi** with the `-dmenu` flag it will go into dmenu emulation
mode.
```bash
ls | rofi -dmenu
```
### DMENU DROP-IN REPLACEMENT
If `argv[0]` (calling command) is dmenu, **rofi** will start in dmenu mode.
This way, it can be used as a drop-in replacement for dmenu. Just copy or symlink **rofi** to dmenu in `$PATH`.
ln -s /usr/bin/rofi /usr/bin/dmenu
This way, it can be used as a drop-in replacement for dmenu. Just copy or
symlink **rofi** to dmenu in `$PATH`.
```bash
ln -s /usr/bin/rofi /usr/bin/dmenu
```
### DMENU VS SCRIPT MODE
Script mode is used to extend **rofi**, dmenu mode is used to extend a script.
The two do share much of the same input format. Please see the **rofi-script(5)** manpage for more information.
The two do share much of the same input format. Please see the
**rofi-script(5)** manpage for more information.
### DMENU SPECIFIC COMMANDLINE FLAGS
A lot of these options can also be modified by the script using special input. See the **rofi-script(5)** manpage
for more information about this syntax.
A lot of these options can also be modified by the script using special input.
See the **rofi-script(5)** manpage for more information about this syntax.
`-sep` *separator*
Separator for `dmenu`. Example: To show a list of 'a' to 'e' with '|' as a separator:
Separator for `dmenu`. Example: To show a list of 'a' to 'e' with '|' as a
separator:
echo "a|b|c|d|e" | rofi -sep '|' -dmenu
```bash
echo "a|b|c|d|e" | rofi -sep '|' -dmenu
```
`-p` *prompt*
Specify the prompt to show in `dmenu` mode. For example, select 'monkey', a,b,c,d, or e.
Specify the prompt to show in `dmenu` mode. For example, select 'monkey',
a,b,c,d, or e.
echo "a|b|c|d|e" | rofi -sep '|' -dmenu -p "monkey"
```bash
echo "a|b|c|d|e" | rofi -sep '|' -dmenu -p "monkey"
```
Default: *dmenu*
@ -71,7 +79,9 @@ Default: *dmenu*
Maximum number of lines the menu may show before scrolling.
rofi -dmenu -l 25
```bash
rofi -dmenu -l 25
```
Default: *15*
@ -81,13 +91,16 @@ Makes `dmenu` searches case-insensitive
`-a` *X*
Active row, mark *X* as active. Where *X* is a comma-separated list of python(1)-style indices and ranges, e.g. indices start at 0, -1 refers to the last row with -2 preceding it, ranges are left-open and right-close, and so on. You can specify:
Active row, mark *X* as active. Where *X* is a comma-separated list of
python(1)-style indices and ranges, e.g. indices start at 0, -1 refers to the
last row with -2 preceding it, ranges are left-open and right-close, and so on.
You can specify:
* A single row: '5'
* A range of (last 3) rows: '-3:'
* 4 rows starting from row 7: '7:11' (or in legacy notation: '7-10')
* A set of rows: '2,0,-9'
* Or any combination: '5,-3:,7:11,2,0,-9'
- A single row: '5'
- A range of (last 3) rows: '-3:'
- 4 rows starting from row 7: '7:11' (or in legacy notation: '7-10')
- A set of rows: '2,0,-9'
- Or any combination: '5,-3:,7:11,2,0,-9'
`-u` *X*
@ -106,15 +119,16 @@ This mode returns directly when no entries given.
`-format` *format*
Allows the output of dmenu to be customized (N is the total number of input entries):
Allows the output of dmenu to be customized (N is the total number of input
entries):
* 's' selected string
* 'i' index (0 - (N-1))
* 'd' index (1 - N)
* 'q' quote string
* 'p' Selected string stripped from Pango markup (Needs to be a valid string)
* 'f' filter string (user input)
* 'F' quoted filter string (user input)
- 's' selected string
- 'i' index (0 - (N-1))
- 'd' index (1 - N)
- 'q' quote string
- 'p' Selected string stripped from Pango markup (Needs to be a valid string)
- 'f' filter string (user input)
- 'F' quoted filter string (user input)
Default: 's'
@ -124,8 +138,9 @@ Select first line that matches the given string
`-mesg` *string*
Add a message line below the filter entry box. Supports Pango markup.
For more information on supported markup, see [here](https://docs.gtk.org/Pango/pango_markup.html)
Add a message line below the filter entry box. Supports Pango markup. For more
information on supported markup, see
[here](https://docs.gtk.org/Pango/pango_markup.html)
`-dump`
@ -144,18 +159,21 @@ Hide the input text. This should not be considered secure!
`-markup-rows`
Tell **rofi** that DMenu input is Pango markup encoded, and should be rendered.
See [here](https://developer.gnome.org/pygtk/stable/pango-markup-language.html) for details about Pango markup.
See [here](https://developer.gnome.org/pygtk/stable/pango-markup-language.html)
for details about Pango markup.
`-multi-select`
Allow multiple lines to be selected. Adds a small selection indicator to the left of each entry.
Allow multiple lines to be selected. Adds a small selection indicator to the
left of each entry.
`-sync`
Force **rofi** mode to first read all data from stdin before showing the selection window. This is original dmenu behavior.
Force **rofi** mode to first read all data from stdin before showing the
selection window. This is original dmenu behavior.
Note: the default asynchronous mode will also be automatically disabled if used with conflicting options,
Note: the default asynchronous mode will also be automatically disabled if used
with conflicting options,
such as `-dump`, `-only-match` or `-auto-select`.
`-window-title` *title*
@ -200,18 +218,19 @@ Set ellipsize mode on the listview.
## PARSING ROW OPTIONS
Extra options for individual rows can be also set. See the **rofi-script(5)** manpage for details; the syntax and supported features are identical.
Extra options for individual rows can be also set. See the **rofi-script(5)**
manpage for details; the syntax and supported features are identical.
## RETURN VALUE
* **0**: Row has been selected accepted by user.
* **1**: User cancelled the selection.
* **10-28**: Row accepted by custom keybinding.
- **0**: Row has been selected accepted by user.
- **1**: User cancelled the selection.
- **10-28**: Row accepted by custom keybinding.
## SEE ALSO
rofi(1), rofi-sensible-terminal(1), dmenu(1), rofi-theme(5), rofi-script(5), rofi-theme-selector(1), ascii(7)
rofi(1), rofi-sensible-terminal(1), dmenu(1), rofi-theme(5), rofi-script(5),
rofi-theme-selector(1), ascii(7)
## AUTHOR
@ -221,7 +240,6 @@ Rasmus Steinke <rasi@xssn.at>
Morgane Glidic <sardemff7+rofi@sardemff7.net>
Original code based on work by: Sean Pringle <sean.pringle@gmail.com>
For a full list of authors, check the AUTHORS file.

13
doc/rofi-theme-selector.1
View file

@ -6,15 +6,15 @@
.SH DESCRIPTION
.PP
\fBrofi-theme-selector\fP is a bash/rofi script to preview and apply themes for \fBrofi\fP\&.
It's part of any installation of \fBrofi\fP\&.
\fBrofi-theme-selector\fP is a bash/rofi script to preview and apply themes for
\fBrofi\fP\&. It's part of any installation of \fBrofi\fP\&.
.SH USAGE
.SS Running rofi-theme-selector
.PP
\fBrofi-theme-selector\fP shows a list of all available themes in a \fBrofi\fP window.
It lets you preview each theme with the Enter key and apply the theme to your
\fBrofi\fP configuration file with Alt+a.
\fBrofi-theme-selector\fP shows a list of all available themes in a \fBrofi\fP
window. It lets you preview each theme with the Enter key and apply the theme
to your \fBrofi\fP configuration file with Alt+a.
.SH Theme directories
.PP
@ -31,7 +31,8 @@ $XDG_DATA_HOME/share/rofi/themes
.RE
.PP
${PREFIX} reflects the install location of rofi. In most cases this will be "/usr".
${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".

20
doc/rofi-theme-selector.1.markdown
View file

@ -6,27 +6,27 @@
## DESCRIPTION
**rofi-theme-selector** is a bash/rofi script to preview and apply themes for **rofi**.
It's part of any installation of **rofi**.
**rofi-theme-selector** is a bash/rofi script to preview and apply themes for
**rofi**. It's part of any installation of **rofi**.
## USAGE
### Running rofi-theme-selector
**rofi-theme-selector** shows a list of all available themes in a **rofi** window.
It lets you preview each theme with the Enter key and apply the theme to your
**rofi** configuration file with Alt+a.
**rofi-theme-selector** shows a list of all available themes in a **rofi**
window. It lets you preview each theme with the Enter key and apply the theme
to your **rofi** configuration file with Alt+a.
## Theme directories
**rofi-theme-selector** searches the following directories for themes:
* ${PREFIX}/share/rofi/themes
* $XDG_CONFIG_HOME/rofi/themes
* $XDG_DATA_HOME/share/rofi/themes
- ${PREFIX}/share/rofi/themes
- $XDG_CONFIG_HOME/rofi/themes
- $XDG_DATA_HOME/share/rofi/themes
${PREFIX} reflects the install location of rofi. In most cases this will be "/usr".<br>
${PREFIX} reflects the install location of rofi. In most cases this will be
"/usr".<br>
$XDG_CONFIG_HOME is normally unset. Default path is "$HOME/.config".<br>
$XDG_DATA_HOME is normally unset. Default path is "$HOME/.local/share".

468
doc/rofi-theme.5
View file

@ -9,8 +9,7 @@
The easiest way to get started theming rofi is by modifying your existing theme.
.PP
Themes can be modified/tweaked by adding theming elements to the end of the
.br
Themes can be modified/tweaked by adding theming elements to the end of the\\
config file. The default location of this file is \fB\fC~/.config/rofi/config.rasi\fR,
if the file does not exists, you can create it.
@ -50,8 +49,8 @@ entry {
.PP
In the above section, \fB\fCentry\fR indicates the widget, \fB\fCplaceholder\fR is the
property we want to modify and we set it to the string \fB\fC"Type here"\fR\&.
To find the commonly available widgets in rofi, see the 'Basic structure' section.
property we want to modify and we set it to the string \fB\fC"Type here"\fR\&. To find
the commonly available widgets in rofi, see the 'Basic structure' section.
.PP
To change the mouse over cursor to a pointer, add:
@ -146,7 +145,8 @@ In this example we specify the size in the em
\[la]https://www.w3.org/Style/LieBos3e/em\[ra] unit.
.PP
Now lets change the text color of both the \fB\fCentry\fR and the \fB\fCelement-text\fR widget to red and background to blue.
Now lets change the text color of both the \fB\fCentry\fR and the \fB\fCelement-text\fR
widget to red and background to blue.
.PP
.RS
@ -213,7 +213,8 @@ entry {
.RE
.PP
By default, the \fB\fCcursor-color\fR will be the same as the \fB\fCtext-color\fR\&. The \fB\fCcursor-width\fR will always default to 2 pixels.
By default, the \fB\fCcursor-color\fR will be the same as the \fB\fCtext-color\fR\&. The
\fB\fCcursor-width\fR will always default to 2 pixels.
.PP
If you want to see the complete theme, including the modification you can run:
@ -267,16 +268,18 @@ rofi -no-config -dump-theme
.SH Description
.PP
The need for a new theme format was motivated by the fact that the way rofi handled widgets has changed. From a very
static drawing of lines and text to a nice structured form of packing widgets. This change made it possible to provide a
more flexible theme framework. The old theme format and config file are not flexible enough to expose these options in a
user-friendly way. Therefore, a new file format has been created, replacing the old one.
The need for a new theme format was motivated by the fact that the way rofi
handled widgets has changed. From a very static drawing of lines and text to a
nice structured form of packing widgets. This change made it possible to
provide a more flexible theme framework. The old theme format and config file
are not flexible enough to expose these options in a user-friendly way.
Therefore, a new file format has been created, replacing the old one.
.SH Format specification
.SH Encoding
.PP
The encoding of the file is UTF-8. Both unix (\fB\fC\\n\fR) and windows (\fB\fC\\r\\n\fR) newlines format are supported. But unix is
preferred.
The encoding of the file is UTF-8. Both unix (\fB\fC\\n\fR) and windows (\fB\fC\\r\\n\fR)
newlines format are supported. But unix is preferred.
.SH Comments
.PP
@ -286,7 +289,8 @@ C and C++ file comments are supported.
.IP \(bu 2
Anything after \fB\fC//\fR and before a newline is considered a comment.
.IP \(bu 2
Everything between \fB\fC/*\fR and \fB\fC*/\fR is a comment, this comment can span multiple lines.
Everything between \fB\fC/*\fR and \fB\fC*/\fR is a comment, this comment can span
multiple lines.
.RE
@ -352,13 +356,15 @@ name
.SH File extension
.PP
The preferred file extension for the new theme format is \fBrasi\fP\&. This is an
abbreviation for \fBr\fPofi \fBa\fPdvanced \fBs\fPtyle \fBi\fPnformation.
If a theme file is split over multiple files, include files can have the: \fBrasinc\fP extension.
abbreviation for \fBr\fPofi \fBa\fPdvanced \fBs\fPtyle \fBi\fPnformation. If a theme
file is split over multiple files, include files can have the: \fBrasinc\fP
extension.
.SH Basic Structure
.PP
Each element has a section with defined properties. Global properties can be defined in section \fB\fC* { }\fR\&.
Sub-section names begin with an optional hash symbol \fB\fC#\fR\&.
Each element has a section with defined properties. Global properties can be
defined in section \fB\fC* { }\fR\&. Sub-section names begin with an optional hash
symbol \fB\fC#\fR\&.
.PP
It is advised to define the \fIglobal properties section\fP on top of the file to
@ -385,13 +391,13 @@ make inheritance of properties clearer.
.RE
.PP
If there are multiple sections with the same name, they are merged. Duplicate properties are overwritten and the last
parsed entry kept.
If there are multiple sections with the same name, they are merged. Duplicate
properties are overwritten and the last parsed entry kept.
.SH Global properties section
.PP
A theme can have one or more global properties sections. If there is more than one,
they will be merged.
A theme can have one or more global properties sections. If there is more than
one, they will be merged.
.PP
The global properties section denotes the defaults for each element.
@ -564,7 +570,8 @@ Format: \fB\fC"[:print:]+"\fR
.RE
.PP
A string is always surrounded by double quotes (\fB\fC"\fR). Between the quotes there can be any printable character.
A string is always surrounded by double quotes (\fB\fC"\fR). Between the quotes there
can be any printable character.
.PP
For example:
@ -677,8 +684,8 @@ where scale is: none, both, width, height
.IP \(bu 2
Format: linear-gradient(stop color,stop1, color, stop2 color, ...);
.IP \(bu 2
Format: linear-gradient(to direction, stop color,stop1, color, stop2 color, ...);
where direction is: top,left,right,bottom.
Format: linear-gradient(to direction, stop color,stop1, color, stop2 color,
...); where direction is: top,left,right,bottom.
.IP \(bu 2
Format: linear-gradient(angle, stop color,stop1, color, stop2 color, ...);
Angle in deg,rad,grad (as used in color).
@ -690,7 +697,8 @@ Where the \fB\fCpath\fR is a string, and \fB\fCstop\fR color is of type color.
.SS Color
.PP
\fBrofi\fP supports the color formats as specified in the CSS standard (1,2,3 and some of CSS 4)
\fBrofi\fP supports the color formats as specified in the CSS standard (1,2,3 and
some of CSS 4)
.RS
.IP \(bu 2
@ -710,7 +718,8 @@ Format: \fB\fChsl[a]( {ANGLE}, {PERCENTAGE}, {PERCENTAGE} [, {PERCENTAGE}])\fR
.IP \(bu 2
Format: \fB\fChwb[a]( {ANGLE}, {PERCENTAGE}, {PERCENTAGE} [, {PERCENTAGE}])\fR
.IP \(bu 2
Format: \fB\fCcmyk( {PERCENTAGE}, {PERCENTAGE}, {PERCENTAGE}, {PERCENTAGE} [, {PERCENTAGE} ])\fR
Format: \fB\fCcmyk( {PERCENTAGE}, {PERCENTAGE}, {PERCENTAGE}, {PERCENTAGE} [,
{PERCENTAGE} ])\fR
.IP \(bu 2
Format: \fB\fC{named-color} [ / {PERCENTAGE} ]\fR
@ -726,26 +735,38 @@ The different values are:
.IP \(bu 2
\fB\fC{HEX}\fR is a hexadecimal number ('0-9a-f' case insensitive).
.IP \(bu 2
\fB\fC{INTEGER}\fR value can be between 0 and 255 or 0-100 when representing percentage.
\fB\fC{INTEGER}\fR value can be between 0 and 255 or 0-100 when representing
percentage.
.IP \(bu 2
\fB\fC{ANGLE}\fR is the angle on the color wheel, can be in \fB\fCdeg\fR, \fB\fCrad\fR, \fB\fCgrad\fR or \fB\fCturn\fR\&. When no unit is specified, degrees is assumed.
\fB\fC{ANGLE}\fR is the angle on the color wheel, can be in \fB\fCdeg\fR, \fB\fCrad\fR, \fB\fCgrad\fR
or \fB\fCturn\fR\&. When no unit is specified, degrees is assumed.
.IP \(bu 2
\fB\fC{PERCENTAGE}\fR can be between 0-1.0, or 0%-100%
.IP \(bu 2
\fB\fC{named-color}\fR is one of the following colors:AliceBlue, AntiqueWhite, Aqua, Aquamarine, Azure, Beige, Bisque, Black, BlanchedAlmond, Blue, BlueViolet, Brown,
BurlyWood, CadetBlue, Chartreuse, Chocolate, Coral, CornflowerBlue, Cornsilk, Crimson, Cyan, DarkBlue, DarkCyan,
DarkGoldenRod, DarkGray, DarkGrey, DarkGreen, DarkKhaki, DarkMagenta, DarkOliveGreen, DarkOrange, DarkOrchid, DarkRed,
DarkSalmon, DarkSeaGreen, DarkSlateBlue, DarkSlateGray, DarkSlateGrey, DarkTurquoise, DarkViolet, DeepPink, DeepSkyBlue,
DimGray, DimGrey, DodgerBlue, FireBrick, FloralWhite, ForestGreen, Fuchsia, Gainsboro, GhostWhite, Gold, GoldenRod,
Gray, Grey, Green, GreenYellow, HoneyDew, HotPink, IndianRed, Indigo, Ivory, Khaki, Lavender, LavenderBlush, LawnGreen,
LemonChiffon, LightBlue, LightCoral, LightCyan, LightGoldenRodYellow, LightGray, LightGrey, LightGreen, LightPink,
LightSalmon, LightSeaGreen, LightSkyBlue, LightSlateGray, LightSlateGrey, LightSteelBlue, LightYellow, Lime, LimeGreen,
Linen, Magenta, Maroon, MediumAquaMarine, MediumBlue, MediumOrchid, MediumPurple, MediumSeaGreen, MediumSlateBlue,
MediumSpringGreen, MediumTurquoise, MediumVioletRed, MidnightBlue, MintCream, MistyRose, Moccasin, NavajoWhite, Navy,
OldLace, Olive, OliveDrab, Orange, OrangeRed, Orchid, PaleGoldenRod, PaleGreen, PaleTurquoise, PaleVioletRed,
PapayaWhip, PeachPuff, Peru, Pink, Plum, PowderBlue, Purple, RebeccaPurple, Red, RosyBrown, RoyalBlue, SaddleBrown,
Salmon, SandyBrown, SeaGreen, SeaShell, Sienna, Silver, SkyBlue, SlateBlue, SlateGray, SlateGrey, Snow, SpringGreen,
SteelBlue, Tan, Teal, Thistle, Tomato, Turquoise, Violet, Wheat, White, WhiteSmoke, Yellow, YellowGreen,transparent
\fB\fC{named-color}\fR is one of the following colors:AliceBlue, AntiqueWhite, Aqua, Aquamarine, Azure, Beige, Bisque, Black,
BlanchedAlmond, Blue, BlueViolet, Brown, BurlyWood, CadetBlue, Chartreuse,
Chocolate, Coral, CornflowerBlue, Cornsilk, Crimson, Cyan, DarkBlue,
DarkCyan, DarkGoldenRod, DarkGray, DarkGrey, DarkGreen, DarkKhaki,
DarkMagenta, DarkOliveGreen, DarkOrange, DarkOrchid, DarkRed, DarkSalmon,
DarkSeaGreen, DarkSlateBlue, DarkSlateGray, DarkSlateGrey, DarkTurquoise,
DarkViolet, DeepPink, DeepSkyBlue, DimGray, DimGrey, DodgerBlue, FireBrick,
FloralWhite, ForestGreen, Fuchsia, Gainsboro, GhostWhite, Gold, GoldenRod,
Gray, Grey, Green, GreenYellow, HoneyDew, HotPink, IndianRed, Indigo,
Ivory, Khaki, Lavender, LavenderBlush, LawnGreen, LemonChiffon, LightBlue,
LightCoral, LightCyan, LightGoldenRodYellow, LightGray, LightGrey,
LightGreen, LightPink, LightSalmon, LightSeaGreen, LightSkyBlue,
LightSlateGray, LightSlateGrey, LightSteelBlue, LightYellow, Lime,
LimeGreen, Linen, Magenta, Maroon, MediumAquaMarine, MediumBlue,
MediumOrchid, MediumPurple, MediumSeaGreen, MediumSlateBlue,
MediumSpringGreen, MediumTurquoise, MediumVioletRed, MidnightBlue,
MintCream, MistyRose, Moccasin, NavajoWhite, Navy, OldLace, Olive,
OliveDrab, Orange, OrangeRed, Orchid, PaleGoldenRod, PaleGreen,
PaleTurquoise, PaleVioletRed, PapayaWhip, PeachPuff, Peru, Pink, Plum,
PowderBlue, Purple, RebeccaPurple, Red, RosyBrown, RoyalBlue, SaddleBrown,
Salmon, SandyBrown, SeaGreen, SeaShell, Sienna, Silver, SkyBlue, SlateBlue,
SlateGray, SlateGrey, Snow, SpringGreen, SteelBlue, Tan, Teal, Thistle,
Tomato, Turquoise, Violet, Wheat, White, WhiteSmoke, Yellow,
YellowGreen,transparent
.RE
@ -784,8 +805,8 @@ Format: \fB\fC(bold|italic|underline|strikethrough|none)\fR
.RE
.PP
Text style indicates how the highlighted text is emphasized. \fB\fCNone\fR indicates that no emphasis
should be applied.
Text style indicates how the highlighted text is emphasized. \fB\fCNone\fR indicates
that no emphasis should be applied.
.RS
.IP \(bu 2
@ -812,7 +833,7 @@ The following options are available on pango 1.50.0 and up:
.PP
The following option is disabled as pango crashes on this if there is eel
upsizing or wrapping. This will be re-enabled once fixed:
upsizing or wrapping. This will be re-enabled once fixed:
.RS
.IP \(bu 2
@ -830,8 +851,8 @@ Format: \fB\fC(dash|solid)\fR
.PP
Indicates how a line should be drawn.
It currently supports:
* \fB\fCdash\fR: a dashed line, where the gap is the same width as the dash
* \fB\fCsolid\fR: a solid line
- \fB\fCdash\fR: a dashed line, where the gap is the same width as the dash
- \fB\fCsolid\fR: a solid line
.SS Distance
.RS
@ -916,7 +937,7 @@ It supports the following operations:
.IP \(bu 2
\fB\fC/\fR : Divide
.IP \(bu 2
\fB\fC*\fR : Multiply
\fB\fC-\fR : Multiply
.IP \(bu 2
\fB\fCmodulo\fR : Modulo
.IP \(bu 2
@ -985,9 +1006,11 @@ Format: \fB\fC{Distance} {Line style}\fR
.IP \(bu 2
Format: \fB\fC{Distance} {Line style} {Distance} {Line style}\fR
.IP \(bu 2
Format: \fB\fC{Distance} {Line style} {Distance} {Line style} {Distance} {Line style}\fR
Format: \fB\fC{Distance} {Line style} {Distance} {Line style} {Distance} {Line
style}\fR
.IP \(bu 2
Format: \fB\fC{Distance} {Line style} {Distance} {Line style} {Distance} {Line style} {Distance} {Line style}\fR
Format: \fB\fC{Distance} {Line style} {Distance} {Line style} {Distance} {Line
style} {Distance} {Line style}\fR
.RE
@ -1024,7 +1047,8 @@ Indicate a place on the window/monitor.
.RS
.IP \(bu 2
Format: \fB\fC(center|east|north|west|south|north east|north west|south west|south east)\fR
Format: \fB\fC(center|east|north|west|south|north east|north west|south west|south
east)\fR
.RE
@ -1051,9 +1075,9 @@ Format: \fB\fC@{PROPERTY NAME}\fR
.RE
.PP
A reference can point to another reference. Currently, the maximum number of redirects is 20.
A property always refers to another property. It cannot be used for a subpart of the property.
For example, this is not valid:
A reference can point to another reference. Currently, the maximum number of
redirects is 20. A property always refers to another property. It cannot be
used for a subpart of the property. For example, this is not valid:
.PP
.RS
@ -1089,8 +1113,9 @@ Format: \fB\fCvar(PROPERTY NAME, DEFAULT)\fR
.RE
.PP
A reference can point to another reference. Currently, the maximum number of redirects is 20.
A property always refers to another property. It cannot be used for a subpart of the property.
A reference can point to another reference. Currently, the maximum number of
redirects is 20. A property always refers to another property. It cannot be
used for a subpart of the property.
.PP
Example:
@ -1107,8 +1132,8 @@ window {
.RE
.PP
If the property \fB\fCwidth\fR is set globally (\fB\fC*{}\fR) that value is used, if the property
\fB\fCwidth\fR is not set, the default value is used.
If the property \fB\fCwidth\fR is set globally (\fB\fC*{}\fR) that value is used, if the
property \fB\fCwidth\fR is not set, the default value is used.
.SS Orientation
.RS
@ -1128,7 +1153,8 @@ Format: \fB\fC(default|pointer|text)\fR
.RE
.PP
Specify the type of mouse cursor that is set when the mouse pointer is over the widget.
Specify the type of mouse cursor that is set when the mouse pointer is over the
widget.
.SS List of keywords
.RS
@ -1138,8 +1164,8 @@ Format: \fB\fC[ keyword, keyword ]\fR
.RE
.PP
A list starts with a '[' and ends with a ']'. The entries in the list are comma-separated.
The \fB\fCkeyword\fR in the list refers to an widget name.
A list starts with a '[' and ends with a ']'. The entries in the list are
comma-separated. The \fB\fCkeyword\fR in the list refers to an widget name.
.SS List of values
.RS
@ -1149,7 +1175,8 @@ Format: \fB\fC[ value, value, ... ]\fR
.RE
.PP
An list starts with a '[' and ends with a ']'. The entries in the list are comma-separated.
An list starts with a '[' and ends with a ']'. The entries in the list are
comma-separated.
.SS Environment variable
.RS
@ -1159,8 +1186,9 @@ Format: \fB\fC${:alnum:}\fR
.RE
.PP
This will parse the environment variable as the property value. (that then can be any of the above types).
The environment variable should be an alphanumeric string without white-space.
This will parse the environment variable as the property value. (that then can
be any of the above types). The environment variable should be an alphanumeric
string without white-space.
.PP
.RS
@ -1180,9 +1208,10 @@ Format: \fB\fCenv(ENVIRONMENT, default)\fR
.RE
.PP
This will parse the environment variable as the property value. (that then can be any of the above types).
The environment variable should be an alphanumeric string without white-space.
If the environment value is not found, the default value is used.
This will parse the environment variable as the property value. (that then can
be any of the above types). The environment variable should be an alphanumeric
string without white-space. If the environment value is not found, the default
value is used.
.PP
.RS
@ -1196,7 +1225,8 @@ window {
.RE
.PP
If environment WIDTH is set, then that value is parsed, otherwise the default value (\fB\fC40%\fR).
If environment WIDTH is set, then that value is parsed, otherwise the default
value (\fB\fC40%\fR).
.SS Inherit
.RS
@ -1221,8 +1251,8 @@ mainbox {
.SH Elements paths
.PP
Element paths exists of two parts, the first part refers to the actual widget by name.
Some widgets have an extra state.
Element paths exists of two parts, the first part refers to the actual widget
by name. Some widgets have an extra state.
.PP
For example:
@ -1238,10 +1268,12 @@ element selected {
.RE
.PP
Here \fB\fCelement selected\fR is the name of the widget, \fB\fCselected\fR is the state of the widget.
Here \fB\fCelement selected\fR is the name of the widget, \fB\fCselected\fR is the state of
the widget.
.PP
The difference between dots and spaces is purely cosmetic. These are all the same:
The difference between dots and spaces is purely cosmetic. These are all the
same:
.PP
.RS
@ -1258,7 +1290,7 @@ element selected {
.RE
.SS Supported element paths
.SS Name
.SS Base widgets
.PP
The default widgets available in \fBrofi\fP and the default hierarchic:
@ -1275,6 +1307,7 @@ The default widgets available in \fBrofi\fP and the default hierarchic:
.RS
.IP \(bu 2
\fB\fCbox\fR: the horizontal @box packing the widgets
.RS
.IP \(bu 2
\fB\fCcase-indicator\fR: the case/sort indicator @textbox
.IP \(bu 2
@ -1284,11 +1317,17 @@ The default widgets available in \fBrofi\fP and the default hierarchic:
.IP \(bu 2
\fB\fCnum-rows\fR: Shows the total number of rows.
.IP \(bu 2
\fB\fCnum-filtered-rows\fR: Shows the total number of rows after filtering.
\fB\fCnum-filtered-rows\fR: Shows the total number of rows after
filtering.
.IP \(bu 2
\fB\fCtextbox-current-entry\fR: Shows the text of the currently selected entry.
\fB\fCtextbox-current-entry\fR: Shows the text of the currently selected
entry.
.IP \(bu 2
\fB\fCicon-current-entry\fR: Shows the icon of the currently selected entry.
\fB\fCicon-current-entry\fR: Shows the icon of the currently selected
entry.
.RE
.RE
@ -1301,11 +1340,14 @@ The default widgets available in \fBrofi\fP and the default hierarchic:
\fB\fCelement\fR: a box in the listview holding the entries
.RS
.IP \(bu 2
\fB\fCelement-icon\fR: the widget in the listview's entry showing the (optional) icon
\fB\fCelement-icon\fR: the widget in the listview's entry showing the
(optional) icon
.IP \(bu 2
\fB\fCelement-index\fR: the widget in the listview's entry keybindable index (1,2,3..0)
\fB\fCelement-index\fR: the widget in the listview's entry
keybindable index (1,2,3..0)
.IP \(bu 2
\fB\fCelement-text\fR: the widget in the listview's entry showing the text.
\fB\fCelement-text\fR: the widget in the listview's entry showing the
text.
.RE
@ -1335,8 +1377,8 @@ The default widgets available in \fBrofi\fP and the default hierarchic:
.RE
.PP
Note that these path names match the default theme. Themes that provide a custom layout will have different
elements, and structure.
Note that these path names match the default theme. Themes that provide a
custom layout will have different elements, and structure.
.SS State
.PP
@ -1348,7 +1390,7 @@ Optional flag(s) indicating state of the widget, used for theming.
.PP
These are appended after the name or class of the widget.
.SS Example:
.SS Example
.PP
\fB\fCbutton selected.normal { }\fR
@ -1358,21 +1400,21 @@ These are appended after the name or class of the widget.
.PP
Currently only the entrybox and scrollbar have states:
.SS Entrybox:
.SS Entrybox
.PP
\fB\fC{visible modifier}.{state}\fR
.PP
Where \fB\fCvisible modifier\fR can be:
* normal: no modification
* selected: the entry is selected/highlighted by user
* alternate: the entry is at an alternating row (uneven row)
- normal: no modification
- selected: the entry is selected/highlighted by user
- alternate: the entry is at an alternating row (uneven row)
.PP
Where \fB\fCstate\fR is:
* normal: no modification
* urgent: this entry is marked urgent
* active: this entry is marked active
- normal: no modification
- urgent: this entry is marked urgent
- active: this entry is marked active
.PP
These can be mixed.
@ -1393,8 +1435,9 @@ nametotextbox selected.active {
.RE
.PP
Sets all selected textboxes marked active to the given text and background color.
Note that a state modifies the original element, it therefore contains all the properties of that element.
Sets all selected textboxes marked active to the given text and background
color. Note that a state modifies the original element, it therefore contains
all the properties of that element.
.SS Scrollbar
.PP
@ -1432,7 +1475,8 @@ Background image
Color of the border
.IP \(bu 2
\fBcursor\fP: cursor
Type of mouse cursor that is set when the mouse pointer is hovered over the widget.
Type of mouse cursor that is set when the mouse pointer is hovered over the
widget.
.RE
@ -1444,31 +1488,37 @@ The font used in the window
.IP \(bu 2
\fBtransparency\fP: string
Indicating if transparency should be used and what type:
.RS
.IP \(bu 2
\fBreal\fP - True transparency. Only works with a compositor.
.IP \(bu 2
\fBbackground\fP - Take a screenshot of the background image and use that.
.IP \(bu 2
\fBscreenshot\fP - Take a screenshot of the screen and use that.
.IP \(bu 2
\fBPath\fP to png file - Use an image.
.IP \(bu 2
\fBlocation\fP: position
The place of the anchor on the monitor
.IP \(bu 2
\fBanchor\fP: anchor
The anchor position on the window
.IP \(bu 2
\fBfullscreen\fP: boolean
Window is fullscreen.
.IP \(bu 2
\fBwidth\fP: distance
The width of the window
.IP \(bu 2
\fBx-offset\fP: distance
.IP \(bu 2
\fBy-offset\fP: distance
The offset of the window to the anchor point, allowing you to push the window left/right/up/down
.RE
.SS scrollbar
.IP \(bu 2
\fBlocation\fP: position
The place of the anchor on the monitor
.IP \(bu 2
\fBanchor\fP: anchor
The anchor position on the window
.IP \(bu 2
\fBfullscreen\fP: boolean Window is fullscreen.
.IP \(bu 2
\fBwidth\fP: distance The width of the window
.IP \(bu 2
\fBx-offset\fP: distance
.IP \(bu 2
\fBy-offset\fP: distance The offset of the window to the anchor point,
allowing you to push the window left/right/up/down
.RE
.SS scrollbar Properties
.RS
.IP \(bu 2
\fBbackground-color\fP: color
@ -1484,11 +1534,9 @@ The offset of the window to the anchor point, allowing you to push the window le
.SS box
.RS
.IP \(bu 2
\fBorientation\fP: orientation
Set the direction the elements are packed.
\fBorientation\fP: orientation Set the direction the elements are packed.
.IP \(bu 2
\fBspacing\fP: distance
Distance between the packed elements.
\fBspacing\fP: distance Distance between the packed elements.
.RE
@ -1503,46 +1551,55 @@ The offset of the window to the anchor point, allowing you to push the window le
.IP \(bu 2
\fBstr\fP/\fBcontent\fP: the string to display by this textbox (string).
.IP \(bu 2
\fBvertical-align\fP: Vertical alignment of the text. A number between 0 (top) and 1 (bottom).
\fBvertical-align\fP: Vertical alignment of the text. A number between 0
(top) and 1 (bottom).
.IP \(bu 2
\fBhorizontal-align\fP: Horizontal alignment of the text. A number between 0 (left) and 1 (right).
\fBhorizontal-align\fP: Horizontal alignment of the text. A number between 0
(left) and 1 (right).
.IP \(bu 2
\fBtext-color\fP: the text color to use.
.IP \(bu 2
\fBtext-transform\fP: text style {color} for the whole text.
.IP \(bu 2
\fBhighlight\fP: text style {color}.
color is optional, multiple highlight styles can be added like: bold underline italic #000000;
This option is only available on the \fB\fCelement-text\fR widget.
\fBhighlight\fP: text style {color}. color is optional, multiple
highlight styles can be added like: bold underline italic #000000; This
option is only available on the \fB\fCelement-text\fR widget.
.IP \(bu 2
\fBwidth\fP: override the desired width for the textbox.
.IP \(bu 2
\fBcontent\fP: Set the displayed text (String).
.IP \(bu 2
\fBplaceholder\fP: Set the displayed text (String) when nothing is entered.
\fBplaceholder\fP: Set the displayed text (String) when nothing is
entered.
.IP \(bu 2
\fBplaceholder-markup\fP: If true, placeholder text supports pango markup for stylizing.
\fBplaceholder-markup\fP: If true, placeholder text supports pango
markup for stylizing.
.IP \(bu 2
\fBplaceholder-color\fP: Color of the placeholder text.
.IP \(bu 2
\fBblink\fP: Enable/Disable blinking on an input textbox (Boolean).
\fBblink\fP: Enable/Disable blinking on an input textbox
(Boolean).
.IP \(bu 2
\fBmarkup\fP: Force markup on, beware that only valid pango markup strings are shown.
\fBmarkup\fP: Force markup on, beware that only valid pango markup
strings are shown.
.IP \(bu 2
\fBtab-stops\fP: array of distances
Set the location of tab stops by their distance from the beginning of the line.
Each distance should be greater than the previous one.
The text appears to the right of the tab stop position (other alignments are not supported yet).
\fBtab-stops\fP: array of distances. Set the location of tab stops by
their distance from the beginning of the line. Each distance should be
greater than the previous one. The text appears to the right of the tab
stop position (other alignments are not supported yet).
.IP \(bu 2
\fBcursor-width\fP: The width of the cursor.
.IP \(bu 2
\fBcursor-color\fP: The color used to draw the cursor.
.IP \(bu 2
\fBcursor-outline\fP: Enable a border (outline) around the cursor. (Boolean)
\fBcursor-outline\fP: Enable a border (outline) around the cursor.
(Boolean)
.IP \(bu 2
\fBcursor-outline-width\fP: The width of the border around the cursor. (Double)
\fBcursor-outline-width\fP: The width of the border around the cursor.
(Double)
.IP \(bu 2
\fBcursor-outline-color\fP: The color to use for the cursor outline. (Color)
\fBcursor-outline-color\fP: The color to use for the cursor outline.
(Color)
.IP \(bu 2
\fBtext-outline\fP: Enable a border (outline) around the text. (Boolean)
.IP \(bu 2
@ -1555,45 +1612,38 @@ The text appears to the right of the tab stop position (other alignments are not
.SS listview
.RS
.IP \(bu 2
\fBcolumns\fP: integer
Number of columns to show (at least 1)
\fBcolumns\fP: integer Number of columns to show (at least 1)
.IP \(bu 2
\fBfixed-height\fP: boolean
Always show \fB\fClines\fR rows, even if fewer elements are available.
\fBfixed-height\fP: boolean Always show \fB\fClines\fR rows, even if fewer
elements are available.
.IP \(bu 2
\fBdynamic\fP: boolean
\fB\fCTrue\fR if the size should change when filtering the list, \fB\fCFalse\fR if it should keep the original height.
\fBdynamic\fP: boolean \fB\fCTrue\fR if the size should change when filtering
the list, \fB\fCFalse\fR if it should keep the original height.
.IP \(bu 2
\fBscrollbar\fP: boolean
If the scrollbar should be enabled/disabled.
\fBscrollbar\fP: boolean If the scrollbar should be enabled/disabled.
.IP \(bu 2
\fBscrollbar-width\fP: distance
Width of the scrollbar
\fBscrollbar-width\fP: distance Width of the scrollbar
.IP \(bu 2
\fBcycle\fP: boolean
When navigating, it should wrap around
\fBcycle\fP: boolean When navigating, it should wrap around
.IP \(bu 2
\fBspacing\fP: distance
Spacing between the elements (both vertical and horizontal)
\fBspacing\fP: distance Spacing between the elements (both vertical
and horizontal)
.IP \(bu 2
\fBlines\fP: integer
Number of rows to show in the list view.
\fBlines\fP: integer Number of rows to show in the list view.
.IP \(bu 2
\fBlayout\fP: orientation
Indicate how elements are stacked. Horizontal implements the dmenu style.
\fBlayout\fP: orientation Indicate how elements are stacked.
Horizontal implements the dmenu style.
.IP \(bu 2
\fBreverse\fP: boolean
Reverse the ordering (top down to bottom up).
\fBreverse\fP: boolean Reverse the ordering (top down to bottom up).
.IP \(bu 2
\fBflow\fP: orientation
The order the elements are layed out. Vertical is the original 'column' view.
\fBflow\fP: orientation The order the elements are layed out.
Vertical is the original 'column' view.
.IP \(bu 2
\fBfixed-columns\fP: boolean
Do not reduce the number of columns shown when number of visible elements is not enough to fill them all.
\fBfixed-columns\fP: boolean Do not reduce the number of columns shown when
number of visible elements is not enough to fill them all.
.IP \(bu 2
\fBrequire-input\fP: boolean
Listview requires user input to be unhidden. The list is still present and
hitting accept will activate the first entry.
\fBrequire-input\fP: boolean Listview requires user input to be unhidden.
The list is still present and hitting accept will activate the first entry.
.RE
@ -1634,16 +1684,16 @@ By default the \fB\fCelement-icon\fR and \fB\fCelement-text\fR child widgets are
\fB\fC[no]-show-icons\fR option.
.PP
A child added with another name is treated the same as the special widget described
in the advanced layout
A child added with another name is treated the same as the special widget
described in the advanced layout
\[la]#advanced-layout\[ra] section.
.SS listview text highlight
.PP
The \fB\fCelement-text\fR widget in the \fB\fClistview\fR is the one used to show the text.
On this widget set the \fB\fChighlight\fR property (only place this property is used) to change
the style of highlighting.
The \fB\fChighlight\fR property consist of the \fB\fCtext-style\fR property and a color.
On this widget set the \fB\fChighlight\fR property (only place this property is used)
to change the style of highlighting. The \fB\fChighlight\fR property consist of the
\fB\fCtext-style\fR property and a color.
.PP
To disable highlighting:
@ -1675,11 +1725,12 @@ To set to red underlined:
.SH Layout
.PP
The new format allows the layout of the \fBrofi\fP window to be tweaked extensively.
For each widget, the themer can specify padding, margin, border, font, and more.
It even allows, as an advanced feature, to pack widgets in a custom structure.
The new format allows the layout of the \fBrofi\fP window to be tweaked
extensively. For each widget, the themer can specify padding, margin, border,
font, and more. It even allows, as an advanced feature, to pack widgets in a
custom structure.
.SS Basic structure
.SS Basic layout structure
.PP
The whole view is made out of boxes that pack other boxes or widgets.
The box can be vertical or horizontal. This is loosely inspired by GTK
@ -1770,7 +1821,8 @@ ns is the num-rows
.SS Advanced layout
.PP
The layout of \fBrofi\fP can be tweaked by packing the 'fixed' widgets in a custom structure.
The layout of \fBrofi\fP can be tweaked by packing the 'fixed' widgets in a
custom structure.
.PP
The following widgets are fixed, as they provide core \fBrofi\fP functionality:
@ -1798,26 +1850,27 @@ num-filtered-rows
.RE
.PP
The following keywords are defined and can be used to automatically pack a subset of the widgets.
These are used in the default theme as depicted in the figure above.
The following keywords are defined and can be used to automatically pack a
subset of the widgets. These are used in the default theme as depicted in the
figure above.
.RS
.IP \(bu 2
mainbox
Packs: \fB\fCinputbar, message, listview, mode-switcher\fR
mainbox Packs: \fB\fCinputbar, message, listview, mode-switcher\fR
.IP \(bu 2
inputbar
Packs: \fB\fCprompt,entry,case-indicator\fR
inputbar Packs: \fB\fCprompt,entry,case-indicator\fR
.RE
.PP
Any widget name starting with \fB\fCtextbox\fR is a textbox widget, others are box widgets and can pack other widgets.
Any widget name starting with \fB\fCtextbox\fR is a textbox widget, others are box
widgets and can pack other widgets.
.PP
There are several special widgets that can be used by prefixing the name of the widget:
There are several special widgets that can be used by prefixing the name of the
widget:
.SS textbox
.SS Textbox widget
.PP
This is a read-only textbox widget. The displayed string can be set with \fB\fCcontent\fR\&.
@ -1838,12 +1891,14 @@ textbox-custom {
.SS Icon
.PP
This is an icon widget. The displayed icon can be set with \fB\fCfilename\fR and size with \fB\fCsize\fR\&.
If the property \fB\fCaction\fR is set, it acts as a button.
\fB\fCaction\fR can be set to a keybinding name and completes that action. (see rofi -show keys for a list).
This is an icon widget. The displayed icon can be set with \fB\fCfilename\fR and size
with \fB\fCsize\fR\&. If the property \fB\fCaction\fR is set, it acts as a button. \fB\fCaction\fR can
be set to a keybinding name and completes that action. (see rofi -show keys for
a list).
.PP
If the \fB\fCsquared\fR property is set to \fBfalse\fP the widget height and width are not forced to be equal.
If the \fB\fCsquared\fR property is set to \fBfalse\fP the widget height and width are
not forced to be equal.
.PP
Example:
@ -1865,9 +1920,9 @@ icon-paste {
.SS button
.PP
This is a textbox widget that can have a 'clickable' action.
The \fB\fCaction\fR can be set to:
\fB\fCkeybinding\fR: accepts a keybinding name and completes that action. (see rofi -show keys for a list).
This is a textbox widget that can have a 'clickable' action. The \fB\fCaction\fR can
be set to: \fB\fCkeybinding\fR: accepts a keybinding name and completes that action.
(see rofi -show keys for a list).
.PP
.RS
@ -1981,19 +2036,19 @@ Explanation of the different parts:
.IP \(bu 2
Content - The content of the widget.
.IP \(bu 2
Padding - Clears an area around the widget.
The padding shows the background color of the widget.
Padding - Clears an area around the widget. The padding shows the
background color of the widget.
.IP \(bu 2
Border - A border that goes around the padding and content.
The border use the border-color of the widget.
Border - A border that goes around the padding and content. The border use
the border-color of the widget.
.IP \(bu 2
Margin - Clears an area outside the border.
The margin is transparent.
Margin - Clears an area outside the border. The margin is transparent.
.RE
.PP
The box model allows us to add a border around elements, and to define space between elements.
The box model allows us to add a border around elements, and to define space
between elements.
.PP
The size of each margin, border, and padding can be set.
@ -2001,8 +2056,9 @@ For the border, a linestyle and radius can be set.
.SS Spacing
.PP
Widgets that can pack more then one child widget (currently box and listview) have the \fB\fCspacing\fR property.
This property sets the distance between the packed widgets (both horizontally and vertically).
Widgets that can pack more then one child widget (currently box and listview)
have the \fB\fCspacing\fR property. This property sets the distance between the packed
widgets (both horizontally and vertically).
.PP
.RS
@ -2023,7 +2079,8 @@ This property sets the distance between the packed widgets (both horizontally an
.SS Advanced box packing
.PP
More dynamic spacing can be achieved by adding dummy widgets, for example to make one widget centered:
More dynamic spacing can be achieved by adding dummy widgets, for example to
make one widget centered:
.PP
.RS
@ -2043,9 +2100,10 @@ More dynamic spacing can be achieved by adding dummy widgets, for example to mak
.RE
.PP
If both dummy widgets are set to expand, \fB\fCchild\fR will be centered. Depending on the \fB\fCexpand\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 expand, \fB\fCchild\fR will be centered. Depending on
the \fB\fCexpand\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
.PP
@ -2061,7 +2119,8 @@ G_MESSAGES_DEBUG=Parser rofi -show run
.RE
.PP
Syntax errors are shown in a popup and printed out to command line with the above command.
Syntax errors are shown in a popup and printed out to command line with the
above command.
.PP
To see the elements queried during running, run:
@ -2076,7 +2135,8 @@ G_MESSAGES_DEBUG=Theme rofi -show run
.RE
.PP
To test minor changes, part of the theme can be passed on the command line, for example to set it to full-screen:
To test minor changes, part of the theme can be passed on the command line, for
example to set it to full-screen:
.PP
.RS
@ -2150,7 +2210,8 @@ It supports the following keys as constraint:
.RE
.PP
@media takes an integer number or a fraction, for integer number \fB\fCpx\fR can be added.
@media takes an integer number or a fraction, for integer number \fB\fCpx\fR can be
added.
.PP
.RS
@ -2315,8 +2376,8 @@ extensions.
.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.
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
@ -2362,8 +2423,9 @@ 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
\fB\fC{datadir}\fR is the install path of \fBrofi\fP data. When installed using a package manager, this is usually: \fB\fC/usr/share/\fR\&.
Several examples are installed together with \fBrofi\fP\&. These can be found in
\fB\fC{datadir}/rofi/themes/\fR, where \fB\fC{datadir}\fR is the install path of \fBrofi\fP
data. When installed using a package manager, this is usually: \fB\fC/usr/share/\fR\&.
.SH SEE ALSO
.PP

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

File diff suppressed because it is too large Load diff