aboutsummaryrefslogtreecommitdiff

Somewhere - Find your papers

Search through PDF files for matching words.

Usage

$ ./smwh -h
USAGE: ./smwh MODE [OPTIONS]
    MODES:
    ./smwh query QUERY [FILE..] (abbrev: q)
        OPTIONS:
            -l [0|NONE] or [1|LOG] or [2|WARN] or [3|VERBOSE]
            -n MAX ANSWERS (default: 5)
    ./smwh index [FILE..] (abbrev: i)
            -l [0|NONE] or [1|LOG] or [2|WARN] or [3|VERBOSE]

There are two 'modes' of execution:

  1. smwh query to rank pdfs based on a keyword
  2. smwh index to index pdfs in order to speed up subsequent queries

both modes accept a list of files or directories to index, but one can also define the variable SMWH_DIRS as a colon-separated list of directories in which to look for PDF files.

Dependencies

Compiling from source

You will need make and pkg-config, then you simply need to run:

$ make

To run the tests run

$ make check

Install

$ make PREFIX=blabla install

this will install smwh into $PREFIX/bin. The default PREFIX is /usr/local, so installing there requires root privileges.

License

Somewhere is released under the terms of the GNU General Public License, either version 3 of the license or, at your discretion, any later version.