tmux display-popup
Display a popup running shell-command (or default-command when omitted) on target-client.
Syntax¶
tmux display-popup [-BCEkN] [-b border-lines] [-c target-client] [-d start-directory] [-e environment] [-h height] [-s style] [-S border-style] [-t target-pane] [-T title] [-w width] [-x position] [-y position] [shell-command [argument ...]]Alias: popup.
Behavior¶
-b,
-B, -C,
-E, -EE,
-K, -N,
-s, and -S options are
accepted in this case; all others are ignored.
-E closes the popup automatically when
shell-command exits. Two
-E closes the popup only if
shell-command exited with success.
-k allows any key to dismiss the popup instead
of only ‘Escape’ or
‘C-c’.
-x and -y give
the position of the popup, they have the same meaning as for the
display-menu command. -w
and -h give the width and height - both may be a
percentage (followed by ‘%’). If
omitted, half of the terminal size is used.
-B does not surround the popup by a
border.
-b sets the type of characters used
for drawing popup borders. When -B is specified,
the -b option is ignored. See
popup-border-lines for possible values for
border-lines.
-s sets the style for the popup and
-S sets the style for the popup border (see
STYLES).
-e takes the form
‘VARIABLE=value’ and sets an
environment variable for the popup; it may be specified multiple
times.
-T is a format for the popup title
(see FORMATS).
The -C flag closes any popup on the
client.
-N disables any previously specified
-E, -EE, or
-k option.
C implementation¶
Internal declarations in tmux 3.7c:
Use from a library¶
Each API describes its own defaults, errors and execution model.
tmux sources and license
Syntax comes from tmux 3.7c list-commands. See the global options for sockets and configuration, and command syntax and targets.
Behavior is taken from the tmux 3.7c manual.
Copyright (c) 2007 Nicholas Marriott <nicholas.marriott@gmail.com> Permission to use, copy, modify, and distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.