Options

Option Summary

• g:asyncrun_exit - script will be executed after finished
• g:asyncrun_mode - 0:async(require vim 7.4.1829) 1:sync 2:shell
• g:asyncrun_bell - non-zero to ring a bell after finished
• g:asyncrun_open - above zero to open quickfix window at given height after command starts
• g:asyncrun_wrapper - enable to setup a command prefix
• g:asyncrun_encs - set shell encoding if it's different from &encoding
• g:asyncrun_trim - non-zero to trim the empty lines in the quickfix window.
• g:asyncrun_auto - event name to trigger QuickFixCmdPre/QuickFixCmdPost, see FAQ
• g:asyncrun_timer - how many messages should be inserted into quickfix every 100ms interval

Option Details

g:asyncrun_exit

define a script which will be executed after finished.

• type: string
• default: ''

A text of vimscript to run when job finished. eg:

let g:asyncrun_exit = "silent call system('afplay ~/.vim/notify.wav &')"

You can play a sound on Mac OS X when job finished like this.

g:asyncrun_mode

This option indicates how to start the job.

• type: integer
• default: 0

available modes:

• 0: start job asynchronously.
• 1: start job with make system in vim.
• 2: start job by using ! command.
• 3: start job in the background, no output to quickfix (+python or +python3 is required on windows).
• 4: start job in a new terminal window on windows.

Mode 0 will fall-back to 1 if you are using an old vim before version 8 or built without +job or +timers.

g:asyncrun_bell

• type: integer
• default: 0

Ring the bell if set it to non-zero.

g:asyncrun_wrapper

This can be used to setup a command prefix.

• type: string
• default: ''

eg:

Prefix your command with a nice command:

let g:asyncrun_wrapper = 'nice -n5'

If you config it to nice -n5, when you use :AsyncRun make, the actual command becomes nice -n5 make.

Using powershell on windows:

let g:asyncrun_wrapper = 'powershell -command'

Then, powershell is used to execute your command on windows.

g:asyncrun_open

If it is above zero, the quickfix window will be open automatically at given height after command starts.

• type: integer
• default: 0

eg:

let g:asyncrun_open = 6

This will open the quickfix window autoomatically when you use AsyncRun command.

g:asyncrun_encs

Job stdout/stderr encoding

• type: string
• default: ''

If your system's default encoding is different from vim's encoding, you can use this to tell vim what encoding are you using in the shell environment. for example, if Chinese / Japanese / Latin characters can't be display correctly in the quickfix window. see encoding

g:asyncrun_trim

• type: integer
• default: ''

non-zero to trim the empty lines in the quickfix window.