xref: /freebsd/usr.bin/resizewin/resizewin.1 (revision 2e3507c25e42292b45a5482e116d278f5515d04d)
1.\" resizewin
2.\"
3.\" Query terminal for size and inform the kernel
4.\"
5.\" Copyright 2015 EMC / Isilon Storage Division
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.Dd May 9, 2017
29.Dt RESIZEWIN 1
30.Os
31.Sh NAME
32.Nm resizewin
33.Nd update terminal size
34.Sh SYNOPSIS
35.Nm
36.Op Fl z
37.Sh DESCRIPTION
38The
39.Nm
40utility
41queries the terminal emulator for the current window size and updates
42the size known to the kernel using the
43.Dv TIOCSWINSZ
44ioctl.
45.Pp
46The following options are available:
47.Bl -tag -width ".Fl z"
48.It Fl z
49Do nothing unless the current kernel terminal size is zero.
50This is useful when run from a user's profile (shell startup) scripts:
51querying the window size is required for serial lines, but not when
52logging in over the network, as protocols like TELNET or SSH already
53handle the terminal size by themselves.
54.El
55.Pp
56After a terminal window has been resized, running
57.Nm
58updates the kernel's window size to match the new size.
59.Pp
60.Nm
61is functionally similar to
62.Xr resize 1 ,
63which is part of the
64.Xr xterm 1 Pq Pa ports/x11/xterm
65distribution.
66However,
67.Nm
68only works with VT100/ANSI-compatible terminals and does not emit
69commands to set environment variables.
70.Pp
71The terminal is assumed to be VT100/ANSI compatible.
72The VT100/ANSI escape sequences are supported by virtually all modern
73terminals, including xterm, konsole, gnome-terminal, iTerm,
74Terminal.app, and PuTTY.
75.Sh SEE ALSO
76.Xr stty 1 ,
77.Xr tty 4
78.Sh HISTORY
79The
80.Nm
81command first appeared in
82.Fx 11.0 .
83