xref: /freebsd/usr.bin/resizewin/resizewin.1 (revision af23369a6deaaeb612ab266eb88b8bb8d560c322)
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.\" $FreeBSD$
29.\"
30.Dd May 9, 2017
31.Dt RESIZEWIN 1
32.Os
33.Sh NAME
34.Nm resizewin
35.Nd update terminal size
36.Sh SYNOPSIS
37.Nm
38.Op Fl z
39.Sh DESCRIPTION
40The
41.Nm
42utility
43queries the terminal emulator for the current window size and updates
44the size known to the kernel using the
45.Dv TIOCSWINSZ
46ioctl.
47.Pp
48The following options are available:
49.Bl -tag -width ".Fl z"
50.It Fl z
51Do nothing unless the current kernel terminal size is zero.
52This is useful when run from a user's profile (shell startup) scripts:
53querying the window size is required for serial lines, but not when
54logging in over the network, as protocols like TELNET or SSH already
55handle the terminal size by themselves.
56.El
57.Pp
58After a terminal window has been resized, running
59.Nm
60updates the kernel's window size to match the new size.
61.Pp
62.Nm
63is functionally similar to
64.Xr resize 1 ,
65which is part of the
66.Xr xterm 1 Pq Pa ports/x11/xterm
67distribution.
68However,
69.Nm
70only works with VT100/ANSI-compatible terminals and does not emit
71commands to set environment variables.
72.Pp
73The terminal is assumed to be VT100/ANSI compatible.
74The VT100/ANSI escape sequences are supported by virtually all modern
75terminals, including xterm, konsole, gnome-terminal, iTerm,
76Terminal.app, and PuTTY.
77.Sh SEE ALSO
78.Xr stty 1 ,
79.Xr tty 4
80.Sh HISTORY
81The
82.Nm
83command first appeared in
84.Fx 11.0 .
85