Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help 
rofi-actions(5)		      File Formats Manual	       rofi-actions(5)

NAME
       rofi-actions - Custom commands following	interaction with rofi menus

DESCRIPTION
       rofi  allows to set custom commands or scripts to be executed when some
       actions are performed in	the menu, such as changing selection,  accept-
       ing an entry or canceling.

       This  makes it possible for example to play sound effects or read aloud
       menu entries on selection.

USAGE
       Following is the	list of	rofi flags for specifying custom  commands  or
       scripts to execute on supported actions:

       -on-selection-changed cmd
	      Command  or  script  to  run when	the current selection changes.
	      Selected text is forwarded to the	command	replacing the  pattern
	      {entry}.

       -on-entry-accepted cmd
	      Command  or  script  to  run when	a menu entry is	accepted.  Ac-
	      cepted text is forwarded to the command  replacing  the  pattern
	      {entry}.

       -on-mode-changed	cmd
	      Command  or  script  to  run  when the menu mode (e.g. drun,win-
	      dow,ssh...)  is changed.

       -on-menu-canceled cmd
	      Command or script	to run when the	menu is	canceled.

       -on-menu-error cmd
	      Command or script	to run when an error menu is shown  (e.g. rofi
	      -e "error	message").  Error text is forwarded to the command re-
	      placing the pattern {error}.

       -on-screenshot-taken cmd
	      Command  or  script  to  run when	a screenshot of	rofi is	taken.
	      Screenshot path is forwarded to the command replacing  the  pat-
	      tern {path}.

   Example usage
       Rofi command line:

	      rofi -on-selection-changed "/path/to/select.sh {entry}" \
		   -on-entry-accepted "/path/to/accept.sh {entry}" \
		   -on-menu-canceled "/path/to/exit.sh"	\
		   -on-mode-changed "/path/to/change.sh" \
		   -on-menu-error "/path/to/error.sh {error}" \
		   -on-screenshot-taken	"/path/to/camera.sh {path}" \
		   -show drun

       Rofi config file:

	      configuration {
		  on-selection-changed:	"/path/to/select.sh {entry}";
		  on-entry-accepted: "/path/to/accept.sh {entry}";
		  on-menu-canceled: "/path/to/exit.sh";
		  on-mode-changed: "/path/to/change.sh";
		  on-menu-error: "/path/to/error.sh {error}";
		  on-screenshot-taken: "/path/to/camera.sh {path}";
	      }

   Play	sound effects
       Here's  an  example  bash  script that plays a sound effect using aplay
       when the	current	selection is changed:

	      #!/bin/bash

	      coproc aplay -q $HOME/Music/selecting_an_item.wav

       The use of coproc for playing sounds is suggested, otherwise  the  rofi
       process will wait for sounds to end playback before exiting.

   Read	aloud
       Here's  an  example bash	script that reads aloud	currently selected en-
       tries using espeak:

	      #!/bin/bash

	      killall espeak
	      echo "selected: $@" | espeak

rofi							       rofi-actions(5)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=rofi-actions&sektion=5&manpath=FreeBSD+Ports+15.1.quarterly>

home | help