Skip to content

Commit

Permalink
[Website] Update 1.7.3 docs.
Browse files Browse the repository at this point in the history
Issue: #2033
  • Loading branch information
DaveDavenport committed Sep 26, 2024
1 parent 558ab34 commit 35a4af1
Show file tree
Hide file tree
Showing 5 changed files with 286 additions and 590 deletions.
40 changes: 8 additions & 32 deletions mkdocs/docs/1.7.3/rofi-dmenu.5.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,13 @@ Force **rofi** mode to first read all data from stdin before showing the selecti
Note: the default asynchronous mode will also be automatically disabled if used with conflicting options,
such as `-dump`, `-only-match` or `-auto-select`.

`-async-pre-read` *number*

Reads the first *number* entries blocking, then switches to async mode.
This makes it feel more 'snappy'.

*default*: 25

`-window-title` *title*

Set name used for the window title. Will be shown as Rofi - *title*
Expand All @@ -170,37 +177,6 @@ Position **rofi** over the window with the given X11 window ID.

Set ellipsize mode to start. So, the end of the string is visible.

`-display-columns`

A comma seperated list of columns to show.

`-display-column-separator`

The column separator. This is a regex.

*default*: '\t'

`-ballot-selected-str` *string*

When multi-select is enabled, prefix this string when element is selected.

*default*: "☑ "

`-ballot-unselected-str` *string*

When multi-select is enabled, prefix this string when element is not selected.

*default*: "☐ "

`-ellipsize-mode` (start|middle|end)

Set ellipsize mode on the listview.

*default* "end"

## PARSING ROW OPTIONS

Extra options for individual rows can be also set. See the **rofi-script(5)** manpage for details; the syntax and supported features are identical.

## RETURN VALUE

Expand All @@ -211,7 +187,7 @@ Extra options for individual rows can be also set. See the **rofi-script(5)** ma

## SEE ALSO

rofi(1), rofi-sensible-terminal(1), dmenu(1), rofi-theme(5), rofi-script(5), rofi-theme-selector(1), ascii(7)
rofi(1), rofi-sensible-terminal(1), dmenu(1), rofi-theme(5), rofi-script(5), rofi-theme-selector(1)

## AUTHOR

Expand Down
33 changes: 4 additions & 29 deletions mkdocs/docs/1.7.3/rofi-keys.5.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -52,15 +52,6 @@ configuration {
}
```

## Unsetting a binding

To unset a binding, pass an empty string.

```css
configuration {
kb-clear-line: "";
}
```

## Keyboard Bindings

Expand All @@ -74,12 +65,6 @@ Paste clipboard

**Default**: Control+v,Insert

### **kb-secondary-copy**

Copy current selection to clipboard

**Default**: Control+c

### **kb-clear-line**
Clear input line

Expand Down Expand Up @@ -151,12 +136,12 @@ Accept entry
**Default**: Control+j,Control+m,Return,KP_Enter

### **kb-accept-custom**
Use entered text as command (in ssh/run modes)
Use entered text as command (in ssh/run modi)

**Default**: Control+Return

### **kb-accept-custom-alt**
Use entered text as command (in ssh/run modes)
Use entered text as command (in ssh/run modi)

**Default**: Control+Shift+Return

Expand Down Expand Up @@ -198,7 +183,7 @@ Go to the next column
### **kb-row-up**
Select previous entry

**Default**: Up,Control+p
**Default**: Up,Control+p,ISO_Left_Tab

### **kb-row-down**
Select next entry
Expand All @@ -208,17 +193,7 @@ Select next entry
### **kb-row-tab**
Go to next row, if one left, accept it, if no left next mode.

**Default**:

### **kb-element-next**
Go to next row.

**Default**: Tab

### **kb-element-prev**
Go to previous row.

**Default**: ISO_Left_Tab
**Default**: Tab

### **kb-page-prev**
Go to the previous page
Expand Down
26 changes: 8 additions & 18 deletions mkdocs/docs/1.7.3/rofi-script.5.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,13 @@

## NAME

**rofi script mode** - Rofi format for scriptable mode.
**rofi script mode** - Rofi format for scriptable modi.


## DESCRIPTION

**rofi** supports modes that use simple scripts in the background to generate a
list and process the result from user actions. This provide a simple interface
to make simple extensions to rofi.
**rofi** supports modes that use simple scripts in the background to generate a list and process the result from user
actions. This provide a simple interface to make simple extensions to rofi.


## USAGE
Expand All @@ -19,18 +18,17 @@ To specify a script mode, set a mode with the following syntax: "{name}:{executa
For example:

```
rofi -show fb -modes "fb:file_browser.sh"
rofi -show fb -modi "fb:file_browser.sh"
```

The name should be unique.

## API

Rofi calls the executable without arguments on startup. This should generate a
list of options, separated by a newline (`\n`) (This can be changed by the
script). If the user selects an option, rofi calls the executable with the text
of that option as the first argument. If the script returns no entries, rofi
quits.
Rofi calls the executable without arguments on startup. This should generate a list of options, separated by a newline
(`\n`) (This can be changed by the script).
If the user selects an option, rofi calls the executable with the text of that option as the first argument.
If the script returns no entries, rofi quits.

A simple script would be:

Expand Down Expand Up @@ -65,10 +63,6 @@ An integer number with the current state:

Environment get set when selected entry get set with the property value of the 'info' row option, if set.

### `ROFI_DATA`

Environment get set when script sets `data` option in header.

## Passing mode options

Extra options, like setting the prompt, can be set by the script.
Expand All @@ -90,10 +84,6 @@ 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.
* **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.
* **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**.
* **theme**: Small theme snippet to f.e. change the background color of a widget.

## Parsing row options

Expand Down
Loading

0 comments on commit 35a4af1

Please sign in to comment.