File: README.namazu

package info (click to toggle)
wwwoffle 2.7a-1.2
  • links: PTS
  • area: main
  • in suites: woody
  • size: 6,360 kB
  • ctags: 1,669
  • sloc: ansic: 18,393; lex: 3,663; sh: 3,123; perl: 614; makefile: 519; lisp: 14
file content (171 lines) | stat: -rw-r--r-- 4,865 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
          WWWOFFLE - World Wide Web Offline Explorer - Version 2.7
          ========================================================


The program namazu is a free (GPL) web server indexing and search program.

        Namazu is a full-text search engine intended for easy
        use. Not only does it work as a small or medium scale Web
        search engine, but also as a personal search system for
        email or other files.

Namazu is different from most such programs in that it only searches the
filesystem that is used by the web server and does not access the server
directly.

The program that performs the searching & indexing for the namazu package is
called mknmz.  The program mknmz-wwwoffle has been written by WATANABE Yoshimasa
to allow indexing of the WWWOFFLE cache.  This is performed directly on the
files in the cache.


Installing Namazu
-----------------

Note: If you already have version 2 or later of Namazu installed and working
      then you can skip this section.

To be able to use this program it must be installed.  The instructions below
give a step-by-step guide to this process assuming that version 2.0.5 of
Namazu is used, later versions should also work.

1) Get the Namazu source code

Download the source for the Namazu programs from

        http://www.namazu.org/


2) Unpack the source code

Use

        tar -xvzf namazu-2.0.5.tar.gz

to create the directory namazu-2.0.5 with the program source files in.


3) Configure the namazu compilation stage

Move to the namazu-2.0.5 directory and run the configuration program

        cd namazu-2.0.5
        ./configure


4) Compile

Run make to compile Namazu

        make
        make install

This will compile and install it.  Any problems at this stage will require the
use of the Namazu documentation to solve.


Installing mknmz-wwwoffle
-------------------------

Note: If you already have version 0.7 or later of mknmz-wwwoffle installed and
      working then you can skip this section.

To be able to use this program it must be installed.  The instructions below
give a step-by-step guide to this process assuming that version 0.7.0 of
mknmz-wwwoffle is used, later versions should also work.

1) Get the mknmz-wwwoffle source code

Download the source for the mknmz-wwwoffle program from

        http://www.naney.org/comp/distrib/mknmz-wwwoffle/


2) Unpack the source code

Use

        tar -xvzf mknmz-wwwoffle-0.7.0.tar.gz

to create the directory mknmz-wwwoffle-0.7.0 with the program source files in.


3) Configure the mknmz-wwwoffle compilation stage

Move to the mknmz-wwwoffle-0.7.0 directory and run the configuration program

        cd mknmz-wwwoffle-0.7.0
        ./configure


4) Compile

Run make to compile mknmz-wwwoffle

        make
        make install

This will compile and install it.  Any problems at this stage will require the
use of the mknmz-wwwoffle documentation to solve.



Configure WWWOFFLE to run with Namazu & mknmz-wwwoffle
------------------------------------------------------

The configuration files for the Namazu programs as used with WWWOFFLE will have
been installed in /var/spool/wwwoffle/search/namazu/conf when WWWOFFLE was
installed.  The scripts used to run the Namazu programs will have been installed
in /var/spool/wwwoffle/search/namazu/scripts when WWWOFFLE was installed.

These files should be correct if the information in the WWWOFFLE Makefile
(LOCALHOST and SPOOLDIR) was set correctly.  Check them, they should have the
spool directory and the proxy hostname and port set correctly.

Also they should be checked to ensure that the Namazu programs are on the path
(you can edit the PATH variable here if they are not in /usr/local/bin).


Indexing
--------

Indexing is the name that is given to the process of searching through the
web-pages to make the search database.

To work with WWWOFFLE I have produced my own scripts that should be used
to call the Namazu indexer progam (mknmz).

   /var/spool/wwwoffle/search/namazu/scripts/wwwoffle-mknmz-full
   /var/spool/wwwoffle/search/namazu/scripts/wwwoffle-mknmz-lasttime

The first of these scripts will do a full search and index all of the URLs in
the cache.  The second one will do a search on the files in the lasttime
directory.


Searching
---------

The search page for Namazu is at http://localhost:8080/search/namazu/ and is
linked to from the "Welcome Page".  The word or words that you want to search
for should be entered here.

This form actually calls the script

   /var/spool/wwwoffle/search/namazu/scripts/wwwoffle-namazu

to do the searching so it is possible to edit this to modify it if required.


Thanks to
---------

Thanks to WATANABE Yoshimasa <naney@naney.org> for writing the mknmz-wwwoffle
program without which the Namazu program and WWWOFFLE could not have been used
together.



Andrew M. Bishop
12th Aug 2001