diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/rofi-script.5 | 17 | ||||
-rw-r--r-- | doc/rofi-sensible-terminal.1 | 1 | ||||
-rw-r--r-- | doc/rofi-theme-selector.1 | 7 | ||||
-rw-r--r-- | doc/rofi-theme.5 | 54 | ||||
-rw-r--r-- | doc/rofi-theme.5.markdown | 1 | ||||
-rw-r--r-- | doc/rofi.1 | 68 |
6 files changed, 77 insertions, 71 deletions
diff --git a/doc/rofi-script.5 b/doc/rofi-script.5 index 646727d7..57ec3e51 100644 --- a/doc/rofi-script.5 +++ b/doc/rofi-script.5 @@ -1,4 +1,3 @@ -.nh .TH ROFI\-SCRIPT 5 rofi\-script .SH NAME .PP @@ -175,20 +174,20 @@ rofi(1), rofi\-sensible\-terminal(1), dmenu(1), rofi\-theme(5), rofi\-theme\-sel .SH AUTHOR .PP -Qball Cow qball@gmpclient.org -\[la]mailto:qball@gmpclient.org\[ra] +Qball Cow +\[la]qball@gmpclient.org\[ra] .PP -Rasmus Steinke rasi@xssn.at -\[la]mailto:rasi@xssn.at\[ra] +Rasmus Steinke +\[la]rasi@xssn.at\[ra] .PP -Quentin Glidic sardemff7+rofi@sardemff7.net -\[la]mailto:sardemff7+rofi@sardemff7.net\[ra] +Quentin Glidic +\[la]sardemff7+rofi@sardemff7.net\[ra] .PP -Original code based on work by: Sean Pringle sean.pringle@gmail.com -\[la]mailto:sean.pringle@gmail.com\[ra] +Original code based on work by: Sean Pringle +\[la]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 653dee3f..30d4a15d 100644 --- a/doc/rofi-sensible-terminal.1 +++ b/doc/rofi-sensible-terminal.1 @@ -1,4 +1,3 @@ -.nh .TH rofi\-sensible\-terminal 1 rofi\-sensible\-terminal .SH NAME .PP diff --git a/doc/rofi-theme-selector.1 b/doc/rofi-theme-selector.1 index e0f09c31..de076ff4 100644 --- a/doc/rofi-theme-selector.1 +++ b/doc/rofi-theme-selector.1 @@ -1,4 +1,3 @@ -.nh .TH rofi\-theme\-selector 1 rofi\-theme\-selector .SH NAME .PP @@ -31,8 +30,8 @@ $XDG\_DATA\_HOME/share/rofi/themes .RE .PP -${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". +${PREFIX} reflects the install location of rofi. In most cases this will be "/usr".<br> +$XDG\_CONFIG\_HOME is normally unset. Default path is "$HOME/.config".<br> $XDG\_DATA\_HOME is normally unset. Default path is "$HOME/.local/share". .SH SEE ALSO @@ -41,5 +40,5 @@ rofi(1) .SH AUTHORS .PP -Qball Cow qball@gmpclient.org +Qball Cow qball@gmpclient.org<br> Rasmus Steinke rasi@xssn.at diff --git a/doc/rofi-theme.5 b/doc/rofi-theme.5 index f82093cc..3a555fdb 100644 --- a/doc/rofi-theme.5 +++ b/doc/rofi-theme.5 @@ -1,4 +1,3 @@ -.nh .TH ROFI\-THEME 5 rofi\-theme .SH NAME .PP @@ -96,7 +95,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\-\§ion names begin with a hash symbol \fB\fC#\fR\&. +Sub\-section 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 @@ -425,7 +424,11 @@ The different values are: .IP \(bu 2 \fB\fC{PERCENTAGE}\fR can be between 0\-1.0, or 0%\-100% .IP \(bu 2 -\fB\fC{named\-color}\fR is one of the following colors:AliceBlue, AntiqueWhite, Aqua, Aquamarine, Azure, Beige, Bisque, Black, BlanchedAlmond, Blue, BlueViolet, Brown, + +.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, 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, @@ -499,7 +502,6 @@ should be applied. .PP For some reason \fB\fCsmall caps\fR does not work on some systems. - .RE .SH Line style @@ -667,7 +669,6 @@ style property. .PP When no unit is specified, pixels are assumed. - .RE .SH Position @@ -676,14 +677,22 @@ Indicate a place on the window/monitor. .RS .IP \(bu 2 + +.PP Format: \fB\fC(center|east|north|west|south|north east|north west|south west|south east)\fR -\fB\fC +.PP +.RS + +.nf + north west | north | north east \-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\- west | center | east \-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\- south west | south | south east -\fR + +.fi +.RE .RE @@ -845,6 +854,7 @@ The current widgets available in \fBrofi\fP: .RS .IP \(bu 2 \fB\fCwindow\fR + .RS .IP \(bu 2 \fB\fCoverlay\fR: the overlay widget. @@ -852,6 +862,7 @@ The current widgets available in \fBrofi\fP: \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 @@ -867,14 +878,15 @@ The current widgets available in \fBrofi\fP: \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 @@ -885,29 +897,26 @@ The current widgets available in \fBrofi\fP: .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 @@ -1009,9 +1018,13 @@ Color of the border .SS window: .RS .IP \(bu 2 + +.PP \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. @@ -1019,20 +1032,32 @@ 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 @@ -1091,6 +1116,8 @@ color is optional, multiple highlight styles can be added like: bold underline i \fBplaceholder\-color\fP: Color of the placeholder text. .IP \(bu 2 \fBblink\fP: Enable/Disable blinking on an input textbox (Boolean). +.IP \(bu 2 +\fBmarkup\fP: Force markup on, beware that only valid pango markup strings are shown. .RE @@ -1230,7 +1257,6 @@ The current layout of \fBrofi\fP is structured as follows: .PP ci is the case\-indicator - .RE .SS Error message structure diff --git a/doc/rofi-theme.5.markdown b/doc/rofi-theme.5.markdown index 48942416..4dd20b24 100644 --- a/doc/rofi-theme.5.markdown +++ b/doc/rofi-theme.5.markdown @@ -676,6 +676,7 @@ The following properties are currently supported: * **placeholder**: Set the displayed text (String) when nothing is entered. * **placeholder-color**: Color of the placeholder text. * **blink**: Enable/Disable blinking on an input textbox (Boolean). +* **markup**: Force markup on, beware that only valid pango markup strings are shown. ### listview: * **columns**: integer @@ -1,4 +1,3 @@ -.nh .TH ROFI 1 rofi .SH NAME .PP @@ -47,7 +46,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 @@ -295,12 +294,6 @@ Start in case sensitive mode. This option can be changed at run\-time using the \fB\fC\-kb\-toggle\-case\-sensitivity\fR key binding. .PP -\fB\fC\-cycle\fR - -.PP -Cycle through the result list. Default is 'true'. - -.PP \fB\fC\-filter\fR \fIfilter\fP .PP @@ -448,7 +441,11 @@ 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 @@ -521,7 +518,11 @@ 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 @@ -573,29 +574,6 @@ Default: \fI0\fP Keep a fixed number of visible lines (See the \fB\fC\-lines\fR option.) .PP -\fB\fC\-fullscreen\fR - -.PP -Use the full\-screen height and width. - -.PP -\fB\fC\-sidebar\-mode\fR - -.PP -Open in sidebar\-mode. In this mode a list of all enabled modes is shown at the bottom. -(See \fB\fC\-modi\fR option) -To show sidebar, use: - -.PP -.RS - -.nf -rofi \-show run \-sidebar\-mode \-lines 0 - -.fi -.RE - -.PP \fB\fC\-eh\fR \fInumber\fP .PP @@ -636,7 +614,11 @@ behavior.) .IP \(bu 2 \fB\-4\fP: the monitor with the focused window. .IP \(bu 2 -\fB\-5\fP: the monitor that shows the mouse pointer.Default: \fI\-5\fP + +.PP +\fB\-5\fP: the monitor that shows the mouse pointer. +.PP +Default: \fI\-5\fP .RE @@ -1092,7 +1074,7 @@ Set ellipsize mode to start. So end of string is visible. .PP Pops up a message dialog (used internally for showing errors) with \fImessage\fP\&. -Message can be multi\-\&line. +Message can be multi\-line. .SS Other .PP @@ -1544,20 +1526,20 @@ first. .SH AUTHOR .RS .IP \(bu 2 -Qball Cow qball@gmpclient.org -\[la]mailto:qball@gmpclient.org\[ra] +Qball Cow +\[la]qball@gmpclient.org\[ra] .IP \(bu 2 -Rasmus Steinke rasi@xssn.at -\[la]mailto:rasi@xssn.at\[ra] +Rasmus Steinke +\[la]rasi@xssn.at\[ra] .IP \(bu 2 -Quentin Glidic sardemff7+rofi@sardemff7.net -\[la]mailto:sardemff7+rofi@sardemff7.net\[ra] +Quentin Glidic +\[la]sardemff7+rofi@sardemff7.net\[ra] .RE .PP -Original code based on work by: Sean Pringle sean.pringle@gmail.com -\[la]mailto:sean.pringle@gmail.com\[ra] +Original code based on work by: Sean Pringle +\[la]sean.pringle@gmail.com\[ra] .PP For a full list of authors, check the \fB\fCAUTHORS\fR file. |