You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -173,20 +173,20 @@ There can be some options before your `[cmd]`:
173
173
|`-mode=?`| "async" | specify how to run the command as `-mode=?`, available modes are `"async"` (default), `"bang"` (with `!` command) and `"terminal"` (in internal terminal), see [running modes](#running-modes) for details. |
174
174
|`-cwd=?`|`unset`| initial directory (use current directory if unset), for example use `-cwd=<root>` to run commands in [project root directory](#project-root), or `-cwd=$(VIM_FILEDIR)` to run commands in current buffer's parent directory. |
175
175
|`-save=?`| 0 | use `-save=1` to save current file, `-save=2` to save all modified files before executing. |
176
-
|`-program=?`|`unset`| set to `make` to use `&makeprg`, `grep` to use `&grepprt` and `wsl` to execute commands in WSL (windows 10), see [command modifiers](https://github.com/skywind3000/asyncrun.vim/wiki/Command-Modifier). |
176
+
|`-program=?`|`unset`| set to `make` to use `&makeprg`, `grep` to use `&grepprt` and `wsl` to execute commands in WSL (windows 10), see [command modifiers](#command-modifier). |
177
177
|`-post=?`|`unset`| vimscript to exec after job finished, spaces **must** be escaped to '\ ' |
178
178
|`-auto=?`|`unset`| event name to trigger `QuickFixCmdPre`/`QuickFixCmdPost`[name] autocmd. |
179
179
|`-raw`|`unset`| use raw output if provided, and `&errorformat` will be ignored. |
180
180
|`-strip`|`unset`| remove the heading/trailing messages if provided (omit command and "[Finished in ...]" message). |
181
-
|`-pos=?`| "bottom" | When using internal terminal with `-mode=term`, `-pos` is used to specify where to split the terminal window, it can be one of `"tab"`, `"curwin"`, `"top"`, `"bottom"`, `"left"`, `"right"` and `"external"`. And you can [customize new runners](https://github.com/skywind3000/asyncrun.vim/wiki/Customize-Runner) and pass runner's name to `-pos` option. |
181
+
|`-pos=?`| "bottom" | When using internal terminal with `-mode=term`, `-pos` is used to specify where to split the terminal window, it can be one of `"tab"`, `"curwin"`, `"top"`, `"bottom"`, `"left"`, `"right"` and `"external"`. And you can [customize new runners](#customize-runner) and pass runner's name to `-pos` option. |
182
182
|`-rows=num`| 0 | When using a horizontal split terminal, this value represents the height of terminal window. |
183
183
|`-cols=num`| 0 | When using a vertical split terminal, this value represents the width of terminal window. |
184
184
|`-errorformat=?`|`unset`| errorformat for error matching, if it is unprovided, use current `&errorformat` value. Beware that `%` needs to be escaped into `\%`. |
185
185
|`-focus=?`| 1 | set to `0` to prevent focus changing when `-mode=term`|
186
186
|`-hidden=?`| 0 | set to `1` to setup `bufhidden` to `hide` for internal terminal |
187
187
|`-silent`|`unset`| provide `-silent` to prevent open quickfix window (will override `g:asyncrun_open` temporarily) |
188
188
189
-
All options must start with a minus and position **before**`[cmd]`. Since no shell command string starts with a minus. So they can be distinguished from shell command easily without any ambiguity.
189
+
All options must start with a minus and position **before**`[cmd]`. Since no shell command string starts with a minus. So they can be distinguished from shell command easily without any ambiguity.
190
190
191
191
Don't worry if you do have a shell command starting with '-', Just put a placeholder `@` before your command to tell asyncrun explicitly: "stop parsing options now, the following string is all my command".
Copy file name to clipboardExpand all lines: doc/asyncrun.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -152,12 +152,12 @@ There can be some options before your `[cmd]`:
152
152
-`-mode=?`: specify how to run the command as `-mode=?`, available modes are `"async"` (default), `"bang"` (with `!` command) and `"terminal"` (in internal terminal), see [running modes](#running-modes) for details.
153
153
-`-cwd=?`: initial directory (use current directory if unset), for example use `-cwd=<root>` to run commands in [project root directory](#project-root), or `-cwd=$(VIM_FILEDIR)` to run commands in current buffer's parent directory.
154
154
-`-save=?`: use `-save=1` to save current file, `-save=2` to save all modified files before executing.
155
-
-`-program=?`: set to `make` to use `&makeprg`, `grep` to use `&grepprt` and `wsl` to execute commands in WSL (windows 10), see [command modifiers](https://github.com/skywind3000/asyncrun.vim/wiki/Command-Modifier).
155
+
-`-program=?`: set to `make` to use `&makeprg`, `grep` to use `&grepprt` and `wsl` to execute commands in WSL (windows 10), see [command modifiers](#command-modifier).
156
156
-`-post=?`: vimscript to exec after job finished, spaces **must** be escaped to '\ '
157
157
-`-auto=?`: event name to trigger `QuickFixCmdPre`/`QuickFixCmdPost`[name] autocmd.
158
158
-`-raw`: use raw output if provided, and `&errorformat` will be ignored.
159
159
-`-strip`: remove the heading/trailing messages if provided (omit command and "[Finished in ...]" message).
160
-
-`-pos=?`: When using internal terminal with `-mode=term`, `-pos` is used to specify where to split the terminal window, it can be one of `"tab"`, `"curwin"`, `"top"`, `"bottom"`, `"left"`, `"right"` and `"external"`. And you can [customize new runners](https://github.com/skywind3000/asyncrun.vim/wiki/Customize-Runner) and pass runner's name to `-pos` option.
160
+
-`-pos=?`: When using internal terminal with `-mode=term`, `-pos` is used to specify where to split the terminal window, it can be one of `"tab"`, `"curwin"`, `"top"`, `"bottom"`, `"left"`, `"right"` and `"external"`. And you can [customize new runners](#customize-runner) and pass runner's name to `-pos` option.
161
161
-`-rows=num`: When using a horizontal split terminal, this value represents the height of terminal window.
162
162
-`-cols=num`: When using a vertical split terminal, this value represents the width of terminal window.
163
163
-`-errorformat=?`: errorformat for error matching, if it is unprovided, use current `&errorformat` value. Beware that `%` needs to be escaped into `\%`.
0 commit comments