usr.bin/resizewin/resizewin.1

   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 8, 2017
  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 SYNOPSIS
  37 .Nm
  38 .Op Fl z
  39 .Sh DESCRIPTION
  40 Query the terminal emulator window size with the
  41 .Dv TIOCSWINSZ
  42 ioctl and set the window size known by the kernel to the new values.
  43 The terminal is assumed to be VT100/ANSI compatible.
  44 .Pp
  45 The following options are available:
  46 .Bl -tag -width ".Fl z"
  47 .It Fl z
  48 Do nothing unless the current kernel terminal size is zero.
  49 .El
  50 .Pp
  51 .Nm
  52 is functionally similar to
  53 .Xr resize 1 ,
  54 which is part of the
  55 .Xr xterm 1
  56 distribution.
  57 However,
  58 .Nm
  59 only works with VT100/ANSI-compatible terminals and does
  60 not emit commands to set environment variables.
  61 .Pp
  62 After a terminal window has been resized, running
  63 .Nm
  64 updates the kernel's window size to match the new size.
  65 .Pp
  66 Note that virtually all modern terninals support VT100/ANSI escape
  67 sequences, including xterm, konsole, gnome-terminal iTerm,
  68 Terminal.app, and PuTTY.
  69 .Sh SEE ALSO
  70 .Xr resize 1 ,
  71 .Xr stty 1
  72 .Sh HISTORY
  73 The
  74 .Nm
  75 command first appeared in
  76 .Fx 11 .