Skip site navigation (1)Skip section navigation (2)
Date:      25 Oct 2001 19:30:05 +0200
From:      Dag-Erling Smorgrav <des@ofug.org>
To:        Ruslan Ermilov <ru@FreeBSD.ORG>
Cc:        arch@FreeBSD.ORG
Subject:   Re: "types" man page
Message-ID:  <xzpsnc7vd9e.fsf@flood.ping.uio.no>
In-Reply-To: <20011025190706.D41293@sunbay.com>
References:  <XFMail.011024095346.jhb@FreeBSD.org> <xzpadyhylgl.fsf@flood.ping.uio.no> <20011025190706.D41293@sunbay.com>

next in thread | previous in thread | raw e-mail | index | archive | help
Ruslan Ermilov <ru@FreeBSD.ORG> writes:
> On Wed, Oct 24, 2001 at 07:52:26PM +0200, Dag-Erling Smorgrav wrote:
> > Ruslan, do you have a suggestion for the proper mdoc incantations for
> > a types(7) entry, based on the items I listed in my original mail?
> Just give me an example entry, and I will mark it up as needed.

pid_t
   Used to store a process ID.
   Defined in <machine/ansi.h>.
   Equivalent to a signed int on all platforms.
   Valid PIDs range from 0 through PID_MAX (defined in <sys/proc.h>)
   inclusive.  The special value NO_PID (ibid.) is used to indicate an
   invalid or nonexistent process.

The man page should also have a section that describes the
relationships between the various headers (including but probably not
limited to <machine/ansi.h>, <sys/cdefs.h>, <sys/inttypes.h>,
<sys/types.h> and <sys/param.h>) that either define these types or
include other headers which define them.  For instance, most programs
will want to include <sys/types.h> or <sys/param.h> to define pid_t,
though <sys/inttypes.h> or <machine/ansi.h> would do.

DES
-- 
Dag-Erling Smorgrav - des@ofug.org

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




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