Vim Tips Wiki
We recommend that you log in before editing. This will allow other users to leave you a message about your edit, and will let you track edits via your Watchlist. Creating an account is quick and free.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.

Latest revision Your text
Line 4: Line 4:
 
|previous=94
 
|previous=94
 
|next=96
 
|next=96
|created=2001
+
|created=August 7, 2001
 
|complexity=intermediate
 
|complexity=intermediate
|author=
+
|author=Anonymous
|version=7.0
+
|version=6.0
 
|rating=88/31
 
|rating=88/31
|category1=Tabs
 
|category2=
 
 
}}
 
}}
Ever want to capture the output of an ex command like <code>:set all</code> into a Vim text buffer for easy viewing? This is actually a very easy thing to accomplish!
+
This is a *request* for a tip. I need to be able to pipe the output of a :blah ex command into the Vim text buffer for editing. I wanted to do this many times for different reasons and could never find a way!
   
  +
I would just love to be able to do :hi --&gt; textBuffer and examine the output at my own leasure scrolling up and down and using Vim search commands on it. Same thing for :set all, and other things. Considering that cut and paste is horrible in windows, I can't for example do :set guioptions? then cut and paste! So I have to retype it, or cut and paste from the help manual. I really want to be able to pipe the output of ex commands into the text buffer. Can someone help me?
You can use the <code>:redir</code> command to redirect the output of an ex command to a register and then paste the contents of the register into a Vim buffer.
 
   
 
==Comments==
 
You can use the :redir command to redirect the output of an ex command to
  +
a register and then paste the contents of the register into a Vim buffer.
 
For example:
 
For example:
  +
 
<pre>
 
<pre>
 
:redir @a
 
:redir @a
Line 23: Line 25:
 
</pre>
 
</pre>
   
Now, register 'a' will have the output of the "set all" ex command. You can paste this into a Vim buffer, using <code>"ap</code>.
+
Now, register 'a' will have the output of the "set all" ex command. You can paste this into a Vim buffer. You can also write a Vim function to do the above.
   
 
See {{help|:redir}}.
You can also write a Vim function to do the above. Since you probably don't want your command output to mess up your carefully constructed window layout, this function will pipe the output of a command into a new tab, allowing you to simply close the tab when done. If you don't like [[using tab pages]], or you don't have tab support because you didn't compile with it or your Vim version is less than 7.0, you could modify this function to use a new split window instead:
 
<pre>
 
function! TabMessage(cmd)
 
redir => message
 
silent execute a:cmd
 
redir END
 
if empty(message)
 
echoerr "no output"
 
else
 
" use "new" instead of "tabnew" below if you prefer split windows instead of tabs
 
tabnew
 
setlocal buftype=nofile bufhidden=wipe noswapfile nobuflisted nomodified
 
silent put=message
 
endif
 
endfunction
 
command! -nargs=+ -complete=command TabMessage call TabMessage(&lt;q-args>)
 
</pre>
 
   
 
----
Example usage:
 
 
This may be obvious to experts, but it took me a very long time to figure it out, because Google searches on terms like 'pipe', 'buffer', 'shell', etc never brought it to my attention. However, you can pipe the contents of the file currently being edited (the current buffer) to a shell command, and replace the current file/buffer with the _output_ of that command, using this:
<pre>:TabMessage highlight</pre>
 
   
 
:%! [cmd]
Note that <code>:redir</code> can use a variable instead of a register, as shown above.
 
   
  +
ie, if you didn't know the :retab command (as for a long time I didn't), you could expand tabs using basic unix commands like ":%! expand -t 4". Wish I'd known this a long time ago, so I'm posting it here in the hopes that others might find it :-)
Note also that <code>:redir</code> will capture silenced messages as well. While this won't be problematic with most builtin commands that echo stuff that we are interested in, this is quite problematic when we execute a sequence of several commands. Since version 7.4-2008, Vim provides an <code>execute()</code> function that'll simplify things and avoid side-effects.
 
   
  +
----
==References==
 
 
The answer is (for ex.):
*{{help|:redir}}
 
*{{help|execute()}}
 
   
 
:read !ls ~
==Related scripts==
 
*{{script|id=120|text=Decho}}
 
   
 
and :help :read for more info
==Comments==
 
This may be obvious to experts, but it took me a very long time to figure it out, because Google searches on terms like 'pipe', 'buffer', 'shell', etc never brought it to my attention. However, you can pipe the contents of the file currently being edited (the current buffer) to a shell command, and replace the current file/buffer with the ''output'' of that command, using this:
 
<pre>
 
:%! [cmd]
 
</pre>
 
 
That is, if you didn't know about the <code>:retab</code> command, you could expand tabs using basic Unix commands like <code>:%! expand -t 4</code>.
 
   
 
----
 
----
 
Here's a function that pipes the output of a command into a new tab (Vim 7.0):
The answer is (for example):
 
  +
 
<pre>
 
<pre>
 
function! TabMessage(cmd)
:read !ls ~
 
 
redir =&gt; message
 
silent execute a:cmd
 
redir END
 
tabnew
 
silent put=message
  +
set nomodified
 
endfunction
 
command! -nargs=+ -complete=command TabMessage call TabMessage(&lt;q-args&gt;)
 
</pre>
 
</pre>
   
 
Example usage:
and {{help|:read}} for more information.
 
 
:TabMessage highlight
----
 
  +
Here is a function that inserts the output of an Ex command into a split window:
 
  +
Another alternative is to use Dredir function in the Decho script {{script|id=120}}.
function! OutputSplitWindow(...)
 
  +
" this function output the result of the Ex command into a split scratch buffer
 
let cmd = join(a:000, ' ')
 
let temp_reg = @"
 
redir @"
 
silent! execute cmd
 
redir END
 
let output = copy(@")
 
let @" = temp_reg
 
if empty(output)
 
echoerr "no output"
 
else
 
new
 
setlocal buftype=nofile bufhidden=wipe noswapfile nobuflisted
 
put! =output
 
endif
 
endfunction
 
command! -nargs=+ -complete=command Output call OutputSplitWindow(<f-args>)
 
Example: :Output echo strftime("%H:%M")
 
:I think I incorporated the useful stuff out of this script into the tip. I did not see much in the way of important differences, and in some ways the tip was better. --[[User:Fritzophrenic|Fritzophrenic]] ([[User talk:Fritzophrenic|talk]]) 18:00, June 3, 2015 (UTC)
 
 
----
 
----
Please note that all contributions to the Vim Tips Wiki are considered to be released under the CC-BY-SA
Cancel Editing help (opens in new window)