diff options
| author | bptato <nincsnevem662@gmail.com> | 2023-09-20 01:40:29 +0200 |
|---|---|---|
| committer | bptato <nincsnevem662@gmail.com> | 2023-09-20 01:40:29 +0200 |
| commit | 24162bb4dc813f36f411cb262e51169d7d31bc43 (patch) | |
| tree | 3e64f5125b62c4826e549ce320502ae4303d3a5f /doc | |
| parent | 2539db24ab3481fd96129650eb2a206e01ab5bfc (diff) | |
| download | chawan-24162bb4dc813f36f411cb262e51169d7d31bc43.tar.gz | |
document pager.extern
it's better than nothing, maybe?
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/config.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/config.md b/doc/config.md index 114a8152..029f9a8a 100644 --- a/doc/config.md +++ b/doc/config.md @@ -882,6 +882,19 @@ q = 'pager.ask("Do you want to exit Chawan?").then(x => x ? pager.quit() : void( </td> </tr> +<tr> +<td>`pager.extern(cmd, options = {setenv: true, suspend: true, wait: false})` +</td> +<td>Run an external command `cmd`. The `$CHA_URL` and `$CHA_CHARSET` variables +are set when `options.setenv` is true. `options.suspend` suspends the pager +while the command is being executed, and `options.wait` makes it so the user +must press a key before the pager is resumed.<br> +Returns true if the command exit successfully, false otherwise.<br> +Warning: this has a bug where the output is written to stdout even if suspend +is true. Redirect to /dev/null in the command if this is not desired. (This +will be fixed in the future.)</td> +</tr> + </table> |