1.\" $NetBSD: linedisc.9,v 1.7 2002/10/14 13:43:25 wiz 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. 70The 71.Fa l_name 72field of the 73.Fa struct linesw 74should point to a string which is to be the symbolic 75name of that line discipline. 76For compatibility purposes, a line discipline number can be passed in 77.Fa no , 78but for new disciplines this should be set to 79.Dv -1 . 80.It Fn ttyldisc_lookup 81Look up a line discipline by 82.Fa name . 83.Dv NULL 84is returned if it can not be found. 85.It Fn ttyldisc_remove 86Remove a line discipline called 87.Fa name 88and return a pointer to it. 89If the discipline cannot be found or removed 90.Fn ttyldisc_remove 91will return 92.Dv NULL . 93.El 94.Sh SEE ALSO 95.Xr tty 4 96.Sh HISTORY 97The 98.Nm 99functions were added in 100.Nx 1.6 . 101.Sh AUTHORS 102The 103.Nx 104extensible line discipline framework was created by 105Eduardo Horvath \*[Lt]eeh@NetBSD.ORG\*[Gt]. 106