d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
f2ac7de925
freebsd-dev/lib/libutil/pty.3

141 lines
4.1 KiB
Groff
Raw Normal View History

Remove whitespace at EOL.
2001-07-15 07:53:42 +00:00
.\"
Finally document the interfaces found in libutil. While being here, also add the missing declaration of forkpty() to libutil.h. Btw., the calling interface for login(3) is crude. Some better abstraction is needed, perhaps similar to logwtmp(3). 2.2 candidate, but i'll wait for the spelling police first. :)
1996-12-29 18:30:42 +00:00
.\" Copyright (c) 1996 Joerg Wunsch
Remove whitespace at EOL.
2001-07-15 07:53:42 +00:00
.\"
Finally document the interfaces found in libutil. While being here, also add the missing declaration of forkpty() to libutil.h. Btw., the calling interface for login(3) is crude. Some better abstraction is needed, perhaps similar to logwtmp(3). 2.2 candidate, but i'll wait for the spelling police first. :)
1996-12-29 18:30:42 +00:00
.\" All rights reserved.
Remove whitespace at EOL.
2001-07-15 07:53:42 +00:00
.\"
Finally document the interfaces found in libutil. While being here, also add the missing declaration of forkpty() to libutil.h. Btw., the calling interface for login(3) is crude. Some better abstraction is needed, perhaps similar to logwtmp(3). 2.2 candidate, but i'll wait for the spelling police first. :)
1996-12-29 18:30:42 +00:00
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Remove whitespace at EOL.
2001-07-15 07:53:42 +00:00
.\"
$Id$ -> $FreeBSD$
1999-08-28 00:22:10 +00:00
.\" $FreeBSD$
Finally document the interfaces found in libutil. While being here, also add the missing declaration of forkpty() to libutil.h. Btw., the calling interface for login(3) is crude. Some better abstraction is needed, perhaps similar to logwtmp(3). 2.2 candidate, but i'll wait for the spelling police first. :)
1996-12-29 18:30:42 +00:00
.\" "
.Dd December 29, 1996
.Os
.Dt PTY 3
.Sh NAME
Remove whitespace at EOL.
2001-07-15 07:53:42 +00:00
.Nm openpty ,
Spelling/mdoc police.
1996-12-30 21:08:45 +00:00
.Nm forkpty
Finally document the interfaces found in libutil. While being here, also add the missing declaration of forkpty() to libutil.h. Btw., the calling interface for login(3) is crude. Some better abstraction is needed, perhaps similar to logwtmp(3). 2.2 candidate, but i'll wait for the spelling police first. :)
1996-12-29 18:30:42 +00:00
.Nd auxiliary functions to obtain a pseudo-terminal
Introduce .Lb macro to libutil manpages Sort .Nm values in some manpages Remove explicit note about compiling with -lutil, it's implicitly declared by .Lb macro now.
2000-04-22 16:17:00 +00:00
.Sh LIBRARY
.Lb libutil
Finally document the interfaces found in libutil. While being here, also add the missing declaration of forkpty() to libutil.h. Btw., the calling interface for login(3) is crude. Some better abstraction is needed, perhaps similar to logwtmp(3). 2.2 candidate, but i'll wait for the spelling police first. :)
1996-12-29 18:30:42 +00:00
.Sh SYNOPSIS
.Fd #include <sys/types.h>
.Fd #include <sys/ioctl.h>
.Fd #include <termios.h>
.Fd #include <libutil.h>
.Ft int
.Fn openpty "int *amaster" "int *aslave" "char *name" "struct termios *termp" "struct winsize *winp"
.Ft int
.Fn forkpty "int *amaster" "char *name" "struct termios *termp" "struct winsize *winp"
.Sh DESCRIPTION
The function
Spelling/mdoc police.
1996-12-30 21:08:45 +00:00
.Fn openpty
Finally document the interfaces found in libutil. While being here, also add the missing declaration of forkpty() to libutil.h. Btw., the calling interface for login(3) is crude. Some better abstraction is needed, perhaps similar to logwtmp(3). 2.2 candidate, but i'll wait for the spelling police first. :)
1996-12-29 18:30:42 +00:00
attempts to obtain the next available pseudo-terminal from the system (see
.Xr pty 4 ) .
Grammatical changes. Reviewed by: joerg
1997-01-01 03:29:33 +00:00
If it successfully finds one, it subsequently tries to change the
Finally document the interfaces found in libutil. While being here, also add the missing declaration of forkpty() to libutil.h. Btw., the calling interface for login(3) is crude. Some better abstraction is needed, perhaps similar to logwtmp(3). 2.2 candidate, but i'll wait for the spelling police first. :)
1996-12-29 18:30:42 +00:00
ownership of the slave device to the real UID of the current process,
the group membership to the group
.Dq tty
(if such a group exists in the system), the access permissions for
reading and writing by the owner, and for writing by the group, and to
invalidate any current use of the line by calling
.Xr revoke 2 .
.Pp
If the argument
Minor mdoc style fixes.
1997-01-09 07:12:09 +00:00
.Fa name
Finally document the interfaces found in libutil. While being here, also add the missing declaration of forkpty() to libutil.h. Btw., the calling interface for login(3) is crude. Some better abstraction is needed, perhaps similar to logwtmp(3). 2.2 candidate, but i'll wait for the spelling police first. :)
1996-12-29 18:30:42 +00:00
is not
.Dv NULL ,
Spelling/mdoc police.
1996-12-30 21:08:45 +00:00
.Fn openpty
Finally document the interfaces found in libutil. While being here, also add the missing declaration of forkpty() to libutil.h. Btw., the calling interface for login(3) is crude. Some better abstraction is needed, perhaps similar to logwtmp(3). 2.2 candidate, but i'll wait for the spelling police first. :)
1996-12-29 18:30:42 +00:00
copies the pathname of the slave pty to this area. The caller is
Grammatical changes. Reviewed by: joerg
1997-01-01 03:29:33 +00:00
responsible for allocating the required space in this array.
Finally document the interfaces found in libutil. While being here, also add the missing declaration of forkpty() to libutil.h. Btw., the calling interface for login(3) is crude. Some better abstraction is needed, perhaps similar to logwtmp(3). 2.2 candidate, but i'll wait for the spelling police first. :)
1996-12-29 18:30:42 +00:00
.Pp
If the arguments
Minor mdoc style fixes.
1997-01-09 07:12:09 +00:00
.Fa termp
Finally document the interfaces found in libutil. While being here, also add the missing declaration of forkpty() to libutil.h. Btw., the calling interface for login(3) is crude. Some better abstraction is needed, perhaps similar to logwtmp(3). 2.2 candidate, but i'll wait for the spelling police first. :)
1996-12-29 18:30:42 +00:00
or
Minor mdoc style fixes.
1997-01-09 07:12:09 +00:00
.Fa winp
Finally document the interfaces found in libutil. While being here, also add the missing declaration of forkpty() to libutil.h. Btw., the calling interface for login(3) is crude. Some better abstraction is needed, perhaps similar to logwtmp(3). 2.2 candidate, but i'll wait for the spelling police first. :)
1996-12-29 18:30:42 +00:00
are not
.Dv NULL ,
Spelling/mdoc police.
1996-12-30 21:08:45 +00:00
.Fn openpty
Finally document the interfaces found in libutil. While being here, also add the missing declaration of forkpty() to libutil.h. Btw., the calling interface for login(3) is crude. Some better abstraction is needed, perhaps similar to logwtmp(3). 2.2 candidate, but i'll wait for the spelling police first. :)
1996-12-29 18:30:42 +00:00
initializes the termios and window size settings from the structures
Grammatical changes. Reviewed by: joerg
1997-01-01 03:29:33 +00:00
these arguments point to, respectively.
Finally document the interfaces found in libutil. While being here, also add the missing declaration of forkpty() to libutil.h. Btw., the calling interface for login(3) is crude. Some better abstraction is needed, perhaps similar to logwtmp(3). 2.2 candidate, but i'll wait for the spelling police first. :)
1996-12-29 18:30:42 +00:00
.Pp
Spelling/mdoc police.
1996-12-30 21:08:45 +00:00
Upon return, the open file descriptors for the master and slave side
Finally document the interfaces found in libutil. While being here, also add the missing declaration of forkpty() to libutil.h. Btw., the calling interface for login(3) is crude. Some better abstraction is needed, perhaps similar to logwtmp(3). 2.2 candidate, but i'll wait for the spelling police first. :)
1996-12-29 18:30:42 +00:00
of the pty are returned in the locations pointed to by
Minor mdoc style fixes.
1997-01-09 07:12:09 +00:00
.Fa amaster
Finally document the interfaces found in libutil. While being here, also add the missing declaration of forkpty() to libutil.h. Btw., the calling interface for login(3) is crude. Some better abstraction is needed, perhaps similar to logwtmp(3). 2.2 candidate, but i'll wait for the spelling police first. :)
1996-12-29 18:30:42 +00:00
and
Minor mdoc style fixes.
1997-01-09 07:12:09 +00:00
.Fa aslave ,
Finally document the interfaces found in libutil. While being here, also add the missing declaration of forkpty() to libutil.h. Btw., the calling interface for login(3) is crude. Some better abstraction is needed, perhaps similar to logwtmp(3). 2.2 candidate, but i'll wait for the spelling police first. :)
1996-12-29 18:30:42 +00:00
respectively.
.Pp
Spelling/mdoc police.
1996-12-30 21:08:45 +00:00
.Fn Forkpty
Finally document the interfaces found in libutil. While being here, also add the missing declaration of forkpty() to libutil.h. Btw., the calling interface for login(3) is crude. Some better abstraction is needed, perhaps similar to logwtmp(3). 2.2 candidate, but i'll wait for the spelling police first. :)
1996-12-29 18:30:42 +00:00
first calls
Spelling/mdoc police.
1996-12-30 21:08:45 +00:00
.Fn openpty
Finally document the interfaces found in libutil. While being here, also add the missing declaration of forkpty() to libutil.h. Btw., the calling interface for login(3) is crude. Some better abstraction is needed, perhaps similar to logwtmp(3). 2.2 candidate, but i'll wait for the spelling police first. :)
1996-12-29 18:30:42 +00:00
to obtain the next available pseudo-terminal from the system. Upon success,
it forks off a new process. In the child process, it closes the descriptor
for the master side of the pty, and calls
.Xr login_tty 3
for the slave pty. In the parent process, it closes the descriptor for the
slave side of the pty. The arguments
Minor mdoc style fixes.
1997-01-09 07:12:09 +00:00
.Fa amaster ,
.Fa name ,
.Fa termp ,
Finally document the interfaces found in libutil. While being here, also add the missing declaration of forkpty() to libutil.h. Btw., the calling interface for login(3) is crude. Some better abstraction is needed, perhaps similar to logwtmp(3). 2.2 candidate, but i'll wait for the spelling police first. :)
1996-12-29 18:30:42 +00:00
and
Minor mdoc style fixes.
1997-01-09 07:12:09 +00:00
.Fa winp
Finally document the interfaces found in libutil. While being here, also add the missing declaration of forkpty() to libutil.h. Btw., the calling interface for login(3) is crude. Some better abstraction is needed, perhaps similar to logwtmp(3). 2.2 candidate, but i'll wait for the spelling police first. :)
1996-12-29 18:30:42 +00:00
have the same meaning as described for
Spelling/mdoc police.
1996-12-30 21:08:45 +00:00
.Fn openpty .
Finally document the interfaces found in libutil. While being here, also add the missing declaration of forkpty() to libutil.h. Btw., the calling interface for login(3) is crude. Some better abstraction is needed, perhaps similar to logwtmp(3). 2.2 candidate, but i'll wait for the spelling police first. :)
1996-12-29 18:30:42 +00:00
.Sh RETURN VALUES
Spelling/mdoc police.
1996-12-30 21:08:45 +00:00
.Fn Openpty
Finally document the interfaces found in libutil. While being here, also add the missing declaration of forkpty() to libutil.h. Btw., the calling interface for login(3) is crude. Some better abstraction is needed, perhaps similar to logwtmp(3). 2.2 candidate, but i'll wait for the spelling police first. :)
1996-12-29 18:30:42 +00:00
returns 0 on success, or -1 on failure.
.Pp
Spelling/mdoc police.
1996-12-30 21:08:45 +00:00
.Fn Forkpty
Finally document the interfaces found in libutil. While being here, also add the missing declaration of forkpty() to libutil.h. Btw., the calling interface for login(3) is crude. Some better abstraction is needed, perhaps similar to logwtmp(3). 2.2 candidate, but i'll wait for the spelling police first. :)
1996-12-29 18:30:42 +00:00
returns -1 on failure, 0 in the slave process, and the process ID of the
slave process in the parent process.
.Sh ERRORS
On failure,
Spelling/mdoc police.
1996-12-30 21:08:45 +00:00
.Fn openpty
Finally document the interfaces found in libutil. While being here, also add the missing declaration of forkpty() to libutil.h. Btw., the calling interface for login(3) is crude. Some better abstraction is needed, perhaps similar to logwtmp(3). 2.2 candidate, but i'll wait for the spelling police first. :)
1996-12-29 18:30:42 +00:00
will set the global variable
.Dv errno
to
.Er ENOENT .
.Pp
In addition to this,
Spelling/mdoc police.
1996-12-30 21:08:45 +00:00
.Fn forkpty
Finally document the interfaces found in libutil. While being here, also add the missing declaration of forkpty() to libutil.h. Btw., the calling interface for login(3) is crude. Some better abstraction is needed, perhaps similar to logwtmp(3). 2.2 candidate, but i'll wait for the spelling police first. :)
1996-12-29 18:30:42 +00:00
may set it to any value as described for
.Xr fork 2 .
.Sh SEE ALSO
.Xr chmod 2 ,
.Xr chown 2 ,
.Xr fork 2 ,
.Xr getuid 2 ,
.Xr open 2 ,
.Xr revoke 2 ,
.Xr login_tty 3 ,
.Xr pty 4 ,
Bad reference of termios(3) changed to termios(4).
1999-08-14 07:52:29 +00:00
.Xr termios 4 ,
Finally document the interfaces found in libutil. While being here, also add the missing declaration of forkpty() to libutil.h. Btw., the calling interface for login(3) is crude. Some better abstraction is needed, perhaps similar to logwtmp(3). 2.2 candidate, but i'll wait for the spelling police first. :)
1996-12-29 18:30:42 +00:00
.Xr group 5
.Sh BUGS
The calling process must have an effective UID of super-user in order
to perform all the intended actions. No notification will occur if
Spelling/mdoc police.
1996-12-30 21:08:45 +00:00
.Fn openpty
Finally document the interfaces found in libutil. While being here, also add the missing declaration of forkpty() to libutil.h. Btw., the calling interface for login(3) is crude. Some better abstraction is needed, perhaps similar to logwtmp(3). 2.2 candidate, but i'll wait for the spelling police first. :)
1996-12-29 18:30:42 +00:00
or
Spelling/mdoc police.
1996-12-30 21:08:45 +00:00
.Fn forkpty
Finally document the interfaces found in libutil. While being here, also add the missing declaration of forkpty() to libutil.h. Btw., the calling interface for login(3) is crude. Some better abstraction is needed, perhaps similar to logwtmp(3). 2.2 candidate, but i'll wait for the spelling police first. :)
1996-12-29 18:30:42 +00:00
failed to proceed with one of the described steps, as long as they could
at least allocate the pty at all (and create the new process in the case
of
Spelling/mdoc police.
1996-12-30 21:08:45 +00:00
.Fn forkpty ) .
Reference in New Issue Copy Permalink