diff options
author | Dave Davenport <qball@blame.services> | 2022-04-14 20:45:37 +0200 |
---|---|---|
committer | Dave Davenport <qball@blame.services> | 2022-04-14 20:45:37 +0200 |
commit | 54e272df295cca15b457aa79f327609128aa76c5 (patch) | |
tree | bbc57dad50366769cf2b78e94965f80a12d80f37 /doc/rofi.1 | |
parent | d57d6de2ce8efcc051355c77c04793abac7210df (diff) |
[Doc] Update rofi.1 with an extra example.
Diffstat (limited to 'doc/rofi.1')
-rw-r--r-- | doc/rofi.1 | 467 |
1 files changed, 235 insertions, 232 deletions
@@ -1,47 +1,66 @@ +.nh .TH ROFI 1 rofi .SH NAME .PP -\fBrofi\fP \- A window switcher, application launcher, ssh dialog, dmenu replacement and more +\fBrofi\fP - A window switcher, application launcher, ssh dialog, dmenu replacement and more .SH SYNOPSIS .PP -\fBrofi\fP [ \-show \fImode\fP ]|[ \-dmenu ]|[ \-e \fImsg\fP ] [ CONFIGURATION ] +\fBrofi\fP [ -show \fImode\fP ]|[ -dmenu ]|[ -e \fImsg\fP ] [ CONFIGURATION ] .SH DESCRIPTION .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 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\&'s main functionality is to assist in your workflow, allowing you to quickly switch -between windows, start applications or log into a remote machine via \fB\fCssh\fR\&. -There are different \fImodes\fP for different types of actions. -\fBrofi\fP is a standalone application and should not be integrated into scripts. -For integration into scripts it has a special mode that functions as a -(drop\-in) replacement for \fBdmenu(1)\fP\&. See emulating dmenu below. +\fBrofi\fP\&'s main functionality is to assist in your workflow, allowing you to +quickly switch between windows, start applications or log into a remote machine +via \fB\fCssh\fR\&. There are different \fImodes\fP for different types of actions. \fBrofi\fP +is a standalone application and should not be integrated into scripts. For +integration into scripts it has a special mode that functions as a (drop-in) +replacement for \fBdmenu(1)\fP\&. See emulating dmenu below. .SS Running rofi .PP -To launch \fBrofi\fP directly in a certain mode, specify a mode with \fB\fCrofi \-show <mode>\fR\&. -To show the \fB\fCrun\fR dialog: +To launch \fBrofi\fP directly in a certain mode, specify a mode with \fB\fCrofi -show <mode>\fR\&. +To show the \fB\fCdrun\fR dialog: .PP .RS .nf -rofi \-show run + rofi -show drun .fi .RE +.PP +A very useful setup in minimalistic window managers is to combine \fB\fCdrun\fR, \fB\fCrun\fR +with \fB\fCwindow\fR mode: + +.PP +.RS + +.nf + rofi -show combi -modes combi -combi-modes "window,drun,run" + +.fi +.RE + +.PP +In this setup it first list all open applications, then all installed +applications. So if you type firefox and hit return, it will switch to the +running firefox, or launch it when it is not running. + .SS Emulating dmenu .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 -For more information see \fBrofi\-dmenu(5)\fP\&. +For more information see \fBrofi-dmenu(5)\fP\&. .SS Display Error message .PP @@ -51,7 +70,7 @@ For more information see \fBrofi\-dmenu(5)\fP\&. .RS .nf -rofi \-e "my message" +rofi -e "my message" .fi .RE @@ -66,23 +85,23 @@ There are currently three methods of setting configuration options (evaluated in .RS .IP \(bu 2 System configuration file (for example \fB\fC/etc/rofi.rasi\fR). -It first checks \fB\fCXDG\_CONFIG\_DIRS\fR, and then \fB\fCSYSCONFDIR\fR (that is passed at compile time). +It first checks \fB\fCXDG_CONFIG_DIRS\fR, and then \fB\fCSYSCONFDIR\fR (that is passed at compile time). It loads the first config file it finds, it does not merge multiple system configuration files. .IP \(bu 2 Rasi theme file: The new \fItheme\fP format can be used to set configuration values. .IP \(bu 2 -Command\-line options: Arguments passed to \fBrofi\fP\&. +Command-line options: Arguments passed to \fBrofi\fP\&. .RE .PP -To get a template config file, run: \fB\fCrofi \-dump\-config > config.rasi\fR +To get a template config file, run: \fB\fCrofi -dump-config > config.rasi\fR .PP This will contain (commented) all current configuration options, modified options are uncommented. .PP -To get a template config file that sets the icon\-theme run: \fB\fCrofi \-icon\-theme hicolor \-dump\-config\fR\&. +To get a template config file that sets the icon-theme run: \fB\fCrofi -icon-theme hicolor -dump-config\fR\&. .PP It is \fBstrongly\fP recommended to use this as a starting point for your configuration. @@ -102,8 +121,8 @@ configuration { .RE .PP -Most of the configuration options mentioned below (beside options like \fB\fC\-show\fR, -\fB\fC\-dump\-config\fR that apply to a single run) can be set here. +Most of the configuration options mentioned below (beside options like \fB\fC-show\fR, +\fB\fC-dump-config\fR that apply to a single run) can be set here. .PP For example to set the dpi value to 72: @@ -137,17 +156,17 @@ lists .RE .PP -For the syntax of these options, see the \fBrofi\-theme(5)\fP manpage. +For the syntax of these options, see the \fBrofi-theme(5)\fP manpage. .PP -For use on the command line, Boolean options have a non\-default command\-line +For use on the command line, Boolean options have a non-default command-line syntax. Example to enable option X: .PP .RS .nf -\-X +-X .fi .RE @@ -159,7 +178,7 @@ To disable option X: .RS .nf -\-no\-X +-no-X .fi .RE @@ -169,39 +188,39 @@ Below is a list of the most important options: .SS General .PP -\fB\fC\-help\fR +\fB\fC-help\fR .PP -The help option shows the full list of command\-line options and the current set values. -These include dynamic (run\-time generated) options. +The help option shows the full list of command-line options and the current set values. +These include dynamic (run-time generated) options. .PP -\fB\fC\-version\fR +\fB\fC-version\fR .PP Show the \fBrofi\fP version and exit. .PP -\fB\fC\-dump\-config\fR +\fB\fC-dump-config\fR .PP Dump the current active configuration, in rasi format, to stdout and exit. -Information about the rasi format can be found in the \fBrofi\-theme(5)\fP manpage. +Information about the rasi format can be found in the \fBrofi-theme(5)\fP manpage. .PP -\fB\fC\-dump\-theme\fR +\fB\fC-dump-theme\fR .PP Dump the current active theme, in rasi format, to stdout and exit. .PP -\fB\fC\-rasi\-validate\fR \fIfilename\fP +\fB\fC-rasi-validate\fR \fIfilename\fP .PP -Try to parse the file and return 0 when successful, non\-zero when failed. +Try to parse the file and return 0 when successful, non-zero when failed. .PP -\fB\fC\-threads\fR \fInum\fP +\fB\fC-threads\fR \fInum\fP .PP Specify the number of threads \fBrofi\fP should use: @@ -212,33 +231,29 @@ Specify the number of threads \fBrofi\fP should use: .IP \(bu 2 1: Disable threading .IP \(bu 2 - -.PP -2..n: Specify the maximum number of threads to use in the thread pool. -.PP -Default: Autodetect +2..n: Specify the maximum number of threads to use in the thread pool.Default: Autodetect .RE .PP -\fB\fC\-display\fR \fIdisplay\fP +\fB\fC-display\fR \fIdisplay\fP .PP The X server to contact. Default is \fB\fC$DISPLAY\fR\&. .PP -\fB\fC\-dmenu\fR +\fB\fC-dmenu\fR .PP Run \fBrofi\fP in dmenu mode. This allows for interactive scripts. In \fB\fCdmenu\fR mode, \fBrofi\fP reads from STDIN, and output to STDOUT. -A simple example, displaying three pre\-defined options: +A simple example, displaying three pre-defined options: .PP .RS .nf -echo \-e "Option #1\\nOption #2\\nOption #3" | rofi \-dmenu +echo -e "Option #1\\nOption #2\\nOption #3" | rofi -dmenu .fi .RE @@ -250,16 +265,16 @@ Or get the options from a script: .RS .nf -\~/my\_script.sh | rofi \-dmenu +~/my_script.sh | rofi -dmenu .fi .RE .PP -See the \fBrofi\-dmenu(5)\fP manpage for more information. +See the \fBrofi-dmenu(5)\fP manpage for more information. .PP -\fB\fC\-show\fR \fImode\fP +\fB\fC-show\fR \fImode\fP .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\&. @@ -267,25 +282,25 @@ The special argument \fB\fCkeys\fR can be used to open a searchable list of supp (see \fIKEY BINDINGS\fP) .PP -To show the run\-dialog: +To show the run-dialog: .PP .RS .nf -rofi \-show run +rofi -show run .fi .RE .PP -If \fB\fC\-show\fR is the last option passed to rofi, the first enabled modes is shown. +If \fB\fC-show\fR is the last option passed to rofi, the first enabled modes is shown. .PP -\fB\fC\-modes\fR \fImode1,mode2\fP +\fB\fC-modes\fR \fImode1,mode2\fP .PP -Specify an ordered, comma\-separated list of modes to enable. +Specify an ordered, comma-separated list of modes to enable. Enabled modes can be changed at runtime. Default key is \fB\fCCtrl+Tab\fR\&. If no modes are specified, all configured modes will be enabled. To only show the \fB\fCrun\fR and \fB\fCssh\fR launcher: @@ -294,7 +309,7 @@ To only show the \fB\fCrun\fR and \fB\fCssh\fR launcher: .RS .nf -rofi \-modes "run,ssh" \-show run +rofi -modes "run,ssh" -show run .fi .RE @@ -312,13 +327,13 @@ Custom modes can be added using the internal \fB\fCscript\fR mode. Each such mod .RE .PP -Example: Have a mode called 'Workspaces' using the \fB\fCi3\_switch\_workspaces.sh\fR script: +Example: Have a mode called 'Workspaces' using the \fB\fCi3_switch_workspaces.sh\fR script: .PP .RS .nf -rofi \-modes "window,run,ssh,Workspaces:i3\_switch\_workspaces.sh" \-show Workspaces +rofi -modes "window,run,ssh,Workspaces:i3_switch_workspaces.sh" -show Workspaces .fi .RE @@ -334,50 +349,50 @@ For that case, \fB\fC#\fR can be used as a separator. .RS .nf -rofi \-modes "My File Browser:fb.sh" \-show "My File Browser" +rofi -modes "My File Browser:fb.sh" -show "My File Browser" .fi .RE .PP -\fB\fC\-case\-sensitive\fR +\fB\fC-case-sensitive\fR .PP -Start in case\-sensitive mode. -This option can be changed at run\-time using the \fB\fC\-kb\-toggle\-case\-sensitivity\fR key binding. +Start in case-sensitive mode. +This option can be changed at run-time using the \fB\fC-kb-toggle-case-sensitivity\fR key binding. .PP -\fB\fC\-cycle\fR +\fB\fC-cycle\fR .PP Cycle through the result list. Default is 'true'. .PP -\fB\fC\-filter\fR \fIfilter\fP +\fB\fC-filter\fR \fIfilter\fP .PP Filter the list by setting text in input bar to \fIfilter\fP .PP -\fB\fC\-config\fR \fIfilename\fP +\fB\fC-config\fR \fIfilename\fP .PP Load an alternative configuration file. .PP -\fB\fC\-cache\-dir\fR \fIfilename\fP +\fB\fC-cache-dir\fR \fIfilename\fP .PP Directory that is used to place temporary files, like history. .PP -\fB\fC\-scroll\-method\fR \fImethod\fP +\fB\fC-scroll-method\fR \fImethod\fP .PP Select the scrolling method. 0: Per page, 1: continuous. .PP -\fB\fC\-normalize\-match\fR +\fB\fC-normalize-match\fR .PP Normalize the string before matching, so \fB\fCo\fR will match \fB\fCö\fR, and \fB\fCé\fR matches \fB\fCe\fR\&. @@ -385,31 +400,31 @@ Normalize the string before matching, so \fB\fCo\fR will match \fB\fCö\fR, and This is not a perfect implementation, but works. For now, it disables highlighting of the matched part. .PP -\fB\fC\-no\-lazy\-grab\fR +\fB\fC-no-lazy-grab\fR .PP Disables lazy grab, this forces the keyboard being grabbed before gui is shown. .PP -\fB\fC\-no\-plugins\fR +\fB\fC-no-plugins\fR .PP Disable plugin loading. .PP -\fB\fC\-plugin\-path\fR \fIdirectory\fP +\fB\fC-plugin-path\fR \fIdirectory\fP .PP Specify the directory where \fBrofi\fP should look for plugins. .PP -\fB\fC\-show\-icons\fR +\fB\fC-show-icons\fR .PP Show application icons in \fB\fCdrun\fR and \fB\fCwindow\fR modes. .PP -\fB\fC\-icon\-theme\fR +\fB\fC-icon-theme\fR .PP Specify icon theme to be used. @@ -417,32 +432,32 @@ If not specified default theme from DE is used, \fIAdwaita\fP and \fIgnome\fP th fallback themes. .PP -\fB\fC\-application\-fallback\-icon\fR +\fB\fC-application-fallback-icon\fR .PP Specify an icon to be used when the application icon in run/drun are not yet loaded or is not available. .PP -\fB\fC\-markup\fR +\fB\fC-markup\fR .PP Use Pango markup to format output wherever possible. .PP -\fB\fC\-normal\-window\fR +\fB\fC-normal-window\fR .PP Make \fBrofi\fP react like a normal application window. Useful for scripts like Clerk that are basically an application. .PP -\fB\fC\-[no\-]steal\-focus\fR +\fB\fC-[no-]steal-focus\fR .PP Make rofi steal focus on launch and restore close to window that held it when launched. .SS Matching .PP -\fB\fC\-matching\fR \fImethod\fP +\fB\fC-matching\fR \fImethod\fP .PP Specify the matching algorithm used. @@ -469,19 +484,19 @@ Default: \fInormal\fP Note: glob matching might be slow for larger lists .PP -\fB\fC\-tokenize\fR +\fB\fC-tokenize\fR .PP Tokenize the input. .PP -\fB\fC\-drun\-categories\fR \fIcategory1\fP,\fIcategory2\fP +\fB\fC-drun-categories\fR \fIcategory1\fP,\fIcategory2\fP .PP Only show desktop files that are present in the listed categories. .PP -\fB\fC\-drun\-match\-fields\fR \fIfield1\fP,\fIfield2\fP,... +\fB\fC-drun-match-fields\fR \fIfield1\fP,\fIfield2\fP,... .PP When using \fB\fCdrun\fR, match only with the specified Desktop entry fields. @@ -499,16 +514,12 @@ The different fields are: .IP \(bu 2 \fBcomment\fP: the application comment .IP \(bu 2 - -.PP -\fBall\fP: all the above -.PP -Default: \fIname,generic,exec,categories,keywords\fP +\fBall\fP: all the aboveDefault: \fIname,generic,exec,categories,keywords\fP .RE .PP -\fB\fC\-drun\-display\-format\fR +\fB\fC-drun-display-format\fR .PP The format string for the \fB\fCdrun\fR dialog: @@ -540,10 +551,10 @@ Default: {name} [<span weight='light' size='small'><i>({generic})</i></span>] .RE .PP -Note: Only fields enabled in \fB\fC\-drun\-match\-fields\fR can be used in the format string. +Note: Only fields enabled in \fB\fC-drun-match-fields\fR can be used in the format string. .PP -\fB\fC\-[no\-]drun\-show\-actions\fR +\fB\fC-[no-]drun-show-actions\fR .PP Show actions present in the Desktop files. @@ -558,7 +569,7 @@ Default: false .RE .PP -\fB\fC\-window\-match\-fields\fR \fIfield1\fP,\fIfield2\fP,... +\fB\fC-window-match-fields\fR \fIfield1\fP,\fIfield2\fP,... .PP When using window mode, match only with the specified fields. @@ -576,16 +587,12 @@ The different fields are: .IP \(bu 2 \fBdesktop\fP: window's current desktop .IP \(bu 2 - -.PP -\fBall\fP: all the above -.PP -Default: \fIall\fP +\fBall\fP: all the aboveDefault: \fIall\fP .RE .PP -\fB\fC\-matching\-negate\-char\fR \fIchar\fP +\fB\fC-matching-negate-char\fR \fIchar\fP .PP Set the character used to negate the query (i.e. if it does \fBnot\fP match the next keyword). @@ -595,7 +602,7 @@ Set to '\\x0' to disable. .RS .nf -Default: '\-' +Default: '-' .fi .RE @@ -605,16 +612,16 @@ Default: '\-' \fBIMPORTANT:\fP In newer \fBrofi\fP releases, all the theming options have been moved into the new theme format. They are no longer normal \fBrofi\fP options that can be passed directly on the command line (there are too many). - Small snippets can be passed on the command line: \fB\fCrofi \-theme\-str 'window {width: 50%;}'\fR to override a single + Small snippets can be passed on the command line: \fB\fCrofi -theme-str 'window {width: 50%;}'\fR to override a single setting. They are merged into the current theme. They can also be appended at the end of the \fBrofi\fP config file to override parts of the theme. .PP Most of the following options are \fBdeprecated\fP and should not be used. Please use the new theme format to customize -\fBrofi\fP\&. More information about the new format can be found in the \fBrofi\-theme(5)\fP manpage. +\fBrofi\fP\&. More information about the new format can be found in the \fBrofi-theme(5)\fP manpage. .PP -\fB\fC\-location\fR +\fB\fC-location\fR .PP Specify where the window should be located. The numbers map to the following locations on screen: @@ -634,68 +641,68 @@ Specify where the window should be located. The numbers map to the following loc Default: \fI0\fP .PP -\fB\fC\-fixed\-num\-lines\fR +\fB\fC-fixed-num-lines\fR .PP Keep a fixed number of visible lines. .PP -\fB\fC\-sidebar\-mode\fR +\fB\fC-sidebar-mode\fR .PP -Open in sidebar\-mode. In this mode, a list of all enabled modes is shown at the bottom. -(See \fB\fC\-modes\fR option) +Open in sidebar-mode. In this mode, a list of all enabled modes is shown at the bottom. +(See \fB\fC-modes\fR option) To show sidebar, use: .PP .RS .nf -rofi \-show run \-sidebar\-mode +rofi -show run -sidebar-mode .fi .RE .PP -\fB\fC\-hover\-select\fR +\fB\fC-hover-select\fR .PP Automatically select the entry the mouse is hovering over. This option is best combined with custom mouse bindings. -To utilize hover\-select and accept an entry in a single click, use: +To utilize hover-select and accept an entry in a single click, use: .PP .RS .nf -rofi \-show run \-hover\-select \-me\-select\-entry '' \-me\-accept\-entry MousePrimary +rofi -show run -hover-select -me-select-entry '' -me-accept-entry MousePrimary .fi .RE .PP -\fB\fC\-eh\fR \fInumber\fP +\fB\fC-eh\fR \fInumber\fP .PP Set row height (in chars) Default: \fI1\fP .PP -\fB\fC\-auto\-select\fR +\fB\fC-auto-select\fR .PP When one entry is left, automatically select it. .PP -\fB\fC\-m\fR \fInum\fP +\fB\fC-m\fR \fInum\fP .PP -\fB\fC\-m\fR \fIname\fP +\fB\fC-m\fR \fIname\fP .PP -\fB\fC\-monitor\fR \fInum\fP +\fB\fC-monitor\fR \fInum\fP .PP -\fB\fC\-monitor\fR \fIname\fP +\fB\fC-monitor\fR \fIname\fP .PP Select monitor to display \fBrofi\fP on. @@ -704,34 +711,30 @@ detection). Negative numbers are handled differently: .RS .IP \(bu 2 -\fB\-1\fP: the currently focused monitor. +\fB-1\fP: the currently focused monitor. .IP \(bu 2 -\fB\-2\fP: the currently focused window (that is, \fBrofi\fP will be displayed on top of the focused window). +\fB-2\fP: the currently focused window (that is, \fBrofi\fP will be displayed on top of the focused window). .IP \(bu 2 -\fB\-3\fP: Position of mouse (overrides the location setting to get normal context menu +\fB-3\fP: Position of mouse (overrides the location setting to get normal context menu behavior.) .IP \(bu 2 -\fB\-4\fP: the monitor with the focused window. +\fB-4\fP: the monitor with the focused window. .IP \(bu 2 - -.PP -\fB\-5\fP: the monitor that shows the mouse pointer. -.PP -Default: \fI\-5\fP +\fB-5\fP: the monitor that shows the mouse pointer.Default: \fI-5\fP .RE .PP -See \fB\fCrofi \-h\fR output for the detected monitors, their position, and size. +See \fB\fCrofi -h\fR output for the detected monitors, their position, and size. .PP -\fB\fC\-theme\fR \fIfilename\fP +\fB\fC-theme\fR \fIfilename\fP .PP Path to the new theme file format. This overrides the old theme settings. .PP -\fB\fC\-theme\-str\fR \fIstring\fP +\fB\fC-theme-str\fR \fIstring\fP .PP Allow theme parts to be specified on the command line as an override. @@ -743,7 +746,7 @@ For example: .RS .nf -rofi \-theme\-str '#window { fullscreen: true; }' +rofi -theme-str '#window { fullscreen: true; }' .fi .RE @@ -753,21 +756,21 @@ This option can be specified multiple times. This is now the method to tweak the theme via the command line. .PP -\fB\fC\-dpi\fR \fInumber\fP +\fB\fC-dpi\fR \fInumber\fP .PP Override the default DPI setting. .RS .IP \(bu 2 -If set to \fB\fC0\fR, it tries to auto\-detect based on X11 screen size (similar to i3 and GTK). +If set to \fB\fC0\fR, it tries to auto-detect based on X11 screen size (similar to i3 and GTK). .IP \(bu 2 -If set to \fB\fC1\fR, it tries to auto\-detect based on the size of the monitor that \fBrofi\fP is displayed on (similar to latest Qt 5). +If set to \fB\fC1\fR, it tries to auto-detect based on the size of the monitor that \fBrofi\fP is displayed on (similar to latest Qt 5). .RE .PP -\fB\fC\-selected\-row\fR \fIselected row\fP +\fB\fC-selected-row\fR \fIselected row\fP .PP Select a certain row. @@ -777,7 +780,7 @@ Default: \fI0\fP .SS PATTERN setting .PP -\fB\fC\-terminal\fR +\fB\fC-terminal\fR .PP Specify which terminal to start. @@ -786,7 +789,7 @@ Specify which terminal to start. .RS .nf -rofi \-terminal xterm +rofi -terminal xterm .fi .RE @@ -795,36 +798,36 @@ rofi \-terminal xterm Pattern: \fI{terminal}\fP .PP -Default: \fIx\-terminal\-emulator\fP +Default: \fIx-terminal-emulator\fP .PP -\fB\fC\-ssh\-client\fR \fIclient\fP +\fB\fC-ssh-client\fR \fIclient\fP .PP Override the used \fB\fCssh\fR client. .PP -Pattern: \fI{ssh\-client}\fP +Pattern: \fI{ssh-client}\fP .PP Default: \fIssh\fP .SS SSH settings .PP -\fB\fC\-ssh\-command\fR \fIcmd\fP +\fB\fC-ssh-command\fR \fIcmd\fP .PP Set the command to execute when starting an ssh session. The pattern \fI{host}\fP is replaced by the selected ssh entry. .PP -Pattern: \fI{ssh\-client}\fP +Pattern: \fI{ssh-client}\fP .PP -Default: \fI{terminal} \-e {ssh\-client} {host}\fP +Default: \fI{terminal} -e {ssh-client} {host}\fP .PP -\fB\fC\-parse\-hosts\fR +\fB\fC-parse-hosts\fR .PP Parse the \fB\fC/etc/hosts\fR file for entries. @@ -833,18 +836,18 @@ Parse the \fB\fC/etc/hosts\fR file for entries. Default: \fIdisabled\fP .PP -\fB\fC\-parse\-known\-hosts\fR -\fB\fC\-no\-parse\-known\-hosts\fR +\fB\fC-parse-known-hosts\fR +\fB\fC-no-parse-known-hosts\fR .PP -Parse the \fB\fC\~/.ssh/known\_hosts\fR file for entries. +Parse the \fB\fC~/.ssh/known_hosts\fR file for entries. .PP Default: \fIenabled\fP .SS Run settings .PP -\fB\fC\-run\-command\fR \fIcmd\fP +\fB\fC-run-command\fR \fIcmd\fP .PP Set command (\fI{cmd}\fP) to execute when running an application. @@ -854,27 +857,27 @@ See \fIPATTERN\fP\&. Default: \fI{cmd}\fP .PP -\fB\fC\-run\-shell\-command\fR \fIcmd\fP +\fB\fC-run-shell-command\fR \fIcmd\fP .PP Set command to execute when running an application in a shell. See \fIPATTERN\fP\&. .PP -Default: \fI{terminal} \-e {cmd}\fP +Default: \fI{terminal} -e {cmd}\fP .PP -\fB\fC\-run\-list\-command\fR \fIcmd\fP +\fB\fC-run-list-command\fR \fIcmd\fP .PP -If set, use an external tool to generate a list of executable commands. Uses \fB\fCrun\-command\fR\&. +If set, use an external tool to generate a list of executable commands. Uses \fB\fCrun-command\fR\&. .PP Default: \fI{cmd}\fP .SS Window switcher settings .PP -\fB\fC\-window\-format\fR \fIformat\fP +\fB\fC-window-format\fR \fIformat\fP .PP Format what is being displayed for windows. @@ -900,7 +903,7 @@ Format what is being displayed for windows. .RE .PP -\fIlen\fP: maximum field length (0 for auto\-size). If length and window \fIwidth\fP are negative, field length is \fIwidth \- len\fP\&. +\fIlen\fP: maximum field length (0 for auto-size). If length and window \fIwidth\fP are negative, field length is \fIwidth - len\fP\&. .br If length is positive, the entry will be truncated or padded to fill that length. @@ -908,17 +911,17 @@ If length is positive, the entry will be truncated or padded to fill that length default: {w} {c} {t} .PP -\fB\fC\-window\-command\fR \fIcmd\fP +\fB\fC-window-command\fR \fIcmd\fP .PP -Set command to execute on selected window for an alt action (\fB\fC\-kb\-accept\-alt\fR). +Set command to execute on selected window for an alt action (\fB\fC-kb-accept-alt\fR). See \fIPATTERN\fP\&. .PP -Default: \fI"wmctrl \-i \-R {window}"\fP +Default: \fI"wmctrl -i -R {window}"\fP .PP -\fB\fC\-window\-thumbnail\fR +\fB\fC-window-thumbnail\fR .PP Show window thumbnail (if available) as icon in the window switcher. @@ -932,7 +935,7 @@ You can stop rofi from exiting when closing a window (allowing multiple to be cl .nf configuration { window { - close\-on\-delete: false; + close-on-delete: false; } } @@ -941,18 +944,18 @@ configuration { .SS Combi settings .PP -\fB\fC\-combi\-modes\fR \fImode1\fP,\fImode2\fP +\fB\fC-combi-modes\fR \fImode1\fP,\fImode2\fP .PP The modes to combine in combi mode. -For syntax to \fB\fC\-combi\-modes\fR, see \fB\fC\-modes\fR\&. +For syntax to \fB\fC-combi-modes\fR, see \fB\fC-modes\fR\&. To get one merge view, of \fB\fCwindow\fR,\fB\fCrun\fR, and \fB\fCssh\fR: .PP .RS .nf -rofi \-show combi \-combi\-modes "window,run,ssh" \-modes combi +rofi -show combi -combi-modes "window,run,ssh" -modes combi .fi .RE @@ -962,7 +965,7 @@ rofi \-show combi \-combi\-modes "window,run,ssh" \-modes combi For that case, \fB\fC#\fR can be used as a separator. .PP -\fB\fC\-combi\-display\-format\fR +\fB\fC-combi-display-format\fR .PP The format string for entries in the \fB\fCcombi\fR dialog: @@ -988,26 +991,26 @@ Default: {mode} {text} .RE .PP -Note: This setting is ignored if \fB\fCcombi\-hide\-mode\-prefix\fR is eanbled. +Note: This setting is ignored if \fB\fCcombi-hide-mode-prefix\fR is eanbled. .SS History and Sorting .PP -\fB\fC\-disable\-history\fR -\fB\fC\-no\-disable\-history\fR (re\-enable history) +\fB\fC-disable-history\fR +\fB\fC-no-disable-history\fR (re-enable history) .PP Disable history .PP -\fB\fC\-sort\fR to enable -\fB\fC\-no\-sort\fR to disable +\fB\fC-sort\fR to enable +\fB\fC-no-sort\fR to disable .PP Enable, disable sorting. -This setting can be changed at runtime (see \fB\fC\-kb\-toggle\-sort\fR). +This setting can be changed at runtime (see \fB\fC-kb-toggle-sort\fR). .PP -\fB\fC\-sorting\-method\fR 'method' to specify the sorting method. +\fB\fC-sorting-method\fR 'method' to specify the sorting method. .PP There are 2 sorting methods: @@ -1021,18 +1024,18 @@ fzf sorting. .RE .PP -\fB\fC\-max\-history\-size\fR \fInumber\fP +\fB\fC-max-history-size\fR \fInumber\fP .PP Maximum number of entries to store in history. Defaults to 25. (WARNING: can cause slowdowns when set too high) .SS Message dialog .PP -\fB\fC\-e\fR \fImessage\fP +\fB\fC-e\fR \fImessage\fP .PP Pops up a message dialog (used internally for showing errors) with \fImessage\fP\&. -Message can be multi\-line. +Message can be multi-line. .SS File browser settings .PP @@ -1048,14 +1051,14 @@ configuration { directory: "/some/directory"; /** * Sorting method. Can be set to: - * \- "name" - * \- "mtime" (modification time) - * \- "atime" (access time) - * \- "ctime" (change time) + * - "name" + * - "mtime" (modification time) + * - "atime" (access time) + * - "ctime" (change time) */ - sorting\-method: "name"; + sorting-method: "name"; /** Group directories before files. */ - directories\-first: true; + directories-first: true; } } @@ -1064,40 +1067,40 @@ configuration { .SS Other .PP -\fB\fC\-drun\-use\-desktop\-cache\fR +\fB\fC-drun-use-desktop-cache\fR .PP Build and use a cache with the content of desktop files. Usable for systems with slow hard drives. .PP -\fB\fC\-drun\-reload\-desktop\-cache\fR +\fB\fC-drun-reload-desktop-cache\fR .PP -If \fB\fCdrun\-use\-desktop\-cache\fR is enabled, rebuild a cache with the content of desktop files. +If \fB\fCdrun-use-desktop-cache\fR is enabled, rebuild a cache with the content of desktop files. .PP -\fB\fC\-drun\-url\-launcher\fR \fIcommand\fP +\fB\fC-drun-url-launcher\fR \fIcommand\fP .PP Command to open a Desktop Entry that is a Link. .PP -\fB\fC\-pid\fR \fIpath\fP +\fB\fC-pid\fR \fIpath\fP .PP -Make \fBrofi\fP create a pid file and check this on startup. The pid file prevents multiple \fBrofi\fP instances from running simultaneously. This is useful when running \fBrofi\fP from a key\-binding daemon. +Make \fBrofi\fP create a pid file and check this on startup. The pid file prevents multiple \fBrofi\fP instances from running simultaneously. This is useful when running \fBrofi\fP from a key-binding daemon. .PP -\fB\fC\-replace\fR +\fB\fC-replace\fR .PP If rofi is already running, based on pid file, try to kill that instance. .PP -\fB\fC\-display\-{mode}\fR \fIstring\fP +\fB\fC-display-{mode}\fR \fIstring\fP .PP -Set the name to use for mode. This is used as prompt and in combi\-browser. +Set the name to use for mode. This is used as prompt and in combi-browser. .PP It is now preferred to use the configuration file: @@ -1108,7 +1111,7 @@ It is now preferred to use the configuration file: .nf configuration { {mode} { - display\-name: *string*; + display-name: *string*; } } @@ -1116,8 +1119,8 @@ configuration { .RE .PP -\fB\fC\-click\-to\-exit\fR -\fB\fC\-no\-click\-to\-exit\fR +\fB\fC-click-to-exit\fR +\fB\fC-no-click-to-exit\fR .PP Click the mouse outside the \fBrofi\fP window to exit. @@ -1127,29 +1130,29 @@ Default: \fIenabled\fP .SH PATTERN .PP -To launch commands (for example, when using the ssh launcher), the user can enter the used command\-line. The following keys can be used that will be replaced at runtime: +To launch commands (for example, when using the ssh launcher), the user can enter the used command-line. The following keys can be used that will be replaced at runtime: .RS .IP \(bu 2 \fB\fC{host}\fR: the host to connect to .IP \(bu 2 -\fB\fC{terminal}\fR: the configured terminal (see \-terminal) +\fB\fC{terminal}\fR: the configured terminal (see -terminal) .IP \(bu 2 -\fB\fC{ssh\-client}\fR: the configured ssh client (see \-ssh\-client) +\fB\fC{ssh-client}\fR: the configured ssh client (see -ssh-client) .IP \(bu 2 \fB\fC{cmd}\fR: the command to execute .IP \(bu 2 -\fB\fC{window}\fR: the window ID of the selected window (in \fB\fCwindow\-command\fR) +\fB\fC{window}\fR: the window ID of the selected window (in \fB\fCwindow-command\fR) .RE .SH THEMING .PP -Please see \fBrofi\-theme(5)\fP manpage for more information on theming. +Please see \fBrofi-theme(5)\fP manpage for more information on theming. .SH KEY BINDINGS .PP -Please see the \fBrofi\-keys(5)\fP manpage for the keybindings and how to set them up. +Please see the \fBrofi-keys(5)\fP manpage for the keybindings and how to set them up. .PP The keybinding can also be used for actions, when the action is executed the @@ -1168,7 +1171,7 @@ after X seconds. configuration { timeout { delay: 15; - action: "kb\-cancel"; + action: "kb-cancel"; } } @@ -1185,7 +1188,7 @@ When the input of the textbox changes: .nf configuration { inputchange { - action: "kb\-row\-first"; + action: "kb-row-first"; } } @@ -1196,9 +1199,9 @@ configuration { .SS window .PP Show a list of all the windows and allow switching between them. -Pressing the \fB\fCdelete\-entry\fR binding (\fB\fCshift\-delete\fR) will close the window. -Pressing the \fB\fCaccept\-custom\fR binding (\fB\fCcontrol\-enter\fR or \fB\fCshift\-enter\fR) will run |