2.11BSD#431 - /usr/man/cat3/getttyent.0

GETTTYENT(3)	    UNIX Programmer's Manual	     GETTTYENT(3)


NAME
     getttyent, getttynam, setttyent, endttyent - get ttys file
     entry

SYNOPSIS
     #include <ttyent.h>

     struct ttyent *getttyent()

     struct ttyent *getttynam(name)
     char *name;

     setttyent()

     endttyent()

DESCRIPTION
     Getttyent, and getttynam each return a pointer to an object
     with the following structure containing the broken-out
     fields of a line from the tty description file.

	  /*
	   * Copyright (c) 1983 Regents of the University of California.
	   * All rights reserved.  The Berkeley software License Agreement
	   * specifies the terms and conditions for redistribution.
	   *
	   *   @(#)ttyent.h   5.1 (Berkeley) 5/30/85
	   */

	  struct    ttyent { /* see getttyent(3) */
	       char *ty_name; /* terminal device name */
	       char *ty_getty;	   /* command to execute, usually getty */
	       char *ty_type; /* terminal type for termcap (3X) */
	       int  ty_status;	   /* status flags (see below for defines) */
	       char	 *ty_window;	/* command to start up window manager */
	       char *ty_comment;   /* usually the location of the terminal */
	  };

	  #define TTY_ON      0x1  /* enable logins (startup getty) */
	  #define TTY_SECURE  0x2  /* allow root to login */

	  extern struct ttyent *getttyent();
	  extern struct ttyent *getttynam();

     ty_name	  is the name of the  character-special  file  in
		  the directory ``/dev".  For various reasons, it
		  must reside in the directory ``/dev".

     ty_getty	  is the  command  (usually  getty(8))	which  is
		  invoked  by init to initialize tty line charac-
		  teristics.  In fact, any arbitrary command  can
		  be  used;  a	typical  use  is  to  initiate	a


Printed 11/26/99	  May 20, 1986				1


GETTTYENT(3)	    UNIX Programmer's Manual	     GETTTYENT(3)


		  terminal emulator in a window system.

     ty_type	  is the name of the default terminal  type  con-
		  nected  to  this  tty line. This is typically a
		  name	from  the  termcap(5)  data  base.    The
		  environment variable `TERM' is initialized with
		  this name by getty(8) or login(1).

     ty_status	  is a mask of bit fields which indicate  various
		  actions  to  be  allowed  on this tty line. The
		  following is a description of each flag.

		  TTY_ON       Enables logins (i.e., init(8) will
			       start  the specified ``getty" com-
			       mand on this entry).

		  TTY_SECURE   Allows root to login on this  ter-
			       minal.  Note that `TTY_ON' must be
			       included for this to be useful.

     ty_window	  is the command to execute for a  window  system
		  associated  with  the  line.	The window system
		  will be started before the command specified in
		  the  ty_getty  entry	is  executed.  If none is
		  specified, this will be null.

     ty_comment   is the trailing comment field, if any; a  lead-
		  ing delimiter and white space will be removed.

     Getttyent reads the next line from the  ttys  file,  opening
     the file if necessary; setttyent rewinds the file; endttyent
     closes it.

     Getttynam searches from the beginning of the  file  until	a
     matching name is found (or until EOF is encountered).

FILES
     /etc/ttys

SEE ALSO
     login(1),	ttyslot(3),  ttys(5),  gettytab(5),   termcap(5),
     getty(8), init(8)

DIAGNOSTICS
     Null pointer (0) returned on EOF or error.

BUGS
     All information is contained in a static area so it must  be
     copied if it is to be saved.


Printed 11/26/99	  May 20, 1986				2