diff options
author | Dave Davenport <qball@gmpclient.org> | 2020-12-02 21:01:10 +0100 |
---|---|---|
committer | Dave Davenport <qball@gmpclient.org> | 2020-12-02 21:01:10 +0100 |
commit | b7186a2ff48c617300b23d746d78b48f5d23cb73 (patch) | |
tree | c7ad5e93a8144e75124d84ee286518306fb8c3d1 | |
parent | 1c9d975dd2aff1794c6484465482c796c41a1358 (diff) |
Deprecate some old config options.
-rw-r--r-- | config/config.c | 14 | ||||
-rw-r--r-- | doc/rofi-script.5 | 29 | ||||
-rw-r--r-- | doc/rofi-sensible-terminal.1 | 5 | ||||
-rw-r--r-- | doc/rofi-theme-selector.1 | 11 | ||||
-rw-r--r-- | doc/rofi-theme.5 | 247 | ||||
-rw-r--r-- | doc/rofi.1 | 327 | ||||
-rw-r--r-- | doc/rofi.1.markdown | 108 | ||||
-rw-r--r-- | include/settings.h | 16 | ||||
-rw-r--r-- | source/dialogs/dmenu.c | 3 | ||||
-rw-r--r-- | source/dialogs/window.c | 3 | ||||
-rw-r--r-- | source/helper.c | 11 | ||||
-rw-r--r-- | source/theme.c | 86 | ||||
-rw-r--r-- | source/view.c | 11 | ||||
-rw-r--r-- | source/widgets/listview.c | 2 | ||||
-rw-r--r-- | source/xrmoptions.c | 23 |
15 files changed, 312 insertions, 584 deletions
diff --git a/config/config.c b/config/config.c index 942063bc..9e97f2b7 100644 --- a/config/config.c +++ b/config/config.c @@ -40,14 +40,6 @@ Settings config = { #else .modi = "run,ssh", #endif - /** Border width around the window. */ - .menu_bw = 1, - /** The width of the switcher. (0100 in % > 100 in pixels) */ - .menu_width = 50, - /** Maximum number of options to show. */ - .menu_lines = 15, - /** Number of columns */ - .menu_columns = 1, /** Font */ .menu_font = "mono 12", @@ -81,8 +73,6 @@ Settings config = { * */ .location = WL_CENTER, - /** Padding between elements */ - .padding = 5, /** Y offset */ .y_offset = 0, /** X offset */ @@ -152,10 +142,6 @@ Settings config = { .click_to_exit = TRUE, .show_match = TRUE, .theme = NULL, - .color_normal = NULL, - .color_active = NULL, - .color_urgent = NULL, - .color_window = NULL, .plugin_path = PLUGIN_PATH, .max_history_size = 25, .combi_hide_mode_prefix = FALSE, diff --git a/doc/rofi-script.5 b/doc/rofi-script.5 index 4e0e26cd..646727d7 100644 --- a/doc/rofi-script.5 +++ b/doc/rofi-script.5 @@ -1,3 +1,4 @@ +.nh .TH ROFI\-SCRIPT 5 rofi\-script .SH NAME .PP @@ -64,6 +65,8 @@ Rofi sets the following environment variable when executing the script: .SS \fB\fCROFI\_RETV\fR .PP An integer number with the current state: + +.RS .IP \(bu 2 \fB0\fP: Initial call of script. .IP \(bu 2 @@ -73,6 +76,8 @@ An integer number with the current state: .IP \(bu 2 \fB10\-28\fP: Custom keybinding 1\-19 +.RE + .SS \fB\fCROFI\_INFO\fR .PP Environment get set when selected entry get set with the property value of the 'info' row option, if set. @@ -96,6 +101,8 @@ For example to set the prompt: .PP The following extra options exists: + +.RS .IP \(bu 2 \fBprompt\fP: Update the prompt text. .IP \(bu 2 @@ -111,6 +118,8 @@ The following extra options exists: .IP \(bu 2 \fBno\-custom\fP: Only accept listed entries, ignore custom input. +.RE + .SH Parsing row options .PP Extra options for individual rows can be set. @@ -130,6 +139,8 @@ For example: .PP The following options are supported: + +.RS .IP \(bu 2 \fBicon\fP: Set the icon for that row. .IP \(bu 2 @@ -139,6 +150,8 @@ The following options are supported: .IP \(bu 2 \fBinfo\fP: Info that, on selection, gets placed in the \fB\fCROFI\_INFO\fR environment variable. This entry does not get searched. +.RE + .PP multiple entries can be passed using the \fB\fC\\x1f\fR separator. @@ -162,20 +175,20 @@ rofi(1), rofi\-sensible\-terminal(1), dmenu(1), rofi\-theme(5), rofi\-theme\-sel .SH AUTHOR .PP -Qball Cow -\[la]qball@gmpclient.org\[ra] +Qball Cow qball@gmpclient.org +\[la]mailto:qball@gmpclient.org\[ra] .PP -Rasmus Steinke -\[la]rasi@xssn.at\[ra] +Rasmus Steinke rasi@xssn.at +\[la]mailto:rasi@xssn.at\[ra] .PP -Quentin Glidic -\[la]sardemff7+rofi@sardemff7.net\[ra] +Quentin Glidic sardemff7+rofi@sardemff7.net +\[la]mailto:sardemff7+rofi@sardemff7.net\[ra] .PP -Original code based on work by: Sean Pringle -\[la]sean.pringle@gmail.com\[ra] +Original code based on work by: Sean Pringle sean.pringle@gmail.com +\[la]mailto:sean.pringle@gmail.com\[ra] .PP For a full list of authors, check the AUTHORS file. diff --git a/doc/rofi-sensible-terminal.1 b/doc/rofi-sensible-terminal.1 index 6d10df97..653dee3f 100644 --- a/doc/rofi-sensible-terminal.1 +++ b/doc/rofi-sensible-terminal.1 @@ -1,3 +1,4 @@ +.nh .TH rofi\-sensible\-terminal 1 rofi\-sensible\-terminal .SH NAME .PP @@ -16,6 +17,8 @@ shipping this script in a way which is appropriate for the distribution. .PP It tries to start one of the following (in that order): + +.RS .IP \(bu 2 \fB\fC$TERMINAL\fR (this is a non\-standard variable) .IP \(bu 2 @@ -53,6 +56,8 @@ alacritty .IP \(bu 2 kitty +.RE + .SH SEE ALSO .PP rofi(1) diff --git a/doc/rofi-theme-selector.1 b/doc/rofi-theme-selector.1 index 99525093..e0f09c31 100644 --- a/doc/rofi-theme-selector.1 +++ b/doc/rofi-theme-selector.1 @@ -1,3 +1,4 @@ +.nh .TH rofi\-theme\-selector 1 rofi\-theme\-selector .SH NAME .PP @@ -18,6 +19,8 @@ It lets you preview each theme with the Enter key and apply the theme to your .SH Theme directories .PP \fBrofi\-theme\-selector\fP searches the following directories for themes: + +.RS .IP \(bu 2 ${PREFIX}/share/rofi/themes .IP \(bu 2 @@ -25,9 +28,11 @@ $XDG\_CONFIG\_HOME/rofi/themes .IP \(bu 2 $XDG\_DATA\_HOME/share/rofi/themes +.RE + .PP -${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> +${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". .SH SEE ALSO @@ -36,5 +41,5 @@ rofi(1) .SH AUTHORS .PP -Qball Cow qball@gmpclient.org<br> +Qball Cow qball@gmpclient.org Rasmus Steinke rasi@xssn.at diff --git a/doc/rofi-theme.5 b/doc/rofi-theme.5 index 39d8f5c1..f82093cc 100644 --- a/doc/rofi-theme.5 +++ b/doc/rofi-theme.5 @@ -1,3 +1,4 @@ +.nh .TH ROFI\-THEME 5 rofi\-theme .SH NAME .PP @@ -19,11 +20,15 @@ preferred. .SH Comments .PP C and C++ file comments are supported. + +.RS .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. +.RE + .PP Comments can be nested and the C comments can be inline. @@ -91,7 +96,7 @@ abbreviation for \fBr\fPofi \fBa\fPdvanced \fBs\fPtyle \fBi\fPnformation. .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 a hash symbol \fB\fC#\fR\&. +Sub\-\§ion names begin with a hash symbol \fB\fC#\fR\&. .PP It is advised to define the \fIglobal properties section\fP on top of the file to @@ -242,6 +247,8 @@ When used, values with the wrong type that cannot be converted are ignored. .PP The current theme format supports different types: + +.RS .IP \(bu 2 a string .IP \(bu 2 @@ -275,12 +282,18 @@ an environment variable .IP \(bu 2 Inherit +.RE + .PP Some of these types are a combination of other types. -.SH String.IP \(bu 2 +.SH String +.RS +.IP \(bu 2 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. @@ -299,9 +312,13 @@ font: "Awasome 12"; .PP The string must be valid UTF\-8. -.SH Integer.IP \(bu 2 +.SH Integer +.RS +.IP \(bu 2 Format: \fB\fC[\-+]?[:digit:]+\fR +.RE + .PP An integer may contain any number. @@ -317,9 +334,13 @@ lines: 12; .fi .RE -.SH Real.IP \(bu 2 +.SH Real +.RS +.IP \(bu 2 Format: \fB\fC[\-+]?[:digit:]+(\\.[:digit:]+)?\fR +.RE + .PP A real is an integer with an optional fraction. @@ -338,9 +359,13 @@ 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.IP \(bu 2 +.SH Boolean +.RS +.IP \(bu 2 Format: \fB\fC(true|false)\fR +.RE + .PP Boolean value is either \fB\fCtrue\fR or \fB\fCfalse\fR\&. This is case\-\&sensitive. @@ -359,6 +384,8 @@ dynamic: false; .SH Color .PP \fBrofi\fP supports the color formats as specified in the CSS standard (1,2,3 and some of CSS 4) + +.RS .IP \(bu 2 Format: \fB\fC#{HEX}{3}\fR (rgb) .IP \(bu 2 @@ -380,11 +407,15 @@ Format: \fB\fCcmyk( {PERCENTAGE}, {PERCENTAGE}, {PERCENTAGE}, {PERCENTAGE} [, {P .IP \(bu 2 Format: \fB\fC{named\-color} [ / {PERCENTAGE} ]\fR +.RE + .PP The white\-space format proposed in CSS4 is also supported. .PP The different values are: + +.RS .IP \(bu 2 \fB\fC{HEX}\fR is a hexadecimal number ('0\-9a\-f' case insensitive). .IP \(bu 2 @@ -394,11 +425,7 @@ The different values are: .IP \(bu 2 \fB\fC{PERCENTAGE}\fR can be between 0\-1.0, or 0%\-100% .IP \(bu 2 - -.PP -\fB\fC{named\-color}\fR is one of the following colors: -.PP -AliceBlue, AntiqueWhite, Aqua, Aquamarine, Azure, Beige, Bisque, Black, BlanchedAlmond, Blue, BlueViolet, Brown, +\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, @@ -413,6 +440,8 @@ PapayaWhip, PeachPuff, Peru, Pink, Plum, PowderBlue, Purple, RebeccaPurple, Red, 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 + .PP For example: @@ -440,12 +469,18 @@ text\-color: Black; .fi .RE -.SH Text style.IP \(bu 2 +.SH Text style +.RS +.IP \(bu 2 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. + +.RS .IP \(bu 2 \fB\fCbold\fR: make the text thicker then the surrounding text. .IP \(bu 2 @@ -457,23 +492,32 @@ should be applied. .IP \(bu 2 \fB\fCsmall caps\fR: emphasise the text using capitalization. +.RE + .PP .RS .PP For some reason \fB\fCsmall caps\fR does not work on some systems. + .RE -.SH Line style.IP \(bu 2 +.SH Line style +.RS +.IP \(bu 2 Format: \fB\fC(dash|solid)\fR +.RE + .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 -.SH Distance.IP \(bu 2 +.SH Distance +.RS +.IP \(bu 2 Format: \fB\fC{Integer}px\fR .IP \(bu 2 Format: \fB\fC{Real}em\fR @@ -484,8 +528,12 @@ Format: \fB\fC{Real}%\fR .IP \(bu 2 Format: \fB\fC{Integer}mm\fR +.RE + .PP A distance can be specified in 3 different units: + +.RS .IP \(bu 2 \fB\fCpx\fR: Screen pixels. .IP \(bu 2 @@ -497,6 +545,8 @@ A distance can be specified in 3 different units: .IP \(bu 2 \fB\fC%\fR: Percentage of the \fBmonitor\fP size. +.RE + .PP Distances used in the horizontal direction use the monitor width. Distances in the vertical direction use the monitor height. @@ -530,6 +580,8 @@ width: calc( 100% \- 37px ); .PP It supports the following operations: + +.RS .IP \(bu 2 \fB\fC+\fR : Add .IP \(bu 2 @@ -545,10 +597,14 @@ It supports the following operations: .IP \(bu 2 \fB\fCmax\fR : Maximum of l or rvalue; +.RE + .PP It uses the C precedence ordering. -.SH Padding.IP \(bu 2 +.SH Padding +.RS +.IP \(bu 2 Format: \fB\fC{Integer}\fR .IP \(bu 2 Format: \fB\fC{Distance}\fR @@ -559,11 +615,15 @@ Format: \fB\fC{Distance} {Distance} {Distance}\fR .IP \(bu 2 Format: \fB\fC{Distance} {Distance} {Distance} {Distance}\fR +.RE + .PP If no unit is specified, pixels are assumed. .PP The different number of fields in the formats are parsed like: + +.RS .IP \(bu 2 1 field: \fB\fCall\fR .IP \(bu 2 @@ -573,7 +633,11 @@ The different number of fields in the formats are parsed like: .IP \(bu 2 4 fields: \fB\fCtop\fR, \fB\fCright\fR, \fB\fCbottom\fR, \fB\fCleft\fR -.SH Border.IP \(bu 2 +.RE + +.SH Border +.RS +.IP \(bu 2 Format: \fB\fC{Integer}\fR .IP \(bu 2 Format: \fB\fC{Distance}\fR @@ -592,6 +656,8 @@ Format: \fB\fC{Distance} {Line style} {Distance} {Line style} {Distance} {Line s .IP \(bu 2 Format: \fB\fC{Distance} {Line style} {Distance} {Line style} {Distance} {Line style} {Distance} {Line style}\fR +.RE + .PP Borders are identical to padding, except that each distance field has a line style property. @@ -601,26 +667,24 @@ style property. .PP When no unit is specified, pixels are assumed. + .RE .SH Position .PP Indicate a place on the window/monitor. -.IP \(bu 2 -Format: \fB\fC(center|east|north|west|south|north east|north west|south west|south east)\fR -.PP .RS - -.nf - +.IP \(bu 2 +Format: \fB\fC(center|east|north|west|south|north east|north west|south west|south east)\fR +\fB\fC north west | north | north east \-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\- - west | center | east + west | center | east \-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\- south west | south | south east +\fR -.fi .RE .SH Visibility @@ -632,9 +696,13 @@ inputbar { enabled: false; } -.SH Reference.IP \(bu 2 +.SH Reference +.RS +.IP \(bu 2 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. @@ -667,22 +735,34 @@ window { .fi .RE -.SH Orientation.IP \(bu 2 +.SH Orientation +.RS +.IP \(bu 2 Format: \fB\fC(horizontal|vertical)\fR +.RE + .PP Specify the orientation of the widget. -.SH List of keywords.IP \(bu 2 +.SH List of keywords +.RS +.IP \(bu 2 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. -.SH Environment variable.IP \(bu 2 +.SH Environment variable +.RS +.IP \(bu 2 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. @@ -698,9 +778,13 @@ The environment variable should be an alphanumeric string without white\-space. .fi .RE -.SH Inherit.IP \(bu 2 +.SH Inherit +.RS +.IP \(bu 2 Format: \fB\fCinherit\fR +.RE + .PP Inherits the property from its parent widget. @@ -757,14 +841,18 @@ element selected { .SH Name .PP The current widgets available in \fBrofi\fP: + +.RS .IP \(bu 2 \fB\fCwindow\fR +.RS .IP \(bu 2 \fB\fCoverlay\fR: the overlay widget. .IP \(bu 2 \fB\fCmainbox\fR: The mainbox box. .IP \(bu 2 \fB\fCinputbar\fR: The input bar box. +.RS .IP \(bu 2 \fB\fCbox\fR: the horizontal @box packing the widgets .IP \(bu 2 @@ -777,27 +865,51 @@ The current widgets available in \fBrofi\fP: \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. + +.RE + .IP \(bu 2 \fB\fClistview\fR: The listview. +.RS .IP \(bu 2 \fB\fCscrollbar\fR: the listview scrollbar .IP \(bu 2 \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 .IP \(bu 2 \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. + +.RE + + +.RE + .IP \(bu 2 \fB\fCmode\-switcher\fR: the main horizontal @box packing the buttons. +.RS .IP \(bu 2 \fB\fCbutton\fR: the buttons @textbox for each mode + +.RE + .IP \(bu 2 \fB\fCmessage\fR: The container holding the textbox. +.RS .IP \(bu 2 \fB\fCtextbox\fR: the message textbox +.RE + + +.RE + + +.RE + .PP Note that these path names match the default theme. Themes that provide a custom layout will have different elements, and structure. @@ -869,7 +981,9 @@ This allows the colors used for drawing the handle to be set independently. .PP The following properties are currently supported: -.SS all widgets:.IP \(bu 2 +.SS all widgets: +.RS +.IP \(bu 2 \fBenabled\fP: enable/disable the widget .IP \(bu 2 \fBpadding\fP: padding @@ -890,14 +1004,14 @@ Background color \fBborder\-color\fP: color Color of the border -.SS window:.IP \(bu 2 +.RE -.PP +.SS window: +.RS +.IP \(bu 2 \fBfont\fP: string The font used in the window .IP \(bu 2 - -.PP \fBtransparency\fP: string Indicating if transparency should be used and what type: \fBreal\fP \- True transparency. Only works with a compositor. @@ -905,36 +1019,28 @@ Indicating if transparency should be used and what type: \fBscreenshot\fP \- Take a screenshot of the screen and use that. \fBPath\fP to png file \- Use an image. .IP \(bu 2 - -.PP \fBlocation\fP: position The place of the anchor on the monitor .IP \(bu 2 - -.PP \fBanchor\fP: anchor The anchor position on the window .IP \(bu 2 - -.PP \fBfullscreen\fP: boolean Window is fullscreen. .IP \(bu 2 - -.PP \fBwidth\fP: distance The width of the window .IP \(bu 2 - -.PP \fBx\-offset\fP: distance .IP \(bu 2 - -.PP \fBy\-offset\fP: distance The offset of the window to the anchor point, allowing you to push the window left/right/up/down -.SS scrollbar:.IP \(bu 2 +.RE + +.SS scrollbar: +.RS +.IP \(bu 2 \fBbackground\-color\fP: color .IP \(bu 2 \fBhandle\-width\fP: distance @@ -943,14 +1049,22 @@ The offset of the window to the anchor point, allowing you to push the window le .IP \(bu 2 \fBborder\-color\fP: color -.SS box:.IP \(bu 2 +.RE + +.SS box: +.RS +.IP \(bu 2 \fBorientation\fP: orientation Set the direction the elements are packed. .IP \(bu 2 \fBspacing\fP: distance Distance between the packed elements. -.SS textbox:.IP \(bu 2 +.RE + +.SS textbox: +.RS +.IP \(bu 2 \fBbackground\-color\fP: color .IP \(bu 2 \fBborder\-color\fP: the color used for the border around the widget. @@ -978,7 +1092,11 @@ color is optional, multiple highlight styles can be added like: bold underline i .IP \(bu 2 \fBblink\fP: Enable/Disable blinking on an input textbox (Boolean). -.SS listview:.IP \(bu 2 +.RE + +.SS listview: +.RS +.IP \(bu 2 \fBcolumns\fP: integer Number of columns to show (at least 1) .IP \(bu 2 @@ -1012,6 +1130,8 @@ Reverse the ordering (top down to bottom up). \fBfixed\-columns\fP: boolean Do not reduce the number of columns shown when number of visible elements is not enough to fill them all. +.RE + .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\&. @@ -1110,6 +1230,7 @@ The current layout of \fBrofi\fP is structured as follows: .PP ci is the case\-indicator + .RE .SS Error message structure @@ -1138,6 +1259,8 @@ The layout of \fBrofi\fP can be tweaked by packing the 'fixed' widgets in a cust .PP The following widgets are fixed, as they provide core \fBrofi\fP functionality: + +.RS .IP \(bu 2 prompt .IP \(bu 2 @@ -1157,9 +1280,13 @@ num\-rows .IP \(bu 2 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. + +.RS .IP \(bu 2 mainbox Packs: \fB\fCinputbar, message, listview, mode\-switcher\fR @@ -1167,11 +1294,15 @@ Packs: \fB\fCinputbar, message, listview, mode\-switcher\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. .PP There are several special widgets that can be used by prefixing the name of the widget: + +.RS .IP \(bu 2 \fB\fCtextbox\fR: This is a textbox widget. The displayed string can be set with \fB\fCstr\fR\&. @@ -1187,6 +1318,8 @@ The \fB\fCaction\fR can be set to: \fB\fCok|alternate\fR: accept entry and launch alternate action (for run launch in terminal). \fB\fCcustom|alternate\fR: accept custom input and launch alternate action. +.RE + .PP To specify children, set the \fB\fCchildren\fR property (this always happens on the \fB\fCbox\fR child, see example below): @@ -1277,6 +1410,8 @@ Just like CSS, \fBrofi\fP uses the box model for each widget. .PP Explanation of the different parts: + +.RS .IP \(bu 2 Content \- The content of the widget. .IP \(bu 2 @@ -1289,6 +1424,8 @@ The border use the border\-color of the widget. 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. @@ -1413,6 +1550,8 @@ Parts of the theme can be conditionally loaded, like the CSS \fB\fC@media\fR opt .PP It supports the following keys as constraint: + +.RS .IP \(bu 2 \fB\fCmin\-width\fR: load when width is bigger or equal then value. .IP \(bu 2 @@ -1428,6 +1567,8 @@ It supports the following keys as constraint: .IP \(bu 2 \fB\fCmonitor\-id\fR: The monitor id, see rofi \-help for id's. +.RE + .PP @media takes an integer number or a fraction, for integer number \fB\fCpx\fR can be added. @@ -1446,11 +1587,15 @@ It supports the following keys as constraint: .PP The rasi file format offers two methods of including other files. This can be used to modify existing themes, or have multiple variations on a theme. + +.RS .IP \(bu 2 import: Import and parse a second file. .IP \(bu 2 theme: Discard theme, and load file as a fresh theme. +.RE + .PP Syntax: @@ -1469,6 +1614,8 @@ The specified file can either by \fIname\fP, \fIfilename\fP,\fIfull path\fP\&. .PP If a filename is provided, it will try to resolve it in the following order: + +.RS .IP \(bu 2 \fB\fC${XDG\_CONFIG\_HOME}/rofi/themes/\fR .IP \(bu 2 @@ -1478,6 +1625,8 @@ If a filename is provided, it will try to resolve it in the following order: .IP \(bu 2 \fB\fC${INSTALL PREFIX}/share/rofi/themes/\fR +.RE + .PP A name is resolved as a filename by appending the \fB\fC\&.rasi\fR extension. @@ -1,3 +1,4 @@ +.nh .TH ROFI 1 rofi .SH NAME .PP @@ -46,7 +47,7 @@ The website for \fB\fCdmenu\fR can be found here .PP \fBrofi\fP does not aim to be 100% compatible with \fB\fCdmenu\fR\&. There are simply too many different flavors of \fB\fCdmenu\fR\&. -The idea is that the basic usage command\-line flags are obeyed, theme\-related flags are not. +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). .SS Display Error message @@ -68,6 +69,8 @@ Markup support can be enabled, see CONFIGURATION options. .SH CONFIGURATION .PP There are currently three methods of setting configuration options (evaluated in order below): + +.RS .IP \(bu 2 System configuration file (for example \fB\fC/etc/rofi.rasi\fR or old format \fB\fC/etc/rofi.conf\fR). It first checks XDG\_CONFIG\_DIRS and then SYSCONFDIR (that is passed at compile time). @@ -86,6 +89,8 @@ This is the recommended way of configuring \fBrofi\fP\&. .IP \(bu 2 Command\-line options: Arguments passed to \fBrofi\fP\&. +.RE + .PP \fBTIP\fP: To get a template config file run: \fB\fCrofi \-dump\-xresources > rofi\-example.config\fR\&. @@ -137,6 +142,8 @@ rofi \-dump\-xresources .PP The configuration system supports the following types: + +.RS .IP \(bu 2 string .IP \(bu 2 @@ -146,6 +153,8 @@ char .IP \(bu 2 Boolean +.RE + .PP Boolean options have a non\-default command\-line syntax. Example to enable option X: @@ -212,6 +221,8 @@ This does not validate all passed values (for example, colors). .PP Specify the number of threads \fBrofi\fP should use: + +.RS .IP \(bu 2 0: Autodetect the number of supported hardware threads. .IP \(bu 2 @@ -219,6 +230,8 @@ Specify the number of threads \fBrofi\fP should use: .IP \(bu 2 2..N: Specify the maximum number of threads to use in the thread pool. +.RE + .PP \fB\fC\-display\fR \fIdisplay\fP @@ -431,6 +444,8 @@ Make \fBrofi\fP react like a normal application window. Useful for scripts like .PP Specify the matching algorithm used. Current the following methods are supported. + +.RS .IP \(bu 2 \fBnormal\fP: match the int string .IP \(bu 2 @@ -440,6 +455,8 @@ Current the following methods are supported. .IP \(bu 2 \fBfuzzy\fP: do a fuzzy match +.RE + .PP Default: \fInormal\fP @@ -464,6 +481,8 @@ Only show desktop files that are present in the listed categories. .PP When using \fB\fCdrun\fR, match only with the specified Desktop entry fields. The different fields are: + +.RS .IP \(bu 2 \fBname\fP: the application's name .IP \(bu 2 @@ -475,17 +494,17 @@ The different fields are: .IP \(bu 2 \fBcomment\fP: the application comment .IP \(bu 2 +\fBall\fP: all of the aboveDefault: \fIname,generic,exec,categories,keywords\fP -.PP -\fBall\fP: all of the above -.PP -Default: \fIname,generic,exec,categories,keywords\fP +.RE .PP \fB\fC\-drun\-display\-format\fR .PP The format string for the \fB\fCdrun\fR dialog: + +.RS .IP \(bu 2 \fBname\fP: the application's name .IP \(bu 2 @@ -497,6 +516,8 @@ The format string for the \fB\fCdrun\fR dialog: .IP \(bu 2 \fBcomment\fP: the application comment +.RE + .PP Pango markup can be used to formatting the output. @@ -533,6 +554,8 @@ Default: false .PP When using window mode, match only with the specified fields. The different fields are: + +.RS .IP \(bu 2 \fBtitle\fP: window's title .IP \(bu 2 @@ -544,11 +567,9 @@ The different fields are: .IP \(bu 2 \fBdesktop\fP: window's current desktop .IP \(bu 2 +\fBall\fP: all of the aboveDefault: \fIall\fP -.PP -\fBall\fP: all of the above -.PP -Default: \fIall\fP +.RE .PP \fB\fC\-matching\-negate\-char\fR \fIchar\fP @@ -572,87 +593,6 @@ Most of the following options are \fBdeprecated\fP and should not be used. Pleas \fBrofi\fP\&. More information about the new format can be found in the \fBrofi\-theme(5)\fP manpage. .PP -\fB\fC\-lines\fR - -.PP -Maximum number of lines to show before scrolling. - -.PP -.RS - |