cf1c6cd395
Convert cygwin-api from using a sect2 element to using a refentry element for each function. This makes it possible to generate manpage-style output for those elements. Note that the chunked html now generates a page for each function, rather than one containing all functions. Also: Remove pointless and incorrect date Move introductory paragraph from the first section to the start of the chapter Add a funcsynopsisinfo element with the header file to be included to each function prototype Remove extern "C" which doesn't process into all formats successfully 2015-06-17 Jon Turney <jon.turney@dronecode.org.uk> * cygwin-api.xml: Move introductory paragraph here. * logon-funcs.xml: Convert from using a sect2 element to using a refentry element for each function. * misc-funcs.xml: Ditto. * path.xml: Ditto. Signed-off-by: Jon TURNEY <jon.turney@dronecode.org.uk>
114 lines
3.1 KiB
XML
114 lines
3.1 KiB
XML
<?xml version="1.0" encoding='UTF-8'?>
|
|
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook V4.5//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
|
|
|
|
<sect1 id="func-cygwin-misc">
|
|
<title>Miscellaneous functions</title>
|
|
|
|
<refentry id="func-cygwin-attach-handle-to-fd">
|
|
<refmeta>
|
|
<refentrytitle>cygwin_attach_handle_to_fd</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo class="manual">Cygwin API Reference</refmiscinfo>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>cygwin_attach_handle_to_fd</refname>
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv>
|
|
<funcsynopsis>
|
|
<funcsynopsisinfo>
|
|
#include <sys/cygwin.h>
|
|
</funcsynopsisinfo>
|
|
<funcprototype>
|
|
<funcdef>int
|
|
<function>cygwin_attach_handle_to_fd</function></funcdef>
|
|
<paramdef>char *<parameter>name</parameter></paramdef>
|
|
<paramdef>int <parameter>fd</parameter></paramdef>
|
|
<paramdef>HANDLE <parameter>handle</parameter></paramdef>
|
|
<paramdef>int <parameter>bin</parameter></paramdef>
|
|
<paramdef>int <parameter>access</parameter></paramdef>
|
|
</funcprototype></funcsynopsis>
|
|
</refsynopsisdiv>
|
|
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<para>This function can be used to turn a Win32 "handle" into a
|
|
posix-style file handle. <parameter>fd</parameter> may be -1 to
|
|
make cygwin allocate a handle; the actual handle is returned
|
|
in all cases.</para>
|
|
|
|
<para>Even after using function, Cygwin doesn't know anything about the
|
|
underlying file or device. It just tries to supply the typical file
|
|
functions on a "best-effort" basis. Use with care. Don't expect too
|
|
much.</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="func-cygwin-internal">
|
|
<refmeta>
|
|
<refentrytitle>cygwin_internal</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo class="manual">Cygwin API Reference</refmiscinfo>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>cygwin_internal</refname>
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv>
|
|
<funcsynopsis>
|
|
<funcsynopsisinfo>
|
|
#include <sys/cygwin.h>
|
|
</funcsynopsisinfo>
|
|
<funcprototype>
|
|
<funcdef>uintptr_t
|
|
<function>cygwin_internal</function></funcdef>
|
|
<paramdef>cygwin_getinfo_types <parameter>t</parameter></paramdef>
|
|
<paramdef><parameter>...</parameter></paramdef>
|
|
</funcprototype></funcsynopsis>
|
|
</refsynopsisdiv>
|
|
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<para>This function gives you access to various internal data and functions.
|
|
It takes two arguments. The first argument is a type from the 'cygwin_getinfo_types'
|
|
enum. The second is an optional pointer.</para>
|
|
<para>Stay away unless you know what you're doing.</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
|
|
<refentry id="func-cygwin-stackdump">
|
|
<refmeta>
|
|
<refentrytitle>cygwin_stackdump</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo class="manual">Cygwin API Reference</refmiscinfo>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>cygwin_stackdump</refname>
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv>
|
|
<funcsynopsis>
|
|
<funcsynopsisinfo>
|
|
#include <sys/cygwin.h>
|
|
</funcsynopsisinfo>
|
|
<funcprototype>
|
|
<funcdef>void
|
|
<function>cygwin_stackdump</function></funcdef>
|
|
<void />
|
|
</funcprototype></funcsynopsis>
|
|
</refsynopsisdiv>
|
|
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<para> Outputs a stackdump to stderr from the called location.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
</sect1>
|