share/man/man9/linedisc.9

   1 .\" $NetBSD: linedisc.9,v 1.10 2005/06/04 22:49:32 uwe Exp $
   2 .\"
   3 .\" Copyright (c) 2000 Christopher G. Demetriou.
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. All advertising materials mentioning features or use of this software
  15 .\"    must display the following acknowledgement:
  16 .\"          This product includes software developed for the
  17 .\"          NetBSD Project.  See http://www.NetBSD.org/ for
  18 .\"          information about NetBSD.
  19 .\" 4. The name of the author may not be used to endorse or promote products
  20 .\"    derived from this software without specific prior written permission.
  21 .\"
  22 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  23 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  24 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  25 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  26 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  27 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  31 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32 .\"
  33 .\" --(license Id: LICENSE.proto,v 1.1 2000/06/13 21:40:26 cgd Exp )--
  34 .\"
  35 .Dd November 1, 2000
  36 .Dt LINEDISC 9
  37 .Os
  38 .Sh NAME
  39 .Nm linedisc ,
  40 .Nm ttyldisc_add ,
  41 .Nm ttyldisc_lookup ,
  42 .Nm ttyldisc_remove
  43 .Nd extensible line discipline framework
  44 .Sh SYNOPSIS
  45 .In sys/conf.h
  46 .Ft int
  47 .Fn ttyldisc_add "struct linesw *disc" "int no"
  48 .Ft struct linesw *
  49 .Fn ttyldisc_remove "const char *name"
  50 .Ft struct linesw *
  51 .Fn ttyldisc_lookup "const char *name"
  52 .Sh DESCRIPTION
  53 The
  54 .Nx
  55 TTY line discipline framework allows extensibility.
  56 Modules that need special line disciplines can add
  57 them as convenient and do not need to modify tty_conf.c.
  58 Line disciplines are now managed by a string, rather than
  59 number.
  60 .Pp
  61 Once the framework has been initialized, a new line
  62 discipline can be added by creating and initializing a
  63 .Fa struct linesw
  64 and calling
  65 .Fn ttyldisc_add .
  66 .Pp
  67 The following is a brief description of each function in the framework:
  68 .Bl -tag -width "ttyldisc_remove()"
  69 .It Fn ttyldisc_add
  70 Register a line discipline.
  71 The
  72 .Fa l_name
  73 field of the
  74 .Fa struct linesw
  75 should point to a string which is to be the symbolic
  76 name of that line discipline.
  77 For compatibility purposes, a line discipline number can be passed in
  78 .Fa no ,
  79 but for new disciplines this should be set to
  80 .Dv -1 .
  81 .It Fn ttyldisc_lookup
  82 Look up a line discipline by
  83 .Fa name .
  84 .Dv NULL
  85 is returned if it can not be found.
  86 .It Fn ttyldisc_remove
  87 Remove a line discipline called
  88 .Fa name
  89 and return a pointer to it.
  90 If the discipline cannot be found or removed
  91 .Fn ttyldisc_remove
  92 will return
  93 .Dv NULL .
  94 .El
  95 .Sh SEE ALSO
  96 .Xr tty 4
  97 .Sh HISTORY
  98 The
  99 .Nm
 100 functions were added in
 101 .Nx 1.6 .
 102 .Sh AUTHORS
 103 The
 104 .Nx
 105 extensible line discipline framework was created by
 106 .An Eduardo Horvath
 107 .Aq eeh@NetBSD.org .