xref: /freebsd/usr.bin/resizewin/resizewin.1 (revision 8ef24a0d4b28fe230e20637f56869cc4148cd2ca)
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 March 17, 2016
31.Dt RESIZEWIN 1
32.Os
33.Sh NAME
34.Nm resizewin
35.Nd update the kernel window size for the current TTY
36.Sh DESCRIPTION
37Query the terminal emulator window size with the
38.Dv TIOCSWINSZ
39ioctl and set the window size known by the kernel to the new values.
40The terminal is assumed to be VT100/ANSI compatible.
41.Nm
42is functionally similar to
43.Xr resize 1 ,
44which is part of the
45.Xr xterm 1
46distribution.
47However,
48.Nm
49only works with VT100/ANSI-compatible terminals and does
50not emit commands to set environment variables.
51.Pp
52After a terminal window has been resized, running
53.Nm
54updates the kernel's window size to match the new size.
55.Pp
56Note that virtually all modern terninals support VT100/ANSI escape
57sequences, including xterm, konsole, gnome-terminal iTerm,
58Terminal.app, and puTTY.
59.Sh SEE ALSO
60.Xr resize 1 ,
61.Xr stty 1
62.Sh HISTORY
63.Nm
64appeared in FreeBSD 11.
65