[giFTcurs-commits] giFTcurs INSTALL INSTALL.ms

[Göran Weinholt]

CVSROOT:        /cvsroot/giftcurs
Module name:    giFTcurs
Branch:         
Changes by:     Göran Weinholt <address@hidden> 03/11/30 14:32:04

Modified files:
        .              : INSTALL INSTALL.ms 

Log message:
        Documented some of our configure flags.

Patches:
Index: giFTcurs/INSTALL
diff -u giFTcurs/INSTALL:1.4 giFTcurs/INSTALL:1.5
--- giFTcurs/INSTALL:1.4        Sat Nov 15 16:46:27 2003
+++ giFTcurs/INSTALL    Sun Nov 30 14:32:03 2003
@@ -11,7 +11,7 @@
 and glib-2.0 installed. pkg-config is also required. If glib-2.0 is
 installed in a non-standard location, you might need to set the
 PKG_CONFIG_PATH environment variable to the directory where glib-2.0.pc is.
-When you've untarred the sources, cd into the giFTcurs directory and type:
+When you've untarred the sources, cd into the source directory and type:
 
      ./configure
      make
@@ -21,6 +21,40 @@
 If things went well you should be able to run giFTcurs and connect to the
 giFT daemon. If you don't have giFT, look at http://giftproject.org/.
 
+CONFIGURE FLAGS
+
+Here are some flags you can pass to configure in order to enable/disable
+features or change what libraries are used:
+
+--with-ncurses[=dir]
+
+     Build with ncurses. If dir is specified, the configure script will try
+     to use the ncurses library in that directory.
+
+--with-ncursesw[=dir]
+
+     Build with ncursesw. The configure script will check if the wadd_ch
+     function is available and in that case enable UTF-8 support.
+
+--disable-libgpm
+
+     By default the configure script will look for libgpm, to get mouse
+     support in the Linux console. This flag turns off this check.
+
+--disable-mouse
+
+     This flag turns off mouse support. This flag exists just so that
+     people who don't need mouse support will get a smaller binary.
+
+--disable-internal-mouse
+
+     If mouse support is enabled, it will by default be handled by routines
+     built-in to giFTcurs. This internal mouse support can use libgpm and
+     xterm mouse codes, but it will not work with e.g. OS/2 terminals.
+
+There are more flags you can pass to configure. Use the --help flag to get
+a list.
+
 INSTALLATION IN CYGWIN
 
 To install giFTcurs for cygwin, you will need to download and install glib.
@@ -28,8 +62,8 @@
 version of glib, and unpack it in cygwin's root directory. Provided that
 the version is 2.2.1-2, the following will do this:
 
-     wget http://web.sfc.keio.ac.jp/~s01397ms/cygwin/glib-2.2.1-2.tar.gz -O -|\
-     tar -C / -xvzf -
+     wget http://web.sfc.keio.ac.jp/~s01397ms/cygwin/glib-2.2.1-2.tar.gz \
+      -O - | tar -C / -xvzf -
 
 Now follow the instructions in the GENERIC INSTALLATION section.
 
Index: giFTcurs/INSTALL.ms
diff -u giFTcurs/INSTALL.ms:1.4 giFTcurs/INSTALL.ms:1.5
--- giFTcurs/INSTALL.ms:1.4     Sat Nov 15 16:46:27 2003
+++ giFTcurs/INSTALL.ms Sun Nov 30 14:32:03 2003
@@ -1,4 +1,4 @@
-.\" $Id: INSTALL.ms,v 1.4 2003/11/15 21:46:27 weinholt Exp $
+.\" $Id: INSTALL.ms,v 1.5 2003/11/30 19:32:03 weinholt Exp $
 .\" giFTcurs INSTALL File source.
 .\" Brian Mays' debian/README.ms from the rxvt package was used as a template.
 .ss 12 0 \"            No extra space after sentences.
@@ -36,8 +36,7 @@
 If \fIglib\-2.0\fP is installed in a non-standard location, you might
 need to set the \fIPKG_CONFIG_PATH\fP environment variable to the
 directory where \fIglib\-2.0.pc\fP is.
-When you've untarred the sources, cd into the \fIgiFTcurs\fP directory
-and type:
+When you've untarred the sources, cd into the source directory and type:
 .Vs
 \&./configure
 make
@@ -48,6 +47,46 @@
 the \fIgiFT\fP daemon.
 If you don't have giFT, look at http://giftproject.org/.
 .SH \" new section
+CONFIGURE FLAGS
+.\" This section should document the flags we add ourselves.
+.LP
+Here are some flags you can pass to configure in order to enable/disable
+features or change what libraries are used:
+.LP
+.B \-\-with\-ncurses[=dir]
+.IP
+Build with ncurses.
+If \fBdir\fP is specified, the configure script will try to use the
+ncurses library in that directory.
+.LP
+.B \-\-with\-ncursesw[=dir]
+.IP
+Build with ncursesw.
+The configure script will check if the \fIwadd_ch\fP function is available
+and in that case enable UTF-8 support.
+.LP
+.B \-\-disable\-libgpm
+.IP
+By default the configure script will look for libgpm, to get mouse
+support in the Linux console.
+This flag turns off this check.
+.LP
+.B \-\-disable\-mouse
+.IP
+This flag turns off mouse support.
+This flag exists just so that people who don't need mouse support will
+get a smaller binary.
+.LP
+.B \-\-disable\-internal\-mouse
+.IP
+If mouse support is enabled, it will by default be handled by routines
+built-in to \fIgiFTcurs\fP.
+This internal mouse support can use libgpm and xterm mouse codes, but
+it will not work with e.g. OS/2 terminals.
+.LP
+There are more flags you can pass to configure. Use the \fB\-\-help\fP
+flag to get a list.
+.SH \" new section
 INSTALLATION IN CYGWIN
 .\" Maintained by rasa.
 .LP
@@ -58,8 +97,8 @@
 version of glib, and unpack it in cygwin's root directory.
 Provided that the version is 2.2.1\-2, the following will do this:
 .Vs
-wget http://web.sfc.keio.ac.jp/~s01397ms/cygwin/glib\-2.2.1\-2.tar.gz \-O \-|\\
-tar \-C / \-xvzf \-
+wget http://web.sfc.keio.ac.jp/~s01397ms/cygwin/glib\-2.2.1\-2.tar.gz \\
+ \-O \- | tar \-C / \-xvzf \-
 .Ve
 Now follow the instructions in the GENERIC INSTALLATION section.
 .SH \" new section