mirror of https://github.com/davatorium/rofi.git
Update manpage.
This commit is contained in:
Dave Davenport
parent
373b55ec9c
commit
a7cecc0d41
188
doc/rofi-theme.5
188
doc/rofi-theme.5
|
|
@ -1,13 +1,13 @@
|
|||
.\" generated with Ronn/v0.7.3
|
||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||
.
|
||||
.TH "ROFI\-THEME" "5" "July 2017" "" ""
|
||||
.TH "ROFI\-THEME" "5" "August 2017" "" ""
|
||||
.
|
||||
.SH "NAME"
|
||||
\fBrofi\-theme\fR \- Rofi theme format files
|
||||
.
|
||||
.SH "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 is not flexible enough to expose these options in a user\-friendly way\. Therefor a new file format has been created, replacing the old one\. The new format is loosely based on css \fIhttps://en\.wikipedia\.org/wiki/Cascading_Style_Sheets\fR, a format widely known, which allows e\.g\. web developers to create their own rofi themes without the need to learn a new markup language\.
|
||||
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\. Therefor, a new file format has been created, replacing the old one\. The new format is loosely based on CSS \fIhttps://en\.wikipedia\.org/wiki/Cascading_Style_Sheets\fR, a widely known format, which allows web developers for example to create their own \fBrofi\fR themes without the need to learn a new markup language\.
|
||||
.
|
||||
.SH "FORMAT SPECIFICATION"
|
||||
.
|
||||
|
|
@ -15,7 +15,7 @@ The need for a new theme format was motivated by the fact that the way rofi hand
|
|||
The encoding of the file is utf\-8\. Both unix (\fB\en\fR) and windows (\fB\er\en\fR) newlines format are supported\. But unix is preferred\.
|
||||
.
|
||||
.SH "Comments"
|
||||
C and C++ file comments are support\.
|
||||
C and C++ file comments are supported\.
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
Anything after \fB//\fR and before a newline is considered a comment\.
|
||||
|
|
@ -43,7 +43,7 @@ property: /* comment */ value;
|
|||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
However this is not:
|
||||
However, this is not:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
|
|
@ -121,7 +121,7 @@ It is advised to define the \fIglobal properties section\fR on top of the file t
|
|||
If there are mulitple sections with the same name, they are merged\. Duplicate properties are overwritten and the last parsed entry kept\.
|
||||
.
|
||||
.SH "Global properties section"
|
||||
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\.
|
||||
.
|
||||
.P
|
||||
The global properties section denotes the defaults for each element\. Each property of this section can be referenced with \fB@{identifier}\fR (See Properties section)
|
||||
|
|
@ -133,7 +133,7 @@ A global properties section is indicated with a \fB*\fR as element path\.
|
|||
A theme can have multiple element theme sections\.
|
||||
.
|
||||
.P
|
||||
The element path can consist of multiple names separated by whitespace or dots\. Each element may contain any number of letters, numbers and \fB\-\fR\. The first element in the element path should always start with a \fB#\fR\.
|
||||
The element path can consist of multiple names separated by whitespace or dots\. Each element may contain any number of letters, numbers and \fB\-\fR\'s\. The first element in the element path should always start with a \fB#\fR\.
|
||||
.
|
||||
.P
|
||||
This is a valid element name:
|
||||
|
|
@ -221,52 +221,52 @@ The properties in a section consist of:
|
|||
Both fields are manditory for a property\.
|
||||
.
|
||||
.P
|
||||
The \fBidentifier\fR names the specified property\. Identifiers can consist of any combination of numbers, letters and \'\-\'\. It must not contain any whitespace\. The structure of the \fBvalue\fR defines the type of the property\. The current parser does not define or enforce a certain type of a particular \fBidentifier\fR\. When used, values with the wrong type that cannot be converted, are ignored\.
|
||||
The \fBidentifier\fR names the specified property\. Identifiers can consist of any combination of numbers, letters and \'\-\'\. It must not contain any whitespace\. The structure of the \fBvalue\fR defines the type of the property\. The current parser does not define or enforce a certain type of a particular \fBidentifier\fR\. When used, values with the wrong type that cannot be converted are ignored\.
|
||||
.
|
||||
.P
|
||||
The current theme format support different type:
|
||||
The current theme format supports different types:
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
a string\.
|
||||
a string
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
an integer number\.
|
||||
an integer number
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
a fractional number\.
|
||||
a fractional number
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
a boolean value\.
|
||||
a boolean value
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
a color\.
|
||||
a color
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
text style\.
|
||||
text style
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
line style\.
|
||||
line style
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
a distance\.
|
||||
a distance
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
a padding\.
|
||||
a padding
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
a border\.
|
||||
a border
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
a position\.
|
||||
a position
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
a reference\.
|
||||
a reference
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
an orientation\.
|
||||
an orientation
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
a list of keywords\.
|
||||
a list of keywords
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
|
|
@ -281,7 +281,7 @@ Format: \fB"[:print:]+"\fR
|
|||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
A string is always surrounded by quotes (\'"\'), between the quotes it can have any printable character\.
|
||||
A string is always surrounded by double quotes (\fB"\fR)\. Between the quotes there can be any printable character\.
|
||||
.
|
||||
.P
|
||||
For example:
|
||||
|
|
@ -297,7 +297,7 @@ font: "Awasome 12";
|
|||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
The string must be valid utf\-8\.
|
||||
The string must be valid UTF\-8\.
|
||||
.
|
||||
.SH "Integer"
|
||||
.
|
||||
|
|
@ -407,7 +407,7 @@ Format: \fB{named\-color} [ / {PERCENTAGE} ]\fR
|
|||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
The in CSS 4 proposed white\-space format is also supported\.
|
||||
The white\-space format proposed in CSS4 is also supported\.
|
||||
.
|
||||
.P
|
||||
The different values are:
|
||||
|
|
@ -419,13 +419,13 @@ The different values are:
|
|||
\fB{INTEGER}\fR value can be between 0 and 255 or 0\-100 when representing percentage\.
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fB{ANGLE}\fR Angle on the color wheel, can be in \fBdeg\fR, \fBrad\fR, \fBgrad\fR or \fBturn\fR\. When no unit is specified, degrees is assumed\.
|
||||
\fB{ANGLE}\fR is the angle on the color wheel, can be in \fBdeg\fR, \fBrad\fR, \fBgrad\fR or \fBturn\fR\. When no unit is specified, degrees is assumed\.
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fB{PERCENTAGE}\fR Can be between 0\-1\.0, or 0%\-100%
|
||||
\fB{PERCENTAGE}\fR can be between 0\-1\.0, or 0%\-100%
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fB{named\-color}\fR Is one of the following colors:
|
||||
\fB{named\-color}\fR is one of the following colors:
|
||||
.
|
||||
.IP
|
||||
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
|
||||
|
|
@ -455,7 +455,7 @@ Format: \fB(bold|italic|underline|strikethrough|none)\fR
|
|||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Text style indicates how the highlighted text is emphasised\. None indicates no emphasis should be applied\.
|
||||
Text style indicates how the highlighted text is emphasized\. \fBNone\fR indicates that no emphasis should be applied\.
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBbold\fR: make the text thicker then the surrounding text\.
|
||||
|
|
@ -482,7 +482,7 @@ Format: \fB(dash|solid)\fR
|
|||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Indicates how a line should be drawn\. It currently supports: * \fBdash\fR: A dashed line\. Where the gap is the same width as the dash\. * \fBsolid\fR: A solid line\.
|
||||
Indicates how a line should be drawn\. It currently supports: * \fBdash\fR: a dashed line, where the gap is the same width as the dash * \fBsolid\fR: a solid line
|
||||
.
|
||||
.SH "Distance"
|
||||
.
|
||||
|
|
@ -525,7 +525,7 @@ Distances used in the horizontal direction use the monitor width\. Distances in
|
|||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
On a full\-hd (1920x1080) monitor defines a padding of 192 pixels on the left and right side and 108 pixels on the top and bottom\.
|
||||
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\.
|
||||
.
|
||||
.SH "Padding"
|
||||
.
|
||||
|
|
@ -547,7 +547,7 @@ Format: \fB{Distance} {Distance} {Distance} {Distance}\fR
|
|||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
If no unit is set, pixels are used\.
|
||||
If no unit is specified, pixels are used\.
|
||||
.
|
||||
.P
|
||||
The different number of fields in the formats are parsed like:
|
||||
|
|
@ -598,7 +598,7 @@ Format: \fB{Distance} {Line style} {Distance} {Line style} {Distance} {Line styl
|
|||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Border are identical to padding, except that each distance field has a line style property\.
|
||||
Borders are identical to padding, except that each distance field has a line style property\.
|
||||
.
|
||||
.SH "Position"
|
||||
Indicate a place on the window/monitor\.
|
||||
|
|
@ -631,7 +631,7 @@ Format: \fB@{PROPERTY NAME}\fR
|
|||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
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\. e\.g\. 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:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
|
|
@ -670,7 +670,7 @@ Format: \fB(horizontal|vertical)\fR
|
|||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Specify an orientation of the widget\.
|
||||
Specify the orientation of the widget\.
|
||||
.
|
||||
.SH "List of keywords"
|
||||
.
|
||||
|
|
@ -680,7 +680,7 @@ Format: \fB[ keyword, keyword ]\fR
|
|||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
A list starts with a \'[\' and ends with a \']\'\. The entries in the list are comma separated\. The \fBkeyword\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 \fBkeyword\fR in the list refers to an widget name\.
|
||||
.
|
||||
.SH "ELEMENTS PATHS"
|
||||
Element paths exists of two parts, the first part refers to the actual widget by name\. Some widgets have an extra state\.
|
||||
|
|
@ -723,34 +723,34 @@ The difference between dots and spaces is purely cosmetic\. These are all the sa
|
|||
.SH "SUPPORTED ELEMENT PATH"
|
||||
.
|
||||
.SH "Name"
|
||||
The current widgets exist in \fBrofi\fR:
|
||||
The current widgets available in \fBrofi\fR:
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fB#window\.box\fR: The container holding the window\.
|
||||
\fB#window\.box\fR: the container holding the window
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fB#window\.overlay\fR: The overlay widget\.
|
||||
\fB#window\.overlay\fR: the overlay widget
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fB#window\.mainbox\.box\fR: The main vertical @box
|
||||
\fB#window\.mainbox\.box\fR: the main vertical @box
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fB#window\.mainbox\.inputbar\.box\fR: The horizontal @box packing the widgets\.
|
||||
\fB#window\.mainbox\.inputbar\.box\fR: the horizontal @box packing the widgets
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fB#window\.mainbox\.inputbar\.case\-indicator\fR: The case/sort indicator @textbox
|
||||
\fB#window\.mainbox\.inputbar\.case\-indicator\fR: the case/sort indicator @textbox
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fB#window\.mainbox\.inputbar\.prompt\fR: The prompt @textbox
|
||||
\fB#window\.mainbox\.inputbar\.prompt\fR: the prompt @textbox
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fB#window\.mainbox\.inputbar\.entry\fR: The main entry @textbox
|
||||
\fB#window\.mainbox\.inputbar\.entry\fR: the main entry @textbox
|
||||
.
|
||||
.IP "" 0
|
||||
|
||||
|
|
@ -758,13 +758,13 @@ The current widgets exist in \fBrofi\fR:
|
|||
.IP "\(bu" 4
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fB#window\.mainbox\.listview\.box\fR: The listview container\.
|
||||
\fB#window\.mainbox\.listview\.box\fR: the listview container
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fB#window\.mainbox\.listview\.scrollbar\fR: The listview scrollbar
|
||||
\fB#window\.mainbox\.listview\.scrollbar\fR: the listview scrollbar
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fB#window\.mainbox\.listview\.element\fR: The entries in the listview
|
||||
\fB#window\.mainbox\.listview\.element\fR: the entries in the listview
|
||||
.
|
||||
.IP "" 0
|
||||
|
||||
|
|
@ -772,10 +772,10 @@ The current widgets exist in \fBrofi\fR:
|
|||
.IP "\(bu" 4
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fB#window\.mainbox\.sidebar\.box\fR: The main horizontal @box packing the buttons\.
|
||||
\fB#window\.mainbox\.sidebar\.box\fR: the main horizontal @box packing the buttons
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fB#window\.mainbox\.sidebar\.button\fR: The buttons @textbox for each mode\.
|
||||
\fB#window\.mainbox\.sidebar\.button\fR: the buttons @textbox for each mode
|
||||
.
|
||||
.IP "" 0
|
||||
|
||||
|
|
@ -783,10 +783,10 @@ The current widgets exist in \fBrofi\fR:
|
|||
.IP "\(bu" 4
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fB#window\.mainbox\.message\.textbox\fR: The message textbox\.
|
||||
\fB#window\.mainbox\.message\.textbox\fR: the message textbox
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fB#window\.mainbox\.message\.box\fR: The box containing the message\.
|
||||
\fB#window\.mainbox\.message\.box\fR: the box containing the message
|
||||
.
|
||||
.IP "" 0
|
||||
|
||||
|
|
@ -800,7 +800,7 @@ The current widgets exist in \fBrofi\fR:
|
|||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Note that these paths names match the default theme\. Themes that provide a custom layout will have different element paths\.
|
||||
Note that these path names match the default theme\. Themes that provide a custom layout will have different element paths\.
|
||||
.
|
||||
.SH "State"
|
||||
State: State of widget
|
||||
|
|
@ -824,10 +824,10 @@ Currently only the entrybox and scrollbar have states:
|
|||
\fB{visible modifier}\.{state}\fR
|
||||
.
|
||||
.P
|
||||
Where \fBvisible 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)
|
||||
Where \fBvisible 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)
|
||||
.
|
||||
.P
|
||||
Where \fBstate\fR is: * normal: No modification\. * urgent: This entry is marked urgent\. * active: This entry is marked active\.
|
||||
Where \fBstate\fR is: * normal: no modification * urgent: this entry is marked urgent * active: this entry is marked active
|
||||
.
|
||||
.P
|
||||
These can be mixed\.
|
||||
|
|
@ -855,15 +855,15 @@ Sets all selected textboxes marked active to the given foreground and background
|
|||
The scrollbar uses the \fBhandle\fR state when drawing the small scrollbar handle\. This allows the colors used for drawing the handle to be set independently\.
|
||||
.
|
||||
.SH "SUPPORTED PROPERTIES"
|
||||
The following properties are currently supports:
|
||||
The following properties are currently supported:
|
||||
.
|
||||
.SS "all widgets:"
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBpadding\fR: padding Padding on the inside of the widget\.
|
||||
\fBpadding\fR: padding Padding on the inside of the widget
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBmargin\fR: padding Margin on the outside of the widget\.
|
||||
\fBmargin\fR: padding Margin on the outside of the widget
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBborder\fR: border Border around the widget (between padding and margin)/
|
||||
|
|
@ -872,41 +872,41 @@ The following properties are currently supports:
|
|||
\fBborder\-radius\fR: padding Sets a radius on the corners of the borders\.
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBbackground\fR: color Background color\.
|
||||
\fBbackground\fR: color Background color
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBforeground\fR: color Foreground color\.
|
||||
\fBforeground\fR: color Foreground color
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBindex\fR: integer (This one does not inherits it value from the parent widget)
|
||||
\fBindex\fR: integer (This one does not inherit it value from the parent widget)
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.SS "window:"
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBfont\fR: string The font used in the window\.
|
||||
\fBfont\fR: string The font used in the window
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBtransparency\fR: string Indicating if transparency should be used and what type: \fBreal\fR \- True transparency\. Only works with a compositor\. \fBbackground\fR \- Take a screenshot of the background image and use that\. \fBscreenshot\fR \- Take a screenshot of the screen and use that\. \fBPath\fR to png file \- Use an image\.
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBposition\fR: position The place of the anchor on the monitor\.
|
||||
\fBposition\fR: position The place of the anchor on the monitor
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBanchor\fR: anchor The anchor position on the window\.
|
||||
\fBanchor\fR: anchor The anchor position on the window
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBfullscreen\fR: boolean Window is fullscreen\.
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBwidth\fR: distance The width of the window\.
|
||||
\fBwidth\fR: distance The width of the window
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBx\-offset\fR: distance
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBy\-offset\fR: distance The offset of the window to the anchor point\. Allowing you to push the window left/right/up/down\.
|
||||
\fBy\-offset\fR: distance The offset of the window to the anchor point, allowing you to push the window left/right/up/down
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
|
|
@ -945,38 +945,38 @@ The following properties are currently supports:
|
|||
\fBforeground\fR: color
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBfont\fR: The font used by this textbox\. (string)
|
||||
\fBfont\fR: the font used by this textbox (string)
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBstr\fR: The string to display by this textbox\. (string)
|
||||
\fBstr\fR: the string to display by this textbox (string)
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBvertical\-align\fR: Vertical alignment of the text\. (0 top, 1 bottom)
|
||||
\fBvertical\-align\fR: vertical alignment of the text (\fB0\fR top, \fB1\fR bottom)
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBhorizontal\-align\fR: Horizontal alignment of the text\. (0 left, 1 right)
|
||||
\fBhorizontal\-align\fR: horizontal alignment of the text (\fB0\fR left, \fB1\fR right)
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBtext\fR: The text color to use (falls back to foreground if not set)
|
||||
\fBtext\fR: the text color to use (falls back to foreground if not set)
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBhighlight\fR: Text Style {color} Color is optional, multiple highlight styles can be added like: bold underline italic #000000;
|
||||
\fBhighlight\fR: text style {color} color is optional, multiple highlight styles can be added like: bold underline italic #000000;
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBwidth\fR: Override the desired width for the textbox\.
|
||||
\fBwidth\fR: override the desired width for the textbox
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.SS "listview:"
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBcolumns\fR: integer Number of columns to show (atleast 1)\.
|
||||
\fBcolumns\fR: integer Number of columns to show (at least 1)
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBfixed\-height\fR: boolean Always show \fBlines\fR rows, even if less elements are available\.
|
||||
\fBfixed\-height\fR: boolean Always show \fBlines\fR rows, even if fewer elements are available\.
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBdynamic\fR: boolean If the size should changed when filtering the list, or if it should keep the original height\.
|
||||
\fBdynamic\fR: boolean \fBTrue\fR if the size should change when filtering the list, \fBFalse\fR if it should keep the original height\.
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBscrollbar\fR: boolean If the scrollbar should be enabled/disabled\.
|
||||
|
|
@ -985,7 +985,7 @@ The following properties are currently supports:
|
|||
\fBscrollbar\-width\fR: distance Width of the scrollbar
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBcycle\fR: boolean When navigating it should wrap around\.
|
||||
\fBcycle\fR: boolean When navigating, it should wrap around
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBspacing\fR: distance Spacing between the elements (both vertical and horizontal)
|
||||
|
|
@ -999,13 +999,13 @@ The following properties are currently supports:
|
|||
.IP "" 0
|
||||
.
|
||||
.SH "Layout"
|
||||
The new format allows the layout of the \fBrofi\fR window to be tweaked extensively\. For each widget the themer can specify padding, margin, border, font and more\. It even allows, as advanced feature, to pack widgets in a custom structure\.
|
||||
The new format allows the layout of the \fBrofi\fR 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"
|
||||
The whole view is build up out of boxes that pack other boxes or widgets\. The box can be either vertical or horizontal\. This is loosely inspired GTK \fIhttp://gtk\.org/\fR\.
|
||||
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 \fIhttp://gtk\.org/\fR\.
|
||||
.
|
||||
.P
|
||||
The current layout of \fBrofi\fR is structured as follow:
|
||||
The current layout of \fBrofi\fR is structured as follows:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
|
|
@ -1047,7 +1047,7 @@ The current layout of \fBrofi\fR is structured as follow:
|
|||
The layout of \fBrofi\fR can be tweaked by packing the \'fixed\' widgets in a custom structure\.
|
||||
.
|
||||
.P
|
||||
The following widgets names are \'fixed\' widgets with functionality:
|
||||
The following widgets are fixed, as they provide core \fBrofi\fR functionality:
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
prompt
|
||||
|
|
@ -1070,7 +1070,7 @@ sidebar
|
|||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
The following exists and automatically pack a subset of the widgets as in the above picture:
|
||||
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\.
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
mainbox Packs: \fBinputbar, message, listview, sidebar\fR
|
||||
|
|
@ -1081,7 +1081,7 @@ inputbar Packs: \fBprompt,entry,case\-indicator\fR
|
|||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Any widget name starting with \fBtextbox\fR is a textbox widget, all others are a box widget and can pack other widgets\. To specify children, set the children property (this always happens on the \fBbox\fR child, see example below):
|
||||
Any widget name starting with \fBtextbox\fR is a textbox widget, others are box widgets and can pack other widgets\. To specify children, set the \fBchildren\fR property (this always happens on the \fBbox\fR child, see example below):
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
|
|
@ -1094,7 +1094,7 @@ children: [prompt,entry,case\-indicator];
|
|||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
The theme needs to be update to match the hierarchy specified\.
|
||||
The theme needs to be updated to match the hierarchy specified\.
|
||||
.
|
||||
.P
|
||||
Below is an example of a theme emulating dmenu:
|
||||
|
|
@ -1148,7 +1148,7 @@ Below is an example of a theme emulating dmenu:
|
|||
.IP "" 0
|
||||
.
|
||||
.SS "Padding and margin"
|
||||
Just like css \fBrofi\fR uses the box model for each widget\.
|
||||
Just like CSS, \fBrofi\fR uses the box model for each widget\.
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
|
|
@ -1184,7 +1184,7 @@ Padding \- Clears an area around the widget\. The padding shows the background c
|
|||
Border \- A border that goes around the padding and content\. The border use the foreground color of the widget\.
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
Margin \- Clears an area outside the border\. The margin is transparent
|
||||
Margin \- Clears an area outside the border\. The margin is transparent\.
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
|
|
@ -1192,10 +1192,10 @@ 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\.
|
||||
.
|
||||
.P
|
||||
The size, on each side, of margin, border and padding can be set\. For the border a linestyle and radius can be set\.
|
||||
The size of each margin, border, and padding can be set\. For the border, a linestyle and radius can be set\.
|
||||
.
|
||||
.SS "Spacing"
|
||||
Widgets that can pack more then one child widget, currently box and listview, the \fBspacing\fR property exists\. This determines the space between the packed widgets (both in horizontal as vertical direction)\.
|
||||
Widgets that can pack more then one child widget (currently box and listview) have the \fBspacing\fR property\. This property sets the distance between the packed widgets (both horizontally and vertically)\.
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
|
|
@ -1216,7 +1216,7 @@ Widgets that can pack more then one child widget, currently box and listview, th
|
|||
.IP "" 0
|
||||
.
|
||||
.SS "Advanced box packing"
|
||||
More dynamic spacing can be achieved by adding dummy widgets, for example to get one widget centered:
|
||||
More dynamic spacing can be achieved by adding dummy widgets, for example to make one widget centered:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
|
|
@ -1237,10 +1237,10 @@ More dynamic spacing can be achieved by adding dummy widgets, for example to get
|
|||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
If both dummy widgets are set to expanding, \fBchild\fR will be centered\. Depending on the \fBexpand\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, \fBchild\fR will be centered\. Depending on the \fBexpand\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"
|
||||
To get debug information from the parser run rofi like:
|
||||
To get debug information from the parser, run rofi like:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
|
|
@ -1253,7 +1253,7 @@ G_MESSAGES_DEBUG=Parser rofi \-show run
|
|||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Syntax errors are shown in a popup and printed out to commandline with the above command\.
|
||||
Syntax errors are shown in a popup and printed out to command line with the above command\.
|
||||
.
|
||||
.P
|
||||
To see the elements queried during running, run:
|
||||
|
|
@ -1269,7 +1269,7 @@ G_MESSAGES_DEBUG=Theme rofi \-show run
|
|||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
To test minor changes, part of the theme can be passed on the commandline, for example to set it fullscreen:
|
||||
To test minor changes, part of the theme can be passed on the command line, for example to set it to full\-screen:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
|
|
@ -1282,7 +1282,7 @@ rofi \-theme\-str \'#window { fullscreen:true;}\' \-show run
|
|||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
To print the current theme run:
|
||||
To print the current theme, run:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
|
|
@ -1295,7 +1295,7 @@ rofi \-dump\-theme
|
|||
.IP "" 0
|
||||
.
|
||||
.SH "EXAMPLES"
|
||||
Several examples are installed together with \fBrofi\fR\. These can be found in \fB{datadir}/rofi/themes/\fR where \fB{datadir}\fR is the install path of \fBrofi\fR data\. When installed using a package manager this is usually: \fB/usr/share/\fR\.
|
||||
Several examples are installed together with \fBrofi\fR\. These can be found in \fB{datadir}/rofi/themes/\fR, where \fB{datadir}\fR is the install path of \fBrofi\fR data\. When installed using a package manager, this is usually: \fB/usr/share/\fR\.
|
||||
.
|
||||
.SH "SEE ALSO"
|
||||
rofi(1)
|
||||
|
|
|
|||
248
doc/rofi.1
248
doc/rofi.1
|
|
@ -1,7 +1,7 @@
|
|||
.\" generated with Ronn/v0.7.3
|
||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||
.
|
||||
.TH "ROFI" "1" "July 2017" "" ""
|
||||
.TH "ROFI" "1" "August 2017" "" ""
|
||||
.
|
||||
.SH "NAME"
|
||||
\fBrofi\fR \- A window switcher, application launcher, ssh dialog and dmenu replacement
|
||||
|
|
@ -10,13 +10,13 @@
|
|||
\fBrofi\fR [ \-show \fImode\fR ]|[ \-dmenu ]|[ \-e \fImsg\fR ] [ CONFIGURATION ]
|
||||
.
|
||||
.SH "DESCRIPTION"
|
||||
\fBrofi\fR is an X11 popup 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\.
|
||||
\fBrofi\fR 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\.
|
||||
.
|
||||
.SH "USAGE"
|
||||
\fBrofi\fR main functionality is to assist in your workflow, allowing you to quickly (with a few keystrokes) switch between windows, start applications or log into a remote machine via ssh\. There are different modi for different type of actions\.
|
||||
\fBrofi\fR\'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 \fImodi\fR for different types of actions\.
|
||||
.
|
||||
.P
|
||||
\fBrofi\fR can also function as (drop in) replacement for \fBdmenu(1)\fR\.
|
||||
\fBrofi\fR can also function as (drop\-in) replacement for \fBdmenu(1)\fR\.
|
||||
.
|
||||
.SS "Running rofi"
|
||||
To launch \fBrofi\fR directly in a certain mode, specify a mode with \fBrofi \-show <mode>\fR\. To show the run dialog:
|
||||
|
|
@ -35,13 +35,13 @@ rofi \-show run
|
|||
\fBrofi\fR can emulate \fBdmenu(1)\fR (a dynamic menu for X) when launched with the \fB\-dmenu\fR flag\.
|
||||
.
|
||||
.P
|
||||
The "official" website for \fBdmenu\fR can be found here \fIhttp://tools\.suckless\.org/dmenu/\fR\.
|
||||
The website for \fBdmenu\fR can be found here \fIhttp://tools\.suckless\.org/dmenu/\fR\.
|
||||
.
|
||||
.P
|
||||
\fBrofi\fR does not aim to be 100% compatible with dmenu\. There are simply to many different flavours of dmenu\. The idea is the basic usage commandline flags are obeyed, theme related flags are not\. Besides this, \fBrofi\fR offers some extended features (like multi\-select, highlighting, message bar, extra key\-bindings)\.
|
||||
\fBrofi\fR does not aim to be 100% compatible with dmenu\. There are simply too many different flavors of dmenu\. The idea is that the basic usage command\-line flags are obeyed, theme\-related flags are not\. Besides, \fBrofi\fR offers some extended features (like multi\-select, highlighting, message bar, extra key bindings)\.
|
||||
.
|
||||
.SS "Display Error message"
|
||||
\fBrofi\fR error dialog can also be called from the commandline\.
|
||||
\fBrofi\fR error dialog can also be called from the command line\.
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
|
|
@ -60,7 +60,7 @@ Markup support can be enabled, see CONFIGURATION options\.
|
|||
There are currently three methods of setting configuration options (evaluated in order below):
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
System configuration file (f\.e\. /etc/rofi\.conf)\.
|
||||
System configuration file (for example \fB/etc/rofi\.conf\fR)\.
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
Xresources: A method of storing key values in the Xserver\. See here \fIhttps://en\.wikipedia\.org/wiki/X_resources\fR for more information\.
|
||||
|
|
@ -80,7 +80,7 @@ Command\-line options: Arguments passed to \fBrofi\fR\.
|
|||
\fBTIP\fR: To get a template config file run: \fBrofi \-dump\-xresources > rofi\-example\.config\fR\. \fBNOTE\fR: In version 1\.4\.0 we support configuration in a new format, a config for this can be generated by: \fBrofi \-dump\-config\fR
|
||||
.
|
||||
.P
|
||||
The Xresources file expects options starting with \fBrofi\.\fR followed by it\'s name\. An Example to set the number of lines:
|
||||
The Xresources file expects options starting with \fBrofi\.\fR followed by its name\. An example to set the number of lines:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
|
|
@ -93,7 +93,7 @@ rofi\.lines: 10
|
|||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Command line options override settings from Xresources file\. The same option set as argument: prefixed with a \'\-\':
|
||||
Command line options override settings from Xresources file\. The same option set as argument — prefixed with a \'\-\':
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
|
|
@ -106,7 +106,7 @@ rofi \-lines 10
|
|||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
To get a list of available options, formatted as Xresources entries run:
|
||||
To get a list of available options formatted as Xresources entries, run:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
|
|
@ -122,13 +122,13 @@ rofi \-dump\-xresources
|
|||
The configuration system supports the following types:
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
String
|
||||
string
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
Integer (signed and unsigned)
|
||||
integer (signed and unsigned)
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
Char
|
||||
char
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
Boolean
|
||||
|
|
@ -174,7 +174,7 @@ The help option shows the full list of commandline options and the current set v
|
|||
\fB\-dump\-xresources\fR
|
||||
.
|
||||
.P
|
||||
Dump the current active configuration in Xresources format to the command\-line\. This does not validate all passed values (e\.g\. colors)\.
|
||||
Dump the current active configuration in Xresources format to the command\-line\. This does not validate all passed values (for example, colors)\.
|
||||
.
|
||||
.P
|
||||
\fB\-threads\fR \fInum\fR
|
||||
|
|
@ -197,7 +197,7 @@ Specify the number of threads \fBrofi\fR should use:
|
|||
\fB\-dmenu\fR
|
||||
.
|
||||
.P
|
||||
Run \fBrofi\fR in dmenu mode\. This allows for interactive scripts\. In \fBdmenu\fR mode, \fBrofi\fR reads from STDIN, and output to STDOUT\. A simple example, displaying 3 pre\-defined options:
|
||||
Run \fBrofi\fR in dmenu mode\. This allows for interactive scripts\. In \fBdmenu\fR mode, \fBrofi\fR reads from STDIN, and output to STDOUT\. A simple example, displaying three pre\-defined options:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
|
|
@ -226,7 +226,7 @@ Or get the options from a script:
|
|||
\fB\-show\fR \fImode\fR
|
||||
.
|
||||
.P
|
||||
Open \fBrofi\fR in a certain mode\. Available modes are \fBwindow\fR, \fBrun\fR, \fBdrun\fR, \fBssh\fR, \fBcombi\fR\. The special argument \fBkeys\fR can be used to open a searchable list of supported keybindings (see \fIKEYBINDINGS\fR)
|
||||
Open \fBrofi\fR in a certain mode\. Available modes are \fBwindow\fR, \fBrun\fR, \fBdrun\fR, \fBssh\fR, \fBcombi\fR\. The special argument \fBkeys\fR can be used to open a searchable list of supported key bindings (see \fIKEY BINDINGS\fR)
|
||||
.
|
||||
.P
|
||||
To show the run\-dialog:
|
||||
|
|
@ -245,7 +245,7 @@ rofi \-show run
|
|||
\fB\-modi\fR \fImode1,mode1\fR
|
||||
.
|
||||
.P
|
||||
Specify a 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 modes will be enabled\. To only show the run and ssh launcher:
|
||||
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 modes will be enabled\. To only show the run and ssh launcher:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
|
|
@ -296,7 +296,7 @@ Start in case sensitive mode\. This option can be changed at run\-time using the
|
|||
\fB\-cycle\fR
|
||||
.
|
||||
.P
|
||||
Cycle through the results list\. Default is \'true\'\.
|
||||
Cycle thru the result list\. Default is \'true\'\.
|
||||
.
|
||||
.P
|
||||
\fB\-filter\fR \fIfilter\fR
|
||||
|
|
@ -308,7 +308,7 @@ Filter the list by setting text in input bar to \fIfilter\fR
|
|||
\fB\-config\fR \fIfilename\fR
|
||||
.
|
||||
.P
|
||||
Load alternative configuration file\.
|
||||
Load an alternative configuration file\.
|
||||
.
|
||||
.P
|
||||
\fB\-scroll\-method\fR \fImethod\fR
|
||||
|
|
@ -338,7 +338,7 @@ Disable plugin loading\.
|
|||
\fB\-plugin\-path\fR \fIdirectory\fR
|
||||
.
|
||||
.P
|
||||
Specify the directory where \fIrofi\fR should look for plugins\.
|
||||
Specify the directory where \fBrofi\fR should look for plugins\.
|
||||
.
|
||||
.SS "Matching"
|
||||
\fB\-matching\fR \fImethod\fR
|
||||
|
|
@ -347,16 +347,16 @@ Specify the directory where \fIrofi\fR should look for plugins\.
|
|||
Specify the matching algorithm used\. Current the following methods are supported\.
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBnormal\fR: Match the int string\.
|
||||
\fBnormal\fR: match the int string
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBregex\fR: Match a regex input\.
|
||||
\fBregex\fR: match a regex input
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBglob\fR: Match a glob pattern\.
|
||||
\fBglob\fR: match a glob pattern
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBfuzzy\fR: Do a fuzzy match\.
|
||||
\fBfuzzy\fR: do a fuzzy match
|
||||
.
|
||||
.IP
|
||||
Default: \fInormal\fR
|
||||
|
|
@ -373,7 +373,7 @@ Note: glob matching might be slow for larger lists
|
|||
Tokenize the input\.
|
||||
.
|
||||
.SS "Layout"
|
||||
Most of the following options are \fBdeprecated\fR and should not be used\. Please use the new theme format to customize rofi\. More information about the new format can be found in the \fBrofi\-theme(5)\fR manpage\.
|
||||
Most of the following options are \fBdeprecated\fR and should not be used\. Please use the new theme format to customize \fBrofi\fR\. More information about the new format can be found in the \fBrofi\-theme(5)\fR manpage\.
|
||||
.
|
||||
.P
|
||||
\fB\-lines\fR
|
||||
|
|
@ -430,7 +430,7 @@ rofi \-width 60
|
|||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
If \fB[value]\fR is larger then 100, size is set in pixels\. Example to span a full hd monitor:
|
||||
If \fB[value]\fR is larger then 100, size is set in pixels\. Example to span a full\-HD monitor:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
|
|
@ -443,7 +443,7 @@ rofi \-width 1920
|
|||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
If \fB[value]\fR is negative, it tries to estimates a character width\. To show 30 characters on a row:
|
||||
If \fB[value]\fR is negative, it tries to estimates a character width\. To show 30 characters in a row:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
|
|
@ -456,7 +456,7 @@ rofi \-width \-30
|
|||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Character width is a rough estimation, and might not be correct, but should work for most monospaced fonts\.
|
||||
Character width is a rough estimate, and might not be correct, but should work for most monospaced fonts\.
|
||||
.
|
||||
.P
|
||||
Default: \fI50\fR
|
||||
|
|
@ -501,13 +501,13 @@ Default: \fI5\fR
|
|||
\fB\-fullscreen\fR
|
||||
.
|
||||
.P
|
||||
Use the full screen height and width\.
|
||||
Use the full\-screen height and width\.
|
||||
.
|
||||
.P
|
||||
\fB\-sidebar\-mode\fR
|
||||
.
|
||||
.P
|
||||
Open in sidebar\-mode\. In this mode a list of all enabled modes is shown at the bottom\. (See \fB\-modi\fR option) To show sidebar use:
|
||||
Open in sidebar\-mode\. In this mode a list of all enabled modes is shown at the bottom\. (See \fB\-modi\fR option) To show sidebar, use:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
|
|
@ -538,16 +538,16 @@ When one entry is left, automatically select it\.
|
|||
\fB\-monitor\fR \fIname\fR
|
||||
.
|
||||
.P
|
||||
Select monitor to display \fBrofi\fR on\. As input it accepts: \fIprimary\fR (if primary output is set), the \fIxrandr\fR output name or integer number (in order of detection)\. Negative numbers are handled differently:
|
||||
Select monitor to display \fBrofi\fR on\. It accepts as input: \fIprimary\fR (if primary output is set), the \fIxrandr\fR output name, or integer number (in order of detection)\. Negative numbers are handled differently:
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fB\-1\fR: the currently focused monitor\.
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fB\-2\fR: the currently focused window (i\.e\. rofi will be displayed on top of the focused window)\.
|
||||
\fB\-2\fR: the currently focused window (that is, \fBrofi\fR will be displayed on top of the focused window)\.
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fB\-3\fR: Position at mouse (overrides the location setting to get normal context menu behaviour\.)
|
||||
\fB\-3\fR: Position at mouse (overrides the location setting to get normal context menu behavior\.)
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fB\-4\fR: the monitor with the focused window\.
|
||||
|
|
@ -561,7 +561,7 @@ Default: \fI\-5\fR
|
|||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
See \fBrofi \-h\fR output for the detected monitors, their position and size\.
|
||||
See \fBrofi \-h\fR output for the detected monitors, their position, and size\.
|
||||
.
|
||||
.P
|
||||
\fB\-theme\fR \fIfilename\fR
|
||||
|
|
@ -573,10 +573,10 @@ Path to the new theme file format\. This overrides the old theme settings\.
|
|||
\fB\-theme\-str\fR \fIstring\fR
|
||||
.
|
||||
.P
|
||||
Allow theme parts to be specified on the commandline as an override\.
|
||||
Allow theme parts to be specified on the command line as an override\.
|
||||
.
|
||||
.P
|
||||
For example
|
||||
For example:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
|
|
@ -595,13 +595,13 @@ This option can be specified multiple times\.
|
|||
\fB\-dpi\fR \fInumber\fR
|
||||
.
|
||||
.P
|
||||
Override the default DPI setting\. If set to \fB0\fR it tries to auto\-detect based on X11 screen size\. (Similar to i3 and GTK) If set to \fB1\fR it tries to auto\-detect based on monitor (rofi is displayed on) size\. (Similar to latest QT5)
|
||||
Override the default DPI setting\. If set to \fB0\fR, it tries to auto\-detect based on X11 screen size (similar to i3 and GTK)\. If set to \fB1\fR, it tries to auto\-detect based on the size of the monitor that rofi is displayed on (similar to latest Qt 5)\.
|
||||
.
|
||||
.SS "PATTERN setting"
|
||||
\fB\-terminal\fR
|
||||
.
|
||||
.P
|
||||
Specify what terminal to start\.
|
||||
Specify which terminal to start\.
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
|
|
@ -674,10 +674,10 @@ Default: \fI{terminal} \-e {cmd}\fR
|
|||
\fB\-run\-list\-command\fR \fIcmd\fR
|
||||
.
|
||||
.P
|
||||
If set, use an external tool to generate list of executable commands\. Uses \'run\-command\'
|
||||
If set, use an external tool to generate list of executable commands\. Uses \fBrun\-command\fR\.
|
||||
.
|
||||
.P
|
||||
Default: \fI""\fR
|
||||
Default: \fI{cmd}\fR
|
||||
.
|
||||
.SS "Window switcher settings"
|
||||
\fB\-window\-format\fR \fIformat\fR
|
||||
|
|
@ -692,24 +692,24 @@ Format what is being displayed for windows\.
|
|||
\fIfield\fR:
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBw\fR: Desktop name
|
||||
\fBw\fR: desktop name
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBt\fR: Title of window
|
||||
\fBt\fR: title of window
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBn\fR: Name
|
||||
\fBn\fR: name
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBr\fR: Role
|
||||
\fBr\fR: role
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBc\fR: Class
|
||||
\fBc\fR: class
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
\fIlen\fR: maximum field length (0 for auto\-size)\. If length negative and window \fIwidth\fR is negative field length is \fIwidth \- len\fR\. if length is positive, the entry will be truncated or padded to fill that length\.
|
||||
\fIlen\fR: maximum field length (0 for auto\-size)\. If length and window \fIwidth\fR are negative, field length is \fIwidth \- len\fR\. if length is positive, the entry will be truncated or padded to fill that length\.
|
||||
.
|
||||
.P
|
||||
default: {w} {c} {t}
|
||||
|
|
@ -718,7 +718,7 @@ default: {w} {c} {t}
|
|||
\fB\-window\-command\fR \fIcmd\fR
|
||||
.
|
||||
.P
|
||||
Set command to execute on selected window for custom action\. See \fIPATTERN\fR\.
|
||||
Set command to execute on selected window for a custom action\. See \fIPATTERN\fR\.
|
||||
.
|
||||
.P
|
||||
Default: \fI"xkill \-id {window}"\fR
|
||||
|
|
@ -727,7 +727,7 @@ Default: \fI"xkill \-id {window}"\fR
|
|||
\fB\-combi\-modi\fR \fImode1,mode2\fR
|
||||
.
|
||||
.P
|
||||
The modi to combine in combi mode\. For syntax to see \fB\-modi\fR\. To get one merge view, of window,run,ssh:
|
||||
The modi to combine in combi mode\. For syntax to see \fB\-modi\fR\. To get one merge view, of \fBwindow\fR,\fBrun\fR, and \fBssh\fR:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
|
|
@ -740,7 +740,7 @@ rofi \-show combi \-combi\-modi "window,run,ssh" \-modi combi
|
|||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Notes: The I3 Window manager does not like commas in the command when specifying an exec command\. For that case \'#\' can be used as an separator\.
|
||||
Notes: The I3 Window manager does not like commas in the command when specifying an exec command\. For that case \'#\' can be used as a separator\.
|
||||
.
|
||||
.SS "History and Sorting"
|
||||
\fB\-disable\-history\fR \fB\-no\-disable\-history\fR (re\-enable history)
|
||||
|
|
@ -752,13 +752,13 @@ Disable history
|
|||
\fB\-levenshtein\-sort\fR to enable \fB\-no\-levenshtein\-sort\fR to disable
|
||||
.
|
||||
.P
|
||||
When searching sort the result based on levenshtein distance\. This setting can be changed at runtime, see \fB\-kb\-toggle\-sort\fR\.
|
||||
When searching, sort the result based on levenshtein distance\. This setting can be changed at runtime (see \fB\-kb\-toggle\-sort\fR)\.
|
||||
.
|
||||
.SS "Dmenu specific"
|
||||
\fB\-sep\fR \fIseparator\fR
|
||||
.
|
||||
.P
|
||||
Separator for dmenu\. Example: To show list \'a\' to \'e\' with \'|\' as separator:
|
||||
Separator for dmenu\. Example: To show a list of \'a\' to \'e\' with \'|\' as a separator:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
|
|
@ -774,7 +774,7 @@ echo "a|b|c|d|e" | rofi \-sep \'|\' \-dmenu
|
|||
\fB\-p\fR \fIprompt\fR
|
||||
.
|
||||
.P
|
||||
Specify the prompt to show in dmenu mode\. E\.g\. 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\.
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
|
|
@ -827,13 +827,13 @@ Makes dmenu searches case\-insensitive
|
|||
\fB\-a\fR \fIX\fR
|
||||
.
|
||||
.P
|
||||
Active row, mark row X as active\. (starting at 0) You can specify single element: \-a 3 A range: \-a 3\-8 or a set of rows: \-a 0,2 or any combination: \-a 0,2\-3,9
|
||||
Active row, mark row X as active (starting at 0)\. You can specify single element: \-a 3 A range: \-a 3\-8 or a set of rows: \-a 0,2 or any combination: \-a 0,2\-3,9
|
||||
.
|
||||
.P
|
||||
\fB\-u\fR \fIX\fR
|
||||
.
|
||||
.P
|
||||
Urgent row, mark row X as urgent\. (starting at 0) You can specify single element: \-u 3 A range: \-u 3\-8 or a set of rows: \-u 0,2 or any combination: \-u 0,2\-3,9
|
||||
Urgent row, mark row X as urgent (starting at 0)\. You can specify single element: \-u 3 A range: \-u 3\-8 or a set of rows: \-u 0,2 or any combination: \-u 0,2\-3,9
|
||||
.
|
||||
.P
|
||||
\fB\-only\-match\fR
|
||||
|
|
@ -851,25 +851,25 @@ Only return a selected item, do not allow custom entry\. This mode returns direc
|
|||
\fB\-format\fR \fIformat\fR
|
||||
.
|
||||
.P
|
||||
Allows the output of dmenu to be customized (N is total number of input entries):
|
||||
Allows the output of dmenu to be customized (N is the total number of input entries):
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\'s\' selected string\.
|
||||
\'s\' selected string
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\'i\' index (0 \- (N\-1))\.
|
||||
\'i\' index (0 \- (N\-1))
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\'d\' index (1 \- N)\.
|
||||
\'d\' index (1 \- N)
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\'q\' quote string\.
|
||||
\'q\' quote string
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\'f\' filter string (user input)\.
|
||||
\'f\' filter string (user input)
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\'F\' quoted filter string (user input)\.
|
||||
\'F\' quoted filter string (user input)
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
|
|
@ -916,7 +916,7 @@ Hide the input text\. This should not be considered secure!
|
|||
\fB\-markup\-rows\fR
|
||||
.
|
||||
.P
|
||||
Tell \fBrofi\fR that DMenu input is pango markup encoded and should be rendered\. See here \fIhttps://developer\.gnome\.org/pango/stable/PangoMarkupFormat\.html\fR for details about pango markup\.
|
||||
Tell \fBrofi\fR that DMenu input is pango markup encoded, and should be rendered\. See here \fIhttps://developer\.gnome\.org/pango/stable/PangoMarkupFormat\.html\fR for details about pango markup\.
|
||||
.
|
||||
.P
|
||||
\fB\-multi\-select\fR
|
||||
|
|
@ -928,16 +928,16 @@ Allow multiple lines to be selected\. Adds a small selection indicator to the le
|
|||
\fB\-sync\fR
|
||||
.
|
||||
.P
|
||||
Force rofi mode to first read all data from stdin before showing selection window\. This is how original dmenu behaviour\.
|
||||
Force rofi mode to first read all data from stdin before showing the selection window\. This is original dmenu behavior\.
|
||||
.
|
||||
.P
|
||||
Note: the default asynchronous mode will also be automatically disabled if used with conflicting options such as \fB\-dump\fR, \fB\-only\-match\fR or \fB\-auto\-select\fR
|
||||
Note: the default asynchronous mode will also be automatically disabled if used with conflicting options, such as \fB\-dump\fR, \fB\-only\-match\fR or \fB\-auto\-select\fR\.
|
||||
.
|
||||
.P
|
||||
\fB\-async\-pre\-read\fR \fInumber\fR
|
||||
.
|
||||
.P
|
||||
Reads the first 25 entries blocking\. Then switches to async mode\. This makes it feel more \'snappy\'\.
|
||||
Reads the first 25 entries blocking, then switches to async mode\. This makes it feel more \'snappy\'\.
|
||||
.
|
||||
.P
|
||||
\fIdefault\fR: 25
|
||||
|
|
@ -946,13 +946,13 @@ Reads the first 25 entries blocking\. Then switches to async mode\. This makes i
|
|||
\fB\-e\fR \fImessage\fR
|
||||
.
|
||||
.P
|
||||
Popup a message dialog (used internally for showing errors) with \fImessage\fR\. Message can be multi\-line\.
|
||||
Pops up a message dialog (used internally for showing errors) with \fImessage\fR\. Message can be multi\-line\.
|
||||
.
|
||||
.SS "Other"
|
||||
\fB\-pid\fR \fIpath\fR
|
||||
.
|
||||
.P
|
||||
Make \fBrofi\fR create a pid file and check this on startup\. Avoiding multiple copies running simultaneously\. This is useful when running \fBrofi\fR from a keybinding daemon\.
|
||||
Make \fBrofi\fR create a pid file and check this on startup\. The pid file prevents multiple \fBrofi\fR instances from running simultaneously\. This is useful when running \fBrofi\fR from a key\-binding daemon\.
|
||||
.
|
||||
.P
|
||||
\fB\-fake\-transparency\fR
|
||||
|
|
@ -994,7 +994,7 @@ Disable parsing of configuration\. This runs rofi in \fIstock\fR mode\.
|
|||
Disables the loading of plugins\.
|
||||
.
|
||||
.P
|
||||
To get a trace with (lots of) debug information set the following environment variable when executing \fBrofi\fR:
|
||||
To get a trace with (lots of) debug information, set the following environment variable when executing \fBrofi\fR:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
|
|
@ -1007,7 +1007,7 @@ G_MESSAGES_DEBUG=all
|
|||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
The trace can be filtered by only outputting the relevant domains, f\.e\.:
|
||||
The trace can be filtered by only outputting the relevant domains, for example:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
|
|
@ -1020,30 +1020,30 @@ G_MESSAGES_DEBUG=Dialogs\.DRun
|
|||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
For more information on debugging see the wiki \fIhttps://github\.com/DaveDavenport/rofi/wiki/Debugging%20Rofi\fR
|
||||
For more information on debugging, see the wiki \fIhttps://github\.com/DaveDavenport/rofi/wiki/Debugging%20Rofi\fR
|
||||
.
|
||||
.SH "PATTERN"
|
||||
To launch commands (e\.g\. when using the ssh launcher) the user can enter the used command\-line, the following keys can be used that will be replaced at runtime:
|
||||
To launch commands (for example, when using the ssh launcher), the user can enter the used command\-line\. The following keys can be used that will be replaced at runtime:
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fB{host}\fR: The host to connect to\.
|
||||
\fB{host}\fR: the host to connect to
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fB{terminal}\fR: The configured terminal (See \-terminal\-emulator)
|
||||
\fB{terminal}\fR: the configured terminal (see \-terminal\-emulator)
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fB{ssh\-client}\fR: The configured ssh client (See \-ssh\-client)
|
||||
\fB{ssh\-client}\fR: the configured ssh client (see \-ssh\-client)
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fB{cmd}\fR: The command to execute\.
|
||||
\fB{cmd}\fR: the command to execute
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fB{window}\fR: The window id of the selected window\. (In \fBwindow\-command\fR)
|
||||
\fB{window}\fR: the window ID of the selected window (in \fBwindow\-command\fR)
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.SH "DMENU REPLACEMENT"
|
||||
If \fBargv[0]\fR (calling command) is dmenu, \fBrofi\fR will start in dmenu mode\. This way it can be used as a drop\-in replacement for dmenu\. just copy or symlink \fBrofi\fR to dmenu in \fB$PATH\fR\.
|
||||
If \fBargv[0]\fR (calling command) is dmenu, \fBrofi\fR will start in dmenu mode\. This way it can be used as a drop\-in replacement for dmenu\. Just copy or symlink \fBrofi\fR to dmenu in \fB$PATH\fR\.
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
|
|
@ -1059,41 +1059,41 @@ ln \-s /usr/bin/rofi /usr/bin/dmenu
|
|||
The theme format below describes the old (pre version 1\.4) theme format\. Please see rofi\-theme(5) manpage for an updated manual\.
|
||||
.
|
||||
.P
|
||||
The theme setup allows you to specify colors per state, similar to \fBi3\fR Currently 3 states exists:
|
||||
The theme setup allows you to specify colors per state, similar to \fBi3\fR Currently 3 states exist:
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBnormal\fR Normal row\.
|
||||
\fBnormal\fR: normal row
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBurgent\fR Highlighted row (urgent)
|
||||
\fBurgent\fR: highlighted row (urgent)
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBactive\fR Highlighted row (active)
|
||||
\fBactive\fR: highlighted row (active)
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
For each state the following 5 colors must be set:
|
||||
For each state, the following 5 colors must be set:
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBbg\fR Background color row
|
||||
\fBbg\fR: background color row
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBfg\fR Text color
|
||||
\fBfg\fR: text color
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBbgalt\fR Background color alternating row
|
||||
\fBbgalt\fR: background color alternating row
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBhlfg\fR Foreground color selected row
|
||||
\fBhlfg\fR: foreground color selected row
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBhlbg\fR Background color selected row
|
||||
\fBhlbg\fR: background color selected row
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
The window background and border color should be specified separate\. The key \fBcolor\-window\fR contains a pair \fBbackground,border,separator\fR\. An example for \fBXresources\fR file:
|
||||
The window background and border color should be specified separately\. The key \fBcolor\-window\fR contains a tuple \fBbackground,border,separator\fR\. An example for \fBXresources\fR file:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
|
|
@ -1125,7 +1125,7 @@ rofi \-color\-normal "#fdf6e3,#002b36,#eee8d5,#586e75,#eee8d5"
|
|||
.IP "" 0
|
||||
.
|
||||
.SH "COLORS"
|
||||
RGB colors can be specified by either its X11 name, or hexadecimal notation\. For example:
|
||||
RGB colors can be specified by either their X11 name or hexadecimal notation\. For example:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
|
|
@ -1138,7 +1138,7 @@ white
|
|||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Or
|
||||
Or:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
|
|
@ -1151,20 +1151,10 @@ Or
|
|||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
ARGB colors are also support, these can be used to create a transparent window if: 1\. Your Xserver supports TrueColor, 2\. You are running a composite manager\.
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
argb:FF444444
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
ARGB colors are also supported\. These can be used to create a transparent window if (1) your Xserver supports TrueColor, and (2) you are running a composite manager\. For example: argb:FF444444
|
||||
.
|
||||
.P
|
||||
Or
|
||||
Or:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
|
|
@ -1177,16 +1167,16 @@ Or
|
|||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
The first two fields specify the alpha level\. This determines the amount of transparency\. (00 everything, FF nothing)\. The other fields represent the actual color, in hex\.
|
||||
The first two fields specify the alpha level\. This determines the amount of transparency (00 everything, FF nothing)\. The other fields represent the actual color, in hex\.
|
||||
.
|
||||
.P
|
||||
Within \fBrofi\fR transparency can be used, e\.g\. if the selected background color is 50% transparent, the background color of the window will be visible through it\.
|
||||
Transparency can be used within \fBrofi\fR, for example if the selected background color is 50% transparent, the background color of the window will be visible thru it\.
|
||||
.
|
||||
.SH "KEYBINDINGS"
|
||||
\fBrofi\fR has the following key\-bindings:
|
||||
.SH "KEY BINDINGS"
|
||||
\fBrofi\fR has the following key bindings:
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBCtrl\-v, Insert\fR: Paste clipboard
|
||||
\fBCtrl\-v, Insert\fR: Paste from clipboard
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBCtrl\-Shift\-v, Shift\-Insert\fR: Paste primary selection
|
||||
|
|
@ -1234,25 +1224,25 @@ Within \fBrofi\fR transparency can be used, e\.g\. if the selected background co
|
|||
\fBCtrl\-p,Up\fR: Select previous entry
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBPage Up\fR: Go to the previous page
|
||||
\fBPage Up\fR: Go to previous page
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBPage Down\fR: Go to the next page
|
||||
\fBPage Down\fR: Go to next page
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBCtrl\-Page Up\fR: Go to the previous column
|
||||
\fBCtrl\-Page Up\fR: Go to previous column
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBCtrl\-Page Down\fR: Go to the next column
|
||||
\fBCtrl\-Page Down\fR: Go to next column
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBCtrl\-Enter\fR: Use entered text as command (in ssh/run modi)
|
||||
\fBCtrl\-Enter\fR: Use entered text as a command (in \fBssh/run modi\fR)
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBShift\-Enter\fR: Launch the application in a terminal (in run mode)
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBShift\-Enter\fR: Return the selected entry and move to the next item while keeping Rofi open\. (in dmenu)
|
||||
\fBShift\-Enter\fR: Return the selected entry and move to the next item while keeping \fBrofi\fR open\. (in dmenu)
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBShift\-Right\fR: Switch to the next modi\. The list can be customized with the \fB\-switchers\fR argument\.
|
||||
|
|
@ -1279,15 +1269,15 @@ Within \fBrofi\fR transparency can be used, e\.g\. if the selected background co
|
|||
\fBAlt\-grave\fR: Toggle levenshtein sorting\.
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBAlt\-Shift\-S\fR: Take a screenshot and store this in the Pictures directory\.
|
||||
\fBAlt\-Shift\-S\fR: Take a screenshot and store it in the Pictures directory\.
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
To get a full list of keybindings on the commandline, see \fBrofi \-dump\-xresources | grep kb\-\fR\. Keybindings can be modified using the configuration systems\. To get searchable list of keybindings, run \fBrofi \-show keys\fR\.
|
||||
To get a full list of key bindings on the commandline, see \fBrofi \-dump\-xresources | grep kb\-\fR\. Key bindings can be modified using the configuration systems\. To get a searchable list of key bindings, run \fBrofi \-show keys\fR\.
|
||||
.
|
||||
.P
|
||||
A keybinding starting with \fB!\fR will act when all keys have been released\.
|
||||
A key binding starting with \fB!\fR will act when all keys have been released\.
|
||||
.
|
||||
.SH "Available Modi"
|
||||
.
|
||||
|
|
@ -1304,7 +1294,7 @@ Shows a list of executables in \fB$PATH\fR and can launch them (optional in a te
|
|||
Same as the \fBrun\fR launches, but the list is created from the installed desktop files\. It automatically launches them in a terminal if specified in the Desktop File\. Pressing the \fBdelete\-entry\fR binding (\fBshift\-delete\fR) will remove this entry from the run history\. Pressing the \fBaccept\-custom\fR binding (\fBcontrol\-enter\fR or \fBshift\-enter\fR) with custom input (no entry matching) will run the command in a terminal\.
|
||||
.
|
||||
.SS "SSH"
|
||||
Shows a list of SSH targets based on your ssh config file, and allows to quickly ssh into them\.
|
||||
Shows a list of SSH targets based on your ssh config file, and allows to quickly \fBssh\fR into them\.
|
||||
.
|
||||
.SS "Keys"
|
||||
Shows a searchable list of key bindings\.
|
||||
|
|
@ -1318,7 +1308,7 @@ Allows custom scripted Modi to be added\.
|
|||
Try using a mono\-space font\.
|
||||
.
|
||||
.SS "The window is completely black\."
|
||||
Check quotes used on the commandline: e\.g\. used “ instead of "\.
|
||||
Check quotes used on the commandline: you might have used \fB“\fR ("smart quotes") instead of \fB"\fR ("machine quotes")\.
|
||||
.
|
||||
.SS "What does the icon in the top right show?"
|
||||
The indicator shows:
|
||||
|
|
@ -1353,7 +1343,7 @@ rofi \-modi run \-show run
|
|||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Show the the run dialog and allow switching to Desktop File run dialog (drun):
|
||||
Show the the run dialog, and allow switching to Desktop File run dialog (drun):
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
|
|
@ -1379,7 +1369,7 @@ rofi \-modi combi \-show combi \-combi\-modi run,drun
|
|||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Combine the run and Desktop File run dialog (drun) and allow switching to window switcher:
|
||||
Combine the run and Desktop File run dialog (drun), and allow switching to window switcher:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
|
|
@ -1405,7 +1395,7 @@ rofi \-show run \-width 100 \-location 1 \-lines 5 \-bw 2 \-yoffset \-2
|
|||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Get a colored list of available wifi networks:
|
||||
Get a colored list of available wi\-fi networks:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
|
|
@ -1418,7 +1408,7 @@ tty\-pipe nmcli device wifi | out2html \-p | rofi \-dmenu \-markup\-rows
|
|||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Popup a text message claiming that this is the end:
|
||||
Pop up a text message claiming that this is the end:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
|
|
@ -1431,7 +1421,7 @@ rofi \-e "This is the end"
|
|||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Popup a text message in red, bold font claiming that this is still the end:
|
||||
Pop up a text message in red, bold font claiming that this is still the end:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
|
|
@ -1444,7 +1434,7 @@ rofi \-e "<span color=\'red\'><b>This is still the end</b></span>>" \-markup
|
|||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Show all keybindings:
|
||||
Show all key bindings:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
|
|
@ -1469,11 +1459,11 @@ Use \fBqalc\fR to get a simple calculator in \fBrofi\fR:
|
|||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.SH "I3"
|
||||
In I3 \fIhttp://i3wm\.org/\fR you want to bind rofi to be launched on key\-release\. Otherwise it cannot grab the keyboard\. See also the I3 manual \fIhttp://i3wm\.org/docs/userguide\.html\fR:
|
||||
.SH "i3"
|
||||
In i3 \fIhttp://i3wm\.org/\fR you want to bind \fBrofi\fR to be launched on key release\. Otherwise, it cannot grab the keyboard\. See also the i3 manual \fIhttp://i3wm\.org/docs/userguide\.html\fR:
|
||||
.
|
||||
.P
|
||||
Some tools (such as import or xdotool) might be unable to run upon a KeyPress event, because the keyboard/pointer is still grabbed\. For these situations, the \-\-release flag can be used, which will execute the command after the keys have been released\.
|
||||
Some tools (such as import or xdotool) might be unable to run upon a KeyPress event, because the keyboard/pointer is still grabbed\. For these situations, the \fB\-\-release\fR flag can be used, as it will execute the command after the keys have been released\.
|
||||
.
|
||||
.SH "LICENSE"
|
||||
.
|
||||
|
|
@ -1503,7 +1493,7 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE\.
|
|||
.fi
|
||||
.
|
||||
.SH "WEBSITE"
|
||||
\fBrofi\fR website can be found at here \fIhttps://davedavenport\.github\.io/rofi/\fR
|
||||
\fBrofi\fR website can be found here \fIhttps://davedavenport\.github\.io/rofi/\fR
|
||||
.
|
||||
.SH "SUPPORT"
|
||||
\fBrofi\fR support can be obtained here \fIirc://irc\.freenode\.net/#rofi\fR (#rofi on irc\.freenode\.net), or via the forum \fIhttps://reddit\.com/r/qtools//\fR
|
||||
|
|
|
|||
Loading…
Reference in New Issue