diff options
| author | Dave Davenport <qball@blame.services> | 2021-12-17 11:13:29 +0100 |
|---|---|---|
| committer | Dave Davenport <qball@blame.services> | 2021-12-17 11:13:29 +0100 |
| commit | fbfb9b0247d02ea240eb2b0436135b5d33504766 (patch) | |
| tree | e1eb12240d6051bee1509bc5b1d0ac2ae52a9222 /doc/rofi.1 | |
| parent | a5f76b9d566f448d2bc9ea9967123d13e65a75d5 (diff) | |
[DOC] Add rofi-dmenu(5) manpage.
Diffstat (limited to 'doc/rofi.1')
| -rw-r--r-- | doc/rofi.1 | 234 |
1 files changed, 1 insertions, 233 deletions
@@ -41,13 +41,7 @@ rofi \-show run \fBrofi\fP can emulate \fBdmenu(1)\fP (a dynamic menu for X11) when launched with the \fB\fC\-dmenu\fR flag. .PP -The website for \fB\fCdmenu\fR can be found here -\[la]http://tools.suckless.org/dmenu/\[ra]\&. - -.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. -Besides, \fBrofi\fP offers some extended features (like multi\-select, highlighting, message bar, extra key bindings). +For more information see \fBrofi\-dmenu(5)\fP\&. .SS Display Error message .PP @@ -962,218 +956,6 @@ fzf sorting. .PP Maximum number of entries to store in history. Defaults to 25. (WARNING: can cause slowdowns when set too high) -.SS Dmenu specific -.PP -\fB\fC\-sep\fR \fIseparator\fP - -.PP -Separator for \fB\fCdmenu\fR\&. Example: To show a list of 'a' to 'e' with '|' as a separator: - -.PP -.RS - -.nf -echo "a|b|c|d|e" | rofi \-sep '|' \-dmenu - -.fi -.RE - -.PP -\fB\fC\-p\fR \fIprompt\fP - -.PP -Specify the prompt to show in \fB\fCdmenu\fR mode. For example, select 'monkey', a,b,c,d, or e. - -.PP -.RS - -.nf -echo "a|b|c|d|e" | rofi \-sep '|' \-dmenu \-p "monkey" - -.fi -.RE - -.PP -Default: \fIdmenu\fP - -.PP -\fB\fC\-l\fR \fInumber of lines to show\fP - -.PP -Maximum number of lines the menu may show before scrolling. - -.PP -.RS - -.nf -rofi \-dmenu \-l 25 - -.fi -.RE - -.PP -Default: \fI15\fP - -.PP -\fB\fC\-i\fR - -.PP -Makes \fB\fCdmenu\fR searches case\-insensitive - -.PP -\fB\fC\-a\fR \fIX\fP - -.PP -Active row, mark \fIX\fP as active. Where \fIX\fP is a comma\-separated list of python(1)\-style indices and ranges, e.g. indices start at 0, \-1 refers to the last row with \-2 preceding it, ranges are left\-open and right\-close, and so on. You can specify: - -.RS -.IP \(bu 2 -A single row: '5' -.IP \(bu 2 -A range of (last 3) rows: '\-3:' -.IP \(bu 2 -4 rows starting from row 7: '7:11' (or in legacy notation: '7\-10') -.IP \(bu 2 -A set of rows: '2,0,\-9' -.IP \(bu 2 -Or any combination: '5,\-3:,7:11,2,0,\-9' - -.RE - -.PP -\fB\fC\-u\fR \fIX\fP - -.PP -Urgent row, mark \fIX\fP as urgent. See \fB\fC\-a\fR option for details. - -.PP -\fB\fC\-only\-match\fR - -.PP -Only return a selected item, do not allow custom entry. -This mode always returns an entry. It will not return if no matching entry is -selected. - -.PP -\fB\fC\-no\-custom\fR - -.PP -Only return a selected item, do not allow custom entry. -This mode returns directly when no entries given. - -.PP -\fB\fC\-format\fR \fIformat\fP - -.PP -Allows the output of dmenu to be customized (N is the total number of input entries): - -.RS -.IP \(bu 2 -\&'s' selected string -.IP \(bu 2 -\&'i' index (0 \-\& (N\-\&1)) -.IP \(bu 2 -\&'d' index (1 \-\& N) -.IP \(bu 2 -\&'q' quote string -.IP \(bu 2 -\&'p' Selected string stripped from Pango markup (Needs to be a valid string) -.IP \(bu 2 -\&'f' filter string (user input) -.IP \(bu 2 -\&'F' quoted filter string (user input) - -.RE - -.PP -Default: 's' - -.PP -\fB\fC\-select\fR \fIstring\fP - -.PP -Select first line that matches the given string - -.PP -\fB\fC\-mesg\fR \fIstring\fP - -.PP -Add a message line below the filter entry box. Supports Pango markup. -For more information on supported markup, see here -\[la]https://docs.gtk.org/Pango/pango_markup.html\[ra] - -.PP -\fB\fC\-dump\fR - -.PP -Dump the filtered list to stdout and quit. -This can be used to get the list as \fBrofi\fP would filter it. -Use together with \fB\fC\-filter\fR command. - -.PP -\fB\fC\-input\fR \fIfile\fP - -.PP -Reads from \fIfile\fP instead of stdin. - -.PP -\fB\fC\-password\fR - -.PP -Hide the input text. This should not be considered secure! - -.PP -\fB\fC\-markup\-rows\fR - -.PP -Tell \fBrofi\fP that DMenu input is Pango markup encoded, and should be rendered. -See here -\[la]https://developer.gnome.org/pygtk/stable/pango-markup-language.html\[ra] for details about Pango markup. - -.PP -\fB\fC\-multi\-select\fR - -.PP -Allow multiple lines to be selected. Adds a small selection indicator to the left of each entry. - -.PP -\fB\fC\-sync\fR - -.PP -Force \fBrofi\fP mode to first read all data from stdin before showing the selection window. This is original dmenu behavior. - -.PP -Note: the default asynchronous mode will also be automatically disabled if used with conflicting options, -such as \fB\fC\-dump\fR, \fB\fC\-only\-match\fR or \fB\fC\-auto\-select\fR\&. - -.PP -\fB\fC\-async\-pre\-read\fR \fInumber\fP - -.PP -Reads the first \fInumber\fP entries blocking, then switches to async mode. -This makes it feel more 'snappy'. - -.PP -\fIdefault\fP: 25 - -.PP -\fB\fC\-window\-title\fR \fItitle\fP - -.PP -Set name used for the window title. Will be shown as Rofi \- \fItitle\fP - -.PP -\fB\fC\-w\fR \fIwindowid\fP - -.PP -Position \fBrofi\fP over the window with the given X11 window ID. - -.PP -\fB\fC\-keep\-right\fR - -.PP -Set ellipsize mode to start. So, the end of the string is visible. - .SS Message dialog .PP \fB\fC\-e\fR \fImessage\fP @@ -1285,20 +1067,6 @@ To launch commands (for example, when using the ssh launcher), the user can ente .RE -.SH DMENU REPLACEMENT -.PP -If \fB\fCargv[0]\fR (calling command) is dmenu, \fBrofi\fP will start in dmenu mode. -This way, it can be used as a drop\-in replacement for dmenu. Just copy or symlink \fBrofi\fP to dmenu in \fB\fC$PATH\fR\&. - -.PP -.RS - -.nf -ln \-s /usr/bin/rofi /usr/bin/dmenu - -.fi -.RE - .SH THEMING .PP Please see \fBrofi\-theme(5)\fP manpage for more information on theming. |