Skip to content

Commit 6f3470c

Browse files
author
skywind3000
committed
update doc
1 parent e6ad44a commit 6f3470c

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -173,20 +173,20 @@ There can be some options before your `[cmd]`:
173173
| `-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. |
174174
| `-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. |
175175
| `-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). |
177177
| `-post=?` | `unset` | vimscript to exec after job finished, spaces **must** be escaped to '\ ' |
178178
| `-auto=?` | `unset` | event name to trigger `QuickFixCmdPre`/`QuickFixCmdPost` [name] autocmd. |
179179
| `-raw` | `unset` | use raw output if provided, and `&errorformat` will be ignored. |
180180
| `-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. |
182182
| `-rows=num` | 0 | When using a horizontal split terminal, this value represents the height of terminal window. |
183183
| `-cols=num` | 0 | When using a vertical split terminal, this value represents the width of terminal window. |
184184
| `-errorformat=?` | `unset` | errorformat for error matching, if it is unprovided, use current `&errorformat` value. Beware that `%` needs to be escaped into `\%`. |
185185
| `-focus=?` | 1 | set to `0` to prevent focus changing when `-mode=term` |
186186
| `-hidden=?` | 0 | set to `1` to setup `bufhidden` to `hide` for internal terminal |
187187
| `-silent` | `unset` | provide `-silent` to prevent open quickfix window (will override `g:asyncrun_open` temporarily) |
188188

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.
190190

191191
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".
192192

doc/asyncrun.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -152,12 +152,12 @@ There can be some options before your `[cmd]`:
152152
- `-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.
153153
- `-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.
154154
- `-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).
156156
- `-post=?`: vimscript to exec after job finished, spaces **must** be escaped to '\ '
157157
- `-auto=?`: event name to trigger `QuickFixCmdPre`/`QuickFixCmdPost` [name] autocmd.
158158
- `-raw`: use raw output if provided, and `&errorformat` will be ignored.
159159
- `-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.
161161
- `-rows=num`: When using a horizontal split terminal, this value represents the height of terminal window.
162162
- `-cols=num`: When using a vertical split terminal, this value represents the width of terminal window.
163163
- `-errorformat=?`: errorformat for error matching, if it is unprovided, use current `&errorformat` value. Beware that `%` needs to be escaped into `\%`.

0 commit comments

Comments
 (0)