
                               mknmz-wwwoffle

                                   README.ja

        Copyright (C) 2000,2001,2002 WATANABE Yoshimasa <naney@naney.org>

This file is part of the mknmz-wwwoffle.

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


Japanese
********

If you want to read a Japanese README file, See 'README.ja' (written in
Japanese, UTF-8).


What's mknmz-wwwoffle?
**********************

mknmz-wwwoffle performs full-text search over the cache created by WWWOFFLE,
using full-text search system Namazu (http://www.namazu.org/).  mknmz-wwwoffle
adds a filter for mknmz which is used to generate index files for cache entries
in WWWOFFLE.


Required packages
*****************

Namazu   (Developed with 2.0.10)
WWWOFFLE (Developed with 2.6d)

How to use mknmz-wwwoffle? (Using mknmz-wwwoffle)
*************************************************

mknmz-wwwoffle lists up search string from the cache directory, then call mknmz
to generate index files for Namazu.

Basically, it is equivalent to the use of mknmz. Invoke mknmz-wwwoffle
specifying http directory under WWWOFFLE's cache directory, or host based sub
directory as a target.

  mknmz-wwwoffle -O /var/lib/mknmz-wwwoffle /var/cache/wwwoffle/http

Above example specifies http directory under /var/cache/wwwoffle (WWWOFFLE's
cache directory). Index files will be generated under /var/lib/mknmz-wwwoffle.

How to use mknmz-wwwoffle? (Using mknmz directly)
*************************************************

Invoke mknmz with providing http sub-directory under WWWOFFLE's cache
directory, or under host based sub-directory. If you provide

  --replace='wwwofflecache::replaceCode'

option, cache file names will be translated into respective URIs. In this case,
specify `--no-encode-uri' option as well, as translated URIs already must be
encoded.

You can specify cache data files as a target by providing

  --allow='D.*$'

option.


How to get newest release
*************************

You can get newest release from official site.

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

Bug report
**********

If you find any bugs, please report them to WATANABE Yoshimasa
<naney@naney.org>.

$Id: README,v 1.5 2002/03/14 12:22:16 naney Exp $
