[openssh.git] / pty.h

/*

pty.h

Author: Tatu Ylonen <ylo@cs.hut.fi>

Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
                   All rights reserved

Created: Fri Mar 17 05:03:28 1995 ylo

Functions for allocating a pseudo-terminal and making it the controlling
tty.

*/

/* RCSID("$Id$"); */

#ifndef PTY_H
#define PTY_H

/* Allocates and opens a pty.  Returns 0 if no pty could be allocated,
   or nonzero if a pty was successfully allocated.  On success, open file
   descriptors for the pty and tty sides and the name of the tty side are 
   returned (the buffer must be able to hold at least 64 characters). */
int pty_allocate(int *ptyfd, int *ttyfd, char *ttyname);

/* Releases the tty.  Its ownership is returned to root, and permissions to
   0666. */
void pty_release(const char *ttyname);

/* Makes the tty the processes controlling tty and sets it to sane modes. 
   This may need to reopen the tty to get rid of possible eavesdroppers. */
void pty_make_controlling_tty(int *ttyfd, const char *ttyname);

/* Changes the window size associated with the pty. */
void pty_change_window_size(int ptyfd, int row, int col,
			    int xpixel, int ypixel);

#endif /* PTY_H */
Commit	Line	Data
8efc0c15	1	/*
	2
	3	pty.h
	4
	5	Author: Tatu Ylonen <ylo@cs.hut.fi>
	6
	7	Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
	8	All rights reserved
	9
	10	Created: Fri Mar 17 05:03:28 1995 ylo
	11
	12	Functions for allocating a pseudo-terminal and making it the controlling
	13	tty.
	14
	15	*/
	16
	17	/* RCSID("$Id$"); */
	18
	19	#ifndef PTY_H
	20	#define PTY_H
	21
	22	/* Allocates and opens a pty. Returns 0 if no pty could be allocated,
	23	or nonzero if a pty was successfully allocated. On success, open file
	24	descriptors for the pty and tty sides and the name of the tty side are
	25	returned (the buffer must be able to hold at least 64 characters). */
	26	int pty_allocate(int ptyfd, int ttyfd, char *ttyname);
	27
	28	/* Releases the tty. Its ownership is returned to root, and permissions to
	29	0666. */
	30	void pty_release(const char *ttyname);
	31
	32	/* Makes the tty the processes controlling tty and sets it to sane modes.
	33	This may need to reopen the tty to get rid of possible eavesdroppers. */
	34	void pty_make_controlling_tty(int ttyfd, const char ttyname);
	35
	36	/* Changes the window size associated with the pty. */
	37	void pty_change_window_size(int ptyfd, int row, int col,
	38	int xpixel, int ypixel);
	39
	40	#endif /* PTY_H */