diff options
author | Dave Davenport <DaveDavenport@users.noreply.github.com> | 2023-01-22 17:25:17 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-01-22 17:25:17 +0100 |
commit | 6caece77d4cc0fa81b3303a4126e4efbb93b41be (patch) | |
tree | 8bd25e47766724f1c7737671d33e8457e811f6ff /doc | |
parent | ebb4459a60e75a25e679dd1c02466d91a662cb76 (diff) |
I785 (#1789)
* [Textbox] Add history to the entrybox.
* [Textbox] Add comments and move into sub functions.
* [doc] Add conflicting constraint section to manpage.
* [Script] Some small memory leak fixes.
* [Entry History] Add documentation.
fixes: #785
Diffstat (limited to 'doc')
-rw-r--r-- | doc/rofi-keys.5 | 14 | ||||
-rw-r--r-- | doc/rofi-keys.5.markdown | 10 | ||||
-rw-r--r-- | doc/rofi-theme.5 | 16 | ||||
-rw-r--r-- | doc/rofi-theme.5.markdown | 15 | ||||
-rw-r--r-- | doc/rofi.1 | 22 | ||||
-rw-r--r-- | doc/rofi.1.markdown | 16 |
6 files changed, 87 insertions, 6 deletions
diff --git a/doc/rofi-keys.5 b/doc/rofi-keys.5 index 7d0ed990..00174a27 100644 --- a/doc/rofi-keys.5 +++ b/doc/rofi-keys.5 @@ -587,6 +587,20 @@ Select row 10 .PP \fBDefault\fP: Super+0 +.SS \fBkb-entry-history-up\fP +.PP +Go up in the entry history. + +.PP +\fBDefault\fP: Control+Up + +.SS \fBkb-entry-history-down\fP +.PP +Go down in the entry history. + +.PP +\fBDefault\fP: Control+Down + .SH Mouse Bindings .SS \fBml-row-left\fP .PP diff --git a/doc/rofi-keys.5.markdown b/doc/rofi-keys.5.markdown index c23abb6d..4ff3ae08 100644 --- a/doc/rofi-keys.5.markdown +++ b/doc/rofi-keys.5.markdown @@ -415,6 +415,16 @@ Select row 10 **Default**: Super+0 +### **kb-entry-history-up** +Go up in the entry history. + +**Default**: Control+Up + +### **kb-entry-history-down** +Go down in the entry history. + +**Default**: Control+Down + ## Mouse Bindings ### **ml-row-left** diff --git a/doc/rofi-theme.5 b/doc/rofi-theme.5 index 62eadb24..98f150b9 100644 --- a/doc/rofi-theme.5 +++ b/doc/rofi-theme.5 @@ -2136,12 +2136,22 @@ It supports the following keys as constraint: .fi .RE +.SH Conflicting constraints +.PP +It is possible to define conflicting constraints in the theme. These conflicts +are not explicitly reported. The most common example is forcing a specific +window size, for example by enabling full-screen mode, having number of lines +set in the listview and having the listview expand to available space. There is +clearly a conflict in these 3 constraints. In this case, listview will not +limit to the number of lines, but tries to fill the available space. It is up +to the theme designer to make sure the theme handles this correctly. + .SH Font Parsing .PP Rofi uses pango -\[la]https://pango.gnome.org/\[ra] for font rendering. The font should be specified in a format that pango -understands. -This normally is the font name followed by the font size. For example: +\[la]https://pango.gnome.org/\[ra] for font rendering. The font should +be specified in a format that pango understands. This normally is the font name +followed by the font size. For example: .PP .RS diff --git a/doc/rofi-theme.5.markdown b/doc/rofi-theme.5.markdown index c1f71c7c..11e52dd3 100644 --- a/doc/rofi-theme.5.markdown +++ b/doc/rofi-theme.5.markdown @@ -1361,12 +1361,21 @@ It supports the following keys as constraint: } ``` +## Conflicting constraints + +It is possible to define conflicting constraints in the theme. These conflicts +are not explicitly reported. The most common example is forcing a specific +window size, for example by enabling full-screen mode, having number of lines +set in the listview and having the listview expand to available space. There is +clearly a conflict in these 3 constraints. In this case, listview will not +limit to the number of lines, but tries to fill the available space. It is up +to the theme designer to make sure the theme handles this correctly. ## Font Parsing -Rofi uses [pango](https://pango.gnome.org/) for font rendering. The font should be specified in a format that pango -understands. -This normally is the font name followed by the font size. For example: +Rofi uses [pango](https://pango.gnome.org/) for font rendering. The font should +be specified in a format that pango understands. This normally is the font name +followed by the font size. For example: ``` mono 18 @@ -1180,6 +1180,28 @@ rofi -filebrowser-cancel-returns-1 true -show filebrowser .PP The \fB\fCshow-hidden\fR can also be triggered with the \fB\fCkb-delete-entry\fR keybinding. +.SS Entry history +.PP +The number of previous inputs for the entry box can be modified by setting +max-history on the entry box. + +.PP +.RS + +.nf +configuration { + entry { + max-history: 30; + } +} + +.fi +.RE + +.PP +By default the file is stored in the systems cache directory, in a file called +\fB\fCrofi-entry-history.txt\fR\&. + .SS Other .PP \fB\fC-drun-use-desktop-cache\fR diff --git a/doc/rofi.1.markdown b/doc/rofi.1.markdown index b709dd94..94e387fe 100644 --- a/doc/rofi.1.markdown +++ b/doc/rofi.1.markdown @@ -726,6 +726,22 @@ rofi -filebrowser-cancel-returns-1 true -show filebrowser The `show-hidden` can also be triggered with the `kb-delete-entry` keybinding. +### Entry history + +The number of previous inputs for the entry box can be modified by setting +max-history on the entry box. + +```css +configuration { + entry { + max-history: 30; + } +} +``` + +By default the file is stored in the systems cache directory, in a file called +`rofi-entry-history.txt`. + ### Other `-drun-use-desktop-cache` |