minor cleanups to the code, KNF, one bug fix; make man pages real

[unix-history] / usr / src / lib / libc / gen / tcsetpgrp.3

diff --git a/usr/src/lib/libc/gen/tcsetpgrp.3 b/usr/src/lib/libc/gen/tcsetpgrp.3
index cb513fe..6317354 100644 (file)
--- a/usr/src/lib/libc/gen/tcsetpgrp.3
+++ b/usr/src/lib/libc/gen/tcsetpgrp.3
@@ -3,61 +3,71 @@
 .\"
 .\" %sccs.include.redist.roff%
 .\"
 .\"
 .\" %sccs.include.redist.roff%
 .\"

-.\"    @(#)tcsetpgrp.3 5.1 (Berkeley) %G%
+.\"    @(#)tcsetpgrp.3 5.2 (Berkeley) %G%

 .\"
 .\"

-.Dd Jun 11, 1991
+.Dd ""

 .Dt TCSETPGRP
 .Os
 .Sh NAME
 .Nm tcsetpgrp
 .Dt TCSETPGRP
 .Os
 .Sh NAME
 .Nm tcsetpgrp

-.LP
-.B "Process Group ID"
-.LP
-.B "Function:  tcsetpgrp()"
-.LP
-.B "Synopsis"
-.LP
-.nf
-#include <sys/types.h>
-
-int tcsetpgrp(int fildes, pid_t pgrp_id);
-.fi
-.LP
-.B "Description"
-.LP
-If the process has a controlling terminal, the tcsetpgrp() function
-shall set the foreground process group ID associated with the
-terminal to pgrp_id.  The file associated with fildes must be the
-controlling terminal of the calling process and the controlling
-terminal must be currently associated with the session of the
-calling process.  The value of pgrp_id must match a process group
-ID of a process in the same session as the calling process.
-.LP
-.B "Returns"
-.LP
-Upon successful completion, tcsetpgrp() returns a value of zero.
-Otherwise, a value of -1 is returned and errno is set to indicate the
-error.
-.LP
-.B "Errors"
-.LP
-If any of the following conditions occur, the tcsetpgrp() function shall
-return -1 and set errno to the corresponding value:
-.nf
-   [EBADF]       The fildes argument is not a valid file descriptor.
-
-   [EINVAL]      The value of the pgrp_id argument is a value not
-                 supported by the implementation.
-
-   [ENOSYS]      The tcsetpgrp() function is not supported in this
-                 implementation.
-
-   [ENOTTY]      The calling process does not have a controlling
-                 terminal, or the file is not the controlling terminal,
-                 or the controlling terminal is no longer associated with
-                 the session of the calling process.
-
-   [EPERM]       The value of pgrp_id is a value supported by the
-                 implementation but does not match the process group ID
-                 of a process in the same session as the calling process.
-.fi
+.Nd set foreground process group ID
+.Sh SYNOPSIS
+.Fd #include <sys/types.h>
+.Ft int
+.Fn tcsetpgrp "int fd" "pid_t pgrp_id"
+.Sh DESCRIPTION
+If the process has a controlling terminal, the
+.Nm tcsetpgrp
+function sets the foreground process group ID associated with the
+terminal device to
+.Fa pgrp_id .
+The terminal device associated with
+.Fa fd
+must be the controlling terminal of the calling process and the
+controlling terminal must be currently associated with the session
+of the calling process.
+The value of
+.Fa pgrp_id
+must be the same as the process group ID of a process in the same
+session as the calling process.
+.Pp
+Upon successful completion,
+.Nm tcsetpgrp
+returns a value of zero.
+.Sh ERRORS
+If an error occurs,
+.Nm tcgetpgrp
+returns -1 and the global variable
+.Va errno
+is set to indicate the error, as follows:
+.Bl -tag -width Er
+.It Bq Er EBADF
+The
+.Fa fd
+argument is not a valid file descriptor.
+.It Bq Er EINVAL
+An invalid value of
+.Fa pgrp_id
+was specified.
+.It Bq Er ENOTTY
+The calling process does not have a controlling terminal, or the file
+represented by
+.Fa fd
+is not the controlling terminal, or the controlling terminal is no
+longer associated with the session of the calling process.
+.It Bq Er EPERM
+The
+.Fa pgrp_id
+argument does not match the process group ID of a process in the same
+session as the calling process.
+.El
+.Sh SEE ALSO
+.Xr setpgid 3 ,
+.Xr setsid 2 ,
+.Xr tcgetpgrp 3
+.Sh STANDARDS
+The
+.Nm tcsetpgprp
+function is expected to be compliant with the
+.St -p1003.1-88
+specification.