Documentation

diff --git a/.gitignore b/.gitignore
index 2249ffa..99b8e5c 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -6,3 +6,4 @@ noipv4
 debian/files
 debian/gaise
 debian/substvars.*
+gaise-*.tar.gz

diff --git a/Makefile b/Makefile
index 9d2f648..26425a4 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -56,8 +56,8 @@ install: installdirs
        $(INSTALL) -m 755 noipv6 $(bindir)/noipv6
        $(INSTALL) -m 755 noipv4 $(bindir)/noipv4
        $(INSTALL) -m 644 ${MODULE} $(libdir)/gaise/${MODULE} 
-       #$(INSTALL) -m 644 noipv6.1 $(man1dir)/noipv6
-       #$(INSTALL) -m 644 noipv4.1 $(man1dir)/noipv4
+       $(INSTALL) -m 644 noipv6.1 $(man1dir)/noipv6.1
+       $(INSTALL) -m 644 noipv4.1 $(man1dir)/noipv4.1
 
 install-strip: install
 

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..477746e
--- /dev/null
+++ b/README
@@ -0,0 +1,32 @@
+Gaise
+=====
+
+  Gaise consists of a pair of programs, noipv4 and noipv6, which
+  suppress IPv4 and IPv6 addresses in getaddrinfo() responses.  The
+  idea is to force the use IPv6 or IPv4 connectivity even when the
+  other is available.
+
+  To install:
+
+     make
+     sudo make install
+
+Licence
+=======
+
+  Copyright © 2011 Richard Kettlewell
+
+  This program is free software; you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation; either version 2 of the License, or
+  (at your option) any later version.
+
+  This program is distributed in the hope that it will be useful, but
+  WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+  General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
+  USA

diff --git a/debian/rules b/debian/rules
index 6ebde30..d269a4b 100755 (executable)
--- a/debian/rules
+++ b/debian/rules
@@ -42,6 +42,7 @@ pkg-gaise:
        mkdir -p debian/gaise/usr/lib/gaise
        mkdir -p debian/gaise/usr/share/man/man1
        $(MAKE) install prefix=debian/gaise/usr mandir=debian/gaise/usr/share/man
+       gzip -9 debian/gaise/usr/share/man/man*/*
        strip --strip-unneeded \
                --remove-section=.comment \
                debian/gaise/usr/lib/gaise/gaise.so

diff --git a/noipv4.1 b/noipv4.1
new file mode 100644 (file)
index 0000000..dbc38d6
--- /dev/null
+++ b/noipv4.1
@@ -0,0 +1,35 @@
+.TH noipv4 1
+.SH NAME
+noipv4 \- run a program with IPv4 address suppressed
+.SH SYNOPSIS
+.B noipv4
+.RB [ -- ]
+.I COMMAND
+.IR ARGS ...
+.SH DESCRIPTION
+.B noipv4
+runs a program with any IPv4 responses to
+.BR getaddrinfo (3)
+calls suppressed.
+The effect is that (subject to the caveats below) it will always IPv6
+connectivity instead of IPv4 connectivity.
+.SH OPTIONS
+.TP
+.B -h
+.TP
+.B --help
+Display usage message.
+.TP
+.B -V
+.TP
+.B --version
+Display version string.
+.SH LIMITATIONS
+.B noipv4
+only intercepts calls to
+.B getaddrinfo (3).
+Any program that uses other means of mapping hostnames to addresses
+will not be affected.
+.PP
+.B noipv4
+does not work on setuid or setgid programs.

diff --git a/noipv6.1 b/noipv6.1
new file mode 100644 (file)
index 0000000..0ac029c
--- /dev/null
+++ b/noipv6.1
@@ -0,0 +1,35 @@
+.TH noipv6 1
+.SH NAME
+noipv6 \- run a program with IPv6 address suppressed
+.SH SYNOPSIS
+.B noipv6
+.RB [ -- ]
+.I COMMAND
+.IR ARGS ...
+.SH DESCRIPTION
+.B noipv6
+runs a program with any IPv6 responses to
+.BR getaddrinfo (3)
+calls suppressed.
+The effect is that (subject to the caveats below) it will always IPv4
+connectivity instead of IPv6 connectivity.
+.SH OPTIONS
+.TP
+.B -h
+.TP
+.B --help
+Display usage message.
+.TP
+.B -V
+.TP
+.B --version
+Display version string.
+.SH LIMITATIONS
+.B noipv6
+only intercepts calls to
+.B getaddrinfo (3).
+Any program that uses other means of mapping hostnames to addresses
+will not be affected.
+.PP
+.B noipv6
+does not work on setuid or setgid programs.