diff options
Diffstat (limited to 'winsup/doc')
| -rw-r--r-- | winsup/doc/ChangeLog | 48 | ||||
| -rw-r--r-- | winsup/doc/cygwinenv.sgml | 5 | ||||
| -rw-r--r-- | winsup/doc/faq-programming.xml | 52 | ||||
| -rw-r--r-- | winsup/doc/faq-using.xml | 6 | ||||
| -rw-r--r-- | winsup/doc/new-features.sgml | 30 | ||||
| -rw-r--r-- | winsup/doc/pathnames.sgml | 30 | ||||
| -rw-r--r-- | winsup/doc/setup-net.sgml | 1 | ||||
| -rw-r--r-- | winsup/doc/using.sgml | 2 |
8 files changed, 25 insertions, 149 deletions
diff --git a/winsup/doc/ChangeLog b/winsup/doc/ChangeLog index 2480c5164..302163500 100644 --- a/winsup/doc/ChangeLog +++ b/winsup/doc/ChangeLog @@ -1,51 +1,3 @@ -2012-08-03 Adam Dinwoodie <Adam.Dinwoodie@metaswitch.com> - - * faq-using.xml (faq.using.man): Make relevance to whatis explicit. - -2012-07-20 Corinna Vinschen <corinna@vinschen.de> - - * pathnames.sgml (pathnames-intro): Remove paragraph on UNC paths. - Try to be clearer on POSIX vs. Win32 paths. - (unc-paths): New section. - (cygdrive): Fix a few SGML qualifiers. - * setup-net.sgml: Move ntsec section from here... - * using.sgml: ..to here. - -2012-07-18 Yaakov Selkowitz <yselkowitz@users.sourceforge.net> - - * new-features.sgml (ov-new1.7.16): Document getmntent_r. - -2012-07-17 Yaakov Selkowitz <yselkowitz@users.sourceforge.net> - - * faq-programming.xml (faq.programming.unix-gui): Update to - reflect the availability of X11 toolkits on Cygwin. - -2012-06-03 Corinna Vinschen <corinna@vinschen.de> - - * new-features.sgml (ov-new1.7.16): Document ReFS support. - -2012-05-10 Yaakov Selkowitz <yselkowitz@users.sourceforge.net> - - * new-features.sgml (ov-new1.7.16): Document memrchr. - -2012-05-09 Yaakov Selkowitz <yselkowitz@users.sourceforge.net> - - * new-features.sgml (ov-new1.7.15): Fix XML syntax. - -2012-05-07 Christopher Faylor <me.cygwin2012@cgf.cx> - - * new-features.sgml (ov-new1.7.15): Fix tag. - -2012-05-06 Christopher Faylor <me.cygwin2012@cgf.cx> - - * cygwinenv.sgml: Add pipe_byte description. - * new-features.sgml (ov-new1.7.15): Add new pipe_byte description for - 1.7.15. - -2012-04-25 Corinna Vinschen <corinna@vinschen.de> - - * new-features.sgml (ov-new1.7.14): Add mouse reporting mode 1005. - 2012-04-24 Corinna Vinschen <corinna@vinschen.de> * new-features.sgml (ov-new1.7.14): New section. Add new console mouse diff --git a/winsup/doc/cygwinenv.sgml b/winsup/doc/cygwinenv.sgml index 3a05e9ba3..2be87c8b2 100644 --- a/winsup/doc/cygwinenv.sgml +++ b/winsup/doc/cygwinenv.sgml @@ -59,11 +59,6 @@ If supplied, wildcard matching is case insensitive. The default is <literal>noi </listitem> <listitem> -<para><envar>(no)pipe_byte</envar> - causes Cygwin to open pipes in byte mode rather than -message mode.</para> -</listitem> - -<listitem> <para><envar>proc_retry:n</envar> - causes <function>fork()</function> and <function>exec*()</function> to retry n times when a child process fails due to certain windows-specific errors. These errors usually occur when diff --git a/winsup/doc/faq-programming.xml b/winsup/doc/faq-programming.xml index 6e1edda65..4aecdc3bf 100644 --- a/winsup/doc/faq-programming.xml +++ b/winsup/doc/faq-programming.xml @@ -810,44 +810,20 @@ a Windows environment which Cygwin handles automatically. <question><para>How should I port my Unix GUI to Windows?</para></question> <answer> -<para>Like other Unix-like platforms, the Cygwin distribtion includes many of -the common GUI toolkits, including X11, X Athena widgets, Motif, Tk, GTK+, -and Qt. Many programs which rely on these toolkits will work with little, if -any, porting work if they are otherwise portable. However, there are a few -things to look out for:</para> -<orderedlist> -<listitem><para>Some packages written for both Windows and X11 incorrectly -treat Cygwin as a Windows platform rather than a Unix variant. Mixing Cygwin's -Unix APIs with Windows' GDI is best avoided; rather, remove these assumptions -so that Cygwin is treated like other X11 platforms.</para></listitem> -<listitem><para>GTK+ programs which use <literal>gtk_builder_connect_signals()</literal> -or <literal>glade_xml_signal_autoconnect()</literal> need to be able to -<literal>dlopen()</literal> themselves. In order for this to work, the program -must be linked with the <literal>-Wl,--export-all-symbols</literal> linker flag. -This can be added to LDFLAGS manually, or handled automatically with the -<literal>-export-dynamic</literal> libtool flag (requires libtool 2.2.8) or -by adding <literal>gmodule-export-2.0</literal> to the pkg-config modules used -to build the package.</para></listitem> -<listitem><para>Programs which include their own loadable modules (plugins) -often must have its modules linked against the symbols in the program. The -most portable solution is for such programs to provide all its symbols (except -for <literal>main()</literal>) in a shared library, against which the plugins -can be linked. Otherwise, the symbols from the executable itself must be -exported.</para> -<para>If the package uses the CMake build system, this can be done by adding -<literal>ENABLE_EXPORTS TRUE</literal> to the executable's <literal>set_target_properties</literal> -command, then adding the executable's target name to the <literal>target_link_libraries</literal> -command for the plugins.</para> -<para>For other build systems, the following steps are required:</para> -<orderedlist> -<listitem><para>The executable must be built before its plugins.</para></listitem> -<listitem><para>Symbols must be exported from the executable with a -<literal>-Wl,--export-all-symbols,--out-implib,libfoo.exe.a</literal> -linker flag, where <literal>foo</literal> represents the name of the -executable.</para></listitem> -<listitem><para>The plugins must be linked with a <literal>-Wl,/path/to/libfoo.exe.a</literal> -linker flag.</para></listitem> -</orderedlist></listitem></orderedlist> +<para>There are two basic strategies for porting Unix GUIs to Windows. +</para> +<para>The first is to use a portable graphics library such as tcl/tk, X11, or +V (and others?). Typically, you will end up with a GUI on Windows that +requires some runtime support. With tcl/tk, you'll want to include the +necessary library files and the tcl/tk DLLs. In the case of X11, you'll +need everyone using your program to have the X11 server installed. +</para> +<para>The second method is to rewrite your GUI using Win32 API calls (or MFC +with VC++). If your program is written in a fairly modular fashion, you +may still want to use Cygwin if your program contains a lot of shared +(non-GUI-related) code. That way you still gain some of the portability +advantages inherent in using Cygwin. +</para> </answer></qandaentry> <qandaentry id="faq.programming.djgpp"> diff --git a/winsup/doc/faq-using.xml b/winsup/doc/faq-using.xml index c08efbc56..5aee7717b 100644 --- a/winsup/doc/faq-using.xml +++ b/winsup/doc/faq-using.xml @@ -238,12 +238,10 @@ related messages. </answer></qandaentry> <qandaentry id="faq.using.man"> -<question><para>Why doesn't <literal>man -k</literal>, -<literal>apropos</literal> or <literal>whatis</literal> work?</para></question> +<question><para>Why doesn't man -k (or apropos) work?</para></question> <answer> -<para>Before you can use <literal>man -k</literal>, <literal>apropos</literal> -or <literal>whatis</literal>, you +<para>Before you can use <literal>man -k</literal> or <literal>apropos</literal>, you must create the whatis database. Just run the command </para> <screen> diff --git a/winsup/doc/new-features.sgml b/winsup/doc/new-features.sgml index 1fe5afea4..2c202a183 100644 --- a/winsup/doc/new-features.sgml +++ b/winsup/doc/new-features.sgml @@ -1,39 +1,11 @@ <sect1 id="ov-new1.7"><title>What's new and what changed in Cygwin 1.7</title> -<sect2 id="ov-new1.7.16"><title>What's new and what changed from 1.7.15 to 1.7.16</title> - -<itemizedlist mark="bullet"> - -<listitem><para> -New API: getmntent_r, memrchr. -</para></listitem> - -<listitem><para> -Recognize ReFS filesystem. -</para></listitem> - -</itemizedlist> - -</sect2> - -<sect2 id="ov-new1.7.15"><title>What's new and what changed from 1.7.14 to 1.7.15</title> - -<itemizedlist mark="bullet"> - -<listitem><para> -CYGWIN=pipe_byte option now forces the opening of pipes in byte mode rather than message mode. -</para></listitem> - -</itemizedlist> - -</sect2> - <sect2 id="ov-new1.7.14"><title>What's new and what changed from 1.7.13 to 1.7.14</title> <itemizedlist mark="bullet"> <listitem><para> -Add mouse reporting modes 1005, 1006 and 1015 to console window. +Add mouse reporting modes 1006 and 1015 to console window. </para></listitem> </itemizedlist> diff --git a/winsup/doc/pathnames.sgml b/winsup/doc/pathnames.sgml index 3a4769e9e..e2a031581 100644 --- a/winsup/doc/pathnames.sgml +++ b/winsup/doc/pathnames.sgml @@ -2,12 +2,12 @@ <sect2 id="pathnames-intro"><title>Introduction</title> -<para>Cygwin supports both POSIX- and Win32-style paths. Directory +<para>Cygwin supports both Win32- and POSIX-style paths. Directory delimiters may be either forward slashes or backslashes. Paths using -backslashes or starting with a drive letter are always handled as -Win32 paths. POSIX paths must only use forward slashes as delimiter, -otherwise they are treated as Win32 paths and file access might fail -in surprising ways.</para> +backslashes are always handled as Win32 paths. POSIX paths must only +use forward slashes as delimiter, otherwise they are treated as Win32 +paths and file access might fail in surprising ways. UNC pathnames +(starting with two slashes and a network name) are also supported.</para> <note><para>The usage of Win32 paths, though possible, is deprecated, since it circumvents important internal path handling mechanisms. @@ -269,27 +269,11 @@ old user mount points as before. </sect2> -<sect2 id="unc-paths"><title>UNC paths</title> - -<para>Apart from the unified POSIX tree starting at the <filename>/</filename> -directory, UNC pathnames starting with two slashes and a server name -(<filename>//machine/share/...</filename>) are supported as well. -They are handled as POSIX paths if only containing forward slashes. There's -also a virtual directory <filename>//</filename> which allows to enumerate -the fileservers known to the local machine with <command>ls</command>. -Same goes for the UNC paths of the type <filename>//machine</filename>, -which allow to enumerate the shares provided by the server -<literal>machine</literal>. For often used UNC paths it makes sense to -add them to the mount table (see <xref linkend="mount-table"></xref> so -they are included in the unified POSIX path tree.</para> - -</sect2> - <sect2 id="cygdrive"><title>The cygdrive path prefix</title> <para>As already outlined in <xref linkend="ov-hi-files"></xref>, you can access arbitary drives on your system by using the cygdrive path prefix. -The default value for this prefix is <filename>/cygdrive</filename>, and +The default value for this prefix is <literal>/cygdrive</literal>, and a path to any drive can be constructed by using the cygdrive prefix and appending the drive letter as subdirectory, like this:</para> @@ -303,7 +287,7 @@ appending the drive letter as subdirectory, like this:</para> on a system are subsumed. The mount options of the cygdrive prefix is used for all file access through the cygdrive prefixed drives. For instance, assuming the cygdrive mount options are <literal>binary,posix=0</literal>, -then any file <filename>/cygdrive/x/file</filename> will be opened in +then any file <literal>/cygdrive/x/file</literal> will be opened in binary mode by default (mount option <literal>binary</literal>), and the case of the filename doesn't matter (mount option <literal>posix=0</literal>). </para> diff --git a/winsup/doc/setup-net.sgml b/winsup/doc/setup-net.sgml index 4694eb330..889f1e0fb 100644 --- a/winsup/doc/setup-net.sgml +++ b/winsup/doc/setup-net.sgml @@ -260,5 +260,6 @@ Problems with Cygwin</ulink>. DOCTOOL-INSERT-setup-env DOCTOOL-INSERT-setup-maxmem DOCTOOL-INSERT-setup-locale +DOCTOOL-INSERT-ntsec DOCTOOL-INSERT-setup-files </chapter> diff --git a/winsup/doc/using.sgml b/winsup/doc/using.sgml index 4a802e6c8..4678cff93 100644 --- a/winsup/doc/using.sgml +++ b/winsup/doc/using.sgml @@ -14,8 +14,6 @@ DOCTOOL-INSERT-using-specialnames DOCTOOL-INSERT-using-cygwinenv -DOCTOOL-INSERT-ntsec - DOCTOOL-INSERT-using-cygserver DOCTOOL-INSERT-using-utils |