PolytreeDE
/
rofi
mirror of https://github.com/davatorium/rofi.git
1
0
Fork 0
Code Releases Activity

Update manpage.

This commit is contained in:
Dave Davenport 2022-02-13 12:22:25 +01:00
parent eff3b86c94
commit fb1eefb298
8 changed files with 145 additions and 326 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
doc/rofi-dmenu.5
View File

@ -1,3 +1,4 @@
.nh
.TH ROFI\-DMENU 5 rofi\-dmenu
.SH NAME
.PP
@ -14,7 +15,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 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).
.SH BASIC CONCEPT
@ -306,20 +307,20 @@ rofi(1), rofi\-sensible\-terminal(1), dmenu(1), rofi\-theme(5), rofi\-script(5),
.SH AUTHOR
.PP
Qball Cow
\[la]qball@gmpclient.org\[ra]
Qball Cow qball@gmpclient.org
\[la]mailto:qball@gmpclient.org\[ra]
.PP
Rasmus Steinke
\[la]rasi@xssn.at\[ra]
Rasmus Steinke rasi@xssn.at
\[la]mailto:rasi@xssn.at\[ra]
.PP
Quentin Glidic
\[la]sardemff7+rofi@sardemff7.net\[ra]
Quentin Glidic sardemff7+rofi@sardemff7.net
\[la]mailto:sardemff7+rofi@sardemff7.net\[ra]
.PP
Original code based on work by: Sean Pringle
\[la]sean.pringle@gmail.com\[ra]
Original code based on work by: Sean Pringle sean.pringle@gmail.com
\[la]mailto:sean.pringle@gmail.com\[ra]
.PP
For a full list of authors, check the AUTHORS file.

17
doc/rofi-keys.5
View File

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

17
doc/rofi-script.5
View File

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

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

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

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

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

50
doc/rofi-theme.5
View File

@ -1,3 +1,4 @@
.nh
.TH ROFI\-THEME 5 rofi\-theme
.SH NAME
.PP
@ -133,7 +134,7 @@ abbreviation for \fBr\fPofi \fBa\fPdvanced \fBs\fPtyle \fBi\fPnformation.
.SH Basic Structure
.PP
Each element has a section with defined properties. Global properties can be defined in section \fB\fC* { }\fR\&.
Sub\-section names begin with a hash symbol \fB\fC#\fR\&.
Sub\-\&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
@ -492,11 +493,7 @@ The different values are:
.IP \(bu 2
\fB\fC{PERCENTAGE}\fR can be between 0\-1.0, or 0%\-100%
.IP \(bu 2
.PP
\fB\fC{named\-color}\fR is one of the following colors:
.PP
AliceBlue, AntiqueWhite, Aqua, Aquamarine, Azure, Beige, Bisque, Black, BlanchedAlmond, Blue, BlueViolet, Brown,
\fB\fC{named\-color}\fR is one of the following colors:AliceBlue, AntiqueWhite, Aqua, Aquamarine, Azure, Beige, Bisque, Black, BlanchedAlmond, Blue, BlueViolet, Brown,
BurlyWood, CadetBlue, Chartreuse, Chocolate, Coral, CornflowerBlue, Cornsilk, Crimson, Cyan, DarkBlue, DarkCyan,
DarkGoldenRod, DarkGray, DarkGrey, DarkGreen, DarkKhaki, DarkMagenta, DarkOliveGreen, DarkOrange, DarkOrchid, DarkRed,
DarkSalmon, DarkSeaGreen, DarkSlateBlue, DarkSlateGray, DarkSlateGrey, DarkTurquoise, DarkViolet, DeepPink, DeepSkyBlue,
@ -734,6 +731,7 @@ style property.
.PP
When no unit is specified, pixels are assumed.
.RE
.SH Position
@ -742,22 +740,14 @@ 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
.PP
.RS
.nf
\fB\fC
north west | north | north east
\-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\-
west | center | east
\-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\-
south west | south | south east
.fi
.RE
\fR
.RE
@ -992,7 +982,6 @@ The current widgets available in \fBrofi\fP:
.RS
.IP \(bu 2
\fB\fCwindow\fR
.RS
.IP \(bu 2
\fB\fCoverlay\fR: the overlay widget.
@ -1000,7 +989,6 @@ 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
@ -1016,15 +1004,14 @@ 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
@ -1035,26 +1022,29 @@ 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
@ -1162,13 +1152,9 @@ Type of mouse cursor that is set when the mouse pointer is hovered over the widg
.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.
@ -1176,32 +1162,20 @@ 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

152
doc/rofi.1
View File

@ -1,3 +1,4 @@
.nh
.TH ROFI 1 rofi
.SH NAME
.PP
@ -174,11 +175,7 @@ Specify the number of threads \fBrofi\fP should use:
.IP \(bu 2
1: Disable threading
.IP \(bu 2
.PP
2..n: Specify the maximum number of threads to use in the thread pool.
.PP
Default: Autodetect
2..n: Specify the maximum number of threads to use in the thread pool.Default: Autodetect
.RE
@ -217,6 +214,9 @@ Or get the options from a script:
.fi
.RE
.PP
See the \fBrofi\-dmenu(5)\fP manpage for more information.
.PP
\fB\fC\-show\fR \fImode\fP
@ -458,11 +458,7 @@ The different fields are:
.IP \(bu 2
\fBcomment\fP: the application comment
.IP \(bu 2
.PP
\fBall\fP: all the above
.PP
Default: \fIname,generic,exec,categories,keywords\fP
\fBall\fP: all the aboveDefault: \fIname,generic,exec,categories,keywords\fP
.RE
@ -535,11 +531,7 @@ The different fields are:
.IP \(bu 2
\fBdesktop\fP: window's current desktop
.IP \(bu 2
.PP
\fBall\fP: all the above
.PP
Default: \fIall\fP
\fBall\fP: all the aboveDefault: \fIall\fP
.RE
@ -672,11 +664,7 @@ behavior.)
.IP \(bu 2
\fB\-4\fP: the monitor with the focused window.
.IP \(bu 2
.PP
\fB\-5\fP: the monitor that shows the mouse pointer.
.PP
Default: \fI\-5\fP
\fB\-5\fP: the monitor that shows the mouse pointer.Default: \fI\-5\fP
.RE
@ -991,7 +979,7 @@ Maximum number of entries to store in history. Defaults to 25. (WARNING: can cau
.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 File browser settings
.PP
@ -1108,96 +1096,11 @@ Please see \fBrofi\-theme(5)\fP manpage for more information on theming.
.SH KEY BINDINGS
.PP
\fBrofi\fP has the following key bindings:
.RS
.IP \(bu 2
\fB\fCControl\-v, Insert\fR: Paste from clipboard
.IP \(bu 2
\fB\fCControl\-Shift\-v, Shift\-Insert\fR: Paste primary selection
.IP \(bu 2
\fB\fCControl\-u\fR: Clear the line
.IP \(bu 2
\fB\fCControl\-a\fR: Beginning of line
.IP \(bu 2
\fB\fCControl\-e\fR: End of line
.IP \(bu 2
\fB\fCControl\-f, Right\fR: Forward one character
.IP \(bu 2
\fB\fCAlt\-f, Control\-Right\fR: Forward one word
.IP \(bu 2
\fB\fCControl\-b, Left\fR: Back one character
.IP \(bu 2
\fB\fCAlt\-b, Control\-Left\fR: Back one word
.IP \(bu 2
\fB\fCControl\-d, Delete\fR: Delete character
.IP \(bu 2
\fB\fCControl\-Alt\-d\fR: Delete word
.IP \(bu 2
\fB\fCControl\-h, Backspace, Shift\-Backspace\fR: Backspace (delete previous character)
.IP \(bu 2
\fB\fCControl\-Alt\-h\fR: Delete previous word
.IP \(bu 2
\fB\fCControl\-j,Control\-m,Enter\fR: Accept entry
.IP \(bu 2
\fB\fCControl\-n,Down\fR: Select next entry
.IP \(bu 2
\fB\fCControl\-p,Up\fR: Select previous entry
.IP \(bu 2
\fB\fCPage Up\fR: Go to previous page
.IP \(bu 2
\fB\fCPage Down\fR: Go to next page
.IP \(bu 2
\fB\fCControl\-Page Up\fR: Go to previous column
.IP \(bu 2
\fB\fCControl\-Page Down\fR: Go to next column
.IP \(bu 2
\fB\fCControl\-Enter\fR: Use entered text as a command (in \fB\fCssh/run modi\fR)
.IP \(bu 2
\fB\fCShift\-Enter\fR: Launch the application in a terminal (in run mode)
.IP \(bu 2
\fB\fCControl\-Shift\-Enter\fR: As Control\-Enter and run the command in terminal (in run mode)
.IP \(bu 2
\fB\fCShift\-Enter\fR: Return the selected entry and move to the next item while keeping \fBrofi\fP open. (in dmenu)
.IP \(bu 2
\fB\fCShift\-Right\fR: Switch to the next mode. The list can be customized with the \fB\fC\-modi\fR argument.
.IP \(bu 2
\fB\fCShift\-Left\fR: Switch to the previous mode. The list can be customized with the \fB\fC\-modi\fR argument.
.IP \(bu 2
\fB\fCControl\-Tab\fR: Switch to the next mode. The list can be customized with the \fB\fC\-modi\fR argument.
.IP \(bu 2
\fB\fCControl\-Shift\-Tab\fR: Switch to the previous mode. The list can be customized with the \fB\fC\-modi\fR argument.
.IP \(bu 2
\fB\fCControl\-space\fR: Set selected item as input text.
.IP \(bu 2
\fB\fCShift\-Del\fR: Delete entry from history.
.IP \(bu 2
\fB\fCgrave\fR: Toggle case sensitivity.
.IP \(bu 2
\fB\fCAlt\-grave\fR: Toggle sorting.
.IP \(bu 2
\fB\fCAlt\-Shift\-S\fR: Take a screenshot and store it in the Pictures directory.
.IP \(bu 2
\fB\fCControl\-l\fR: File complete for run dialog.
.RE
Please see the \fBrofi\-keys(5)\fP manpage for the keybindings and how to set them up.
.PP
This list might not be complete, to get a full list of all key bindings
supported in your rofi, see \fB\fCrofi \-h\fR\&. The options starting with \fB\fC\-kb\fR are keybindings.
.PP
Key bindings can be modified using the configuration systems. Multiple keys can be bound
to one action by comma separating them. For example \fB\fC\-kb\-primary\-paste "Conctrol+v,Insert"\fR
.PP
To get a searchable list of key bindings, run \fB\fCrofi \-show keys\fR\&.
.PP
A key binding starting with \fB\fC!\fR will act when all keys have been released.
.PP
You can bind certain events to key\-actions:
The keybinding can also be used for actions, when the action is executed the
mentioned keystroke is inserted:
.SS Timeout
.PP
@ -1236,9 +1139,6 @@ configuration {
.fi
.RE
.PP
For a full list of bindings, see the \fBrofi\-keys(5)\fP manpage.
.SH Available Modi
.SS window
.PP
@ -1464,18 +1364,6 @@ rofi \-show keys
.fi
.RE
.PP
Use \fB\fCqalc\fR to get a simple calculator in \fBrofi\fP:
.PP
.RS
.nf
rofi \-show calc \-modi "calc:qalc +u8 \-nocurrencies"
.fi
.RE
.SH i3
.PP
In i3
@ -1620,21 +1508,21 @@ first.
.SH AUTHOR
.RS
.IP \(bu 2
Qball Cow
\[la]qball@blame.services\[ra]
Qball Cow qball@blame.services
\[la]mailto:qball@blame.services\[ra]
.IP \(bu 2
Rasmus Steinke
\[la]rasi@xssn.at\[ra]
Rasmus Steinke rasi@xssn.at
\[la]mailto:rasi@xssn.at\[ra]
.IP \(bu 2
Quentin Glidic
\[la]sardemff7+rofi@sardemff7.net\[ra]
Quentin Glidic sardemff7+rofi@sardemff7.net
\[la]mailto:sardemff7+rofi@sardemff7.net\[ra]
.RE
.PP
Original code based on work by: Sean Pringle
\[la]https://github.com/seanpringle/simpleswitcher\[ra]
\[la]sean.pringle@gmail.com\[ra]
\[la]https://github.com/seanpringle/simpleswitcher\[ra] sean.pringle@gmail.com
\[la]mailto:sean.pringle@gmail.com\[ra]
.PP
For a full list of authors, check the \fB\fCAUTHORS\fR file.

60
doc/rofi.1.markdown
View File

@ -131,6 +131,8 @@ Or get the options from a script:
~/my_script.sh | rofi -dmenu
See the **rofi-dmenu(5)** manpage for more information.
`-show` *mode*
Open **rofi** in a certain mode. Available modes are `window`, `run`, `drun`, `ssh`, `combi`.
@ -674,54 +676,10 @@ Please see **rofi-theme(5)** manpage for more information on theming.
## KEY BINDINGS
**rofi** has the following key bindings:
Please see the **rofi-keys(5)** manpage for the keybindings and how to set them up.
* `Control-v, Insert`: Paste from clipboard
* `Control-Shift-v, Shift-Insert`: Paste primary selection
* `Control-u`: Clear the line
* `Control-a`: Beginning of line
* `Control-e`: End of line
* `Control-f, Right`: Forward one character
* `Alt-f, Control-Right`: Forward one word
* `Control-b, Left`: Back one character
* `Alt-b, Control-Left`: Back one word
* `Control-d, Delete`: Delete character
* `Control-Alt-d`: Delete word
* `Control-h, Backspace, Shift-Backspace`: Backspace (delete previous character)
* `Control-Alt-h`: Delete previous word
* `Control-j,Control-m,Enter`: Accept entry
* `Control-n,Down`: Select next entry
* `Control-p,Up`: Select previous entry
* `Page Up`: Go to previous page
* `Page Down`: Go to next page
* `Control-Page Up`: Go to previous column
* `Control-Page Down`: Go to next column
* `Control-Enter`: Use entered text as a command (in `ssh/run modi`)
* `Shift-Enter`: Launch the application in a terminal (in run mode)
* `Control-Shift-Enter`: As Control-Enter and run the command in terminal (in run mode)
* `Shift-Enter`: Return the selected entry and move to the next item while keeping **rofi** open. (in dmenu)
* `Shift-Right`: Switch to the next mode. The list can be customized with the `-modi` argument.
* `Shift-Left`: Switch to the previous mode. The list can be customized with the `-modi` argument.
* `Control-Tab`: Switch to the next mode. The list can be customized with the `-modi` argument.
* `Control-Shift-Tab`: Switch to the previous mode. The list can be customized with the `-modi` argument.
* `Control-space`: Set selected item as input text.
* `Shift-Del`: Delete entry from history.
* `grave`: Toggle case sensitivity.
* `Alt-grave`: Toggle sorting.
* `Alt-Shift-S`: Take a screenshot and store it in the Pictures directory.
* `Control-l`: File complete for run dialog.
This list might not be complete, to get a full list of all key bindings
supported in your rofi, see `rofi -h`. The options starting with `-kb` are keybindings.
Key bindings can be modified using the configuration systems. Multiple keys can be bound
to one action by comma separating them. For example `-kb-primary-paste "Conctrol+v,Insert"`
To get a searchable list of key bindings, run `rofi -show keys`.
A key binding starting with `!` will act when all keys have been released.
You can bind certain events to key-actions:
The keybinding can also be used for actions, when the action is executed the
mentioned keystroke is inserted:
### Timeout
@ -750,8 +708,6 @@ configuration {
}
```
For a full list of bindings, see the **rofi-keys(5)** manpage.
## Available Modi
### window
@ -899,10 +855,6 @@ Show all key bindings:
rofi -show keys
Use `qalc` to get a simple calculator in **rofi**:
rofi -show calc -modi "calc:qalc +u8 -nocurrencies"
## i3
In [i3](http://i3wm.org/) you want to bind **rofi** to be launched on key release. Otherwise, it cannot grab the keyboard.
@ -960,7 +912,7 @@ If you run custom C plugins, you can disable them using:
Disables the loading of plugins.
To further debug the plugin, you can get a trace with (lots of) debug information. This debug output can be enabled for
multiple parts in rofi using the glib debug framework. Debug domains can be enabled by setting the G_MESSAGES_DEBUG
multiple parts in rofi using the glib debug framework. Debug domains can be enabled by setting the G\_MESSAGES\_DEBUG
environment variable. At the time of creation of this page, the following debug domains exist:
* all: Show debug information from all domains.