PolytreeDE/rofi
1
0
Fork 0
mirror of https://github.com/davatorium/rofi.git synced 2024-11-18 13:54:36 -05:00
Code Releases Activity

[Doc] Small textual fix.

Browse source
This commit is contained in:
Dave Davenport 2021-06-10 21:59:56 +02:00
parent 00f290beed
commit ab07156b75
6 changed files with 45 additions and 82 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
doc/rofi-script.5
View file

@ -1,3 +1,4 @@
.nh
.TH ROFI\-SCRIPT 5 rofi\-script .TH ROFI\-SCRIPT 5 rofi\-script
.SH NAME .SH NAME
.PP .PP
@ -193,20 +194,20 @@ rofi(1), rofi\-sensible\-terminal(1), dmenu(1), rofi\-theme(5), rofi\-theme\-sel
.SH AUTHOR .SH AUTHOR
.PP .PP
Qball Cow Qball Cow qball@gmpclient.org
\[la]qball@gmpclient.org\[ra] \[la]mailto:qball@gmpclient.org\[ra]
.PP .PP
Rasmus Steinke Rasmus Steinke rasi@xssn.at
\[la]rasi@xssn.at\[ra] \[la]mailto:rasi@xssn.at\[ra]
.PP .PP
Quentin Glidic Quentin Glidic sardemff7+rofi@sardemff7.net
\[la]sardemff7+rofi@sardemff7.net\[ra] \[la]mailto:sardemff7+rofi@sardemff7.net\[ra]
.PP .PP
Original code based on work by: Sean Pringle Original code based on work by: Sean Pringle sean.pringle@gmail.com
\[la]sean.pringle@gmail.com\[ra] \[la]mailto:sean.pringle@gmail.com\[ra]
.PP .PP
For a full list of authors, check the AUTHORS file. For a full list of authors, check the AUTHORS file.

1
doc/rofi-sensible-terminal.1
View file

@ -1,3 +1,4 @@
.nh
.TH rofi\-sensible\-terminal 1 rofi\-sensible\-terminal .TH rofi\-sensible\-terminal 1 rofi\-sensible\-terminal
.SH NAME .SH NAME
.PP .PP

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

@ -1,3 +1,4 @@
.nh
.TH rofi\-theme\-selector 1 rofi\-theme\-selector .TH rofi\-theme\-selector 1 rofi\-theme\-selector
.SH NAME .SH NAME
.PP .PP
@ -30,8 +31,8 @@ $XDG\_DATA\_HOME/share/rofi/themes
.RE .RE
.PP .PP
${PREFIX} reflects the install location of rofi. In most cases this will be "/usr".<br> ${PREFIX} reflects the install location of rofi. In most cases this will be "/usr".
$XDG\_CONFIG\_HOME is normally unset. Default path is "$HOME/.config".<br> $XDG\_CONFIG\_HOME is normally unset. Default path is "$HOME/.config".
$XDG\_DATA\_HOME is normally unset. Default path is "$HOME/.local/share". $XDG\_DATA\_HOME is normally unset. Default path is "$HOME/.local/share".
.SH SEE ALSO .SH SEE ALSO
@ -40,5 +41,5 @@ rofi(1)
.SH AUTHORS .SH AUTHORS
.PP .PP
Qball Cow qball@gmpclient.org<br> Qball Cow qball@gmpclient.org
Rasmus Steinke rasi@xssn.at Rasmus Steinke rasi@xssn.at

51
doc/rofi-theme.5
View file

@ -1,3 +1,4 @@
.nh
.TH ROFI\-THEME 5 rofi\-theme .TH ROFI\-THEME 5 rofi\-theme
.SH NAME .SH NAME
.PP .PP
@ -95,7 +96,7 @@ abbreviation for \fBr\fPofi \fBa\fPdvanced \fBs\fPtyle \fBi\fPnformation.
.SH Basic Structure .SH Basic Structure
.PP .PP
Each element has a section with defined properties. Global properties can be defined in section \fB\fC* { }\fR\&. Each element has a section with defined properties. Global properties can be defined in section \fB\fC* { }\fR\&.
Sub\-section names begin with a hash symbol \fB\fC#\fR\&. Sub\-\&section names begin with a hash symbol \fB\fC#\fR\&.
.PP .PP
It is advised to define the \fIglobal properties section\fP on top of the file to It is advised to define the \fIglobal properties section\fP on top of the file to
@ -426,11 +427,7 @@ The different values are:
.IP \(bu 2 .IP \(bu 2
\fB\fC{PERCENTAGE}\fR can be between 0\-1.0, or 0%\-100% \fB\fC{PERCENTAGE}\fR can be between 0\-1.0, or 0%\-100%
.IP \(bu 2 .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, BurlyWood, CadetBlue, Chartreuse, Chocolate, Coral, CornflowerBlue, Cornsilk, Crimson, Cyan, DarkBlue, DarkCyan,
DarkGoldenRod, DarkGray, DarkGrey, DarkGreen, DarkKhaki, DarkMagenta, DarkOliveGreen, DarkOrange, DarkOrchid, DarkRed, DarkGoldenRod, DarkGray, DarkGrey, DarkGreen, DarkKhaki, DarkMagenta, DarkOliveGreen, DarkOrange, DarkOrchid, DarkRed,
DarkSalmon, DarkSeaGreen, DarkSlateBlue, DarkSlateGray, DarkSlateGrey, DarkTurquoise, DarkViolet, DeepPink, DeepSkyBlue, DarkSalmon, DarkSeaGreen, DarkSlateBlue, DarkSlateGray, DarkSlateGrey, DarkTurquoise, DarkViolet, DeepPink, DeepSkyBlue,
@ -662,6 +659,7 @@ style property.
.PP .PP
When no unit is specified, pixels are assumed. When no unit is specified, pixels are assumed.
.RE .RE
.SH Position .SH Position
@ -670,22 +668,14 @@ Indicate a place on the window/monitor.
.RS .RS
.IP \(bu 2 .IP \(bu 2
.PP
Format: \fB\fC(center|east|north|west|south|north east|north west|south west|south east)\fR Format: \fB\fC(center|east|north|west|south|north east|north west|south west|south east)\fR
.PP \fB\fC
.RS
.nf
north west | north | north east north west | north | north east
\-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\- \-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\-
west | center | east west | center | east
\-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\- \-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\-
south west | south | south east south west | south | south east
\fR
.fi
.RE
.RE .RE
@ -857,7 +847,6 @@ The current widgets available in \fBrofi\fP:
.RS .RS
.IP \(bu 2 .IP \(bu 2
\fB\fCwindow\fR \fB\fCwindow\fR
.RS .RS
.IP \(bu 2 .IP \(bu 2
\fB\fCoverlay\fR: the overlay widget. \fB\fCoverlay\fR: the overlay widget.
@ -865,7 +854,6 @@ The current widgets available in \fBrofi\fP:
\fB\fCmainbox\fR: The mainbox box. \fB\fCmainbox\fR: The mainbox box.
.IP \(bu 2 .IP \(bu 2
\fB\fCinputbar\fR: The input bar box. \fB\fCinputbar\fR: The input bar box.
.RS .RS
.IP \(bu 2 .IP \(bu 2
\fB\fCbox\fR: the horizontal @box packing the widgets \fB\fCbox\fR: the horizontal @box packing the widgets
@ -881,15 +869,14 @@ The current widgets available in \fBrofi\fP:
\fB\fCnum\-filtered\-rows\fR: Shows the total number of rows after filtering. \fB\fCnum\-filtered\-rows\fR: Shows the total number of rows after filtering.
.RE .RE
.IP \(bu 2 .IP \(bu 2
\fB\fClistview\fR: The listview. \fB\fClistview\fR: The listview.
.RS .RS
.IP \(bu 2 .IP \(bu 2
\fB\fCscrollbar\fR: the listview scrollbar \fB\fCscrollbar\fR: the listview scrollbar
.IP \(bu 2 .IP \(bu 2
\fB\fCelement\fR: a box in the listview holding the entries \fB\fCelement\fR: a box in the listview holding the entries
.RS .RS
.IP \(bu 2 .IP \(bu 2
\fB\fCelement\-icon\fR: the widget in the listview's entry showing the (optional) icon \fB\fCelement\-icon\fR: the widget in the listview's entry showing the (optional) icon
@ -900,26 +887,29 @@ The current widgets available in \fBrofi\fP:
.RE .RE
.RE .RE
.IP \(bu 2 .IP \(bu 2
\fB\fCmode\-switcher\fR: the main horizontal @box packing the buttons. \fB\fCmode\-switcher\fR: the main horizontal @box packing the buttons.
.RS .RS
.IP \(bu 2 .IP \(bu 2
\fB\fCbutton\fR: the buttons @textbox for each mode \fB\fCbutton\fR: the buttons @textbox for each mode
.RE .RE
.IP \(bu 2 .IP \(bu 2
\fB\fCmessage\fR: The container holding the textbox. \fB\fCmessage\fR: The container holding the textbox.
.RS .RS
.IP \(bu 2 .IP \(bu 2
\fB\fCtextbox\fR: the message textbox \fB\fCtextbox\fR: the message textbox
.RE .RE
.RE .RE
.RE .RE
.PP .PP
@ -1024,13 +1014,9 @@ Type of mouse cursor that is set when the mouse pointer is hovered over the widg
.SS window: .SS window:
.RS .RS
.IP \(bu 2 .IP \(bu 2
.PP
\fBfont\fP: string \fBfont\fP: string
The font used in the window The font used in the window
.IP \(bu 2 .IP \(bu 2
.PP
\fBtransparency\fP: string \fBtransparency\fP: string
Indicating if transparency should be used and what type: Indicating if transparency should be used and what type:
\fBreal\fP \- True transparency. Only works with a compositor. \fBreal\fP \- True transparency. Only works with a compositor.
@ -1038,32 +1024,20 @@ Indicating if transparency should be used and what type:
\fBscreenshot\fP \- Take a screenshot of the screen and use that. \fBscreenshot\fP \- Take a screenshot of the screen and use that.
\fBPath\fP to png file \- Use an image. \fBPath\fP to png file \- Use an image.
.IP \(bu 2 .IP \(bu 2
.PP
\fBlocation\fP: position \fBlocation\fP: position
The place of the anchor on the monitor The place of the anchor on the monitor
.IP \(bu 2 .IP \(bu 2
.PP
\fBanchor\fP: anchor \fBanchor\fP: anchor
The anchor position on the window The anchor position on the window
.IP \(bu 2 .IP \(bu 2
.PP
\fBfullscreen\fP: boolean \fBfullscreen\fP: boolean
Window is fullscreen. Window is fullscreen.
.IP \(bu 2 .IP \(bu 2
.PP
\fBwidth\fP: distance \fBwidth\fP: distance
The width of the window The width of the window
.IP \(bu 2 .IP \(bu 2
.PP
\fBx\-offset\fP: distance \fBx\-offset\fP: distance
.IP \(bu 2 .IP \(bu 2
.PP
\fBy\-offset\fP: distance \fBy\-offset\fP: distance
The offset of the window to the anchor point, allowing you to push the window left/right/up/down The offset of the window to the anchor point, allowing you to push the window left/right/up/down
@ -1263,6 +1237,7 @@ The current layout of \fBrofi\fP is structured as follows:
.PP .PP
ci is the case\-indicator ci is the case\-indicator
.RE .RE
.SS Error message structure .SS Error message structure

49
doc/rofi.1
View file

@ -1,3 +1,4 @@
.nh
.TH ROFI 1 rofi .TH ROFI 1 rofi
.SH NAME .SH NAME
.PP .PP
@ -46,7 +47,7 @@ The website for \fB\fCdmenu\fR can be found here
.PP .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\&. \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). Besides, \fBrofi\fP offers some extended features (like multi\-select, highlighting, message bar, extra key bindings).
.SS Display Error message .SS Display Error message
@ -180,11 +181,7 @@ Specify the number of threads \fBrofi\fP should use:
.IP \(bu 2 .IP \(bu 2
1: Disable threading 1: Disable threading
.IP \(bu 2 .IP \(bu 2
2..N: Specify the maximum number of threads to use in the thread pool.Default: Autodetect
.PP
2..N: Specify the maximum number of threads to use in the thread pool.
.PP
Default: Autodetect
.RE .RE
@ -464,11 +461,7 @@ The different fields are:
.IP \(bu 2 .IP \(bu 2
\fBcomment\fP: the application comment \fBcomment\fP: the application comment
.IP \(bu 2 .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 .RE
@ -541,11 +534,7 @@ The different fields are:
.IP \(bu 2 .IP \(bu 2
\fBdesktop\fP: window's current desktop \fBdesktop\fP: window's current desktop
.IP \(bu 2 .IP \(bu 2
\fBall\fP: all of the aboveDefault: \fIall\fP
.PP
\fBall\fP: all of the above
.PP
Default: \fIall\fP
.RE .RE
@ -572,7 +561,7 @@ Default: '\-'
\fBrofi\fP options that can be passed directly on the commandline (there are too many). \fBrofi\fP options that can be passed directly on the commandline (there are too many).
Small snippets can be passed on the commandline: \fB\fCrofi \-theme\-str 'window {width: 50%;}'\fR to override a single Small snippets can be passed on the commandline: \fB\fCrofi \-theme\-str 'window {width: 50%;}'\fR to override a single
setting. They are merged into the current theme. setting. They are merged into the current theme.
They can also be appended to the end of the \fBrofi\fP config file to override parts of the theme. They can also be appended at the end of the \fBrofi\fP config file to override parts of the theme.
.PP .PP
Most of the following options are \fBdeprecated\fP and should not be used. Please use the new theme format to customize Most of the following options are \fBdeprecated\fP and should not be used. Please use the new theme format to customize
@ -678,11 +667,7 @@ behavior.)
.IP \(bu 2 .IP \(bu 2
\fB\-4\fP: the monitor with the focused window. \fB\-4\fP: the monitor with the focused window.
.IP \(bu 2 .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 .RE
@ -1163,7 +1148,7 @@ Set ellipsize mode to start. So end of string is visible.
.PP .PP
Pops up a message dialog (used internally for showing errors) with \fImessage\fP\&. Pops up a message dialog (used internally for showing errors) with \fImessage\fP\&.
Message can be multi\-line. Message can be multi\-\&line.
.SS File browser settings .SS File browser settings
.PP .PP
@ -1617,7 +1602,7 @@ all: Show debug information from all domains.
.IP \(bu 2 .IP \(bu 2
X11Helper: The X11 Helper functions. X11Helper: The X11 Helper functions.
.IP \(bu 2 .IP \(bu 2
View: The main rofi\_view functions. View: The main window view functions.
.IP \(bu 2 .IP \(bu 2
Widgets.Box: The Box widget. Widgets.Box: The Box widget.
.IP \(bu 2 .IP \(bu 2
@ -1677,21 +1662,21 @@ first.
.SH AUTHOR .SH AUTHOR
.RS .RS
.IP \(bu 2 .IP \(bu 2
Qball Cow Qball Cow qball@blame.services
\[la]qball@blame.services\[ra] \[la]mailto:qball@blame.services\[ra]
.IP \(bu 2 .IP \(bu 2
Rasmus Steinke Rasmus Steinke rasi@xssn.at
\[la]rasi@xssn.at\[ra] \[la]mailto:rasi@xssn.at\[ra]
.IP \(bu 2 .IP \(bu 2
Quentin Glidic Quentin Glidic sardemff7+rofi@sardemff7.net
\[la]sardemff7+rofi@sardemff7.net\[ra] \[la]mailto:sardemff7+rofi@sardemff7.net\[ra]
.RE .RE
.PP .PP
Original code based on work by: Sean Pringle Original code based on work by: Sean Pringle
\[la]https://github.com/seanpringle/simpleswitcher\[ra] \[la]https://github.com/seanpringle/simpleswitcher\[ra] sean.pringle@gmail.com
\[la]sean.pringle@gmail.com\[ra] \[la]mailto:sean.pringle@gmail.com\[ra]
.PP .PP
For a full list of authors, check the \fB\fCAUTHORS\fR file. For a full list of authors, check the \fB\fCAUTHORS\fR file.

2
doc/rofi.1.markdown
View file

@ -984,7 +984,7 @@ environment variable. At creation of this page the following debug domains exist
* all: Show debug information from all domains. * all: Show debug information from all domains.
* X11Helper: The X11 Helper functions. * X11Helper: The X11 Helper functions.
* View: The main rofi_view functions. * View: The main window view functions.
* Widgets.Box: The Box widget. * Widgets.Box: The Box widget.
* Dialogs.DMenu: The dmenu mode. * Dialogs.DMenu: The dmenu mode.
* Dialogs.Run: The run mode. * Dialogs.Run: The run mode.