1.\" $NetBSD: linedisc.9,v 1.6 2002/02/13 08:18:44 ross 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 ttyldisc_add , 40.Nm ttyldisc_lookup , 41.Nm ttyldisc_remove 42.Nd extensible line discipline framework 43.Sh SYNOPSIS 44.Fd #include \*[Lt]sys/conf.h\*[Gt] 45.Ft int 46.Fn ttyldisc_add "struct linesw *disc" "int no" 47.Ft struct linesw * 48.Fn ttyldisc_remove "char *name" 49.Ft struct linesw * 50.Fn ttyldisc_lookup "char *name" 51.Sh DESCRIPTION 52The 53.Nx 54TTY line discipline framework allows extensibility. 55Modules that need special line disciplines can add 56them as convenient and do not need to modify tty_conf.c. 57Line disciplines are now managed by a string, rather than 58number. 59.Pp 60Once the framework has been initialized, a new line 61discipline can be added by creating and initializing a 62.Fa struct linesw 63and calling 64.Fn ttyldisc_add . 65.Pp 66The following is a brief description of each function in the framework: 67.Bl -tag -width "ttyldisc_remove()" 68.It Fn ttyldisc_add 69Register a line discipline. The 70.Fa l_name 71field of the 72.Fa struct linesw 73should point to a string which is to be the symbolic 74name of that line discipline. For compatibility 75purposes, a line discipline number can be passed in 76.Fa no , 77but for new disciplines this should be set to 78.Dv -1 . 79.It Fn ttyldisc_lookup 80Look up a line discipline by 81.Fa name . 82.Dv NULL 83is returned if it can not be found. 84.It Fn ttyldisc_remove 85Remove a line discipline called 86.Fa name 87and return a pointer to it. If the discipline cannot 88be found or removed 89.Fn ttyldisc_remove 90will return 91.Dv NULL . 92.El 93.Sh SEE ALSO 94.Xr tty 4 95.Sh HISTORY 96The 97.Nm 98functions were added in 99.Nx 1.6 . 100.Sh AUTHORS 101The 102.Nx 103extensible line discipline framework was created by 104Eduardo Horvath \*[Lt]eeh@NetBSD.ORG\*[Gt]. 105