diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml new file mode 100644 index 00000000..4137d29a --- /dev/null +++ b/.github/workflows/mkdocs.yml @@ -0,0 +1,20 @@ +name: Publish docs via GitHub Pages +on: + push: + branches: + - sphinx + - next + +jobs: + build: + name: Deploy docs + runs-on: ubuntu-latest + steps: + - name: Checkout master + uses: actions/checkout@v1 + + - name: Deploy docs + uses: mhausenblas/mkdocs-deploy-gh-pages@master + env: + CONFIG_FILE: mkdocs/mkdocs.yml + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/CONFIG.md b/CONFIG.md index 8732b12c..f065cb86 100644 --- a/CONFIG.md +++ b/CONFIG.md @@ -1,22 +1,8 @@ -> # :warning: This page does not describe all of **ROFI**'s configuration options, just the most common usecase. For the full configuration options, check the manpages. +> This page does not describe all of **ROFI**'s configuration options, just the most common usecase. For the full configuration options, check the manpages.
-## :exclamation: Upgrade from old configuration format to new :exclamation: - -In release after '2 Jan 2020' you can convert to the new configuration format by using the following command: - -```bash -rofi -upgrade-config -``` - -This will create `~/.config/rofi/config.rasi` (or the default location for your system) with the previously configured options. - -From 1.7.0 the old configuration format is no longer supported and the `-upgrade-config` option is no longer available. - -
- # Where does the configuration live Rofi's configurations, custom themes live in `${XDG_CONFIG_HOME}/rofi/`, on most systems this is `~/.config/rofi/`. @@ -62,6 +48,12 @@ configuration { } ``` +To create a copy of the current theme, you can run: + +```bash +rofi -dump-theme > ~/.config/rofi/current.rasi +``` + # Configuration file format ## Encoding @@ -195,6 +187,7 @@ configuration { ``` -Rofi will first parse the config block in `~/.config/rofi/config.rasi`, then parse `~/.config/rofi/myConfig.rasi` and then load the theme `myTheme`.\ -More information can be obtained from **Themes** section\ -Imports can be nested. +Rofi will first parse the config block in `~/.config/rofi/config.rasi`, then +parse `~/.config/rofi/myConfig.rasi` and then load the theme `myTheme`. More +information can be obtained from the **rofi-theme(5)** manpage. Imports can be +nested. diff --git a/INSTALL.md b/INSTALL.md index aff74e02..4e305095 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -184,6 +184,8 @@ can then load the core in GDB. > Where the core file is located and what its exact name is different on each distributions. Please consult the > relevant documentation. +For more information see the rofi-debugging(5) manpage. + ## Install distribution ### Debian or Ubuntu diff --git a/doc/rofi-theme.5 b/doc/rofi-theme.5 index b7b64b25..080c0854 100644 --- a/doc/rofi-theme.5 +++ b/doc/rofi-theme.5 @@ -4,7 +4,7 @@ .PP \fBrofi-theme\fP - Rofi theme format files -.SH GETTING STARTED WITH THEMING +.SH Getting started with theming .PP The easiest way to get started theming rofi is by modifying your existing theme. @@ -227,7 +227,7 @@ rofi -dump-theme .fi .RE -.SH DEFAULT THEME LOADING +.SH Default theme loading .PP By default, rofi loads the default theme. This theme is \fBalways\fP loaded. The default configuration contains: @@ -265,14 +265,14 @@ rofi -no-config -dump-theme .fi .RE -.SH DESCRIPTION +.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. -.SH FORMAT SPECIFICATION +.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 @@ -556,7 +556,7 @@ Inherit .PP Some of these types are a combination of other types. -.SH String +.SS String .RS .IP \(bu 2 Format: \fB\fC"[:print:]+"\fR @@ -595,7 +595,7 @@ text { .PP The following special characters can be escaped: \fB\fC\\b\fR, \fB\fC\\f\fR, \fB\fC\\n\fR, \fB\fC\\r\fR, \fB\fC\\t\fR, \fB\fC\\v\fR, \fB\fC\\\fR and \fB\fC"\fR\&. -.SH Integer +.SS Integer .RS .IP \(bu 2 Format: \fB\fC[-+]?[:digit:]+\fR @@ -617,7 +617,7 @@ lines: 12; .fi .RE -.SH Real +.SS Real .RS .IP \(bu 2 Format: \fB\fC[-+]?[:digit:]+(\\.[:digit:]+)?\fR @@ -642,7 +642,7 @@ real: 3.4; .PP The following is not valid: \fB\fC\&.3\fR, \fB\fC3.\fR or scientific notation: \fB\fC3.4e-3\fR\&. -.SH Boolean +.SS Boolean .RS .IP \(bu 2 Format: \fB\fC(true|false)\fR @@ -664,7 +664,7 @@ dynamic: false; .fi .RE -.SH Image +.SS Image .PP \fBrofi\fP support a limited set of background-image formats. @@ -688,7 +688,7 @@ Angle in deg,rad,grad (as used in color). .PP Where the \fB\fCpath\fR is a string, and \fB\fCstop\fR color is of type color. -.SH Color +.SS Color .PP \fBrofi\fP supports the color formats as specified in the CSS standard (1,2,3 and some of CSS 4) @@ -776,7 +776,7 @@ text-color: Black; .fi .RE -.SH Text style +.SS Text style .RS .IP \(bu 2 Format: \fB\fC(bold|italic|underline|strikethrough|none)\fR @@ -820,7 +820,7 @@ The following option is disabled as pango crashes on this if there is eel .RE -.SH Line style +.SS Line style .RS .IP \(bu 2 Format: \fB\fC(dash|solid)\fR @@ -833,7 +833,7 @@ 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 -.SH Distance +.SS Distance .RS .IP \(bu 2 Format: \fB\fC{Integer}px\fR @@ -935,7 +935,7 @@ It supports the following operations: .PP It uses the C precedence ordering. -.SH Padding +.SS Padding .RS .IP \(bu 2 Format: \fB\fC{Integer}\fR @@ -968,7 +968,7 @@ The different number of fields in the formats are parsed like: .RE -.SH Border +.SS Border .RS .IP \(bu 2 Format: \fB\fC{Integer}\fR @@ -1003,7 +1003,7 @@ When no unit is specified, pixels are assumed. .RE -.SH Position +.SS Position .PP Indicate a place on the window/monitor. @@ -1028,7 +1028,7 @@ Format: \fB\fC(center|east|north|west|south|north east|north west|south west|sou .RE -.SH Visibility +.SS Visibility .PP It is possible to hide widgets: @@ -1043,7 +1043,7 @@ inputbar { .fi .RE -.SH Reference +.SS Reference .RS .IP \(bu 2 Format: \fB\fC@{PROPERTY NAME}\fR @@ -1110,7 +1110,7 @@ window { 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. -.SH Orientation +.SS Orientation .RS .IP \(bu 2 Format: \fB\fC(horizontal|vertical)\fR @@ -1120,7 +1120,7 @@ Format: \fB\fC(horizontal|vertical)\fR .PP Specify the orientation of the widget. -.SH Cursor +.SS Cursor .RS .IP \(bu 2 Format: \fB\fC(default|pointer|text)\fR @@ -1130,7 +1130,7 @@ Format: \fB\fC(default|pointer|text)\fR .PP Specify the type of mouse cursor that is set when the mouse pointer is over the widget. -.SH List of keywords +.SS List of keywords .RS .IP \(bu 2 Format: \fB\fC[ keyword, keyword ]\fR @@ -1141,7 +1141,7 @@ Format: \fB\fC[ keyword, keyword ]\fR 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. -.SH List of values +.SS List of values .RS .IP \(bu 2 Format: \fB\fC[ value, value, ... ]\fR @@ -1151,7 +1151,7 @@ Format: \fB\fC[ value, value, ... ]\fR .PP An list starts with a '[' and ends with a ']'. The entries in the list are comma-separated. -.SH Environment variable +.SS Environment variable .RS .IP \(bu 2 Format: \fB\fC${:alnum:}\fR @@ -1198,7 +1198,7 @@ window { .PP If environment WIDTH is set, then that value is parsed, otherwise the default value (\fB\fC40%\fR). -.SH Inherit +.SS Inherit .RS .IP \(bu 2 Format: \fB\fCinherit\fR @@ -1219,7 +1219,7 @@ mainbox { .fi .RE -.SH ELEMENTS PATHS +.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. @@ -1257,10 +1257,10 @@ element selected { .fi .RE -.SH SUPPORTED ELEMENT PATH -.SH Name +.SS Supported element paths +.SS Name .PP -The current widgets available in \fBrofi\fP: +The default widgets available in \fBrofi\fP and the default hierarchic: .RS .IP \(bu 2 @@ -1338,7 +1338,7 @@ The current widgets available in \fBrofi\fP: Note that these path names match the default theme. Themes that provide a custom layout will have different elements, and structure. -.SH State +.SS State .PP State: State of widget @@ -1401,11 +1401,11 @@ Note that a state modifies the original element, it therefore contains all the p The scrollbar uses the \fB\fChandle\fR state when drawing the small scrollbar handle. This allows the colors used for drawing the handle to be set independently. -.SH SUPPORTED PROPERTIES +.SH Widget properties .PP The following properties are currently supported: -.SS all widgets: +.SS all widgets .RS .IP \(bu 2 \fBenabled\fP: enable/disable rendering of the widget @@ -1436,7 +1436,7 @@ Type of mouse cursor that is set when the mouse pointer is hovered over the widg .RE -.SS window: +.SS window .RS .IP \(bu 2 \fBfont\fP: string @@ -1468,7 +1468,7 @@ The offset of the window to the anchor point, allowing you to push the window le .RE -.SS scrollbar: +.SS scrollbar .RS .IP \(bu 2 \fBbackground-color\fP: color @@ -1481,7 +1481,7 @@ The offset of the window to the anchor point, allowing you to push the window le .RE -.SS box: +.SS box .RS .IP \(bu 2 \fBorientation\fP: orientation @@ -1492,7 +1492,7 @@ The offset of the window to the anchor point, allowing you to push the window le .RE -.SS textbox: +.SS textbox .RS .IP \(bu 2 \fBbackground-color\fP: color @@ -1552,7 +1552,7 @@ The text appears to the right of the tab stop position (other alignments are not .RE -.SS listview: +.SS listview .RS .IP \(bu 2 \fBcolumns\fP: integer @@ -1600,7 +1600,7 @@ hitting accept will activate the first entry. .PP Each element is a \fB\fCbox\fR called \fB\fCelement\fR\&. Each \fB\fCelement\fR can contain an \fB\fCelement-icon\fR and \fB\fCelement-text\fR\&. -.SS listview text highlight: +.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 @@ -2009,7 +2009,7 @@ If both dummy widgets are set to expand, \fB\fCchild\fR will be centered. Depend remaining space will be equally divided between both dummy and child widget (expand enabled), or both dummy widgets (expand disabled). -.SH DEBUGGING +.SH Debugging .PP To get debug information from the parser, run rofi like: @@ -2259,7 +2259,7 @@ If a filename is provided, it will try to resolve it in the following order: .PP A name is resolved as a filename by appending the \fB\fC\&.rasi\fR extension. -.SH EXAMPLES +.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\&. diff --git a/doc/rofi-theme.5.markdown b/doc/rofi-theme.5.markdown index bec95423..99e98e5f 100644 --- a/doc/rofi-theme.5.markdown +++ b/doc/rofi-theme.5.markdown @@ -4,7 +4,7 @@ **rofi-theme** - Rofi theme format files -## GETTING STARTED WITH THEMING +## Getting started with theming The easiest way to get started theming rofi is by modifying your existing theme. @@ -150,7 +150,7 @@ If you want to see the complete theme, including the modification you can run: rofi -dump-theme ``` -## DEFAULT THEME LOADING +## Default theme loading By default, rofi loads the default theme. This theme is **always** loaded. The default configuration contains: @@ -174,14 +174,14 @@ To see the default theme, run the following command: rofi -no-config -dump-theme ``` -## DESCRIPTION +## Description 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. -## FORMAT SPECIFICATION +## Format specification ## Encoding @@ -370,7 +370,7 @@ The current theme format supports different types: Some of these types are a combination of other types. -## String +### String * Format: `"[:print:]+"` @@ -392,7 +392,7 @@ text { The following special characters can be escaped: `\b`, `\f`, `\n`, `\r`, `\t`, `\v`, `\` and `"`. -## Integer +### Integer * Format: `[-+]?[:digit:]+` @@ -404,7 +404,7 @@ For examples: lines: 12; ``` -## Real +### Real * Format: `[-+]?[:digit:]+(\.[:digit:]+)?` @@ -418,7 +418,7 @@ real: 3.4; The following is not valid: `.3`, `3.` or scientific notation: `3.4e-3`. -## Boolean +### Boolean * Format: `(true|false)` @@ -431,7 +431,7 @@ For example: dynamic: false; ``` -## Image +### Image **rofi** support a limited set of background-image formats. @@ -446,7 +446,7 @@ dynamic: false; Where the `path` is a string, and `stop` color is of type color. -## Color +### Color **rofi** supports the color formats as specified in the CSS standard (1,2,3 and some of CSS 4) @@ -502,7 +502,7 @@ background-color: transparent; text-color: Black; ``` -## Text style +### Text style * Format: `(bold|italic|underline|strikethrough|none)` @@ -524,7 +524,7 @@ The following options are available on pango 1.50.0 and up: * `capitalize`: Capitalize the text. -## Line style +### Line style * Format: `(dash|solid)` @@ -533,7 +533,7 @@ It currently supports: * `dash`: a dashed line, where the gap is the same width as the dash * `solid`: a solid line -## Distance +### Distance * Format: `{Integer}px` * Format: `{Real}em` @@ -559,7 +559,7 @@ For example: On a full-HD (1920x1080) monitor, it defines a padding of 192 pixels on the left and right side and 108 pixels on the top and bottom. -### Calculating sizes +#### Calculating sizes Rofi supports some maths in calculating sizes. For this it uses the CSS syntax: @@ -586,7 +586,7 @@ It supports the following operations: It uses the C precedence ordering. -## Padding +### Padding * Format: `{Integer}` * Format: `{Distance}` @@ -604,7 +604,7 @@ The different number of fields in the formats are parsed like: * 4 fields: `top`, `right`, `bottom`, `left` -## Border +### Border * Format: `{Integer}` * Format: `{Distance}` @@ -622,7 +622,7 @@ style property. > When no unit is specified, pixels are assumed. -## Position +### Position Indicate a place on the window/monitor. @@ -638,7 +638,7 @@ Indicate a place on the window/monitor. * Format: `(center|east|north|west|south|north east|north west|south west|south east)` -## Visibility +### Visibility It is possible to hide widgets: @@ -649,7 +649,7 @@ inputbar { ``` -## Reference +### Reference * Format: `@{PROPERTY NAME}` @@ -690,32 +690,32 @@ If the property `width` is set globally (`*{}`) that value is used, if the prope `width` is not set, the default value is used. -## Orientation +### Orientation * Format: `(horizontal|vertical)` Specify the orientation of the widget. -## Cursor +### Cursor * Format: `(default|pointer|text)` Specify the type of mouse cursor that is set when the mouse pointer is over the widget. -## List of keywords +### List of keywords * Format: `[ keyword, keyword ]` A list starts with a '[' and ends with a ']'. The entries in the list are comma-separated. The `keyword` in the list refers to an widget name. -## List of values +### List of values * Format: `[ value, value, ... ]` An list starts with a '[' and ends with a ']'. The entries in the list are comma-separated. -## Environment variable +### Environment variable * Format: `${:alnum:}` @@ -742,7 +742,7 @@ window { If environment WIDTH is set, then that value is parsed, otherwise the default value (`40%`). -## Inherit +### Inherit * Format: `inherit` @@ -755,7 +755,7 @@ mainbox { ``` -## ELEMENTS PATHS +## Elements paths Element paths exists of two parts, the first part refers to the actual widget by name. Some widgets have an extra state. @@ -780,11 +780,11 @@ element selected { } ``` -## SUPPORTED ELEMENT PATH +### Supported element paths -## Name +### Name -The current widgets available in **rofi**: +The default widgets available in **rofi** and the default hierarchic: * `window` * `overlay`: the overlay widget. @@ -813,7 +813,7 @@ Note that these path names match the default theme. Themes that provide a custom elements, and structure. -## State +### State State: State of widget @@ -821,7 +821,7 @@ Optional flag(s) indicating state of the widget, used for theming. These are appended after the name or class of the widget. -### Example: +#### Example: `button selected.normal { }` @@ -829,7 +829,7 @@ These are appended after the name or class of the widget. Currently only the entrybox and scrollbar have states: -### Entrybox: +#### Entrybox: `{visible modifier}.{state}` @@ -857,17 +857,17 @@ nametotextbox selected.active { 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. -### Scrollbar +#### Scrollbar The scrollbar uses the `handle` state when drawing the small scrollbar handle. This allows the colors used for drawing the handle to be set independently. -## SUPPORTED PROPERTIES +## Widget properties The following properties are currently supported: -### all widgets: +### all widgets * **enabled**: enable/disable rendering of the widget * **padding**: padding @@ -887,7 +887,7 @@ The following properties are currently supported: * **cursor**: cursor Type of mouse cursor that is set when the mouse pointer is hovered over the widget. -### window: +### window * **font**: string The font used in the window @@ -912,21 +912,21 @@ The following properties are currently supported: The offset of the window to the anchor point, allowing you to push the window left/right/up/down -### scrollbar: +### scrollbar * **background-color**: color * **handle-width**: distance * **handle-color**: color * **border-color**: color -### box: +### box * **orientation**: orientation Set the direction the elements are packed. * **spacing**: distance Distance between the packed elements. -### textbox: +### textbox * **background-color**: color * **border-color**: the color used for the border around the widget. @@ -959,7 +959,7 @@ The following properties are currently supported: * **text-outline-width**: The width of the border around the text. (Double) * **text-outline-color**: The color to use for the text outline. (Color) -### listview: +### listview * **columns**: integer Number of columns to show (at least 1) * **fixed-height**: boolean @@ -990,7 +990,7 @@ The following properties are currently supported: Each element is a `box` called `element`. Each `element` can contain an `element-icon` and `element-text`. -### listview text highlight: +#### listview text highlight The `element-text` widget in the `listview` is the one used to show the text. On this widget set the `highlight` property (only place this property is used) to change @@ -1291,7 +1291,7 @@ If both dummy widgets are set to expand, `child` will be centered. Depending on remaining space will be equally divided between both dummy and child widget (expand enabled), or both dummy widgets (expand disabled). -## DEBUGGING +## Debugging To get debug information from the parser, run rofi like: @@ -1434,7 +1434,7 @@ A name is resolved as a filename by appending the `.rasi` extension. -## EXAMPLES +## Examples Several examples are installed together with **rofi**. These can be found in `{datadir}/rofi/themes/`, where `{datadir}` is the install path of **rofi** data. When installed using a package manager, this is usually: `/usr/share/`. diff --git a/doc/rofi.1 b/doc/rofi.1 index 20db729f..d99e8f26 100644 --- a/doc/rofi.1 +++ b/doc/rofi.1 @@ -1577,11 +1577,17 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. .SH SUPPORT .PP \fBrofi\fP support can be obtained: - * GitHub Discussions + +.RS +.IP \(bu 2 +GitHub Discussions \[la]https://github.com/davatorium/rofi/discussions\[ra] - * IRC +.IP \(bu 2 +IRC \[la]irc://irc.libera.chat:6697/#rofi\[ra] (#rofi on irc.libera.chat), +.RE + .SH DEBUGGING .PP For more information see \fBrofi-debugging(5)\fP manpage. diff --git a/doc/rofi.1.markdown b/doc/rofi.1.markdown index 73d94af6..dc1bde35 100644 --- a/doc/rofi.1.markdown +++ b/doc/rofi.1.markdown @@ -1001,6 +1001,7 @@ been released. ## SUPPORT **rofi** support can be obtained: + * [GitHub Discussions](https://github.com/davatorium/rofi/discussions) * [IRC](irc://irc.libera.chat:6697/#rofi) (#rofi on irc.libera.chat), diff --git a/mkdocs/docs/1.7.0/rofi-script.5.markdown b/mkdocs/docs/1.7.0/rofi-script.5.markdown new file mode 100644 index 00000000..3e6bd778 --- /dev/null +++ b/mkdocs/docs/1.7.0/rofi-script.5.markdown @@ -0,0 +1,145 @@ +# ROFI-SCRIPT 5 rofi-script + +## NAME + +**rofi script mode** - Rofi format for scriptable modi. + + +## DESCRIPTION + +**rofi** supports modes that use simple scripts in the background to generate a list and process the result from user +actions. This provide a simple interface to make simple extensions to rofi. + + +## USAGE + +To specify a script mode, set a mode with the following syntax: "{name}:{executable}" + +For example: + +``` +rofi -show fb -modi "fb:file_browser.sh" +``` + +The name should be unique. + +## API + +Rofi calls the executable without arguments on startup. This should generate a list of options, separated by a newline +(`\n`) (This can be changed by the script). +If the user selects an option, rofi calls the executable with the text of that option as the first argument. +If the script returns no entries, rofi quits. + +A simple script would be: + +```bash +#!/usr/bin/env bash + +if [ x"$@" = x"quit" ] +then + exit 0 +fi +echo "reload" +echo "quit" + +``` + +This shows two entries, reload and quit. When the quit entry is selected, rofi closes. + +## Environment + +Rofi sets the following environment variable when executing the script: + +### `ROFI_RETV` + +An integer number with the current state: + + * **0**: Initial call of script. + * **1**: Selected an entry. + * **2**: Selected a custom entry. + * **10-28**: Custom keybinding 1-19 ( need to be explicitly enabled by script ). + +### `ROFI_INFO` + +Environment get set when selected entry get set with the property value of the 'info' row option, if set. + +## Passing mode options + +Extra options, like setting the prompt, can be set by the script. +Extra options are lines that start with a NULL character (`\0`) followed by a key, separator (`\x1f`) and value. + +For example to set the prompt: + +```bash + echo -en "\0prompt\x1fChange prompt\n" +``` + +The following extra options exists: + + * **prompt**: Update the prompt text. + * **message**: Update the message text. + * **markup-rows**: If 'true' renders markup in the row. + * **urgent**: Mark rows as urgent. (for syntax see the urgent option in dmenu mode) + * **active**: Mark rows as active. (for syntax see the active option in dmenu mode) + * **delim**: Set the delimiter for for next rows. Default is '\n' and this option should finish with this. Only call this on first call of script, it is remembered for consecutive calls. + * **no-custom**: If set to 'true'; only accept listed entries, ignore custom input. + * **use-hot-keys**: If set to true, it enabled the Custom keybindings for script. Warning this breaks the normal rofi flow. + +## Parsing row options + +Extra options for individual rows can be set. +The extra option can be specified following the same syntax as mode option, but following the entry. + +For example: + +```bash + echo -en "aap\0icon\x1ffolder\n" +``` + +The following options are supported: + + * **icon**: Set the icon for that row. + * **meta**: Specify invisible search terms. + * **nonselectable**: If true the row cannot activated. + * **info**: Info that, on selection, gets placed in the `ROFI_INFO` environment variable. This entry does not get searched. + +multiple entries can be passed using the `\x1f` separator. + +```bash + echo -en "aap\0icon\x1ffolder\x1finfo\x1ftest\n" +``` + +## Executing external program + +If you want to launch an external program from the script, you need to make sure it is launched in the background. +If not rofi will wait for its output (to display). + +In bash the best way to do this is using `coproc`. + +```bash + coproc ( myApp > /dev/null 2>&1 ) +``` + + +## DASH shell + +If you use the `dash` shell for your script, take special care with how dash handles escaped values for the separators. +See issue #1201 on github. + + +## SEE ALSO + +rofi(1), rofi-sensible-terminal(1), dmenu(1), rofi-theme(5), rofi-theme-selector(1) + +## AUTHOR + +Qball Cow + +Rasmus Steinke + +Quentin Glidic + + +Original code based on work by: Sean Pringle + +For a full list of authors, check the AUTHORS file. diff --git a/mkdocs/docs/1.7.0/rofi-theme.5.markdown b/mkdocs/docs/1.7.0/rofi-theme.5.markdown new file mode 100644 index 00000000..ba96ead3 --- /dev/null +++ b/mkdocs/docs/1.7.0/rofi-theme.5.markdown @@ -0,0 +1,1140 @@ +# ROFI-THEME 5 rofi-theme + +## NAME + +**rofi-theme** - Rofi theme format files + +## DESCRIPTION + +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. + +## FORMAT SPECIFICATION + +## Encoding + +The encoding of the file is utf-8. Both unix (`\n`) and windows (`\r\n`) newlines format are supported. But unix is +preferred. + +## Comments + +C and C++ file comments are supported. + +* Anything after `// ` and before a newline is considered a comment. +* Everything between `/*` and `*/` is a comment. + +Comments can be nested and the C comments can be inline. + +The following is valid: + +```css +// Magic comment. +property: /* comment */ value; +``` + +However, this is not: + +```css +prop/*comment*/erty: value; +``` + +## White space + +White space and newlines, like comments, are ignored by the parser. + +This: + +```css +property: name; +``` + +Is identical to: + +```css + property : +name + +; +``` + +## File extension + +The preferred file extension for the new theme format is **rasi**. This is an +abbreviation for **r**ofi **a**dvanced **s**tyle **i**nformation. + +## Basic Structure + +Each element has a section with defined properties. 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 +make inheritance of properties clearer. + +```css +/* Global properties section */ +* { + // list of properties +} + +/* Element theme section. */ +{element path} { + // list of properties +} +{elements... } { + // list of properties +} +``` + +If there are multiple sections with the same name, they are merged. Duplicate properties are overwritten and the last +parsed entry kept. + +## Global properties section + +A theme can have one or more global properties sections. If there is more than one, +they will be merged. + +The global properties section denotes the defaults for each element. +Each property of this section can be referenced with `@{identifier}` +(See Properties section) + +A global properties section is indicated with a `*` as element path. + +## Element theme section + +A theme can have multiple element theme sections. + +The element path can consist of multiple names separated by whitespace or dots. +Each element may contain any number of letters, numbers and `-`'s. +The first element in the element path should always start with a `#`. +Multiple elements can be specified by a `,`. + +This is a valid element name: + +```css +element normal.normal { + background-color: blue; +} +button { + background-color: blue; +} +``` + +And is identical to: + +```css +element normal normal, button { + background-color: blue; +} +``` + +Each section inherits the global properties. Properties can be explicitly inherited from their parent with the +`inherit` keyword. +In the following example: + +```css +window { + a: 1; + b: 2; + children: [ mainbox ]; +} +mainbox { + a: inherit; + b: 4; + c: 8; +} +``` + +The element `mainbox` will have the following set of properties (if `mainbox` is a child of `window`): + +```css +a: 1; +b: 4; +c: 8; +``` + +If multiple sections are defined with the same name, they are merged by the +parser. If multiple properties with the same name are defined in one section, +the last encountered property is used. + +## Properties Format + +The properties in a section consist of: + +```css +{identifier}: {value}; +``` + +Both fields are mandatory for a property. + +The `identifier` names the specified property. Identifiers can consist of any +combination of numbers, letters and '-'. It must not contain any whitespace. +The structure of the `value` defines the type of the property. The current +parser does not define or enforce a certain type of a particular `identifier`. +When used, values with the wrong type that cannot be converted are ignored. + +The current theme format supports different types: + + * a string + * an integer number + * a fractional number + * a boolean value + * a color + * image + * text style + * line style + * a distance + * a padding + * a border + * a position + * a reference + * an orientation + * a cursor + * a list of keywords + * an environment variable + * Inherit + +Some of these types are a combination of other types. + +## String + +* Format: `"[:print:]+"` + +A string is always surrounded by double quotes (`"`). Between the quotes there can be any printable character. + +For example: + +```css +font: "Awasome 12"; +``` + +The string must be valid UTF-8. + +## Integer + +* Format: `[-+]?[:digit:]+` + +An integer may contain any number. + +For examples: + +```css +lines: 12; +``` + +## Real + +* Format: `[-+]?[:digit:]+(\.[:digit:]+)?` + +A real is an integer with an optional fraction. + +For example: + +```css +real: 3.4; +``` + +The following is not valid: `.3`, `3.` or scientific notation: `3.4e-3`. + +## Boolean + +* Format: `(true|false)` + +Boolean value is either `true` or `false`. This is case-sensitive. + + +For example: + +```css +dynamic: false; +``` + +## Image + +**rofi** support a limited set of background-image formats. + +* Format: url("path to image"); +* Format: url("path to image", scale); + where scale is: none, both, width, height +* Format: linear-gradient(stop color,stop1, color, stop2 color, ...); +* Format: linear-gradient(to direction, stop color,stop1, color, stop2 color, ...); + where direction is: top,left,right,bottom. +* Format: linear-gradient(angle, stop color,stop1, color, stop2 color, ...); + Angle in deg,rad,grad (as used in color). + +Where the `path` is a string, and `stop` color is of type color. + +## Color + +**rofi** supports the color formats as specified in the CSS standard (1,2,3 and some of CSS 4) + +* Format: `#{HEX}{3}` (rgb) +* Format: `#{HEX}{4}` (rgba) +* Format: `#{HEX}{6}` (rrggbb) +* Format: `#{HEX}{8}` (rrggbbaa) +* Format: `rgb[a]({INTEGER},{INTEGER},{INTEGER}[, {PERCENTAGE}])` +* Format: `rgb[a]({INTEGER}%,{INTEGER}%,{INTEGER}%[, {PERCENTAGE}])` +* Format: `hsl[a]( {ANGLE}, {PERCENTAGE}, {PERCENTAGE} [, {PERCENTAGE}])` +* Format: `hwb[a]( {ANGLE}, {PERCENTAGE}, {PERCENTAGE} [, {PERCENTAGE}])` +* Format: `cmyk( {PERCENTAGE}, {PERCENTAGE}, {PERCENTAGE}, {PERCENTAGE} [, {PERCENTAGE} ])` +* Format: `{named-color} [ / {PERCENTAGE} ]` + +The white-space format proposed in CSS4 is also supported. + +The different values are: + + * `{HEX}` is a hexadecimal number ('0-9a-f' case insensitive). + * `{INTEGER}` value can be between 0 and 255 or 0-100 when representing percentage. + * `{ANGLE}` is the angle on the color wheel, can be in `deg`, `rad`, `grad` or `turn`. When no unit is specified, degrees is assumed. + * `{PERCENTAGE}` can be between 0-1.0, or 0%-100% + * `{named-color}` 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 + + + +For example: + +```css +background-color: #FF0000; +border-color: rgba(0,0,1, 0.5); +text-color: SeaGreen; +``` +or + +```css +background-color: transparent; +text-color: Black; +``` + +## Text style + +* Format: `(bold|italic|underline|strikethrough|none)` + +Text style indicates how the highlighted text is emphasized. `None` indicates that no emphasis +should be applied. + + * `bold`: make the text thicker then the surrounding text. + * `italic`: put the highlighted text in script type (slanted). + * `underline`: put a line under the highlighted text. + * `strikethrough`: put a line through the highlighted text. + +## Line style + +* Format: `(dash|solid)` + +Indicates how a line should be drawn. +It currently supports: + * `dash`: a dashed line, where the gap is the same width as the dash + * `solid`: a solid line + +## Distance + +* Format: `{Integer}px` +* Format: `{Real}em` +* Format: `{Real}ch` +* Format: `{Real}%` +* Format: `{Integer}mm` + +A distance can be specified in 3 different units: + +* `px`: Screen pixels. +* `em`: Relative to text height. +* `ch`: Relative to width of a single number. +* `mm`: Actual size in millimeters (based on dpi). +* `%`: Percentage of the **monitor** size. + +Distances used in the horizontal direction use the monitor width. Distances in +the vertical direction use the monitor height. +For example: + +```css + padding: 10%; +``` +On a full-HD (1920x1080) monitor, it defines a padding of 192 pixels on the left +and right side and 108 pixels on the top and bottom. + +### Calculating sizes + +Rofi supports some maths in calculating sizes. For this it uses the CSS syntax: + +```css +width: calc( 100% - 37px ); +``` + +It supports the following operations: + +* `+` : Add +* `-` : Subtract +* `/` : Divide +* `*` : Multiply +* `%` : Multiply +* `min` : Minimum of l or rvalue; +* `max` : Maximum of l or rvalue; + +It uses the C precedence ordering. + +## Padding + +* Format: `{Integer}` +* Format: `{Distance}` +* Format: `{Distance} {Distance}` +* Format: `{Distance} {Distance} {Distance}` +* Format: `{Distance} {Distance} {Distance} {Distance}` + +If no unit is specified, pixels are assumed. + +The different number of fields in the formats are parsed like: + +* 1 field: `all` +* 2 fields: `top&bottom` `left&right` +* 3 fields: `top`, `left&right`, `bottom` +* 4 fields: `top`, `right`, `bottom`, `left` + + +## Border + +* Format: `{Integer}` +* Format: `{Distance}` +* Format: `{Distance} {Distance}` +* Format: `{Distance} {Distance} {Distance}` +* Format: `{Distance} {Distance} {Distance} {Distance}` +* Format: `{Distance} {Line style}` +* Format: `{Distance} {Line style} {Distance} {Line style}` +* Format: `{Distance} {Line style} {Distance} {Line style} {Distance} {Line style}` +* Format: `{Distance} {Line style} {Distance} {Line style} {Distance} {Line style} {Distance} {Line style}` + +Borders are identical to padding, except that each distance field has a line +style property. + +> When no unit is specified, pixels are assumed. + +## Position + +Indicate a place on the window/monitor. + +* Format: `(center|east|north|west|south|north east|north west|south west|south east)` + +``` + +north west | north | north east +-------------|-------------|------------ + west | center | east +-------------|-------------|------------ +south west | south | south east +``` + +## Visibility + +It is possible to hide widgets: + +inputbar { + enabled: false; +} + +## Reference + +* Format: `@{PROPERTY NAME}` + +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: + +```css +highlight: bold @pink; +``` + +But this is: + +```css +* { + myhigh: bold #FAA; +} + +window { + highlight: @myhigh; +} +``` + +## Orientation + + * Format: `(horizontal|vertical)` + +Specify the orientation of the widget. + +## Cursor + + * Format: `(default|pointer|text)` + +Specify the type of mouse cursor that is set when the mouse pointer is over the widget. + +## List of keywords + +* Format: `[ keyword, keyword ]` + +A list starts with a '[' and ends with a ']'. The entries in the list are comma-separated. +The `keyword` in the list refers to an widget name. + +## Environment variable + +* Format: `${:alnum:}` + +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. + +```css +* { + background-color: ${BG}; +} +``` + +## Inherit + + * Format: `inherit` + +Inherits the property from its parent widget. + +```css +mainbox { + border-color: inherit; +} +``` + + +## ELEMENTS PATHS + +Element paths exists of two parts, the first part refers to the actual widget by name. +Some widgets have an extra state. + +For example: + +```css +element selected { +} +``` + +Here `element selected` is the name of the widget, `selected` is the state of the widget. + +The difference between dots and spaces is purely cosmetic. These are all the same: + +```css +element .selected { + +element.selected { +} +element selected { +} +``` + +## SUPPORTED ELEMENT PATH + +## Name + +The current widgets available in **rofi**: + +* `window` + * `overlay`: the overlay widget. + * `mainbox`: The mainbox box. + * `inputbar`: The input bar box. + * `box`: the horizontal @box packing the widgets + * `case-indicator`: the case/sort indicator @textbox + * `prompt`: the prompt @textbox + * `entry`: the main entry @textbox + * `num-rows`: Shows the total number of rows. + * `num-filtered-rows`: Shows the total number of rows after filtering. + * `listview`: The listview. + * `scrollbar`: the listview scrollbar + * `element`: a box in the listview holding the entries + * `element-icon`: the widget in the listview's entry showing the (optional) icon + * `element-index`: the widget in the listview's entry keybindable index (1,2,3..0) + * `element-text`: the widget in the listview's entry showing the text. + * `mode-switcher`: the main horizontal @box packing the buttons. + * `button`: the buttons @textbox for each mode + * `message`: The container holding the textbox. + * `textbox`: the message textbox + +Note that these path names match the default theme. Themes that provide a custom layout will have different +elements, and structure. + + +## State + +State: State of widget + +Optional flag(s) indicating state of the widget, used for theming. + +These are appended after the name or class of the widget. + +### Example: + +`button selected.normal { }` + +`element selected.urgent { }` + +Currently only the entrybox and scrollbar have states: + +### Entrybox: + +`{visible modifier}.{state}` + +Where `visible modifier` can be: + * normal: no modification + * selected: the entry is selected/highlighted by user + * alternate: the entry is at an alternating row (uneven row) + +Where `state` is: + * normal: no modification + * urgent: this entry is marked urgent + * active: this entry is marked active + +These can be mixed. + +Example: + +```css +nametotextbox selected.active { + background-color: #003642; + text-color: #008ed4; +} +``` + +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. + +### Scrollbar + +The scrollbar uses the `handle` state when drawing the small scrollbar handle. +This allows the colors used for drawing the handle to be set independently. + + +## SUPPORTED PROPERTIES + +The following properties are currently supported: + +### all widgets: + +* **enabled**: enable/disable the widget +* **padding**: padding + Padding on the inside of the widget +* **margin**: padding + Margin on the outside of the widget +* **border**: border + Border around the widget (between padding and margin)/ +* **border-radius**: padding + Sets a radius on the corners of the borders. +* **background-color**: color + Background color +* **background-image**: image + Background image +* **border-color**: color + Color of the border +* **cursor**: cursor + Type of mouse cursor that is set when the mouse pointer is hovered over the widget. + +### window: + +* **font**: string + The font used in the window + +* **transparency**: string + Indicating if transparency should be used and what type: + **real** - True transparency. Only works with a compositor. + **background** - Take a screenshot of the background image and use that. + **screenshot** - Take a screenshot of the screen and use that. + **Path** to png file - Use an image. + +* **location**: position + The place of the anchor on the monitor +* **anchor**: anchor + The anchor position on the window +* **fullscreen**: boolean + Window is fullscreen. +* **width**: distance + The width of the window +* **x-offset**: distance +* **y-offset**: distance + The offset of the window to the anchor point, allowing you to push the window left/right/up/down + + +### scrollbar: + +* **background-color**: color +* **handle-width**: distance +* **handle-color**: color +* **border-color**: color + +### box: + +* **orientation**: orientation + Set the direction the elements are packed. +* **spacing**: distance + Distance between the packed elements. + +### textbox: + +* **background-color**: color +* **border-color**: the color used for the border around the widget. +* **font**: the font used by this textbox (string). +* **str**: the string to display by this textbox (string). +* **vertical-align**: Vertical alignment of the text. A number between 0 (top) and 1 (bottom). +* **horizontal-align**: Horizontal alignment of the text. A number between 0 (left) and 1 (right). +* **text-color**: the text color to use. +* **highlight**: text style {color}. + color is optional, multiple highlight styles can be added like: bold underline italic #000000; + This option is only available on the `element-text` widget. +* **width**: override the desired width for the textbox. +* **content**: Set the displayed text (String). +* **placeholder**: Set the displayed text (String) when nothing is entered. +* **placeholder-color**: Color of the placeholder text. +* **blink**: Enable/Disable blinking on an input textbox (Boolean). +* **markup**: Force markup on, beware that only valid pango markup strings are shown. + +### listview: +* **columns**: integer + Number of columns to show (at least 1) +* **fixed-height**: boolean + Always show `lines` rows, even if fewer elements are available. +* **dynamic**: boolean + `True` if the size should change when filtering the list, `False` if it should keep the original height. +* **scrollbar**: boolean + If the scrollbar should be enabled/disabled. +* **scrollbar-width**: distance + Width of the scrollbar +* **cycle**: boolean + When navigating, it should wrap around +* **spacing**: distance + Spacing between the elements (both vertical and horizontal) +* **lines**: integer + Number of rows to show in the list view. +* **layout**: orientation + Indicate how elements are stacked. Horizontal implements the dmenu style. +* **reverse**: boolean + Reverse the ordering (top down to bottom up). +* **fixed-columns**: boolean + Do not reduce the number of columns shown when number of visible elements is not enough to fill them all. + +Each element is a `box` called `element`. Each `element` can contain an `element-icon` and `element-text`. + +### listview text highlight: + +The `element-text` widget in the `listview` is the one used to show the text. +On this widget set the `highlight` property (only place this property is used) to change +the style of highlighting. +The `highlight` property consist of the `text-style` property and a color. + +To disable highlighting: + +```css + element-text { + highlight: None; + } +``` + +To set to red underlined: + +```css + element-text { + highlight: underline red; + } +``` + +## Layout + +The new format allows the layout of the **rofi** 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. + +### Basic structure + +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](http://gtk.org/). + +The current layout of **rofi** is structured as follows: + +``` +|------------------------------------------------------------------------------------| +| window {BOX:vertical} | +| |-------------------------------------------------------------------------------| | +| | mainbox {BOX:vertical} | | +| | |---------------------------------------------------------------------------| | | +| | | inputbar {BOX:horizontal} | | | +| | | |---------| |-| |---------------------------------|---| |---| |---| |---| | | | +| | | | prompt | |:| | entry |#fr| | / | |#ns| |ci | | | | +| | | |---------| |_| |---------------------------------|---| |---| |---| |---| | | | +| | |---------------------------------------------------------------------------| | | +| | | | +| | |---------------------------------------------------------------------------| | | +| | | message | | | +| | | |-----------------------------------------------------------------------| | | | +| | | | textbox | | | | +| | | |-----------------------------------------------------------------------| | | | +| | |---------------------------------------------------------------------------| | | +| | | | +| | |-----------------------------------------------------------------------------| | +| | | listview | | +| | |-----------------------------------------------------------------------------| | +| | | | +| | |---------------------------------------------------------------------------| | | +| | | mode-switcher {BOX:horizontal} | | | +| | | |---------------| |---------------| |--------------| |---------------| | | | +| | | | Button | | Button | | Button | | Button | | | | +| | | |---------------| |---------------| |--------------| |---------------| | | | +| | |---------------------------------------------------------------------------| | | +| |-------------------------------------------------------------------------------| | +|------------------------------------------------------------------------------------| + + +``` +> * ci is the case-indicator +> * fr is the num-filtered-rows +> * ns is the num-rows + +### Error message structure + +``` +|-----------------------------------------------------------------------------------| +| window {BOX:vertical} | +| |------------------------------------------------------------------------------| | +| | error-message {BOX:vertical} | | +| | |-------------------------------------------------------------------------| | | +| | | textbox | | | +| | | |-----------------| |-------------------------------------------------| | | | +| | | |element-icon | |element-text | | | | +| | | |-----------------| |-------------------------------------------------| | | | +| | |-------------------------------------------------------------------------| | | +| |------------------------------------------------------------------------------| | +|-----------------------------------------------------------------------------------| + + +``` + +### Advanced layout + +The layout of **rofi** can be tweaked by packing the 'fixed' widgets in a custom structure. + +The following widgets are fixed, as they provide core **rofi** functionality: + + * prompt + * entry + * overlay + * case-indicator + * message + * listview + * mode-switcher + * num-rows + * num-filtered-rows + +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. + + * mainbox + Packs: `inputbar, message, listview, mode-switcher` + * inputbar + Packs: `prompt,entry,case-indicator` + +Any widget name starting with `textbox` is a textbox widget, others are box widgets and can pack other widgets. + +There are several special widgets that can be used by prefixing the name of the widget: + +#### textbox + +This is a read-only textbox widget. The displayed string can be set with `content`. + + +Example: + +```css +textbox-custom { + expand: false; + content: "My Message"; +} +``` + +#### Icon + +This is an icon widget. The displayed icon can be set with `filename` and size with `size`. +If the property `action` is set, it acts as a button. +`action` can be set to a keybinding name and completes that action. (see rofi -show keys for a list). + +If the `squared` property is set to **false** the widget height and width are not forced to be equal. + +Example: + +```css +icon-paste { + expand: false; + filename: "gtk-paste"; + size: 24; + vertical-align: 0.5; + action: "kb-primary-paste"; +} +``` + + +#### button + +This is a textbox widget that can have a 'clickable' action. +The `action` can be set to: +`keybinding`: accepts a keybinding name and completes that action. (see rofi -show keys for a list). + +```css +button-paste { + expand: false; + content: "My Clickable Message"; + vertical-align: 0.5; + action: "kb-primary-paste"; +} +``` + + +#### Children + +To specify children, set the `children` +property (this always happens on the `box` child, see example below): + +```css +inputbar { + children: [prompt,entry,overlay,case-indicator]; +} +``` + +The theme needs to be updated to match the hierarchy specified. + +Below is an example of a theme emulating dmenu: + +```css +* { + background-color: Black; + text-color: White; + border-color: White; + font: "Times New Roman 12"; +} + +window { + anchor: north; + location: north; + width: 100%; + padding: 4px; + children: [ horibox ]; +} + +horibox { + orientation: horizontal; + children: [ prompt, entry, listview ]; +} + +listview { + layout: horizontal; + spacing: 5px; + lines: 10; +} + +entry { + expand: false; + width: 10em; +} + +element { + padding: 0px 2px; +} +element selected { + background-color: SteelBlue; +} +``` + + +### Padding and margin + +Just like CSS, **rofi** uses the box model for each widget. + +``` +|-------------------------------------------------------------------| +| margin | +| |-------------------------------------------------------------| | +| | border | | +| | |---------------------------------------------------------| | | +| | | padding | | | +| | | |-----------------------------------------------------| | | | +| | | | content | | | | +| | | |-----------------------------------------------------| | | | +| | |---------------------------------------------------------| | | +| |-------------------------------------------------------------| | +|-------------------------------------------------------------------| +``` + +Explanation of the different parts: + + * Content - The content of the widget. + * Padding - Clears an area around the widget. + The padding shows the background color of the widget. + * Border - A border that goes around the padding and content. + The border use the border-color of the widget. + * Margin - Clears an area outside the border. + The margin is transparent. + +The box model allows us to add a border around elements, and to define space between elements. + +The size of each margin, border, and padding can be set. +For the border, a linestyle and radius can be set. + +### Spacing + +Widgets that can pack more then one child widget (currently box and listview) have the `spacing` property. +This property sets the distance between the packed widgets (both horizontally and vertically). + +``` +|---------------------------------------| +| |--------| s |--------| s |-------| | +| | child | p | child | p | child | | +| | | a | | a | | | +| | | c | | c | | | +| | | i | | i | | | +| | | n | | n | | | +| |--------| g |--------| g |-------| | +|---------------------------------------| +``` + +### Advanced box packing + +More dynamic spacing can be achieved by adding dummy widgets, for example to make one widget centered: + +``` +|--------------------------------------------| +| |-----------| |--------| |-----------| | +| | dummy | | child | | dummy | | +| | expand: y | | | | expand: y | | +| | | | | | | | +| | | | | | | | +| | | | | | | | +| |-----------| |--------| |-----------| | +|--------------------------------------------| +``` + +If both dummy widgets are set to expand, `child` will be centered. Depending on the `expand` flag of child the +remaining space will be equally divided between both dummy and child widget (expand enabled), or both dummy widgets +(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 command line 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 command line, for example to set it to full-screen: + +``` +rofi -theme-str 'window { fullscreen:true;}' -show run +``` + +To print the current theme, run: + +``` +rofi -dump-theme +``` + +## Media support + +Parts of the theme can be conditionally loaded, like the CSS `@media` option. + +``` +@media ( min-width: 120 ) { + +} +``` + +It supports the following keys as constraint: + + * `min-width`: load when width is bigger or equal then value. + * `max-width`: load when width is smaller then value. + * `min-height`: load when height is bigger or equal then value. + * `max-height`: load when height is smaller then value. + * `min-aspect-ratio` load when aspect ratio is over value. + * `max-aspect-ratio`: load when aspect ratio is under value. + * `monitor-id`: The monitor id, see rofi -help for id's. + +@media takes an integer number or a fraction, for integer number `px` can be added. + + +``` +@media ( min-width: 120 px ) { + +} +``` + + +## Font Parsing + +Rofi uses [pango](https://pango.gnome.org/) for font rendering. The font should be specified in a format that pango +understands. +This normally is the font name followed by the font size. For example: + +``` +mono 18 +``` + +Or + +``` +FontAwesome 22 +``` + +## 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. + + + +## EXAMPLES + +Several examples are installed together with **rofi**. These can be found in `{datadir}/rofi/themes/`, where +`{datadir}` is the install path of **rofi** data. When installed using a package manager, this is usually: `/usr/share/`. + +## SEE ALSO + +rofi(1), rofi-script(5), rofi-theme-selector(1) diff --git a/mkdocs/docs/1.7.0/rofi.1.markdown b/mkdocs/docs/1.7.0/rofi.1.markdown new file mode 100644 index 00000000..ab312b95 --- /dev/null +++ b/mkdocs/docs/1.7.0/rofi.1.markdown @@ -0,0 +1,1086 @@ +# ROFI 1 rofi + +## NAME + +**rofi** - A window switcher, application launcher, ssh dialog, dmenu replacement and more + +## SYNOPSIS + +**rofi** [ -show *mode* ]|[ -dmenu ]|[ -e *msg* ] [ CONFIGURATION ] + + +## DESCRIPTION + +**rofi** is an X11 pop-up window switcher, run dialog, dmenu replacement, and more. It focuses on +being fast to use and have minimal distraction. It supports keyboard and mouse navigation, type to +filter, tokenized search and more. + + +## USAGE + +**rofi**'s main functionality is to assist in your workflow, allowing you to quickly switch +between windows, start applications or log into a remote machine via `ssh`. +There are different *modi* for different types of actions. + +**rofi** can also function as (drop-in) replacement for **dmenu(1)**. + +### Running rofi + +To launch **rofi** directly in a certain mode, specify a mode with `rofi -show `. +To show the `run` dialog: + + rofi -show run + +### Emulating dmenu + +**rofi** can emulate **dmenu(1)** (a dynamic menu for X11) when launched with the `-dmenu` flag. + +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). + +### Display Error message + +**rofi** error dialog can also be called from the command line. + + rofi -e "my message" + +Markup support can be enabled, see CONFIGURATION options. + +## CONFIGURATION + +There are currently three methods of setting configuration options (evaluated in order below): + + * System configuration file (for example `/etc/rofi.rasi`). + It first checks `XDG_CONFIG_DIRS`, and then `SYSCONFDIR` (that is passed at compile time). + It loads the first config file it finds, it does not merge multiple system configuration files. + * Rasi theme file: The new *theme* format can be used to set configuration values. + * Command-line options: Arguments passed to **rofi**. + +To get a template config file, run: `rofi -dump-config > config.rasi` + +This will contain (commented) all current configuration options, modified options are uncommented. + +The configuration system supports the following types: + + * string + * integer (signed and unsigned) + * char + * boolean + * lists + +For the syntax of these options, see the **rofi-theme(5)** manpage. + +For use on the command line, Boolean options have a non-default command-line +syntax. Example to enable option X: + + -X + +To disable option X: + + -no-X + +Below is a list of the most important options: + +### General + +`-help` + +The help option shows the full list of command-line options and the current set values. +These include dynamic (run-time generated) options. + +`-version` + +Show the **rofi** version and exit. + +`-dump-config` + +Dump the current active configuration, in rasi format, to stdout and exit. +Information about the rasi format can be found in the **rofi-theme(5)** manpage. + +`-dump-theme` + +Dump the current active theme, in rasi format, to stdout and exit. + +`-rasi-validate` *filename* + +Try to parse the file and return 0 when successful, non-zero when failed. + +`-threads` *num* + +Specify the number of threads **rofi** should use: + + * 0: Autodetect the number of supported hardware threads. + * 1: Disable threading + * 2..n: Specify the maximum number of threads to use in the thread pool. + + Default: Autodetect + +`-display` *display* + +The X server to contact. Default is `$DISPLAY`. + +`-dmenu` + +Run **rofi** in dmenu mode. This allows for interactive scripts. +In `dmenu` mode, **rofi** reads from STDIN, and output to STDOUT. +A simple example, displaying three pre-defined options: + + echo -e "Option #1\nOption #2\nOption #3" | rofi -dmenu + +Or get the options from a script: + + ~/my_script.sh | rofi -dmenu + +`-show` *mode* + +Open **rofi** in a certain mode. Available modes are `window`, `run`, `drun`, `ssh`, `combi`. +The special argument `keys` can be used to open a searchable list of supported key bindings +(see *KEY BINDINGS*) + +To show the run-dialog: + + rofi -show run + +If `-show` is the last option passed to rofi, the first enabled modi is shown. + +`-modi` *mode1,mode2* + +Specify an ordered, comma-separated list of modes to enable. +Enabled modes can be changed at runtime. Default key is `Ctrl+Tab`. +If no modes are specified, all configured modes will be enabled. +To only show the `run` and `ssh` launcher: + + rofi -modi "run,ssh" -show run + +Custom modes can be added using the internal `script` mode. Each such mode has two parameters: + + :