[Refdb-cvs] CVS: elisp refdb-mode-manual.xml,1.3,1.4

[Markus H. <mho...@us...>]

Update of /cvsroot/refdb/elisp
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv12328

Modified Files:
	refdb-mode-manual.xml 
Log Message:
updated for 1.2

Index: refdb-mode-manual.xml
===================================================================
RCS file: /cvsroot/refdb/elisp/refdb-mode-manual.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -U2 -r1.3 -r1.4
--- refdb-mode-manual.xml	8 Dec 2005 00:58:26 -0000	1.3
+++ refdb-mode-manual.xml	18 Dec 2005 23:52:00 -0000	1.4
@@ -73,9 +73,12 @@
     <sect1>
       <title>Using refdb-mode with NTEmacs</title>
-      <para>Windows is an extra challenge for refdb-mode, as we have to call Cygwin programs (the RefDB clients) from a Win32 application through Lisp commands, leaving enough room for things to go wrong. It boils down to getting your <filename>.emacs</filename> right, and we'll show here step by step what it takes to see the light. You'll notice that the setup uses UTF-8 quite heavily, assuming that you've set up your RefDB databases accordingly. I've settled for this encoding as it gave me the simplest consistent setup possible. You may well experiment with other character encodings, but I hardly see any benefit in doing so.</para>
+      <para>Windows is an extra challenge for refdb-mode, as we have to call Cygwin programs (which use Unix-style paths) from a Win32 application (which uses Win32-style paths) by running a Cygwin shell (which needs a different environment than the one it inherits from NTEmacs) through Lisp commands, leaving enough room for things to go wrong. It boils down to getting your <filename>.emacs</filename> right, and we'll show here step by step what it takes to see the light. You'll notice that the setup uses UTF-8 quite heavily, assuming that you've set up your RefDB databases accordingly. I've settled for this encoding as it gave me the simplest consistent setup possible. You may well experiment with other character encodings, but I hardly see any benefit in doing so.</para>
       <note>
 	<para>Some of the administrative functions currently do not work under NTEmacs. Affected are all functions which run <command>sudo</command> for authentication or which start an xterm to obtain database passwords.</para>
       </note>
-      <programlisting>
+      <note>
+	<para>Path names need a little extra care on Windows. Save yourself a great deal of pain by adding all Win32 executables that you want to call (mainly viewers for RTF, PDF, and Postscript files) to your Windows PATH. In your <filename>/usr/local/etc/refdb-mode-config.el</filename> file, use the command names instead of the full paths of the viewing programs.</para>
+	</note>
+       <programlisting>
 ;; use Unix-style line endings
 (setq-default buffer-file-coding-system 'undecided-unix)
@@ -89,5 +92,5 @@
 	      file-coding-system-alist))
       </programlisting>
-      <para>First we ask NTEmacs to use Unix-style line endings. The second expression makes sure that all XML files as well as all files with the string "utf-8" in their name (e.g. <filename>refdata.utf-8.ris</filename>) are loaded as Unicode files using the UTF-8 character encoding.</para>
+      <para>First we ask NTEmacs to use Unix-style line endings. The second expression makes sure that all XML files as well as all files with the string "utf8" in their name (e.g. <filename>refdata-utf8.ris</filename>) are loaded as Unicode files using the UTF-8 character encoding.</para>
       <programlisting>
 ;; use bash as the default shell
@@ -110,4 +113,7 @@
       </programlisting>
       <para>This block of commands uses the Cygwin version of <command>bash</command> as the default shell. It also makes sure that a few additional directories are added to the path. Finally it tells NTEmacs that the data returned by the shell use the UTF-8 encoding as well. The paths shown here need to be adapted to your local installation.</para>
+      <note>
+	<para>If you want to process SGML files, you'll have to set <envar>SGML_CATALOG_FILES</envar> in your <filename>.bashrc</filename> using Unix-style paths (bash, when called from NTEmacs, doesn't seem to evaluate <filename>/etc/profile</filename>).</para>
+      </note>
       <programlisting>
 ;; refdb-mode and ris mode