2004-01-12 Joshua Daniel Franklin <joshuadfranklin@yahoo.com>
* dll_init.sgml: Update funcsynopsis for DocBook 4.2 SGML DTD. * dtable.sgml: Update funcsynopsis for DocBook 4.2 SGML DTD. * external.sgml: Update funcsynopsis for DocBook 4.2 SGML DTD. * path.sgml: Update funcsynopsis for DocBook 4.2 SGML DTD. * pinfo.cc: Update funcsynopsis for DocBook 4.2 SGML DTD. * shared.sgml: Update funcsynopsis for DocBook 4.2 SGML DTD. * stackdump.sgml: Update funcsynopsis for DocBook 4.2 SGML DTD.
This commit is contained in:
parent
4d5d7a2c09
commit
e9dfbae165
|
@ -2,10 +2,10 @@
|
||||||
<sect1 id="func-cygwin-detach-dll">
|
<sect1 id="func-cygwin-detach-dll">
|
||||||
<title>cygwin_detach_dll</title>
|
<title>cygwin_detach_dll</title>
|
||||||
|
|
||||||
<funcsynopsis>
|
<funcsynopsis><funcprototype>
|
||||||
<funcdef>extern "C" void
|
<funcdef>extern "C" void
|
||||||
<function>cygwin_detach_dll</function></funcdef>
|
<function>cygwin_detach_dll</function></funcdef>
|
||||||
<paramdef>int <parameter>dll_index</parameter></paramdef>
|
<paramdef>int <parameter>dll_index</parameter></paramdef>
|
||||||
</funcsynopsis>
|
</funcprototype></funcsynopsis>
|
||||||
|
|
||||||
</sect1>
|
</sect1>
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
<sect1 id="func-cygwin-attach-handle-to-fd">
|
<sect1 id="func-cygwin-attach-handle-to-fd">
|
||||||
<title>cygwin_attach_handle_to_fd</title>
|
<title>cygwin_attach_handle_to_fd</title>
|
||||||
|
|
||||||
<funcsynopsis>
|
<funcsynopsis><funcprototype>
|
||||||
<funcdef>extern "C" int
|
<funcdef>extern "C" int
|
||||||
<function>cygwin_attach_handle_to_fd</function></funcdef>
|
<function>cygwin_attach_handle_to_fd</function></funcdef>
|
||||||
<paramdef>char *<parameter>name</parameter></paramdef>
|
<paramdef>char *<parameter>name</parameter></paramdef>
|
||||||
|
@ -10,7 +10,7 @@
|
||||||
<paramdef>HANDLE <parameter>handle</parameter></paramdef>
|
<paramdef>HANDLE <parameter>handle</parameter></paramdef>
|
||||||
<paramdef>int <parameter>bin</parameter></paramdef>
|
<paramdef>int <parameter>bin</parameter></paramdef>
|
||||||
<paramdef>int <parameter>access</parameter></paramdef>
|
<paramdef>int <parameter>access</parameter></paramdef>
|
||||||
</funcsynopsis>
|
</funcprototype></funcsynopsis>
|
||||||
|
|
||||||
<para>This function can be used to turn a Win32 "handle" into a
|
<para>This function can be used to turn a Win32 "handle" into a
|
||||||
posix-style file handle. <parameter>fd</parameter> may be -1 to
|
posix-style file handle. <parameter>fd</parameter> may be -1 to
|
||||||
|
|
|
@ -2,12 +2,12 @@
|
||||||
<sect1 id="func-cygwin-internal">
|
<sect1 id="func-cygwin-internal">
|
||||||
<title>cygwin_internal</title>
|
<title>cygwin_internal</title>
|
||||||
|
|
||||||
<funcsynopsis>
|
<funcsynopsis><funcprototype>
|
||||||
<funcdef>extern "C" DWORD
|
<funcdef>extern "C" DWORD
|
||||||
<function>cygwin_internal</function></funcdef>
|
<function>cygwin_internal</function></funcdef>
|
||||||
<paramdef>cygwin_getinfo_types <parameter>t</parameter></paramdef>
|
<paramdef>cygwin_getinfo_types <parameter>t</parameter></paramdef>
|
||||||
<paramdef><parameter>...</parameter></paramdef>
|
<paramdef><parameter>...</parameter></paramdef>
|
||||||
</funcsynopsis>
|
</funcprototype></funcsynopsis>
|
||||||
|
|
||||||
<para>This function gives you access to various internal data and functions.
|
<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'
|
It takes two arguments. The first argument is a type from the 'cygwin_getinfo_types'
|
||||||
|
|
|
@ -1,12 +1,12 @@
|
||||||
<sect1 id="func-cygwin-posix-to-win32-path-list">
|
<sect1 id="func-cygwin-posix-to-win32-path-list">
|
||||||
<title>cygwin_posix_to_win32_path_list</title>
|
<title>cygwin_posix_to_win32_path_list</title>
|
||||||
|
|
||||||
<funcsynopsis>
|
<funcsynopsis><funcprototype>
|
||||||
<funcdef>extern "C" void
|
<funcdef>extern "C" void
|
||||||
<function>cygwin_posix_to_win32_path_list</function></funcdef>
|
<function>cygwin_posix_to_win32_path_list</function></funcdef>
|
||||||
<paramdef>const char *<parameter>posix</parameter></paramdef>
|
<paramdef>const char *<parameter>posix</parameter></paramdef>
|
||||||
<paramdef>char *<parameter>win32</parameter></paramdef>
|
<paramdef>char *<parameter>win32</parameter></paramdef>
|
||||||
</funcsynopsis>
|
</funcprototype></funcsynopsis>
|
||||||
|
|
||||||
<para>Given a POSIX path-style string (i.e. /foo:/bar) convert it to
|
<para>Given a POSIX path-style string (i.e. /foo:/bar) convert it to
|
||||||
the equivalent Win32 path-style string (i.e. d:\;e:\bar).
|
the equivalent Win32 path-style string (i.e. d:\;e:\bar).
|
||||||
|
@ -38,12 +38,12 @@ cygwin_posix_to_win32_path_list_buf_size</link></para>
|
||||||
<sect1 id="func-cygwin-win32-to-posix-path-list">
|
<sect1 id="func-cygwin-win32-to-posix-path-list">
|
||||||
<title>cygwin_win32_to_posix_path_list</title>
|
<title>cygwin_win32_to_posix_path_list</title>
|
||||||
|
|
||||||
<funcsynopsis>
|
<funcsynopsis><funcprototype>
|
||||||
<funcdef>extern "C" void
|
<funcdef>extern "C" void
|
||||||
<function>cygwin_win32_to_posix_path_list</function></funcdef>
|
<function>cygwin_win32_to_posix_path_list</function></funcdef>
|
||||||
<paramdef>const char *<parameter>win32</parameter></paramdef>
|
<paramdef>const char *<parameter>win32</parameter></paramdef>
|
||||||
<paramdef>char *<parameter>posix</parameter></paramdef>
|
<paramdef>char *<parameter>posix</parameter></paramdef>
|
||||||
</funcsynopsis>
|
</funcprototype></funcsynopsis>
|
||||||
|
|
||||||
<para>Given a Win32 path-style string (i.e. d:\;e:\bar) convert it to
|
<para>Given a Win32 path-style string (i.e. d:\;e:\bar) convert it to
|
||||||
the equivalent POSIX path-style string (i.e. /foo:/bar).
|
the equivalent POSIX path-style string (i.e. /foo:/bar).
|
||||||
|
@ -57,11 +57,11 @@ cygwin_win32_to_posix_path_list_buf_size</link></para>
|
||||||
<sect1 id="func-cygwin-posix-to-win32-path-list-buf-size">
|
<sect1 id="func-cygwin-posix-to-win32-path-list-buf-size">
|
||||||
<title>cygwin_posix_to_win32_path_list_buf_size</title>
|
<title>cygwin_posix_to_win32_path_list_buf_size</title>
|
||||||
|
|
||||||
<funcsynopsis>
|
<funcsynopsis><funcprototype>
|
||||||
<funcdef>extern "C" int
|
<funcdef>extern "C" int
|
||||||
<function>cygwin_posix_to_win32_path_list_buf_size</function></funcdef>
|
<function>cygwin_posix_to_win32_path_list_buf_size</function></funcdef>
|
||||||
<paramdef>const char *<parameter>path_list</parameter></paramdef>
|
<paramdef>const char *<parameter>path_list</parameter></paramdef>
|
||||||
</funcsynopsis>
|
</funcprototype></funcsynopsis>
|
||||||
|
|
||||||
<para>Returns the number of bytes needed to hold the result of calling
|
<para>Returns the number of bytes needed to hold the result of calling
|
||||||
<link linkend="func-cygwin-posix-to-win32-path-list">
|
<link linkend="func-cygwin-posix-to-win32-path-list">
|
||||||
|
@ -72,11 +72,11 @@ cygwin_posix_to_win32_path_list</link>.</para>
|
||||||
<sect1 id="func-cygwin-win32-to-posix-path-list-buf-size">
|
<sect1 id="func-cygwin-win32-to-posix-path-list-buf-size">
|
||||||
<title>cygwin_win32_to_posix_path_list_buf_size</title>
|
<title>cygwin_win32_to_posix_path_list_buf_size</title>
|
||||||
|
|
||||||
<funcsynopsis>
|
<funcsynopsis><funcprototype>
|
||||||
<funcdef>extern "C" int
|
<funcdef>extern "C" int
|
||||||
<function>cygwin_win32_to_posix_path_list_buf_size</function></funcdef>
|
<function>cygwin_win32_to_posix_path_list_buf_size</function></funcdef>
|
||||||
<paramdef>const char *<parameter>path_list</parameter></paramdef>
|
<paramdef>const char *<parameter>path_list</parameter></paramdef>
|
||||||
</funcsynopsis>
|
</funcprototype></funcsynopsis>
|
||||||
|
|
||||||
<para>Tells you how many bytes are needed for the results of <link
|
<para>Tells you how many bytes are needed for the results of <link
|
||||||
linkend="func-cygwin-win32-to-posix-path-list">
|
linkend="func-cygwin-win32-to-posix-path-list">
|
||||||
|
@ -87,12 +87,12 @@ cygwin_win32_to_posix_path_list</link>.</para>
|
||||||
<sect1 id="func-cygwin-conv-to-posix-path">
|
<sect1 id="func-cygwin-conv-to-posix-path">
|
||||||
<title>cygwin_conv_to_posix_path</title>
|
<title>cygwin_conv_to_posix_path</title>
|
||||||
|
|
||||||
<funcsynopsis>
|
<funcsynopsis><funcprototype>
|
||||||
<funcdef>extern "C" void
|
<funcdef>extern "C" void
|
||||||
<function>cygwin_conv_to_posix_path</function></funcdef>
|
<function>cygwin_conv_to_posix_path</function></funcdef>
|
||||||
<paramdef>const char *<parameter>path</parameter></paramdef>
|
<paramdef>const char *<parameter>path</parameter></paramdef>
|
||||||
<paramdef>char *<parameter>posix_path</parameter></paramdef>
|
<paramdef>char *<parameter>posix_path</parameter></paramdef>
|
||||||
</funcsynopsis>
|
</funcprototype></funcsynopsis>
|
||||||
|
|
||||||
<para>Converts a Win32 path to a POSIX path. If
|
<para>Converts a Win32 path to a POSIX path. If
|
||||||
<parameter>path</parameter> is already a POSIX path, leaves it alone.
|
<parameter>path</parameter> is already a POSIX path, leaves it alone.
|
||||||
|
@ -106,12 +106,12 @@ size; use MAX_PATH if needed.</para>
|
||||||
<sect1 id="func-cygwin-conv-to-win32-path">
|
<sect1 id="func-cygwin-conv-to-win32-path">
|
||||||
<title>cygwin_conv_to_win32_path</title>
|
<title>cygwin_conv_to_win32_path</title>
|
||||||
|
|
||||||
<funcsynopsis>
|
<funcsynopsis><funcprototype>
|
||||||
<funcdef>extern "C" void
|
<funcdef>extern "C" void
|
||||||
<function>cygwin_conv_to_win32_path</function></funcdef>
|
<function>cygwin_conv_to_win32_path</function></funcdef>
|
||||||
<paramdef>const char *<parameter>path</parameter></paramdef>
|
<paramdef>const char *<parameter>path</parameter></paramdef>
|
||||||
<paramdef>char *<parameter>win32_path</parameter></paramdef>
|
<paramdef>char *<parameter>win32_path</parameter></paramdef>
|
||||||
</funcsynopsis>
|
</funcprototype></funcsynopsis>
|
||||||
|
|
||||||
<para>Converts a POSIX path to a Win32 path. If
|
<para>Converts a POSIX path to a Win32 path. If
|
||||||
<parameter>path</parameter> is already a Win32 path, leaves it alone.
|
<parameter>path</parameter> is already a Win32 path, leaves it alone.
|
||||||
|
@ -124,12 +124,12 @@ size; use MAX_PATH if needed.</para>
|
||||||
<sect1 id="func-cygwin-conv-to-full-posix-path">
|
<sect1 id="func-cygwin-conv-to-full-posix-path">
|
||||||
<title>cygwin_conv_to_full_posix_path</title>
|
<title>cygwin_conv_to_full_posix_path</title>
|
||||||
|
|
||||||
<funcsynopsis>
|
<funcsynopsis><funcprototype>
|
||||||
<funcdef>extern "C" void
|
<funcdef>extern "C" void
|
||||||
<function>cygwin_conv_to_full_posix_path</function></funcdef>
|
<function>cygwin_conv_to_full_posix_path</function></funcdef>
|
||||||
<paramdef>const char *<parameter>path</parameter></paramdef>
|
<paramdef>const char *<parameter>path</parameter></paramdef>
|
||||||
<paramdef>char *<parameter>posix_path</parameter></paramdef>
|
<paramdef>char *<parameter>posix_path</parameter></paramdef>
|
||||||
</funcsynopsis>
|
</funcprototype></funcsynopsis>
|
||||||
|
|
||||||
<para>Converts a Win32 path to a POSIX path. If
|
<para>Converts a Win32 path to a POSIX path. If
|
||||||
<parameter>path</parameter> is already a POSIX path, leaves it alone.
|
<parameter>path</parameter> is already a POSIX path, leaves it alone.
|
||||||
|
@ -143,12 +143,12 @@ buffer of sufficient size; use MAX_PATH if needed.</para>
|
||||||
<sect1 id="func-cygwin-conv-to-full-win32-path">
|
<sect1 id="func-cygwin-conv-to-full-win32-path">
|
||||||
<title>cygwin_conv_to_full_win32_path</title>
|
<title>cygwin_conv_to_full_win32_path</title>
|
||||||
|
|
||||||
<funcsynopsis>
|
<funcsynopsis><funcprototype>
|
||||||
<funcdef>extern "C" void
|
<funcdef>extern "C" void
|
||||||
<function>cygwin_conv_to_full_win32_path</function></funcdef>
|
<function>cygwin_conv_to_full_win32_path</function></funcdef>
|
||||||
<paramdef>const char *<parameter>path</parameter></paramdef>
|
<paramdef>const char *<parameter>path</parameter></paramdef>
|
||||||
<paramdef>char *<parameter>win32_path</parameter></paramdef>
|
<paramdef>char *<parameter>win32_path</parameter></paramdef>
|
||||||
</funcsynopsis>
|
</funcprototype></funcsynopsis>
|
||||||
|
|
||||||
<para>Converts a POSIX path to a Win32 path. If
|
<para>Converts a POSIX path to a Win32 path. If
|
||||||
<parameter>path</parameter> is already a Win32 path, leaves it alone.
|
<parameter>path</parameter> is already a Win32 path, leaves it alone.
|
||||||
|
@ -162,11 +162,11 @@ buffer of sufficient size; use MAX_PATH if needed.</para>
|
||||||
<sect1 id="func-cygwin-posix-path-list-p">
|
<sect1 id="func-cygwin-posix-path-list-p">
|
||||||
<title>cygwin_posix_path_list_p</title>
|
<title>cygwin_posix_path_list_p</title>
|
||||||
|
|
||||||
<funcsynopsis>
|
<funcsynopsis><funcprototype>
|
||||||
<funcdef>extern "C" int
|
<funcdef>extern "C" int
|
||||||
<function>posix_path_list_p</function></funcdef>
|
<function>posix_path_list_p</function></funcdef>
|
||||||
<paramdef>const char *<parameter>path</parameter></paramdef>
|
<paramdef>const char *<parameter>path</parameter></paramdef>
|
||||||
</funcsynopsis>
|
</funcprototype></funcsynopsis>
|
||||||
|
|
||||||
<para>This function tells you if the supplied
|
<para>This function tells you if the supplied
|
||||||
<parameter>path</parameter> is a POSIX-style path (i.e. posix names,
|
<parameter>path</parameter> is a POSIX-style path (i.e. posix names,
|
||||||
|
@ -181,14 +181,14 @@ parameter.</para>
|
||||||
<sect1 id="func-cygwin-split-path">
|
<sect1 id="func-cygwin-split-path">
|
||||||
<title>cygwin_split_path</title>
|
<title>cygwin_split_path</title>
|
||||||
|
|
||||||
<funcsynopsis>
|
<funcsynopsis><funcprototype>
|
||||||
<funcdef>extern "C" void
|
<funcdef>extern "C" void
|
||||||
<function>cygwin_split_path</function>
|
<function>cygwin_split_path</function>
|
||||||
</funcdef>
|
</funcdef>
|
||||||
<paramdef>const char * <parameter>path</parameter></paramdef>
|
<paramdef>const char * <parameter>path</parameter></paramdef>
|
||||||
<paramdef>char * <parameter>dir</parameter></paramdef>
|
<paramdef>char * <parameter>dir</parameter></paramdef>
|
||||||
<paramdef>char * <parameter>file</parameter></paramdef>
|
<paramdef>char * <parameter>file</parameter></paramdef>
|
||||||
</funcsynopsis>
|
</funcprototype></funcsynopsis>
|
||||||
|
|
||||||
<para>Split a path into the directory and the file portions. Both
|
<para>Split a path into the directory and the file portions. Both
|
||||||
<parameter>dir</parameter> and <parameter>file</parameter> are
|
<parameter>dir</parameter> and <parameter>file</parameter> are
|
||||||
|
|
|
@ -617,12 +617,12 @@ pinfo::release ()
|
||||||
<sect1 id="func-cygwin-winpid-to-pid">
|
<sect1 id="func-cygwin-winpid-to-pid">
|
||||||
<title>cygwin_winpid_to_pid</title>
|
<title>cygwin_winpid_to_pid</title>
|
||||||
|
|
||||||
<funcsynopsis>
|
<funcsynopsis><funcprototype>
|
||||||
<funcdef>extern "C" pid_t
|
<funcdef>extern "C" pid_t
|
||||||
<function>cygwin_winpid_to_pid</function>
|
<function>cygwin_winpid_to_pid</function>
|
||||||
</funcdef>
|
</funcdef>
|
||||||
<paramdef>int <parameter>winpid</parameter></paramdef>
|
<paramdef>int <parameter>winpid</parameter></paramdef>
|
||||||
</funcsynopsis>
|
</funcprototype></funcsynopsis>
|
||||||
|
|
||||||
<para>Given a windows pid, converts to the corresponding Cygwin
|
<para>Given a windows pid, converts to the corresponding Cygwin
|
||||||
pid, if any. Returns -1 if windows pid does not correspond to
|
pid, if any. Returns -1 if windows pid does not correspond to
|
||||||
|
|
|
@ -2,11 +2,11 @@
|
||||||
<sect1 id="func-cygwin-getshared">
|
<sect1 id="func-cygwin-getshared">
|
||||||
<title>cygwin_getshared</title>
|
<title>cygwin_getshared</title>
|
||||||
|
|
||||||
<funcsynopsis>
|
<funcsynopsis><funcprototype>
|
||||||
<funcdef>shared_info *
|
<funcdef>shared_info *
|
||||||
<function>cygwin_getshared</function></funcdef>
|
<function>cygwin_getshared</function></funcdef>
|
||||||
<void>
|
<void>
|
||||||
</funcsynopsis>
|
</funcprototype></funcsynopsis>
|
||||||
|
|
||||||
<para>Returns a pointer to an internal Cygwin memory structure
|
<para>Returns a pointer to an internal Cygwin memory structure
|
||||||
containing shared information used by cooperating cygwin processes.
|
containing shared information used by cooperating cygwin processes.
|
||||||
|
|
|
@ -1,11 +1,11 @@
|
||||||
<sect1 id="func-cygwin-stackdump">
|
<sect1 id="func-cygwin-stackdump">
|
||||||
<title>cygwin_stackdump</title>
|
<title>cygwin_stackdump</title>
|
||||||
|
|
||||||
<funcsynopsis>
|
<funcsynopsis><funcprototype>
|
||||||
<funcdef>extern "C" void
|
<funcdef>extern "C" void
|
||||||
<function>cygwin_stackdump</function></funcdef>
|
<function>cygwin_stackdump</function></funcdef>
|
||||||
<void>
|
<void>
|
||||||
</funcsynopsis>
|
</funcprototype></funcsynopsis>
|
||||||
|
|
||||||
<para> Outputs a stackdump to stderr from the called location.
|
<para> Outputs a stackdump to stderr from the called location.
|
||||||
</para>
|
</para>
|
||||||
|
|
Loading…
Reference in New Issue