Tech. Documentation - indexer command

---

---

NAME

indexer - Indexing daemon for EPrints

---

SYNOPSIS

indexer start [options]

indexer stop

indexer status

---

DESCRIPTION

This daemon runs in the background and creates index files for all eprints archives. It builds indexes for each archive in turn then starts again.

Messages and errors are logged to /opt/eprints2/var/indexer.log unless you change the log options. If it appears to be having problems try raising the log level and examining the log.

Once all the archives have been indexed, the indexer rolls the logs (up to logfile.5) and then starts again. See --rollcount for ways to customise this.

---

OPTIONS

--help

Print a brief help message and exit.

--man

Print the full manual page and then exit.

--quiet

Be vewwy vewwy quiet. This option will supress all output unless an error occurs.

--force

Start up, even if the PID file exists (implying another copy is running). This is useful for starting after a crash, but be carefully not to run to copies at once as BAD THINGS will happen.

--verbose

Explain in detail what is going on. May be repeated for greater effect.

--logfile filename

Log to filename rather than default indexer log.

--loglevel level

Set the level of detail to log. Level may be 0-5.

Do not log anything.
Report start, stop and errors.
3. [default]
   
All above, plus report names of archives being indexed and warnings.
All above, plus report processes starting and stopping and each dataset being indexed.
All above, plus report details of index process.
All above, plus report id of every item indexed.

--rollcount number

Set the number of once-through logs that should be kept. If set to zero then indexer will never roll the logs but rather just keep writing to the main log.

--notdaemon

Do not become a daemon, remain attached to the current terminal (errors still go to the log file).

--once

Only index each archive once rather than loop for ever.

--version

Output version information and exit.

---

Making into a service

This has only been tested under redhat linux. It make work on other OS's, but not promise.

To make the indexer into a service which starts and stops on reboots etc. like httpd and mysqld do the following (as root):

 ln -s /opt/eprints2/bin/epindexer /etc/init.d/epindexer 
 chkconfig --add epindexer
 chkconfig epindexer on

The epindexer script runs as root, changes user to "eprints" (or whatever uid your eprints install runs as) and then calls indexer.

EPrints 2.3 Documentation - indexer command