diff options
author | Qball Cow <qball@gmpclient.org> | 2015-06-02 19:01:25 +0200 |
---|---|---|
committer | Qball Cow <qball@gmpclient.org> | 2015-06-02 19:01:25 +0200 |
commit | 8a3510e03374dc4dcc5f26fad214d7e1bed80cf7 (patch) | |
tree | 3351d4c85e438d2b706387e5b9110c4fb06e7d9f /doc/rofi.1 | |
parent | 6edb3771e3e259725ddb3d8eae7b8d807c1e7848 (diff) |
Switch to ronn for manpage generation.
Diffstat (limited to 'doc/rofi.1')
-rw-r--r-- | doc/rofi.1 | 1964 |
1 files changed, 1152 insertions, 812 deletions
@@ -1,932 +1,1270 @@ -.TH ROFI 1 rofi -.SH NAME -.PP -\fBrofi\fP \- A window switcher, run launcher, ssh dialog and dmenu replacement -.SH SYNOPSIS -.PP -\fBrofi\fP -[ \-width \fIpct_scr\fP ] -[ \-lines \fIlines\fP ] -[ \-columns \fIcolumns\fP ] -[ \-font \fIpangofont\fP ] -[ \-fg \fIcolor\fP ] -[ \-fg\-urgent \fIcolor\fP ] -[ \-fg\-active \fIcolor\fP ] -[ \-bg\-urgent \fIcolor\fP ] -[ \-bg\-active \fIcolor\fP ] -[ \-bg \fIcolor\fP ] -[ \-bgalt \fIcolor\fP ] -[ \-hlfg \fIcolor\fP ] -[ \-hlbg \fIcolor\fP ] -[ \-key\-\fBmode\fP \fIcombo\fP ] -[ \-terminal \fIterminal\fP ] -[ \-location \fIposition\fP ] -[ \-fixed\-num\-lines ] -[ \-padding \fIpadding\fP ] -[ \-opacity \fIopacity%\fP ] -[ \-display \fIdisplay\fP ] -[ \-bc \fIcolor\fP ] -[ \-bw \fIwidth\fP ] -[ \-dmenu [ \-p \fIprompt\fP ] [ \-sep \fIseparator\fP ] [ \-l \fIselected line\fP ] [ \-mesg ] [ \-filter ] [ \-select ] ] -[ \-ssh\-client \fIclient\fP ] -[ \-ssh\-command \fIcommand\fP ] -[ \-disable\-history ] -[ \-levenshtein\-sort ] -[ \-case\-sensitive ] -[ \-show \fImode\fP ] -[ \-modi \fImode1,mode2\fP ] -[ \-eh \fIelement height\fP ] -[ \-lazy\-filter\-limit \fIlimit\fP ] -[ \-e \fImessage\fP] -[ \-a \fIrow\fP ] -[ \-u \fIrow\fP ] -[ \-pid \fIpath\fP ] -[ \-now ] -[ \-rnow ] -[ \-snow ] -[ \-version ] -[ \-help] -[ \-dump\-Xresources ] -[ \-auto\-select ] -[ \-parse\-hosts ] -[ \-combi\-modi \fImode1,mode2\fP ] -[ \-quiet ] -.SH DESCRIPTION -.PP -\fBrofi\fP is an X11 popup window switcher, run dialog, dmenu replacement and more. It focuses on -being fast to use and have minimal distraction. It supports keyboard and mouse navigation, type to -filter, tokenized search and more. -.SH USAGE -.PP -\fBrofi\fP can be used in three ways, single\-shot; executes once and directly exits when done, as a -daemon listening to specific key\-combination or emulating dmenu. -.SS Single\-shot mode -.PP -To launch \fBrofi\fP directly in a certain mode, specifying \fB\fCrofi \-show <mode>\fR\&. -To show the run dialog: -.PP -.RS +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "ROFI\-MANPAGE" "" "June 2015" "" "" +. +.SH "NAME" +\fBrofi\fR \- A window switcher, run launcher, ssh dialog and dmenu replacement +. +.SH "SYNOPSIS" +\fBrofi\fR [ \-width \fIpct_scr\fR ] [ \-lines \fIlines\fR ] [ \-columns \fIcolumns\fR ] [ \-font \fIpangofont\fR ] [ \-fg \fIcolor\fR ] [ \-fg\-urgent \fIcolor\fR ] [ \-fg\-active \fIcolor\fR ] [ \-bg\-urgent \fIcolor\fR ] [ \-bg\-active \fIcolor\fR ] [ \-bg \fIcolor\fR ] [ \-bgalt \fIcolor\fR ] [ \-hlfg \fIcolor\fR ] [ \-hlbg \fIcolor\fR ] [ \-key\-\fBmode\fR \fIcombo\fR ] [ \-terminal \fIterminal\fR ] [ \-location \fIposition\fR ] [ \-fixed\-num\-lines ] [ \-padding \fIpadding\fR ] [ \-opacity \fIopacity%\fR ] [ \-display \fIdisplay\fR ] [ \-bc \fIcolor\fR ] [ \-bw \fIwidth\fR ] [ \-dmenu [ \-p \fIprompt\fR ] [ \-sep \fIseparator\fR ] [ \-l \fIselected line\fR ] [ \-mesg ] [ \-filter ] [ \-select ] ] [ \-ssh\-client \fIclient\fR ] [ \-ssh\-command \fIcommand\fR ] [ \-disable\-history ] [ \-levenshtein\-sort ] [ \-case\-sensitive ] [ \-show \fImode\fR ] [ \-modi \fImode1,mode2\fR ] [ \-eh \fIelement height\fR ] [ \-lazy\-filter\-limit \fIlimit\fR ] [ \-e \fImessage\fR] [ \-a \fIrow\fR ] [ \-u \fIrow\fR ] [ \-pid \fIpath\fR ] [ \-now ] [ \-rnow ] [ \-snow ] [ \-version ] [ \-help] [ \-dump\-Xresources ] [ \-auto\-select ] [ \-parse\-hosts ] [ \-combi\-modi \fImode1,mode2\fR ] [ \-quiet ] +. +.SH "DESCRIPTION" +\fBrofi\fR is an X11 popup window switcher, run dialog, dmenu replacement and more\. It focuses on being fast to use and have minimal distraction\. It supports keyboard and mouse navigation, type to filter, tokenized search and more\. +. +.SH "USAGE" +\fBrofi\fR can be used in three ways, single\-shot; executes once and directly exits when done, as a daemon listening to specific key\-combination or emulating dmenu\. +. +.SS "Single\-shot mode" +To launch \fBrofi\fR directly in a certain mode, specifying \fBrofi \-show <mode>\fR\. To show the run dialog: +. +.IP "" 4 +. .nf + rofi \-show run +. .fi -.RE -.SS Daemon mode -.PP -To launch \fBrofi\fP in daemon mode don't specify a mode to show (\fB\fC\-show <mode>\fR), instead you can -bind keys to launch a certain mode. To have run mode open when pressing \fB\fCF2\fR start \fBrofi\fP like: -.PP -.RS +. +.IP "" 0 +. +.SS "Daemon mode" +To launch \fBrofi\fR in daemon mode don\'t specify a mode to show (\fB\-show <mode>\fR), instead you can bind keys to launch a certain mode\. To have run mode open when pressing \fBF2\fR start \fBrofi\fR like: +. +.IP "" 4 +. .nf + rofi \-key\-run F2 +. .fi -.RE -.PP -Keybindings can also be specified in the \fB\fCXresources\fR file. -.SS Emulating dmenu -.PP -\fBrofi\fP can emulate \fB\fCdmenu\fR (a dynamic menu for X) when launched with the \fB\fC\-dmenu\fR flag. -.PP -The official website for \fB\fCdmenu\fR can be found here -\[la]http://tools.suckless.org/dmenu/\[ra]\&. -.SH OPTIONS -.PP +. +.IP "" 0 +. +.P +Keybindings can also be specified in the \fBXresources\fR file\. +. +.SS "Emulating dmenu" +\fBrofi\fR can emulate \fBdmenu\fR (a dynamic menu for X) when launched with the \fB\-dmenu\fR flag\. +. +.P +The official website for \fBdmenu\fR can be found here \fIhttp://tools\.suckless\.org/dmenu/\fR\. +. +.SH "OPTIONS" There are currently three methods of setting configuration options: -.RS -.IP \(bu 2 -Compile time: edit config.c. This method is strongly discouraged. -.IP \(bu 2 -Xresources: A method of storing key values in the Xserver. See -here -\[la]https://en.wikipedia.org/wiki/X_resources\[ra] for more information. -This is the recommended way of configuring \fBrofi\fP\&. -.IP \(bu 2 -Command\-line options: Arguments passed to \fBrofi\fP\&. -.RE -.PP -The Xresources options and the command\-line options are aliased. So to set option X you would set: -.PP -.RS -.nf -rofi.X: value -.fi -.RE -.PP -In the Xresources file, and to (override) this via the command\-line you would pass the same key -prefixed with a '\-': -.PP -.RS +. +.IP "\(bu" 4 +Compile time: edit config\.c\. This method is strongly discouraged\. +. +.IP "\(bu" 4 +Xresources: A method of storing key values in the Xserver\. See here \fIhttps://en\.wikipedia\.org/wiki/X_resources\fR for more information\. This is the recommended way of configuring \fBrofi\fR\. +. +.IP "\(bu" 4 +Command\-line options: Arguments passed to \fBrofi\fR\. +. +.IP "" 0 +. +.P +The Xresources options and the command\-line options are aliased\. So to set option X you would set: +. +.IP "" 4 +. .nf + +rofi\.X: value +. +.fi +. +.IP "" 0 +. +.P +In the Xresources file, and to (override) this via the command\-line you would pass the same key prefixed with a \'\-\': +. +.IP "" 4 +. +.nf + rofi \-X value +. .fi -.RE -.PP +. +.IP "" 0 +. +.P To get a list of available options, formatted as Xresources entries run: -.PP -.RS +. +.IP "" 4 +. .nf + rofi \-dump\-Xresources +. .fi -.RE -.PP +. +.IP "" 0 +. +.P The configuration system supports the following types: -.RS -.IP \(bu 2 +. +.IP "\(bu" 4 String -.IP \(bu 2 +. +.IP "\(bu" 4 Integer (signed and unsigned) -.IP \(bu 2 +. +.IP "\(bu" 4 Char -.IP \(bu 2 +. +.IP "\(bu" 4 Boolean -.RE -.PP -The boolean option has a non\-default command\-line syntax, to enable option X you do: -.PP -.RS +. +.IP "" 0 +. +.P +The boolean option has a non\-default command\-line syntax, to enable option X you do: +. +.IP "" 4 +. .nf + \-X +. .fi -.RE -.PP +. +.IP "" 0 +. +.P to disable it: -.PP -.RS +. +.IP "" 4 +. .nf + \-no\-X +. .fi -.RE -.PP +. +.IP "" 0 +. +.P Below is a list of the most important options: -.SS General -.PP -\fB\fC\-key\-{mode}\fR \fBKEY\fP -.IP -Set the key combination to display a {mode} in daemon mode. -.PP -.RS +. +.SS "General" +\fB\-key\-{mode}\fR \fBKEY\fR +. +.P +Set the key combination to display a {mode} in daemon mode\. +. +.IP "" 4 +. .nf + rofi \-key\-run F12 rofi \-key\-ssh control+shift+s rofi \-key\-window mod1+Tab +. .fi -.RE -.PP -\fB\fC\-dmenu\fR -.IP -Run \fBrofi\fP in dmenu mode. Allowing it to be used for user interaction in scripts. -.IP -In \fB\fCdmenu\fR mode, \fBrofi\fP will read input from STDIN, and will output to STDOUT by default. -.IP +. +.IP "" 0 +. +.P +\fB\-dmenu\fR +. +.P +Run \fBrofi\fR in dmenu mode\. Allowing it to be used for user interaction in scripts\. +. +.P +In \fBdmenu\fR mode, \fBrofi\fR will read input from STDIN, and will output to STDOUT by default\. +. +.P Example to let the user choose between three pre\-defined options: -.PP -.RS +. +.IP "" 4 +. .nf - echo \-e "Option #1\\nOption #2\\nOption #3" | rofi \-dmenu + + echo \-e "Option #1\enOption #2\enOption #3" | rofi \-dmenu +. .fi -.RE -.IP +. +.IP "" 0 +. +.P Or get the options from a script: -.PP -.RS -.nf - ~/my_script.sh | rofi \-dmenu -.fi -.RE -.IP -Pressing \fB\fCshift\-enter\fR will open the selected entries and move to the next entry. -.PP -\fB\fC\-show\fR \fImode\fP -.IP -Open \fBrofi\fP in a certain mode. -.IP +. +.IP "" 4 +. +.nf + + ~/my_script\.sh | rofi \-dmenu +. +.fi +. +.IP "" 0 +. +.P +Pressing \fBshift\-enter\fR will open the selected entries and move to the next entry\. +. +.P +\fB\-show\fR \fImode\fR +. +.P +Open \fBrofi\fR in a certain mode\. +. +.P For example to show the run\-dialog: -.PP -.RS +. +.IP "" 4 +. .nf + rofi \-show run +. .fi -.RE -.IP +. +.IP "" 0 +. +.P This function deprecates \-rnow,\-snow and \-now -.PP -\fB\fC\-switchers\fR \fImode1,mode1\fP -\fB\fC\-modi\fR \fImode1,mode1\fP -.IP -Give a comma separated list of modes to enable, in what order. -.IP +. +.P +\fB\-switchers\fR \fImode1,mode1\fR \fB\-modi\fR \fImode1,mode1\fR +. +.P +Give a comma separated list of modes to enable, in what order\. +. +.P For example to only show the run and ssh launcher (in that order): -.PP -.RS +. +.IP "" 4 +. .nf + rofi \-modi "run,ssh" \-show run +. .fi -.RE -.IP -Custom modes can be added using the internal 'script' mode. Each mode has two parameters: -.PP -.RS +. +.IP "" 0 +. +.P +Custom modes can be added using the internal \'script\' mode\. Each mode has two parameters: +. +.IP "" 4 +. .nf + <name>:<script> +. +.fi +. +.IP "" 0 +. +.P +So to have a mode \'Workspaces\' using the \fBi3_switch_workspace\.sh\fR script type: +. +.IP "" 4 +. +.nf + + rofi \-modi "window,run,ssh,Workspaces:i3_switch_workspaces\.sh" \-show Workspaces +. .fi -.RE -.IP -So to have a mode 'Workspaces' using the \fB\fCi3_switch_workspace.sh\fR script type: -.PP -.RS -.nf - rofi \-modi "window,run,ssh,Workspaces:i3_switch_workspaces.sh" \-show Workspaces -.fi -.RE -.PP -\fB\fC\-case\-sensitive\fR -.IP -Start in case sensitive mode. -.PP -\fB\fC\-quiet\fR -.IP -Do not print any message when starting in daemon mode. -.SS Theming -.PP -\fB\fC\-bg\fR -.PP -\fB\fC\-bg\-active\fR -.PP -\fB\fC\-bg\-urgent\fR -.IP -Set the background text color (X11 named color or hex #rrggbb) for the menu. -.PP -.RS +. +.IP "" 0 +. +.P +\fB\-case\-sensitive\fR +. +.P +Start in case sensitive mode\. +. +.P +\fB\-quiet\fR +. +.P +Do not print any message when starting in daemon mode\. +. +.SS "Theming" +\fB\-bg\fR +. +.P +\fB\-bg\-active\fR +. +.P +\fB\-bg\-urgent\fR +. +.P +Set the background text color (X11 named color or hex #rrggbb) for the menu\. +. +.IP "" 4 +. .nf + rofi \-bg "#222222" +. .fi -.RE -.IP -Default: \fI#f2f1f0\fP -.PP -\fB\fC\-bgalt\fR -.IP -Set the background text color for alternating rows (X11 named color or hex #rrggbb) for the menu. -.PP -.RS +. +.IP "" 0 +. +.P +Default: \fI#f2f1f0\fR +. +.P +\fB\-bgalt\fR +. +.P +Set the background text color for alternating rows (X11 named color or hex #rrggbb) for the menu\. +. +.IP "" 4 +. .nf + rofi \-bgalt "#222222" +. .fi -.RE -.IP -Default: \fI#f2f1f0\fP -.PP -\fB\fC\-bc\fR -.IP -Set the border color (X11 named color or hex #rrggbb) for the menu. -.PP -.RS +. +.IP "" 0 +. +.P +Default: \fI#f2f1f0\fR +. +.P +\fB\-bc\fR +. +.P +Set the border color (X11 named color or hex #rrggbb) for the menu\. +. +.IP "" 4 +. .nf + rofi \-bc black +. .fi -.RE -.IP -Default: \fIblack\fP -.PP -\fB\fC\-bw\fR -.IP -Set the border width in pixels. -.PP -.RS +. +.IP "" 0 +. +.P +Default: \fIblack\fR +. +.P +\fB\-bw\fR +. +.P +Set the border width in pixels\. +. +.IP "" 4 +. .nf + rofi \-bw 1 +. .fi -.RE -.IP -Default: \fI1\fP -.PP -\fB\fC\-fg\fR -.PP -\fB\fC\-fg\-urgent\fR -.PP -\fB\fC\-fg\-active\fR -.IP -Set the foreground text color (X11 named color or hex #rrggbb) for the menu. -.PP -.RS +. +.IP "" 0 +. +.P +Default: \fI1\fR +. +.P +\fB\-fg\fR +. +.P +\fB\-fg\-urgent\fR +. +.P +\fB\-fg\-active\fR +. +.P +Set the foreground text color (X11 named color or hex #rrggbb) for the menu\. +. +.IP "" 4 +. .nf + rofi \-fg "#cccccc" +. .fi -.RE -.IP -Default: \fI#222222\fP -.PP -\fB\fC\-hlbg\fR -.PP -\fB\fC\-hlbg\-active\fR -.PP -\fB\fC\-hlbg\-urgent\fR -.IP -Set the background text color (X11 named color or hex #rrggbb) for the highlighted item in the -menu. -.PP -.RS +. +.IP "" 0 +. +.P +Default: \fI#222222\fR +. +.P +\fB\-hlbg\fR +. +.P +\fB\-hlbg\-active\fR +. +.P +\fB\-hlbg\-urgent\fR +. +.P +Set the background text color (X11 named color or hex #rrggbb) for the highlighted item in the menu\. +. +.IP "" 4 +. .nf + rofi \-hlbg "#005577" +. .fi -.RE -.IP -Default: \fI#005577\fP -.PP -\fB\fC\-hlfg\fR -.PP -\fB\fC\-hlfg\-active\fR -.PP -\fB\fC\-hlfg\-urgent\fR -.IP -Set the foreground text color (X11 named color or hex #rrggbb) for the highlighted item in the -menu. -.PP -.RS +. +.IP "" 0 +. +.P +Default: \fI#005577\fR +. +.P +\fB\-hlfg\fR +. +.P +\fB\-hlfg\-active\fR +. +.P +\fB\-hlfg\-urgent\fR +. +.P +Set the foreground text color (X11 named color or hex #rrggbb) for the highlighted item in the menu\. +. +.IP "" 4 +. .nf + rofi \-hlfg "#ffffff" +. .fi -.RE -.IP -Default: \fI#FFFFFF\fP -.PP -\fB\fC\-font\fR -.IP -Pango font name for use by the menu. -.PP -.RS -.nf - rofi \-font monospace\\ 14 -.fi -.RE -.IP -Default: \fImono 12\fP -.PP -\fB\fC\-opacity\fR -.IP -Set the window opacity (0\-100). -.PP -.RS +. +.IP "" 0 +. +.P +Default: \fI#FFFFFF\fR +. +.P +\fB\-font\fR +. +.P +Pango font name for use by the menu\. +. +.IP "" 4 +. .nf + + rofi \-font monospace\e 14 +. +.fi +. +.IP "" 0 +. +.P +Default: \fImono 12\fR +. +.P +\fB\-opacity\fR +. +.P +Set the window opacity (0\-100)\. +. +.IP "" 4 +. +.nf + rofi \-opacity "75" +. .fi -.RE -.IP -Default: \fI100\fP -.PP -\fB\fC\-eh\fR \fIelement height\fP -.IP -The height of a field in lines. e.g. -.PP -.RS -.nf - echo \-e "a\\n3|b\\n4|c\\n5" | rofi \-sep '|' \-eh 2 \-dmenu -.fi -.RE -.IP -Default: \fI1\fP -.PP +. +.IP "" 0 +. +.P +Default: \fI100\fR +. +.P +\fB\-eh\fR \fIelement height\fR +. +.P +The height of a field in lines\. e\.g\. +. +.IP "" 4 +. +.nf + + echo \-e "a\en3|b\en4|c\en5" | rofi \-sep \'|\' \-eh 2 \-dmenu +. +.fi +. +.IP "" 0 +. +.P +Default: \fI1\fR +. +.P The following options are further explained in the theming section: -.PP -\fB\fC\-color\-enabled\fR -.PP -.RS -.nf -Enable the exteneded coloring options. -.fi -.RE -.PP -\fB\fC\-color\-window\fR \fIbackground\fP \fIborder color\fP -.PP -.RS -.nf -Set window background and border color. -.fi -.RE -.PP -\fB\fC\-color\-normal\fR \fIbackground,foreground,background alt, highlight background, highlight foreground\fP -\fB\fC\-color\-urgent\fR \fIbackground,foreground,background alt, highlight background, highlight foreground\fP -\fB\fC\-color\-active\fR \fIbackground,foreground,background alt, highlight background, highlight foreground\fP -.PP -.RS -.nf -Specify the colors used in a row per state (normal, active, urgent). -.fi -.RE -.SS Layout -.PP -\fB\fC\-lines\fR -.IP -Maximum number of lines the menu may show before scrolling. -.PP -.RS +. +.P +\fB\-color\-enabled\fR +. +.IP "" 4 +. .nf + +Enable the exteneded coloring options\. +. +.fi +. +.IP "" 0 +. +.P +\fB\-color\-window\fR \fIbackground\fR \fIborder color\fR +. +.IP "" 4 +. +.nf + +Set window background and border color\. +. +.fi +. +.IP "" 0 +. +.P +\fB\-color\-normal\fR \fIbackground, foreground, background alt, highlight background, highlight foreground\fR +. +.P +\fB\-color\-urgent\fR \fIbackground, foreground, background alt, highlight background, highlight foreground\fR +. +.P +\fB\-color\-active\fR \fIbackground, foreground, background alt, highlight background, highlight foreground\fR +. +.IP "" 4 +. +.nf + +Specify the colors used in a row per state (normal, active, urgent)\. +. +.fi +. +.IP "" 0 +. +.SS "Layout" +\fB\-lines\fR +. +.P +Maximum number of lines the menu may show before scrolling\. +. +.IP "" 4 +. +.nf + rofi \-lines 25 +. .fi -.RE -.IP -Default: \fI15\fP -.PP -\fB\fC\-columns\fR -.IP -The number of columns the menu may show before scrolling. -.PP -.RS +. +.IP "" 0 +. +.P +Default: \fI15\fR +. +.P +\fB\-columns\fR +. +.P +The number of columns the menu may show before scrolling\. +. +.IP "" 4 +. .nf + rofi \-columns 2 +. .fi -.RE -.IP -Default: \fI1\fP -.PP -\fB\fC\-width\fR [value] -.IP -Set the width of the menu as a percentage of the screen width. -.PP -.RS +. +.IP "" 0 +. +.P +Default: \fI1\fR +. +.P +\fB\-width\fR [value] +. +.P +Set the width of the menu as a percentage of the screen width\. +. +.IP "" 4 +. .nf + rofi \-width 60 +. .fi -.RE -.IP -If value is larger then 100, the size is set in pixels. e.g. to span a full hd monitor: -.PP -.RS +. +.IP "" 0 +. +.P +If value is larger then 100, the size is set in pixels\. e\.g\. to span a full hd monitor: +. +.IP "" 4 +. .nf + rofi \-width 1920 +. .fi -.RE -.IP -If the value is negative, it tries to estimates a character width. To show 30 characters on a row: -.PP -.RS +. +.IP "" 0 +. +.P +If the value is negative, it tries to estimates a character width\. To show 30 characters on a row: +. +.IP "" 4 +. .nf + rofi \-width \-30 +. .fi -.RE -.IP -Character width is a rough estimation, and might not be correct, but should work for most monospaced fonts. -.IP -Default: \fI50\fP -.PP -\fB\fC\-location\fR -.IP -Specify where the window should be located. The numbers map to the following location on the -monitor: -.PP -.RS +. +.IP "" 0 +. +.P +Character width is a rough estimation, and might not be correct, but should work for most monospaced fonts\. +. +.P +Default: \fI50\fR +. +.P +\fB\-location\fR +. +.P +Specify where the window should be located\. The numbers map to the following location on the monitor: +. +.IP "" 4 +. .nf + 1 2 3 8 0 4 7 6 5 +. .fi -.RE -.IP -Default: \fI0\fP -.PP -\fB\fC\-fixed\-num\-lines\fR -.IP -Keep a fixed number of visible lines (See the \fB\fC\-lines\fR option.) -.PP -\fB\fC\-padding\fR -.IP -Define the inner margin of the window. -.IP -Default: \fI5\fP -.PP -\fB\fC\-sidebar\-mode\fR -.PP -.RS -.nf -Go into side\-bar mode, it will show list of modi at the bottom. +. +.IP "" 0 +. +.P +Default: \fI0\fR +. +.P +\fB\-fixed\-num\-lines\fR +. +.P +Keep a fixed number of visible lines (See the \fB\-lines\fR option\.) +. +.P +\fB\-padding\fR +. +.P +Define the inner margin of the window\. +. +.P +Default: \fI5\fR +. +.P +\fB\-sidebar\-mode\fR +. +.IP "" 4 +. +.nf + +Go into side\-bar mode, it will show list of modi at the bottom\. To show sidebar use: + rofi \-show run \-sidebar\-mode \-lines 0 +. +.fi +. +.IP "" 0 +. +.P +\fB\-lazy\-filter\-limit\fR \fIlimit\fR +. +.P +The number of entries required for \fBrofi\fR to go into lazy filter mode\. In lazy filter mode, it won\'t re\-filter the list on each keypress, but only after \fBrofi\fR been idle for 250ms\. Experiments shows that the default (5000 lines) works well, set to 0 to always enable\. +. +.P +Default: \fI5000\fR +. +.P +\fB\-auto\-select\fR +. +.IP "" 4 +. +.nf + +When one entry is left, automatically select this\. +. .fi -.RE -.PP -\fB\fC\-lazy\-filter\-limit\fR \fIlimit\fP -.PP - The number of entries required for \fBrofi\fP to go into lazy filter mode. - In lazy filter mode, it won't re\-filter the list on each keypress, but only after \fBrofi\fP been - idle for 250ms. Experiments shows that the default (5000 lines) works well, set to 0 to always - enable. -.PP - Default: \fI5000\fP -.PP -\fB\fC\-auto\-select\fR -.PP -.RS -.nf -When one entry is left, automatically select this. -.fi -.RE -.SS PATTERN setting -.PP -\fB\fC\-terminal\fR -.IP -Specify what terminal to start. -.PP -.RS +. +.IP "" 0 +. +.SS "PATTERN setting" +\fB\-terminal\fR +. +.P +Specify what terminal to start\. +. +.IP "" 4 +. .nf + rofi \-terminal xterm +. +.fi +. +.IP "" 0 +. +.P +Pattern: \fI{terminal}\fR Default: \fIx\-terminal\-emulator\fR +. +.P +\fB\-ssh\-client\fR \fIclient\fR +. +.P +Override the used ssh client\. +. +.P +Pattern: \fI{ssh\-client}\fR Default: \fIssh\fR +. +.SS "SSH settings" +\fB\-ssh\-command\fR \fIcmd\fR +. +.P +Set the command to execute when starting a ssh session\. The pattern \fI{host}\fR is replaced by the selected ssh entry\. +. +.P +Default: \fI{terminal} \-e {ssh\-client} {host}\fR +. +.P +\fB\-parse\-hosts\fR +. +.IP "" 4 +. +.nf + +Parse the `/etc/hosts` files for entries\. +. .fi -.RE -.IP -Pattern: \fI{terminal}\fP -Default: \fIx\-terminal\-emulator\fP -.PP -\fB\fC\-ssh\-client\fR \fIclient\fP -.IP -Override the used ssh client. -.IP -Pattern: \fI{ssh\-client}\fP -Default: \fIssh\fP -.SS SSH settings -.PP -\fB\fC\-ssh\-command\fR \fIcmd\fP -.IP -Set the command to execute when starting a ssh session. -The pattern \fI{host}\fP is replaced by the selected ssh entry. -.IP -Default: \fI{terminal} \-e {ssh\-client} {host}\fP -.PP -\fB\fC\-parse\-hosts\fR -.PP -.RS -.nf -Parse the `/etc/hosts` files for entries. -.fi -.RE -.SS Run settings -.PP -\fB\fC\-run\-command\fR \fIcmd\fP -.IP -Set the command (\fI{cmd}\fP) to execute when running an application. -See \fIPATTERN\fP\&. -.IP -Default: \fI{cmd}\fP -.PP -\fB\fC\-run\-shell\-command\fR \fIcmd\fP -.IP -Set the command to execute when running an application in a shell. -See \fIPATTERN\fP\&. -.IP -Default: \fI{terminal} \-e {cmd}\fP -.PP -\fB\fC\-run\-list\-command\fR \fIcmd\fP -.IP -If set, use an external tool to generate list of executable commands. Uses 'run\-command' -.IP -Default: \fI""\fP -.SS Combi settings -.PP -\fB\fC\-combi\-modi\fR \fImode1,mode2\fP -.PP -.RS -.nf -The modi to combine in the combi mode. -For syntax to see `\-modi`. +. +.IP "" 0 +. +.SS "Run settings" +\fB\-run\-command\fR \fIcmd\fR +. +.P +Set the command (\fI{cmd}\fR) to execute when running an application\. See \fIPATTERN\fR\. +. +.P +Default: \fI{cmd}\fR +. +.P +\fB\-run\-shell\-command\fR \fIcmd\fR +. +.P +Set the command to execute when running an application in a shell\. See \fIPATTERN\fR\. +. +.P +Default: \fI{terminal} \-e {cmd}\fR +. +.P +\fB\-run\-list\-command\fR \fIcmd\fR +. +.P +If set, use an external tool to generate list of executable commands\. Uses \'run\-command\' +. +.P +Default: \fI""\fR +. +.SS "Combi settings" +\fB\-combi\-modi\fR \fImode1,mode2\fR +. +.IP "" 4 +. +.nf + +The modi to combine in the combi mode\. +For syntax to see `\-modi`\. To get one merge view, of window,run,ssh: + rofi \-show combi \-combi\-modi "window,run,ssh" +. .fi -.RE -.SS History and Sorting -.PP -\fB\fC\-disable\-history\fR -\fB\fC\-no\-disable\-history\fR (re\-enable history) -.IP +. +.IP "" 0 +. +.SS "History and Sorting" +\fB\-disable\-history\fR \fB\-no\-disable\-history\fR (re\-enable history) +. +.P Disable history -.PP -\fB\fC\-levenshtein\-sort\fR to enable -\fB\fC\-no\-levenshtein\-sort\fR to disable -.IP -When searching sort the result based on levenshtein distance. -.SS Dmenu specific -.PP -\fB\fC\-sep\fR \fIseparator\fP -.PP -.RS -.nf -Separator for dmenu. For example to show list a to e with '|' as separator: - echo "a|b|c|d|e" | rofi \-sep '|' \-dmenu -.fi -.RE -.PP -\fB\fC\-p\fR \fIprompt\fP -.PP -.RS -.nf -Specify the prompt to show in dmenu mode. E.g. select monkey a,b,c,d or e. - echo "a|b|c|d|e" | rofi \-sep '|' \-dmenu \-p "monkey:" +. +.P +\fB\-levenshtein\-sort\fR to enable \fB\-no\-levenshtein\-sort\fR to disable +. +.P +When searching sort the result based on levenshtein distance\. +. +.SS "Dmenu specific" +\fB\-sep\fR \fIseparator\fR +. +.IP "" 4 +. +.nf + +Separator for dmenu\. For example to show list a to e with \'|\' as separator: + + echo "a|b|c|d|e" | rofi \-sep \'|\' \-dmenu +. +.fi +. +.IP "" 0 +. +.P +\fB\-p\fR \fIprompt\fR +. +.IP "" 4 +. +.nf + +Specify the prompt to show in dmenu mode\. E\.g\. select monkey a,b,c,d or e\. + + echo "a|b|c|d|e" | rofi \-sep \'|\' \-dmenu \-p "monkey:" + Default: *dmenu* +. .fi -.RE -.PP -\fB\fC\-l\fR \fIselected line\fP -.PP -.RS +. +.IP "" 0 +. +.P +\fB\-l\fR \fIselected line\fR +. +.IP "" 4 +. .nf -Select a certain line. + +Select a certain line\. + Default: *0* +. .fi -.RE -.PP -\fB\fC\-i\fR -.PP -.RS +. +.IP "" 0 +. +.P +\fB\-i\fR +. +.IP "" 4 +. .nf -Number mode, return the index of the selected row. (starting at 0) + +Number mode, return the index of the selected row\. (starting at 0) +. .fi -.RE -.PP -\fB\fC\-a\fR \fIX\fP -.PP -.RS +. +.IP "" 0 +. |