share/man/man4/snp.4

   1 .\"
   2 .\" $FreeBSD$
   3 .\"
   4 .Dd November 5, 2008
   5 .Dt SNP 4
   6 .Os
   7 .Sh NAME
   8 .Nm snp
   9 .Nd tty snoop interface
  10 .Sh SYNOPSIS
  11 .In sys/snoop.h
  12 .Ft int
  13 .Fn ioctl fd SNPSTTY &dev
  14 .Ft int
  15 .Fn ioctl fd SNPGTTY &dev
  16 .Ft int
  17 .Fn ioctl fd FIONREAD &result
  18 .Sh DESCRIPTION
  19 .Pa /dev/snp
  20 is a snoop device which allows users to attach to any tty
  21 and watch activities on it.
  22 The kernel must be compiled with
  23 .Cd "device snp" ,
  24 or the
  25 .Nm
  26 module must be loaded,
  27 for these devices to be available.
  28 .Pp
  29 To associate a given
  30 .Nm
  31 device with a tty to be observed, open the
  32 .Nm
  33 device and a tty device, and then issue the
  34 .Dv SNPSTTY
  35 ioctl on
  36 .Nm
  37 device.
  38 The argument passed to the
  39 .Xr ioctl 2
  40 is the address of a variable of type
  41 .Vt int ,
  42 holding the file descriptor of a tty device.
  43 To detach the
  44 .Nm
  45 device from a tty use a pointer to a value of
  46 \-1.
  47 .Pp
  48 The
  49 .Dv SNPGTTY
  50 ioctl returns information about the current tty attached to
  51 the open
  52 .Nm
  53 device.
  54 .Pp
  55 The
  56 .Dv FIONREAD
  57 ioctl returns a positive value equal to the number of characters
  58 in a read buffer.
  59 Special values defined are:
  60 .Bl -tag -width ".Dv SNP_TTYCLOSE"
  61 .It Dv SNP_OFLOW
  62 device overflow occurred, device detached.
  63 .It Dv SNP_TTYCLOSE
  64 tty not attached.
  65 .It Dv SNP_DETACH
  66 .Nm
  67 device has been detached by user or tty device has been closed
  68 and detached.
  69 .El
  70 .Sh SEE ALSO
  71 .Xr pty 4 ,
  72 .Xr sio 4 ,
  73 .Xr kldload 8 ,
  74 .Xr watch 8
  75 .Sh HISTORY
  76 The
  77 .Nm
  78 device first appeared in
  79 .Fx 2.1 .
  80 In
  81 .Fx 8.0
  82 the
  83 .Nm
  84 driver was rewritten to work with the replaced TTY subsystem.
  85 .Sh AUTHORS
  86 The author of the current implementation is
  87 .An Ed Schouten Aq ed@FreeBSD.org .
  88 Previous versions of
  89 .Nm
  90 were based on code written by
  91 .An Ugen J.S. Antsilevich Aq ugen@NetVision.net.il .
  92 .Sh BUGS
  93 This version of
  94 .Nm
  95 does not return proper error codes when calling
  96 .Dv FIONREAD .
  97 It also does not allow
  98 .Dv SNPSTTY
  99 to detach itself from the TTY.