usr.bin/tty/tty.1

   1 .\" Copyright (c) 1990, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to Berkeley by
   5 .\" the Institute of Electrical and Electronics Engineers, Inc.
   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 .\" 3. All advertising materials mentioning features or use of this software
  16 .\"    must display the following acknowledgement:
  17 .\"     This product includes software developed by the University of
  18 .\"     California, Berkeley and its contributors.
  19 .\" 4. Neither the name of the University nor the names of its contributors
  20 .\"    may be used to endorse or promote products derived from this software
  21 .\"    without specific prior written permission.
  22 .\"
  23 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33 .\" SUCH DAMAGE.
  34 .\"
  35 .\"     @(#)tty.1       8.1 (Berkeley) 6/6/93
  36 .\" $FreeBSD: src/usr.bin/tty/tty.1,v 1.6.2.1 2002/06/21 15:29:47 charnier Exp $
  37 .\" $DragonFly: src/usr.bin/tty/tty.1,v 1.2 2003/06/17 04:29:33 dillon Exp $
  38 .\"
  39 .Dd June 6, 1993
  40 .Dt TTY 1
  41 .Os
  42 .Sh NAME
  43 .Nm tty
  44 .Nd return user's terminal name
  45 .Sh SYNOPSIS
  46 .Nm
  47 .Op Fl s
  48 .Sh DESCRIPTION
  49 The
  50 .Nm
  51 utility writes the name of the terminal attached to standard input
  52 to standard output.
  53 The name that is written is the string returned by
  54 .Xr ttyname 3 .
  55 If the standard input is not a terminal, the message ``not a tty''
  56 is written.
  57 The options are as follows:
  58 .Bl -tag -width Ds
  59 .It Fl s
  60 Don't write the terminal name; only the exit status is affected
  61 when this option is specified.
  62 The
  63 .Fl s
  64 option is deprecated in favor of the
  65 .Dq Li "test -t 0"
  66 command.
  67 .El
  68 .Pp
  69 The
  70 .Nm
  71 utility
  72 exits 0 if the standard input is a terminal, 1 if the standard input is
  73 not a terminal, and >1 if an error occurs.
  74 .Sh SEE ALSO
  75 .Xr test 1 ,
  76 .Xr ttyname 3
  77 .Sh STANDARDS
  78 The
  79 .Nm
  80 utility is expected to be
  81 .St -p1003.2
  82 compatible.
  83 .Sh HISTORY
  84 A
  85 .Nm
  86 command appeared in
  87 .At v1 .