Skip to content

Latest commit

 

History

History
136 lines (129 loc) · 9.55 KB

doc.md

File metadata and controls

136 lines (129 loc) · 9.55 KB

Currently supported commands

Interactive

In interactive mode these commands are supported:

\alias
<key> [<n> | <str>] show alias key, or set it to a str or history item
\aliases
show aliases [containing a string]
\append
append nth shown item to script <file>
\await
await the appearance of regex in the output, then stop a repeat
\capture <file>
write to <file>
\cd
change local working dir
\clear
clear this pane
\close
kill the current pane
\clr
send a clear screen char
\debug
set log level to debug
\delay [num]
set the delay between sending lines
\do
run a (not-shell) command and send the output slowly to the current pane
\dosh
run a shell command and send the output (text mode, line at a time)
\dump <n>
dump n (or 3000) lines of output to a file
\edit
edit a file (default /tmp/buffer)
\enq
Enqueue a command for await (or "clear" to clear the queue).
\eof
send an eof char
\even
split layout vertically evenly
\find <phrase>
Find commands in the history.
\grep
grep for a phrase in the output
\help
this help
\info
set log level to info
\last (or history) [n]
show last n (or 10) commands (see alias)
\ls <opts>
run ls in this pane
\n
run command in item number n
\newlines [on|off]
turn on or off always sending a newline
\panes
list panes
\pwd
print current (meta) working directory
\repeat
repeat the last M commands every N seconds (or stop a repeat)
\run <script>
Run a script
\scripts
show scripts in script library, optionally search for a name
\select <id>
send to pane <id> instead select <id> <id>
\send <file>
send a file
\set <var> <value>
set a variable for inline replacement
\shell
run command in a local shell
\show
show contents of a script
\sleep X
sleep for X seconds
\small
make the command pane small
\split
split current pane
\stop
send ^C to the current pane stop <id> ...
\timing [on|off]
turn on or off showing times in the prompt
\trace
set log level to trace
\uni <text>
Look up unicode character to output
\unwatch
stop watching the current window+pane
\watch [filename]
start watching the current window+pane by piping to a file
\xfer [filename]
send a file or directory to the remote console

Scripts

In scripting mode, these additional commands are supported:

\buffer [lines|none]
turn on line buffering
\done
indicate that the script is done
\emit
emit a value matched in a wait regex
\exec <script-name>
execute a program, and send output from the current pane to the program's stdin, and wait for the program to exit
\pause <msg>
show msg or 'press return to continue'
\run <name>
run another script in the same directory
\send
send a file, abort if it cannot be sent.
\timeout
set a timeout
\trace [off|on]
turn on tracing
\wait <delay> <regex>
wait after <delay> more steps for a regex
\wait begin <regex>
wait for a regex until we see an end
\wait end
end a wait begin
\wait for <regex>
wait for a regex immediately

For more verbose descriptions of these commands, please refer to the source code!