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

[Doc] Update manpage urls and add new-selection setting.

This commit is contained in:
Dave Davenport 2022-07-31 16:28:05 +02:00
parent 406a6954aa
commit 8e8765e2ce
4 changed files with 62 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/rofi-script.5
View File

@ -6,8 +6,9 @@
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
\fBrofi\fP supports modes that use simple scripts in the background to generate a list and process the result from user \fBrofi\fP supports modes that use simple scripts in the background to generate a
actions. This provide a simple interface to make simple extensions to rofi. list and process the result from user actions. This provide a simple interface
to make simple extensions to rofi.
.SH USAGE .SH USAGE
.PP .PP
@ -30,10 +31,11 @@ The name should be unique.
.SH API .SH API
.PP .PP
Rofi calls the executable without arguments on startup. This should generate a list of options, separated by a newline Rofi calls the executable without arguments on startup. This should generate a
(\fB\fC\\n\fR) (This can be changed by the script). list of options, separated by a newline (\fB\fC\\n\fR) (This can be changed by the
If the user selects an option, rofi calls the executable with the text of that option as the first argument. script). If the user selects an option, rofi calls the executable with the text
If the script returns no entries, rofi quits. of that option as the first argument. If the script returns no entries, rofi
quits.
.PP .PP
A simple script would be: A simple script would be:
@ -124,7 +126,9 @@ The following extra options exists:
.IP \(bu 2 .IP \(bu 2
\fBuse-hot-keys\fP: If set to true, it enabled the Custom keybindings for script. Warning this breaks the normal rofi flow. \fBuse-hot-keys\fP: If set to true, it enabled the Custom keybindings for script. Warning this breaks the normal rofi flow.
.IP \(bu 2 .IP \(bu 2
\fBkeep-selection\fP: If set, the selection is not moved to the first entry, but the current position is maintained. \fBkeep-selection\fP: If set, the selection is not moved to the first entry, but the current position is maintained. The filter is cleared.
.IP \(bu 2
\fBnew-selection\fP: If \fB\fCkeep-selection\fR is set, this allows you to override the selected entry (absolute position).
.IP \(bu 2 .IP \(bu 2
\fBdata\fP: Passed data to the next execution of the script via \fBROFI_DATA\fP\&. \fBdata\fP: Passed data to the next execution of the script via \fBROFI_DATA\fP\&.
.IP \(bu 2 .IP \(bu 2

17
doc/rofi-script.5.markdown
View File

@ -7,8 +7,9 @@
## DESCRIPTION ## DESCRIPTION
**rofi** supports modes that use simple scripts in the background to generate a list and process the result from user **rofi** supports modes that use simple scripts in the background to generate a
actions. This provide a simple interface to make simple extensions to rofi. list and process the result from user actions. This provide a simple interface
to make simple extensions to rofi.
## USAGE ## USAGE
@ -25,10 +26,11 @@ The name should be unique.
## API ## API
Rofi calls the executable without arguments on startup. This should generate a list of options, separated by a newline Rofi calls the executable without arguments on startup. This should generate a
(`\n`) (This can be changed by the script). list of options, separated by a newline (`\n`) (This can be changed by the
If the user selects an option, rofi calls the executable with the text of that option as the first argument. script). If the user selects an option, rofi calls the executable with the text
If the script returns no entries, rofi quits. of that option as the first argument. If the script returns no entries, rofi
quits.
A simple script would be: A simple script would be:
@ -88,7 +90,8 @@ The following extra options exists:
* **delim**: Set the delimiter for for next rows. Default is '\n' and this option should finish with this. Only call this on first call of script, it is remembered for consecutive calls. * **delim**: Set the delimiter for for next rows. Default is '\n' and this option should finish with this. Only call this on first call of script, it is remembered for consecutive calls.
* **no-custom**: If set to 'true'; only accept listed entries, ignore custom input. * **no-custom**: If set to 'true'; only accept listed entries, ignore custom input.
* **use-hot-keys**: If set to true, it enabled the Custom keybindings for script. Warning this breaks the normal rofi flow. * **use-hot-keys**: If set to true, it enabled the Custom keybindings for script. Warning this breaks the normal rofi flow.
* **keep-selection**: If set, the selection is not moved to the first entry, but the current position is maintained. * **keep-selection**: If set, the selection is not moved to the first entry, but the current position is maintained. The filter is cleared.
* **new-selection**: If `keep-selection` is set, this allows you to override the selected entry (absolute position).
* **data**: Passed data to the next execution of the script via **ROFI_DATA**. * **data**: Passed data to the next execution of the script via **ROFI_DATA**.
* **theme**: Small theme snippet to f.e. change the background color of a widget. * **theme**: Small theme snippet to f.e. change the background color of a widget.

39
doc/rofi.1
View File

@ -10,9 +10,9 @@
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
\fBrofi\fP is an X11 pop-up window switcher, run dialog, dmenu replacement, and more. It focuses on \fBrofi\fP is an X11 pop-up window switcher, run dialog, dmenu replacement, and
being fast to use and have minimal distraction. It supports keyboard and mouse navigation, type to more. It focuses on being fast to use and have minimal distraction. It supports
filter, tokenized search and more. keyboard and mouse navigation, type to filter, tokenized search and more.
.SH USAGE .SH USAGE
.PP .PP
@ -57,7 +57,8 @@ running firefox, or launch it when it is not running.
.SS Emulating dmenu .SS Emulating dmenu
.PP .PP
\fBrofi\fP can emulate \fBdmenu(1)\fP (a dynamic menu for X11) when launched with the \fB\fC-dmenu\fR flag. \fBrofi\fP can emulate \fBdmenu(1)\fP (a dynamic menu for X11) when launched with
the \fB\fC-dmenu\fR flag.
.PP .PP
For more information see \fBrofi-dmenu(5)\fP\&. For more information see \fBrofi-dmenu(5)\fP\&.
@ -191,8 +192,8 @@ Below is a list of the most important options:
\fB\fC-help\fR \fB\fC-help\fR
.PP .PP
The help option shows the full list of command-line options and the current set values. The help option shows the full list of command-line options and the current set
These include dynamic (run-time generated) options. values. These include dynamic (run-time generated) options.
.PP .PP
\fB\fC-version\fR \fB\fC-version\fR
@ -277,9 +278,10 @@ See the \fBrofi-dmenu(5)\fP manpage for more information.
\fB\fC-show\fR \fImode\fP \fB\fC-show\fR \fImode\fP
.PP .PP
Open \fBrofi\fP in a certain mode. Available modes are \fB\fCwindow\fR, \fB\fCrun\fR, \fB\fCdrun\fR, \fB\fCssh\fR, \fB\fCcombi\fR\&. Open \fBrofi\fP in a certain mode. Available modes are \fB\fCwindow\fR, \fB\fCrun\fR, \fB\fCdrun\fR,
The special argument \fB\fCkeys\fR can be used to open a searchable list of supported key bindings \fB\fCssh\fR, \fB\fCcombi\fR\&. The special argument \fB\fCkeys\fR can be used to open a searchable
(see \fIKEY BINDINGS\fP) list of supported key bindings
(see the \fBrofi-keys(5)\fP manpage)
.PP .PP
To show the run-dialog: To show the run-dialog:
@ -315,7 +317,8 @@ rofi -modes "run,ssh" -show run
.RE .RE
.PP .PP
Custom modes can be added using the internal \fB\fCscript\fR mode. Each such mode has two parameters: Custom modes can be added using the internal \fB\fCscript\fR mode. Each such mode has
two parameters:
.PP .PP
.RS .RS
@ -339,8 +342,8 @@ rofi -modes "window,run,ssh,Workspaces:i3_switch_workspaces.sh" -show Workspaces
.RE .RE
.PP .PP
Notes: The i3 window manager dislikes commas in the command when specifying an exec command. Notes: The i3 window manager dislikes commas in the command when specifying an
For that case, \fB\fC#\fR can be used as a separator. exec command. For that case, \fB\fC#\fR can be used as a separator.
.PP .PP
\fBTIP\fP: The name is allowed to contain spaces: \fBTIP\fP: The name is allowed to contain spaces:
@ -1358,7 +1361,7 @@ If no match, the input is handled by the first combined modes.
.SH FAQ .SH FAQ
.SS The text in the window switcher is not nicely aligned. .SS The text in the window switcher is not nicely aligned.
.PP .PP
Try using a mono-space font. Try using a mono-space font or tabs + the tab-stops setting..
.SS The window is completely black. .SS The window is completely black.
.PP .PP
@ -1527,7 +1530,7 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
.SH WEBSITE .SH WEBSITE
.PP .PP
\fBrofi\fP website can be found here \fBrofi\fP website can be found here
\[la]https://davedavenport.github.io/rofi/\[ra] \[la]https://github.com/davatorium/rofi/\[ra]
.SH SUPPORT .SH SUPPORT
.PP .PP
@ -1546,11 +1549,11 @@ For more information see \fBrofi-debugging(5)\fP manpage.
.SH ISSUE TRACKER .SH ISSUE TRACKER
.PP .PP
The \fBrofi\fP issue tracker can be found here The \fBrofi\fP issue tracker can be found here
\[la]https://github.com/DaveDavenport/rofi/issues\[ra] \[la]https://github.com/davatorium/rofi/issues\[ra]
Before creating an issue, consider posting a question on the discussion forum
.PP \[la]https://github.com/davatorium/rofi/discussions\[ra] first.
When creating an issue, please read this When creating an issue, please read this
\[la]https://github.com/DaveDavenport/rofi/blob/master/.github/CONTRIBUTING.md\[ra] \[la]https://github.com/davatorium/rofi/blob/master/.github/CONTRIBUTING.md\[ra]
first. first.
.SH SEE ALSO .SH SEE ALSO

37
doc/rofi.1.markdown
View File

@ -11,9 +11,9 @@
## DESCRIPTION ## DESCRIPTION
**rofi** is an X11 pop-up window switcher, run dialog, dmenu replacement, and more. It focuses on **rofi** is an X11 pop-up window switcher, run dialog, dmenu replacement, and
being fast to use and have minimal distraction. It supports keyboard and mouse navigation, type to more. It focuses on being fast to use and have minimal distraction. It supports
filter, tokenized search and more. keyboard and mouse navigation, type to filter, tokenized search and more.
## USAGE ## USAGE
@ -48,7 +48,8 @@ running firefox, or launch it when it is not running.
### Emulating dmenu ### Emulating dmenu
**rofi** can emulate **dmenu(1)** (a dynamic menu for X11) when launched with the `-dmenu` flag. **rofi** can emulate **dmenu(1)** (a dynamic menu for X11) when launched with
the `-dmenu` flag.
For more information see **rofi-dmenu(5)**. For more information see **rofi-dmenu(5)**.
@ -122,8 +123,8 @@ Below is a list of the most important options:
`-help` `-help`
The help option shows the full list of command-line options and the current set values. The help option shows the full list of command-line options and the current set
These include dynamic (run-time generated) options. values. These include dynamic (run-time generated) options.
`-version` `-version`
@ -172,9 +173,10 @@ See the **rofi-dmenu(5)** manpage for more information.
`-show` *mode* `-show` *mode*
Open **rofi** in a certain mode. Available modes are `window`, `run`, `drun`, `ssh`, `combi`. Open **rofi** in a certain mode. Available modes are `window`, `run`, `drun`,
The special argument `keys` can be used to open a searchable list of supported key bindings `ssh`, `combi`. The special argument `keys` can be used to open a searchable
(see *KEY BINDINGS*) list of supported key bindings
(see the **rofi-keys(5)** manpage)
To show the run-dialog: To show the run-dialog:
@ -191,7 +193,8 @@ To only show the `run` and `ssh` launcher:
rofi -modes "run,ssh" -show run rofi -modes "run,ssh" -show run
Custom modes can be added using the internal `script` mode. Each such mode has two parameters: Custom modes can be added using the internal `script` mode. Each such mode has
two parameters:
<name>:<script> <name>:<script>
@ -199,8 +202,8 @@ Example: Have a mode called 'Workspaces' using the `i3_switch_workspaces.sh` scr
rofi -modes "window,run,ssh,Workspaces:i3_switch_workspaces.sh" -show Workspaces rofi -modes "window,run,ssh,Workspaces:i3_switch_workspaces.sh" -show Workspaces
Notes: The i3 window manager dislikes commas in the command when specifying an exec command. Notes: The i3 window manager dislikes commas in the command when specifying an
For that case, `#` can be used as a separator. exec command. For that case, `#` can be used as a separator.
**TIP**: The name is allowed to contain spaces: **TIP**: The name is allowed to contain spaces:
@ -877,7 +880,7 @@ If no match, the input is handled by the first combined modes.
### The text in the window switcher is not nicely aligned. ### The text in the window switcher is not nicely aligned.
Try using a mono-space font. Try using a mono-space font or tabs + the tab-stops setting..
### The window is completely black. ### The window is completely black.
@ -967,7 +970,7 @@ been released.
## WEBSITE ## WEBSITE
**rofi** website can be found [here](https://davedavenport.github.io/rofi/) **rofi** website can be found [here](https://github.com/davatorium/rofi/)
## SUPPORT ## SUPPORT
@ -982,9 +985,9 @@ For more information see **rofi-debugging(5)** manpage.
## ISSUE TRACKER ## ISSUE TRACKER
The **rofi** issue tracker can be found [here](https://github.com/DaveDavenport/rofi/issues) The **rofi** issue tracker can be found [here](https://github.com/davatorium/rofi/issues)
Before creating an issue, consider posting a question on the [discussion forum](https://github.com/davatorium/rofi/discussions) first.
When creating an issue, please read [this](https://github.com/DaveDavenport/rofi/blob/master/.github/CONTRIBUTING.md) When creating an issue, please read [this](https://github.com/davatorium/rofi/blob/master/.github/CONTRIBUTING.md)
first. first.
## SEE ALSO ## SEE ALSO