diff runtime/doc/channel.txt @ 10147:65afd399ffa7 v7.4.2344

commit https://github.com/vim/vim/commit/169ebb080454357279ad5ad21ac532deaec605e8 Author: Bram Moolenaar <Bram@vim.org> Date: Wed Sep 7 23:32:23 2016 +0200 patch 7.4.2344 Problem: The "Reading from channel output..." message can be unwanted. Appending to a buffer leaves an empty first line behind. Solution: Add the "out_msg" and "err_msg" options. Writing the first line overwrites the first, empty line.
author Christian Brabandt <cb@256bit.org>
date Wed, 07 Sep 2016 23:45:05 +0200
parents d4b7232fc63a
children 01521953bdf1
line wrap: on
line diff
--- a/runtime/doc/channel.txt
+++ b/runtime/doc/channel.txt
@@ -1,4 +1,4 @@
-*channel.txt*      For Vim version 7.4.  Last change: 2016 Sep 01
+*channel.txt*      For Vim version 7.4.  Last change: 2016 Sep 07
 
 
 		  VIM REFERENCE MANUAL	  by Bram Moolenaar
@@ -646,6 +646,8 @@ See |job_setoptions()| and |ch_setoption
 "out_buf": number	the number of the buffer to write to
 "out_modifiable": 0	when writing to a buffer, 'modifiable' will be off
 			(see below)
+"out_msg": 0		when writing to a new buffer, the first line will be
+			set to "Reading from channel output..."
 
 				*job-err_io* *err_name* *err_buf*
 "err_io": "out"		stderr messages to go to stdout
@@ -657,6 +659,8 @@ See |job_setoptions()| and |ch_setoption
 "err_buf": number	the number of the buffer to write to
 "err_modifiable": 0	when writing to a buffer, 'modifiable' will be off
 			(see below)
+"err_msg": 0		when writing to a new buffer, the first line will be
+			set to "Reading from channel error..."
 
 "block_write": number	only for testing: pretend every other write to stdin
 			will block
@@ -686,8 +690,16 @@ buffer number.
 
 For a new buffer 'buftype' is set to "nofile" and 'bufhidden' to "hide".  If
 you prefer other settings, create the buffer first and pass the buffer number.
+					*out_modifiable* *err_modifiable*
+The "out_modifiable" and "err_modifiable" options can be used to set the
+'modifiable' option off, or write to a buffer that has 'modifiable' off.  That
+means that lines will be appended to the buffer, but the user can't easily
+change the buffer.
+					*out_msg* *err_msg*
+The "out_msg" option can be used to specify whether a new buffer will have the
+first line set to "Reading from channel output...".  The default is to add the
+message.  "err_msg" does the same for channel error.
 
-The "out_modifiable" and "err_modifiable" options can be used to set the
 'modifiable' option off, or write to a buffer that has 'modifiable' off.  That
 means that lines will be appended to the buffer, but the user can't easily
 change the buffer.