neulab/tldr huggingface dataset:
pacman4console was written by Michael Billars (aka Dr. Mike) and is available at https://sites.google.com/site/doctormike/pacman.html.
This manual page was written by Joao Eriberto Mota Filho <eriberto@eriberto.pro.br> for the Debian project (but may be used by others).
ROFI(1)                      General Commands Manual                     ROFI(1)
rofi - A window switcher, application launcher, ssh dialog, dmenu replacement and more
rofi [ -show mode ]|[ -dmenu ]|[ -e msg ] [ CONFIGURATION ]
rofi 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.
rofi'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 ssh.  There are different modi for different types of actions.
rofi can also function as (drop-in) replacement for dmenu(1).
Running rofi To launch rofi directly in a certain mode, specify a mode with rofi -show <mode>.  To show the run dialog:
rofi -show run
Emulating dmenu rofi can emulate dmenu(1) (a dynamic menu for X11) when launched with the -dmenu flag.
The website for dmenu can be found here ⟨http://tools.suckless.org/dmenu/⟩.
rofi does not aim to be 100% compatible with dmenu. There are simply too many flavors of dmenu.  The idea is that the basic usage command-line flags are obeyed, theme-related flags are not.  Besides, rofi offers some extended features (like multi-select, highlighting, message bar, extra key bindings).
Display Error message rofi error dialog can also be called from the command line.
rofi -e "my message"
Markup support can be enabled, see CONFIGURATION options.
There are currently three methods of setting configuration options (evaluated in order below):
• System configuration file  (for example /etc/rofi.rasi).  It first checks XDG_CONFIG_DIRS, and then SYSCONFDIR (that is passed at compile time).  It loads the first config file it finds, it does not merge multiple system configuration files.
• Rasi theme file: The new theme format can be used to set configuration values.
• Command-line options: Arguments passed to rofi.
To get a template config file, run: rofi -dump-config > config.rasi
This will contain (commented) all current configuration options, modified options are uncommented.
The configuration system supports the following types:
• string
• integer (signed and unsigned)
• char
• boolean
• lists
For the syntax of these options, see the rofi-theme(5) manpage.
For use on the command line, Boolean options have a non-default command-line syntax. Example to enable option X:
To disable option X:
-no-X
Below is a list of the most important options:
General -help
The help option shows the full list of command-line options and the current set values.  These include dynamic (run-time generated) options.
Show the rofi version and exit.
-dump-config
Dump the current active configuration, in rasi format, to stdout and exit.  Information about the rasi format can be found in the rofi-theme(5) manpage.
-dump-theme
Dump the current active theme, in rasi format, to stdout and exit.
-rasi-validate filename
Try to parse the file and return 0 when successful, non-zero when failed.
-threads num
Specify the number of threads rofi should use:
• 0: Autodetect the number of supported hardware threads.
• 1: Disable threading
• 2..n: Specify the maximum number of threads to use in the thread pool.Default:  Autodetect
-display display
The X server to contact. Default is $DISPLAY.
-dmenu
Run rofi in dmenu mode. This allows for interactive scripts.  In dmenu mode, rofi reads from STDIN, and output to STDOUT.  A simple example, displaying three pre-defined options:
echo -e "Option #1\nOption #2\nOption #3" | rofi -dmenu
Or get the options from a script:
/my_script.sh | rofi -dmenu
-show mode
Open rofi in a certain mode. Available modes are window, run, drun, ssh, combi.  The special argument keys can be used to open a searchable list of supported key bindings (see KEY BINDINGS)
To show the run-dialog:
If -show is the last option passed to rofi, the first enabled modi is shown.
-modi mode1,mode2
Specify an ordered, comma-separated list of modes to enable.  Enabled modes can be changed at runtime. Default key is Ctrl+Tab.  If no modes are specified, all configured modes will be enabled.  To only show the run and ssh launcher:
rofi -modi "run,ssh" -show run
Custom modes can be added using the internal script mode. Each such mode has two parameters:
<name>:<script>
Example: Have a mode called 'Workspaces' using the i3_switch_workspaces.sh script:
rofi -modi "window,run,ssh,Workspaces:i3_switch_workspaces.sh" -show Workspaces
Notes: The i3 window manager dislikes commas in the command when specifying an exec command.  For that case, # can be used as a separator.
TIP: The name is allowed to contain spaces:
rofi -modi "My File Browser:fb.sh" -show "My File Browser"
-case-sensitive
Start in case-sensitive mode.  This option can be changed at run-time using the -kb-toggle-case-sensitivity key binding.
-cycle
Cycle through the result list. Default is 'true'.
-filter filter
Filter the list by setting text in input bar to filter
-config filename
Load an alternative configuration file.
-cache-dir filename
Directory that is used to place temporary files, like history.
-scroll-method method
Select the scrolling method. 0: Per page, 1: continuous.
-normalize-match
Normalize the string before matching, so o will match ö, and é matches e. This is not a perfect implementation, but works. For now, it disables highlighting of the matched part.
-no-lazy-grab
Disables lazy grab, this forces the keyboard being grabbed before gui is shown.
-no-plugins
Disable plugin loading.
-plugin-path directory
Specify the directory where rofi should look for plugins.
-show-icons
Show application icons in drun and window modes.
-icon-theme
Specify icon theme to be used.  If not specified default theme from DE is used, Adwaita and gnome themes act as fallback themes.
-application-fallback-icon
Specify an icon to be used when the application icon in run/drun are not yet loaded or is not available.
-markup
Use Pango markup to format output wherever possible.
-normal-window
Make rofi react like a normal application window. Useful for scripts like Clerk that are basically an application.
-[no-]steal-focus
Make rofi steal focus on launch and restore close to window that held it when launched.
Matching -matching method
Specify the matching algorithm used.  Currently, the following methods are supported:
• normal: match the int string
• regex: match a regex input
• glob: match a glob pattern
• fuzzy: do a fuzzy match
• prefix: match prefix
Default: normal
Note: glob matching might be slow for larger lists
-tokenize
Tokenize the input.
-drun-categories category1,category2
Only show desktop files that are present in the listed categories.
-drun-match-fields field1,field2,...
When using drun, match only with the specified Desktop entry fields.  The different fields are:
• name: the application's name
• generic: the application's generic name
• exec: the application's  executable
• categories: the application's categories
• comment: the application comment
• all: all the aboveDefault: name,generic,exec,categories,keywords
-drun-display-format
The format string for the drun dialog:
Pango markup can be used to formatting the output.
Default: {name} [<span weight='light' size='small'><i>({generic})</i></span>]
Note: Only fields enabled in -drun-match-fields can be used in the format string.
-[no-]drun-show-actions
Show actions present in the Desktop files.
-window-match-fields field1,field2,...
When using window mode, match only with the specified fields.  The different fields are:
• title: window's title
• class: window's class
• role: window's role
• name: window's name
• desktop: window's current desktop
• all: all the aboveDefault: all
-matching-negate-char char
Set the character used to negate the query (i.e. if it does not match the next keyword).  Set to '\x0' to disable.
Default: '-'
Layout and Theming IMPORTANT: In newer rofi releases, all the theming options have been moved into the new theme format. They are no longer normal rofi options that can be passed directly on the command line (there are too many). Small snippets can be passed on the command line: rofi -theme-str 'window {width: 50%;}' to override a single setting. They are merged into the current theme. They can also be appended at the end of the rofi config file to override parts of the theme.
Most of the following options are deprecated and should not be used. Please use the new theme format to customize rofi. More information about the new format can be found in the rofi-theme(5) manpage.
-location
Specify where the window should be located. The numbers map to the following locations on screen:
1 2 3 8 0 4 7 6 5
-fixed-num-lines
Keep a fixed number of visible lines.
-sidebar-mode
Open in sidebar-mode. In this mode, a list of all enabled modes is shown at the bottom.  (See -modi option) To show sidebar, use:
rofi -show run -sidebar-mode
-hover-select
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:
rofi -show run -hover-select -me-select-entry '' -me-accept-entry MousePrimary
-eh number
Set row height (in chars) Default: 1
-auto-select
When one entry is left, automatically select it.
-m num
-m name
-monitor num
-monitor name
Select monitor to display rofi on.  It accepts as input: primary (if primary output is set), the xrandr output name, or integer number (in order of detection). Negative numbers are handled differently:
• -1: the currently focused monitor.
• -2: the currently focused window (that is, rofi will be displayed on top of the focused window).
• -3: Position of mouse (overrides the location setting to get normal context menu behavior.)
• -4: the monitor with the focused window.
• -5: the monitor that shows the mouse pointer.Default: -5
See rofi -h output for the detected monitors, their position, and size.
-theme filename
Path to the new theme file format. This overrides the old theme settings.
-theme-str string
Allow theme parts to be specified on the command line as an override.
rofi -theme-str '#window { fullscreen: true; }'
This option can be specified multiple times.  This is now the method to tweak the theme via the command line.
-dpi  number
Override the default DPI setting.
• If set to 0, it tries to auto-detect based on X11 screen size (similar to i3 and GTK).
• If set to 1, it tries to auto-detect based on the size of the monitor that rofi is displayed on (similar to latest Qt 5).
-selected-row selected row
Select a certain row.
PATTERN setting -terminal
Specify which terminal to start.
rofi -terminal xterm
Pattern: {terminal}
Default: x-terminal-emulator
-ssh-client client
Override the used ssh client.
Pattern: {ssh-client}
Default: ssh
SSH settings -ssh-command cmd
Set the command to execute when starting an ssh session.  The pattern {host} is replaced by the selected ssh entry.
Default: {terminal} -e {ssh-client} {host}
-parse-hosts
Parse the /etc/hosts file for entries.
-parse-known-hosts -no-parse-known-hosts
Parse the  /.ssh/known_hosts file for entries.
Default: enabled
Run settings -run-command cmd
Set command ({cmd}) to execute when running an application.  See PATTERN.
Default: {cmd}
-run-shell-command cmd
Set command to execute when running an application in a shell.  See PATTERN.
Default: {terminal} -e {cmd}
-run-list-command cmd
If set, use an external tool to generate a list of executable commands. Uses run-command.
Window switcher settings -window-format format
Format what is being displayed for windows.
format: {field[:len]}
field:
• w: desktop name
• t: title of window
• n: name
• r: role
• c: class
len: maximum field length (0 for auto-size). If length and window width are negative, field length is width - len. If length is positive, the entry will be truncated or padded to fill that length.
default: {w}  {c}   {t}
-window-command cmd
Set command to execute on selected window for an alt action (-kb-accept-alt).  See PATTERN.
Default: "wmctrl -i -R {window}"
-window-thumbnail
Show window thumbnail (if available) as icon in the window switcher.
You can stop rofi from exiting when closing a window (allowing multiple to be closed in a row).
configuration { window { close-on-delete: false; } }
Combi settings -combi-modi mode1,mode2
The modi to combine in combi mode.  For syntax to -combi-modi, see -modi. To get one merge view, of window,run, and ssh:
rofi -show combi -combi-modi "window,run,ssh" -modi combi
NOTE: The i3 window manager dislikes commas in the command when specifying an exec command.  For that case, # can be used as a separator.
History and Sorting -disable-history -no-disable-history (re-enable history)
Disable history
-sort to enable -no-sort to disable
Enable, disable sorting.  This setting can be changed at runtime (see -kb-toggle-sort).
-sorting-method 'method' to specify the sorting method.
There are 2 sorting methods:
• levenshtein (Default)
• fzf sorting.
-max-history-size number
Maximum number of entries to store in history. Defaults to 25. (WARNING: can cause slowdowns when set too high)
Dmenu specific -sep separator
Separator for dmenu. Example: To show a list of 'a' to 'e' with '|' as a separator:
echo "a|b|c|d|e" | rofi -sep '|' -dmenu
-p prompt
Specify the prompt to show in dmenu mode. For example, select 'monkey', a,b,c,d, or e.
echo "a|b|c|d|e" | rofi -sep '|' -dmenu -p "monkey"
Default: dmenu
-l number of lines to show
Maximum number of lines the menu may show before scrolling.
rofi -dmenu -l 25
Default: 15
Makes dmenu searches case-insensitive
-a X
Active row, mark X as active. Where X 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:
• A single row: '5'
• A range of (last 3) rows: '-3:'
• 4 rows starting from row 7: '7:11' (or in legacy notation: '7-10')
• A set of rows: '2,0,-9'
• Or any combination: '5,-3:,7:11,2,0,-9'
-u X
Urgent row, mark X as urgent. See -a option for details.
-only-match
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.
-no-custom
Only return a selected item, do not allow custom entry.  This mode returns directly when no entries given.
-format format
Allows the output of dmenu to be customized (N is the total number of input entries):
• 's' selected string
• 'i' index (0 - (N-1))
• 'd' index (1 - N)
• 'q' quote string
• 'p' Selected string stripped from Pango markup (Needs to be a valid string)
• 'f' filter string (user input)
• 'F' quoted filter string (user input)
Default: 's'
-select string
Select first line that matches the given string
-mesg string
Add a message line below the filter entry box. Supports Pango markup. For more information on supported markup, see here ⟨https://docs.gtk.org/Pango/pango_markup.html⟩
Dump the filtered list to stdout and quit.  This can be used to get the list as rofi would filter it.  Use together with -filter command.
-input file
Reads from file instead of stdin.
-password
Hide the input text. This should not be considered secure!
-markup-rows
Tell rofi that DMenu input is Pango markup encoded, and should be rendered.  See here ⟨https://developer.gnome.org/pygtk/stable/pango- markup-language.html⟩ for details about Pango markup.
-multi-select
Allow multiple lines to be selected. Adds a small selection indicator to the left of each entry.
Force rofi mode to first read all data from stdin before showing the selection window. This is original dmenu behavior.
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
-w windowid
Position rofi over the window with the given X11 window ID.
-keep-right
Set ellipsize mode to start. So, the end of the string is visible.
Message dialog -e message
Pops up a message dialog (used internally for showing errors) with message.  Message can be multi-line.
File browser settings File browser behavior can be controlled via the following options:
configuration { filebrowser { /** Directory the file browser starts in. */ directory: "/some/directory"; /** * Sorting method. Can be set to: *   - "name" *   - "mtime" (modification time) *   - "atime" (access time) *   - "ctime" (change time) */ sorting-method: "name"; /** Group directories before files. */ directories-first: true; } }
Other -drun-use-desktop-cache
Build and use a cache with the content of desktop files. Usable for systems with slow hard drives.
-drun-reload-desktop-cache
If drun-use-desktop-cache is enabled, rebuild a cache with the content of desktop files.
-drun-url-launcher command
Command to open a Desktop Entry that is a Link.
-pid path
Make rofi create a pid file and check this on startup. The pid file prevents multiple rofi instances from running simultaneously. This is useful when running rofi from a key-binding daemon.
-display-{mode} string
Set the name to use for mode. This is used as prompt and in combi-browser.
It is now preferred to use the configuration file:
configuration { {mode} { display-name: *string*; } }
-click-to-exit -no-click-to-exit
Click the mouse outside the rofi window to exit.
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:
• {host}: the host to connect to
• {terminal}: the configured terminal (see -terminal-emulator)
• {ssh-client}: the configured ssh client (see -ssh-client)
• {cmd}: the command to execute
• {window}: the window ID of the selected window (in window-command)
If argv[0] (calling command) is dmenu, rofi will start in dmenu mode. This way, it can be used as a drop-in replacement for dmenu. Just copy or symlink rofi to dmenu in $PATH.
ln -s /usr/bin/rofi /usr/bin/dmenu
Please see rofi-theme(5) manpage for more information on theming.
rofi has the following key bindings:
• Control-v, Insert: Paste from clipboard
• Control-Shift-v, Shift-Insert: Paste primary selection
• Control-u: Clear the line
• Control-a: Beginning of line
• Control-e: End of line
• Control-f, Right: Forward one character
• Alt-f, Control-Right: Forward one word
• Control-b, Left: Back one character
• Alt-b, Control-Left: Back one word
• Control-d, Delete: Delete character
• Control-Alt-d: Delete word
• Control-h, Backspace, Shift-Backspace: Backspace (delete previous character)
• Control-Alt-h: Delete previous word
• Control-j,Control-m,Enter: Accept entry
• Control-n,Down: Select next entry
• Control-p,Up: Select previous entry
• Page Up: Go to previous page
• Page Down: Go to next page
• Control-Page Up: Go to previous column
• Control-Page Down: Go to next column
• Control-Enter: Use entered text as a command (in ssh/run modi)
• Shift-Enter: Launch the application in a terminal (in run mode)
• Control-Shift-Enter: As Control-Enter and run the command in terminal (in run mode)
• Shift-Enter: Return the selected entry and move to the next item while keeping rofi open. (in dmenu)
• Shift-Right: Switch to the next mode. The list can be customized with the -modi argument.
• Shift-Left: Switch to the previous mode. The list can be customized with the -modi argument.
• Control-Tab: Switch to the next mode. The list can be customized with the -modi argument.
• Control-Shift-Tab: Switch to the previous mode. The list can be customized with the -modi argument.
• Control-space: Set selected item as input text.
• Shift-Del: Delete entry from history.
• grave: Toggle case sensitivity.
• Alt-grave: Toggle sorting.
• Alt-Shift-S: Take a screenshot and store it in the Pictures directory.
• Control-l: File complete for run dialog.
This list might not be complete, to get a full list of all key bindings supported in your rofi, see rofi -h. The options starting with -kb are keybindings.
Key bindings can be modified using the configuration systems. Multiple keys can be bound to one action by comma separating them. For example -kb-primary-paste "Conctrol+v,Insert"
To get a searchable list of key bindings, run rofi -show keys.
A key binding starting with ! will act when all keys have been released.
You can bind certain events to key-actions:
Timeout You can configure an action to be taken when rofi has not been interacted with for a certain amount of seconds. You can specify a keybinding to trigger after X seconds.
configuration { timeout { delay:  15; action: "kb-cancel"; } }
Input change When the input of the textbox changes:
configuration { inputchange { action: "kb-row-first"; } }
Available Modi window Show a list of all the windows and allow switching between them. Pressing the delete-entry binding (shift-delete) will close the window. Pressing the accept-custom binding (control-enter or shift-enter) will run a command on the window.  (See option window-command );
If there is no match, it will try to launch the input.
windowcd Shows a list of the windows on the current desktop and allows switching between them.  Pressing the delete-entry binding (shift-delete) will kill the window.  Pressing the accept-custom binding (control-enter or shift-enter) will run a command on the window.  (See option window-command );
run Shows a list of executables in $PATH and can launch them (optional in a terminal).  Pressing the delete-entry binding (shift-delete) will remove this entry from the run history.  Pressing the accept-custom binding (control-enter) will run the command as entered in the entry box. Pressing the accept-alt binding (shift-enter) will run the command in a terminal.
When pressing the mode-complete binding (Control-l), you can use the File Browser mode to launch the application with a file as the first argument.
drun Same as the run launches, but the list is created from the installed desktop files. It automatically launches them in a terminal if specified in the Desktop File.  Pressing the delete-entry binding (shift-delete) will remove this entry from the run history.  Pressing the accept-custom binding (control-enter) will run the command as entered in the entry box. Pressing the accept-alt binding (shift-enter) will run the command in a terminal.
When pressing the mode-complete binding (Control-l), you can use the File Browser mode to launch the application passing a file as argument if specified in the desktop file.
The DRUN mode tries to follow the XDG Desktop Entry Specification ⟨https://freedesktop.org/wiki/Specifications/desktop-entry-spec/⟩ and should be compatible with applications using this standard.  Some applications create invalid desktop files, rofi will discard these entries.  See the debugging section for more info on DRUN mode, this will print why desktop files are discarded.
There are two advanced options to tweak the behaviour:
configuration { drun { /** Parse user desktop files. */ parse-user:   true; /** Parse system desktop files. */ parse-system: false; } }
ssh Shows a list of SSH targets based on your ssh config file, and allows to quickly ssh into them.
keys Shows a searchable list of key bindings.
script Allows custom scripted Modi to be added, see the rofi-script(5) manpage for more information.
combi Combines multiple modi in one list. Specify which modi are included with the -combi-modi option.
When using the combi mode, a !bang can be used to filter the results by modi.  All modi that match the bang as a prefix are included.  For example, say you have specified -combi-modi run,window,windowcd. If your query begins with the bang !w, only results from the window and windowcd modi are shown, even if the rest of the input text would match results from run.
If no match, the input is handled by the first combined modi.
The text in the window switcher is not nicely aligned. Try using a mono-space font.
The window is completely black. Check quotes used on the command-line: you might have used “ ("smart quotes") instead of " ("machine quotes").
What does the icon in the top right show? The indicator shows:
` ` Case insensitive and no sorting. `-` Case sensitivity enabled, no sorting. `+` Case insensitive and Sorting enabled `±` Sorting and Case sensitivity enabled"
Some basic usage examples of rofi:
Show the run dialog:
rofi -modi run -show run
Show the run dialog, and allow switching to Desktop File run dialog (drun):
rofi -modi run,drun -show run
Combine the run and Desktop File run dialog (drun):
rofi -modi combi -show combi -combi-modi run,drun
Combine the run and Desktop File run dialog (drun), and allow switching to window switcher:
rofi -modi combi,window -show combi -combi-modi run,drun
Pop up a text message claiming that this is the end:
rofi -e "This is the end"
Pop up a text message in red, bold font claiming that this is still the end:
rofi -e "<span color='red'><b>This is still the end</b></span>" -markup
Show all key bindings:
rofi -show keys
Use qalc to get a simple calculator in rofi:
rofi -show calc -modi "calc:qalc +u8 -nocurrencies"
i3 In i3 ⟨http://i3wm.org/⟩ you want to bind rofi to be launched on key release. Otherwise, it cannot grab the keyboard.  See also the i3 manual ⟨http://i3wm.org/docs/userguide.html⟩:
Some tools (such as import or xdotool) might be unable to run upon a KeyPress event, because the keyboard/pointer is still grabbed. For these situations, the --release flag can be used, as it will execute the command after the keys have been released.
rofi website can be found here ⟨https://davedavenport.github.io/rofi/⟩
rofi support can be obtained: * GitHub Discussions ⟨https://github.com/davatorium/rofi/discussions⟩ * Forum (Reddit) ⟨https://reddit.com/r/qtools//⟩ * IRC ⟨irc://irc.libera.chat:6697/#rofi⟩ (#rofi on irc.libera.chat),
To debug, it is smart to first try disabling your custom configuration: -no-config
Disable parsing of configuration. This runs rofi in stock mode.
If you run custom C plugins, you can disable them using:
Disables the loading of plugins.
To further debug the plugin, you can get a trace with (lots of) debug information.  This debug output can be enabled for multiple parts in rofi using the glib debug framework. Debug domains can be enabled by setting the G_MESSAGES_DEBUG environment variable. At the time of creation of this page, the following debug domains exist:
• all: Show debug information from all domains.
• X11Helper: The X11 Helper functions.
• View: The main window view functions.
• Widgets.Box: The Box widget.
• Dialogs.DMenu: The dmenu mode.
• Dialogs.Run: The run mode.
• Dialogs.DRun: The desktop file run mode.
• Dialogs.Window: The window mode.
• Dialogs.Script: The script mode.
• Dialogs.Combi: The script mode.
• Dialogs.Ssh: The ssh mode.
• Rofi: The main application.
• Timings: Get timing output.
• Theme: Theme engine debug output. (warning lots of output).
• Widgets.Icon: The Icon widget.
• Widgets.Box: The box widget.
• Widgets.Container: The container widget.
• Widgets.Window: The window widget.
• Helpers.IconFetcher: Information about icon lookup.
The output of this can provide useful information when writing an issue.
More information (possibly outdated) see this ⟨https://github.com/DaveDavenport/rofi/wiki/Debugging%20Rofi⟩ wiki entry.
The rofi issue tracker can be found here ⟨https://github.com/DaveDavenport/rofi/issues⟩
When creating an issue, please read this ⟨https://github.com/DaveDavenport/rofi/blob/master/.github/CONTRIBUTING.md⟩ first.
rofi-sensible-terminal(1), dmenu(1), rofi-theme(5), rofi-script(5), rofi-theme-selector(1)
• Qball Cow qball@blame.services ⟨mailto:qball@blame.services⟩
• Rasmus Steinke rasi@xssn.at ⟨mailto:rasi@xssn.at⟩
• Quentin Glidic sardemff7+rofi@sardemff7.net ⟨mailto:sardemff7+rofi@sardemff7.net⟩
Original code based on work by: Sean Pringle ⟨https://github.com/seanpringle/simpleswitcher⟩ sean.pringle@gmail.com ⟨mailto:sean.pringle@gmail.com⟩
For a full list of authors, check the AUTHORS file.
srun(1)                          Slurm Commands                          srun(1)
srun - Run parallel jobs
srun [OPTIONS(0)... [executable(0) [args(0)...]]] [ : [OPTIONS(N)...]] executable(N) [args(N)...]
Run a parallel job on cluster managed by Slurm.  If necessary, srun will first create a resource allocation in which to run the parallel job.
srun will return the highest exit code of all tasks run or the highest signal (with the high-order bit set in an 8-bit integer -- e.g. 128 + signal) of any task that exited with a signal. The value 253 is reserved for out-of-memory errors.
The executable is resolved in the following order:
1. If executable starts with ".", then path is constructed as: current working directory / executable 2. If executable starts with a "/", then path is considered absolute. 3. If executable can be resolved through PATH. See path_resolution(7). 4. If executable is in current working directory.
--accel-bind=<options> Control how tasks are bound to generic resources of type gpu, mic and nic.  Multiple options may be specified. Supported options include:
g      Bind each task to GPUs which are closest to the allocated CPUs.
m      Bind each task to MICs which are closest to the allocated CPUs.
n      Bind each task to NICs which are closest to the allocated CPUs.
v      Verbose mode. Log how tasks are bound to GPU and NIC devices.
This option applies to job allocations.
-A, --account=<account> Charge resources used by this job to specified account.  The account is an arbitrary string. The account name may be changed after job submission using the scontrol command. This option applies to job allocations.
--acctg-freq Define the job accounting and profiling sampling intervals.  This can be used to override the JobAcctGatherFrequency parameter in Slurm's configuration file, slurm.conf.  The supported format is follows:
The default value for the task sampling interval is 30. The default value for all other intervals is 0.  An interval of 0 disables sampling of the specified type.  If the task sampling interval is 0, accounting information is collected only at job termination (reducing Slurm interference with the job). Smaller (non-zero) values have a greater impact upon job performance, but a value of 30 seconds is not likely to be noticeable for applications having less than 10,000 tasks. This option applies job allocations.
-B --extra-node-info=<sockets[:cores[:threads]]> Restrict node selection to nodes with at least the specified number of sockets, cores per socket and/or threads per core. NOTE: These options do not specify the resource allocation size. Each value specified is considered a minimum.  An asterisk (*) can be used as a placeholder indicating that all available resources of that type are to be utilized. Values can also be specified as min-max. The individual levels can also be specified in separate options if desired: --sockets-per-node=<sockets> --cores-per-socket=<cores> --threads-per-core=<threads> If task/affinity plugin is enabled, then specifying an allocation in this manner also sets a default --cpu-bind option of threads if the -B option specifies a thread count, otherwise an option of cores if a core count is specified, otherwise an option of sockets.  If SelectType is configured to select/cons_res, it must have a parameter of CR_Core, CR_Core_Memory, CR_Socket, or CR_Socket_Memory for this option to be honored.  If not specified, the scontrol show job will display 'ReqS:C:T=*:*:*'. This option applies to job allocations.  NOTE: This option is mutually exclusive with --hint, --threads-per-core and --ntasks-per-core.
--bb=<spec> Burst buffer specification. The form of the specification is system dependent.  Also see --bbf. This option applies to job allocations.
--bbf=<file_name> Path of file containing burst buffer specification.  The form of the specification is system dependent.  Also see --bb. This option applies to job allocations.
--bcast[=<dest_path>] Copy executable file to allocated compute nodes.  If a file name is specified, copy the executable to the specified destination file path.  If the path specified ends with '/' it is treated as a target directory, and the destination file name will be slurm_bcast_<job_id>.<step_id>_<nodename>.  If no dest_path is specified, then the current working directory is used, and the filename follows the above pattern.  For example, "srun --bcast=/tmp/mine -N3 a.out" will copy the file "a.out" from your current directory to the file "/tmp/mine" on each of the three allocated compute nodes and execute that file. This option applies to step allocations.
-b, --begin=<time> Defer initiation of this job until the specified time.  It accepts times of the form HH:MM:SS to run a job at a specific time of day (seconds are optional).  (If that time is already past, the next day is assumed.)  You may also specify midnight, noon, fika (3 PM) or teatime (4 PM) and you can have a time-of-day suffixed with AM or PM for running in the morning or the evening.  You can also say what day the job will be run, by specifying a date of the form MMDDYY or MM/DD/YY YYYY-MM-DD. Combine date and time using the following format YYYY-MM-DD[THH:MM[:SS]]. You can also give times like now + count time-units, where the time-units can be seconds (default), minutes, hours, days, or weeks and you can tell Slurm to run the job today with the keyword today and to run the job tomorrow with the keyword tomorrow.  The value may be changed after job submission using the scontrol command.  For example: --begin=16:00 --begin=now+1hour --begin=now+60           (seconds by default) --begin=2010-01-20T12:34:00
Notes on date/time specifications: - Although the 'seconds' field of the HH:MM:SS time specification is allowed by the code, note that the poll time of the Slurm scheduler is not precise enough to guarantee dispatch of the job on the exact second.  The job will be eligible to start on the next poll following the specified time. The exact poll interval depends on the Slurm scheduler (e.g., 60 seconds with the default sched/builtin). - If no time (HH:MM:SS) is specified, the default is (00:00:00). - If a date is specified without a year (e.g., MM/DD) then the current year is assumed, unless the combination of MM/DD and HH:MM:SS has already passed for that year, in which case the next year is used. This option applies to job allocations.
--cluster-constraint=<list> Specifies features that a federated cluster must have to have a sibling job submitted to it. Slurm will attempt to submit a sibling job to a cluster if it has at least one of the specified features.
--comment=<string> An arbitrary comment. This option applies to job allocations.
--compress[=type] Compress file before sending it to compute hosts.  The optional argument specifies the data compression library to be used. Supported values are "lz4" (default) and "zlib".  Some compression libraries may be unavailable on some systems.  For use with the --bcast option. This option applies to step allocations.
WARNING: When srun is executed from within salloc or sbatch, the constraint value can only contain a single feature name. None of the other operators are currently supported for job steps. This option applies to job and step allocations.
NOTE: If SelectPlugin=cons_res this option won't be honored with the topology/tree or topology/3d_torus plugins, both of which can modify the node ordering. This option applies to job allocations.
--cores-per-socket=<cores> Restrict node selection to nodes with at least the specified number of cores per socket.  See additional information under -B option above when task/affinity plugin is enabled. This option applies to job allocations.
--cpu-bind=[{quiet,verbose},]type Bind tasks to CPUs.  Used only when the task/affinity or task/cgroup plugin is enabled.  NOTE: To have Slurm always report on the selected CPU binding for all commands executed in a shell, you can enable verbose mode by setting the SLURM_CPU_BIND environment variable value to "verbose".
The following informational environment variables are set when --cpu-bind is in use: SLURM_CPU_BIND_VERBOSE SLURM_CPU_BIND_TYPE SLURM_CPU_BIND_LIST
See the ENVIRONMENT VARIABLES section for a more detailed description of the individual SLURM_CPU_BIND variables. These variable are available only if the task/affinity plugin is configured.
When using --cpus-per-task to run multithreaded tasks, be aware that CPU binding is inherited from the parent of the process. This means that the multithreaded task should either specify or clear the CPU binding itself to avoid having all threads of the multithreaded task use the same mask/CPU as the parent. Alternatively, fat masks (masks which specify more than one allowed CPU) could be used for the tasks in order to provide multiple CPUs for the multithreaded tasks.
Note that a job step can be allocated different numbers of CPUs on each node or be allocated CPUs not starting at location zero. Therefore one of the options which automatically generate the task binding is recommended.  Explicitly specified masks or bindings are only honored when the job step has been allocated every available CPU on the node.
Binding a task to a NUMA locality domain means to bind the task to the set of CPUs that belong to the NUMA locality domain or "NUMA node".  If NUMA locality domain options are used on systems with no NUMA support, then each socket is considered a locality domain.
If the --cpu-bind option is not used, the default binding mode will depend upon Slurm's configuration and the step's resource allocation.  If all allocated nodes have the same configured CpuBind mode, that will be used.  Otherwise if the job's Partition has a configured CpuBind mode, that will be used.  Otherwise if Slurm has a configured TaskPluginParam value, that mode will be used.  Otherwise automatic binding will be performed as described below.
Auto Binding Applies only when task/affinity is enabled. If the job step allocation includes an allocation with a number of sockets, cores, or threads equal to the number of tasks times cpus-per-task, then the tasks will by default be bound to the appropriate resources (auto binding). Disable this mode of operation by explicitly setting "--cpu-bind=none". Use TaskPluginParam=autobind=[threads|cores|sockets] to set a default cpu binding in case "auto binding" doesn't find a match.
q[uiet] Quietly bind before task runs (default)
v[erbose] Verbosely report binding before task runs
no[ne] Do not bind tasks to CPUs (default unless auto binding is applied)
rank   Automatically bind by task rank.  The lowest numbered task on each node is bound to socket (or core or thread) zero, etc.  Not supported unless the entire node is allocated to the job.
map_cpu:<list> Bind by setting CPU masks on tasks (or ranks) as specified where <list> is <cpu_id_for_task_0>,<cpu_id_for_task_1>,...  CPU IDs are interpreted as decimal values unless they are preceded with '0x' in which case they interpreted as hexadecimal values.  If the number of tasks (or ranks) exceeds the number of elements in this list, elements in the list will be reused as needed starting from the beginning of the list.  To simplify support for large task counts, the lists may follow a map with an asterisk and repetition count.  For example "map_cpu:0x0f*4,0xf0*4".  Not supported unless the entire node is allocated to the job.
mask_cpu:<list> Bind by setting CPU masks on tasks (or ranks) as specified where <list> is <cpu_mask_for_task_0>,<cpu_mask_for_task_1>,...  The mapping is specified for a node and identical mapping is applied to the tasks on every node (i.e. the lowest task ID on each node is mapped to the first mask specified in the list, etc.).  CPU masks are always interpreted as hexadecimal values but can be preceded with an optional '0x'.  If the number of tasks (or ranks) exceeds the number of elements in this list, elements in the list will be reused as needed starting from the beginning of the list.  To simplify support for large task counts, the lists may follow a map with an asterisk and repetition count.  For example "mask_cpu:0x0f*4,0xf0*4".  Not supported unless the entire node is allocated to the job.
rank_ldom Bind to a NUMA locality domain by rank. Not supported unless the entire node is allocated to the job.
map_ldom:<list> Bind by mapping NUMA locality domain IDs to tasks as specified where <list> is <ldom1>,<ldom2>,...<ldomN>.  The locality domain IDs are interpreted as decimal values unless they are preceded with '0x' in which case they are interpreted as hexadecimal values.  Not supported unless the entire node is allocated to the job.
mask_ldom:<list> Bind by setting NUMA locality domain masks on tasks as specified where <list> is <mask1>,<mask2>,...<maskN>.  NUMA locality domain masks are always interpreted as hexadecimal values but can be preceded with an optional '0x'.  Not supported unless the entire node is allocated to the job.
sockets Automatically generate masks binding tasks to sockets.  Only the CPUs on the socket which have been allocated to the job will be used.  If the number of tasks differs from the number of allocated sockets this can result in sub-optimal binding.
cores  Automatically generate masks binding tasks to cores. If the number of tasks differs from the number of allocated cores this can result in sub-optimal binding.
threads Automatically generate masks binding tasks to threads.  If the number of tasks differs from the number of allocated threads this can result in sub-optimal binding.
ldoms  Automatically generate masks binding tasks to NUMA locality domains.  If the number of tasks differs from the number of allocated locality domains this can result in sub-optimal binding.
boards Automatically generate masks binding tasks to boards.  If the number of tasks differs from the number of allocated boards this can result in sub-optimal binding. This option is supported by the task/cgroup plugin only.
help   Show help message for cpu-bind
This option applies to job and step allocations.
Request that the job step initiated by this srun command be run at some requested frequency if possible, on the CPUs selected for the step on the compute node(s).
-c, --cpus-per-task=<ncpus> Request that ncpus be allocated per process. This may be useful if the job is multithreaded and requires more than one CPU per task for optimal performance. The default is one CPU per process.  If -c is specified without -n, as many tasks will be allocated per node as possible while satisfying the -c restriction. For instance on a cluster with 8 CPUs per node, a job request for 4 nodes and 3 CPUs per task may be allocated 3 or 6 CPUs per node (1 or 2 tasks per node) depending upon resource consumption by other jobs. Such a job may be unable to execute more than a total of 4 tasks.
WARNING: There are configurations and options interpreted differently by job and job step requests which can result in inconsistencies for this option.  For example srun -c2 --threads-per-core=1 prog may allocate two cores for the job, but if each of those cores contains two threads, the job allocation will include four CPUs. The job step allocation will then launch two threads per CPU for a total of two tasks.
WARNING: When srun is executed from within salloc or sbatch, there are configurations and options which can result in inconsistent allocations when -c has a value greater than -c on salloc or sbatch.
This option applies only to job allocations.
-d, --dependency=<dependency_list> Defer the start of this job until the specified dependencies have been satisfied completed. This option does not apply to job steps (executions of srun within an existing salloc or sbatch allocation) only to job allocations.  <dependency_list> is of the form <type:job_id[:job_id][,type:job_id[:job_id]]> or <type:job_id[:job_id][?type:job_id[:job_id]]>.  All dependencies must be satisfied if the "," separator is used.  Any dependency may be satisfied if the "?" separator is used.  Only one separator may be used.  Many jobs can share the same dependency and these jobs may even belong to different  users. The  value may be changed after job submission using the scontrol command. Dependencies on remote jobs are allowed in a federation.  Once a job dependency fails due to the termination state of a preceding job, the dependent job will never be run, even if the preceding job is requeued and has a different termination state in a subsequent execution. This option applies to job allocations.
-D, --chdir=<path> Have the remote processes do a chdir to path before beginning execution. The default is to chdir to the current working directory of the srun process. The path can be specified as full path or relative path to the directory where the command is executed. This option applies to job allocations.
-e, --error=<filename pattern> Specify how stderr is to be redirected. By default in interactive mode, srun redirects stderr to the same file as stdout, if one is specified. The --error option is provided to allow stdout and stderr to be redirected to different locations.  See IO Redirection below for more options.  If the specified file already exists, it will be overwritten. This option applies to job and step allocations.
-E, --preserve-env Pass the current values of environment variables SLURM_JOB_NODES and SLURM_NTASKS through to the executable, rather than computing them from commandline parameters. This option applies to job allocations.
--exact Allow a step access to only the resources requested for the step. By default, all non-GRES resources on each node in the step allocation will be used. Note that no other parallel step will have access to those resources unless --overlap is specified. This option applies to step allocations.
--epilog=<executable> srun will run executable just after the job step completes.  The command line arguments for executable will be the command and arguments of the job step.  If executable is "none", then no srun epilog will be run. This parameter overrides the SrunEpilog parameter in slurm.conf. This parameter is completely independent from the Epilog parameter in slurm.conf. This option applies to job allocations.
--exclusive[=user|mcs] This option applies to job and job step allocations, and has two slightly different meanings for each one.  When used to initiate a job, the job allocation cannot share nodes with other running jobs (or just other users with the "=user" option or "=mcs" option). The default shared/exclusive behavior depends on system configuration and the partition's OverSubscribe option takes precedence over the job's option.
This option can also be used when initiating more than one job step within an existing resource allocation (default), where you want separate processors to be dedicated to each job step. If sufficient processors are not available to initiate the job step, it will be deferred. This can be thought of as providing a mechanism for resource management to the job within its allocation (--exact implied).
The exclusive allocation of CPUs applies to job steps by default. In order to share the resources use the --overlap option.
See EXAMPLE below.
--export=<[ALL,]environment variables|ALL|NONE> Identify which environment variables from the submission environment are propagated to the launched application.
--export=ALL Default mode if --export is not specified. All of the users environment will be loaded from callers environment.
--export=NONE None of the user environment will be defined. User must use absolute path to the binary to be executed that will define the environment. User can not specify explicit environment variables with NONE. This option is particularly important for jobs that are submitted on one cluster and execute on a different cluster (e.g. with different paths).  To avoid steps inheriting environment export settings (e.g. NONE) from sbatch command, either set --export=ALL or the environment variable SLURM_EXPORT_ENV should be set to ALL.
--export=<[ALL,]environment variables> Exports all SLURM* environment variables along with explicitly defined variables. Multiple environment variable names should be comma separated.  Environment variable names may be specified to propagate the current value (e.g. "--export=EDITOR") or specific values may be exported (e.g. "--export=EDITOR=/bin/emacs"). If ALL is specified, then all user environment variables will be loaded and will take precedence over any explicitly given environment variables.