Skip site navigation (1)Skip section navigation (2)
Date:      Thu, 9 Aug 2001 09:12:40 -0700 (PDT)
From:      Evan Sarmiento <kaworu@sektor7.ath.cx>
To:        freebsd-gnats-submit@freebsd.org
Subject:   docs/29571: [PATCH] No man page for pgrp kernel functions
Message-ID:  <200108091612.f79GCea54375@freefall.freebsd.org>

index | next in thread | raw e-mail


>Number:         29571
>Category:       docs
>Synopsis:       [PATCH] No man page for pgrp kernel functions
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Thu Aug 09 09:20:01 PDT 2001
>Closed-Date:
>Last-Modified:
>Originator:     Evan Sarmiento
>Release:        5.0-RELEASE
>Organization:
>Environment:
FreeBSD armitage.sekt7.org 5.0-CURRENT FreeBSD 5.0-CURRENT #2: Sat Aug  4 15:43:02 EDT 2001     root@armitage.sekt7.org:/usr/src/sys/i386/compile/INSPIRON  i386

>Description:
No manpage for the pgrp() functions loacted in /usr/src/sys/kern/kern_proc.c. This manpages references three functions,
enterpgrp, leavepgrp, and pgdelete.
>How-To-Repeat:

>Fix:
.\" Copyright (c) 2001 Evan Sarmiento.
.\" All rights reserved.
.\"
.\" 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 AUTHOR AND CONTRIBUTORS ``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 AUTHOR OR CONTRIBUTORS 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.
.\"
.\"
.Dd August 8, 2001
.Os
.Dt PGFIND 9
.Sh NAME
.Nm enterpgrp, leavepgrp, pgdelete 
.Nd functions for manipulating process groups 
.Sh SYNOPSIS
.In sys/proc.h
.Ft "int"
.Fn enterpgrp "struct proc *p, pid_t pgid, int mksess"
.Ft "int"
.Fn leavepgrp "struct proc *p"
.Ft "static void"
.Fn pgdelete  "struct pgrp *pgrp"
.Sh DESCRIPTION
.Fn enterpgrp 
takes three arguments: 
.Fa p
.Fa pgid
and
.Fa mksess.
.Fa p
represents a pointer to a 
.Fa proc
structure which is going to enter the process group refrenced by
.Fa pgid.
.Fa mksses
is an option, that when toggled, makes
.Fa p
the leader of a new session. 
.Pp
If 
.Fa pgrp
is
.Fa NULL
the process specified by
.Fa p
becomes the leader of the process group.
.Pp
.Fn leavepgrp
only takes one argument, a pointer to a
.Fa proc
structure designated by
.Fa p.
.Fa pgrp
removes the proc structure referenced by p from its proces group.
.Pp
.Fn pgdelete
requires one argument, 
.Fa pgrp,
which is a pointer to a pgrp structure. 
.Fn pgdelete
deletes the process group
whose number is referenced by 
.Fa pgrp. 
.Sh RETURN VALUES
.Fn enterpgrp
returns a 
.Fa ESRCH
if the process specified in the argument could not be found, otherwise it returns 0 on success.
.Pp
.Fn leavepgrp
only returns 0.
.Pp
.Fn pgdelete
does not return anything, as it is a void function.
.Sh AUTHORS
This man page was written by
.An Evan Sarmiento Aq kaworu@sektor7.ath.cx .

>Release-Note:
>Audit-Trail:
>Unformatted:

To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message



home | help

Want to link to this message? Use this
URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?200108091612.f79GCea54375>