Return to iovec.xml CVS log

Up to [cvsweb.bsd.lv] / docbook2mdoc

Add examples.
Allow missing <parameter> in printing function prototype.

<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="iovec">

	<refmeta>
		<refentrytitle>iovec</refentrytitle>
		<manvolnum>9S</manvolnum>
	</refmeta>

	<refnamediv>
		<refname>iovec</refname>
		<refpurpose>data storage structure for I/O using uio</refpurpose>
	</refnamediv>

	<refsynopsisdiv>
		<synopsis>
			#include &lt;sys/uio.h&gt;
		</synopsis>
	</refsynopsisdiv>

	<refsect1><title>Interface Level</title>
		<para>
			Architecture independent level 1 (DDI/DKI).
		</para>
	</refsect1>

	<refsect1><title>Description</title>

		<para>
			An <structname>iovec</structname> structure describes a data
			storage area for transfer in a
			<citerefentry><refentrytitle>uio</refentrytitle>
				<manvolnum>9S</manvolnum>
			</citerefentry>
			structure. Conceptually,
			it may be thought of as a base address and length specification.
		</para>

	</refsect1>
	<refsect1><title>Structure Members</title>

		<programlisting>
			caddr_t  iov_base;  /* base address of the data storage area */
			/* represented by the iovec structure */
			int      iov_len;   /* size of the data storage area in bytes */
		</programlisting>

		<para>...</para>
	</refsect1>
</refentry>