--- trunk/PlusPlus.pm	2004/12/03 13:31:43	1
+++ trunk/PlusPlus.pm	2004/12/03 15:23:23	3
@@ -4,7 +4,7 @@
 use strict;
 use warnings;
 
-our $VERSION = '0.01';
+our $VERSION = '0.02';
 
 use Carp;
 
@@ -20,8 +20,12 @@
 =head1 DESCRIPTION
 
 This is perl module to use SWISH++ indexer by Paul J. Lucas. SWISH++ is
-rewrite of swish-e in C++ with blazingly fast performance, but without
-support for properties (which this module tries to fix)
+rewrite of swish-e in C++ which is extremly fast (thank to mmap), but without
+support for properties (which this module tries to fix).
+
+Implementation of this module is crafted after L<Plucene::Simple> and it
+should be easy to replace Plucene with this module for increased
+performance. However, this module is not plug-in replacement.
 
 =head1 METHODS
 
@@ -29,39 +33,94 @@
 
 Create new indexing object.
 
-  my $i = new SWISH::PlusPlus(
-  	index => '/path/to/index',
+  my $i = SWISH::PlusPlus->open(
+  	index_dir => '/path/to/index',
+	index => 'index++',
+	search => 'search++',
   );
 
 Options to open are following:
 
 =over 5
 
+=item C<index_dir>
+
+Path to directory in which index will be created.
+
 =item C<index>
 
-path to directory in which index will be created.
+Full or partial path to SWISH++ index executable. By default, it's B<index>
+for self-compiled version. If you use Debian GNU/Linux package specify
+B<index++>. See C<Debian>.
+
+=item C<search>
+
+Full or partial path to SWISH++ search executable. By default, it's B<search>.
 
 =back
 
 =cut
 
-sub new {
+sub open {
         my $class = shift;
         my $self = {@_};
 	bless($self, $class);
 
-	foreach (qw(index)) {
+	foreach (qw(index_dir)) {
 		croak "need $_" unless $self->{$_};
 	}
 
-	if (! -e $self->{'index'}) {
-		mkdir $self->{'index'} || confess "can't create index ",$self->{'index'},": $!";
+	if (! -e $self->{'index_dir'}) {
+		mkdir $self->{'index_dir'} || confess "can't create index ",$self->{'index'},": $!";
 	}
 
+	# default executables
+	$self->{'index'} ||= 'index';
+	$self->{'search'} ||= 'search';
+
 	$self ? return $self : return undef;
 }
 
 
+=head2 check_bin
+
+Check if swish++ binaries specified in L<open> are available and verify
+version signature.
+
+  if ($i->check_bin) {
+  	print "swish++ binaries found\n";
+  };
+
+It will also setup property 
+
+  $i->{'version'}
+
+which you can examine to see version.
+
+=cut
+
+sub check_bin {
+	my $self = shift;
+
+	my $i = `$self->{'index'} -V 2>&1` || confess "can't find '",$self->{'index'},"' binary";
+	my $s = `$self->{'search'} -V 2>&1` || confess "can't find '",$self->{'search'},"' binary";
+
+	chomp $i;
+	chomp $s;
+
+	confess $self->{'index'}," binary is not SWISH++" unless ($i =~ m/^SWISH\+\+/);
+	confess $self->{'search'}," binary is not SWISH++" unless ($s =~ m/^SWISH\+\+/);
+
+	if ($i eq $s) {
+		$self->{'version'} = $i;
+		return 1;
+	} else  {
+		carp "version difference: index is $i while search is $s";
+		return;
+	}
+
+}
+
 1;
 __END__
 
@@ -69,6 +128,16 @@
 
 None by default.
 
+=head1 RELATED
+
+=head2 Debian
+
+Debian version of swish++ is often old (version 5 at moment of this writing
+while version 6 is available in source code), so this module by default
+uses executable names B<index> and B<search> for self-compiled version
+instead of one from Debian package. See L<open> how to specify Debian
+default binaries B<index++> and B<search++>.
+
 =head1 SEE ALSO
 
 Mention other useful documentation such as the documentation of