imgSeekCmd User Guide

by Ricardo Niederberger Cabral
<nieder|at|mail.ru>
Time-stamp: <03/03/09 18:03:38 rnc>

Introduction

imgSeekCmd is a command-line interface to common imgSeek image database operations.

When imgSeek is properly installed, you can run imgSeekCmd the same way you would run imgSeek:

$ imgSeekCmd

Commands

Every command must be performed on a database. You can specify which one to use with the -b parameter. The default database ~/.imgseek/img-db.iqd will be used if you don't provide one. If there is no database on the provided file, a new one will be created before actions are performed.

The following database operations are allowed:

add

You can scan all database directories for new images, add new images from a given directory recursively or not and provide options for these actions. From the add command help output:

Switches:
        -h      Show this help.
        -s      Scan all database directories for new images, adding them.
        -r      Recurse into subdirectories when adding a path
Parameters:
        [None]
Optional parameters:
        -i      Ignore images with this string on their path
        -b      Database to use. [~/.imgseek/img-db.iqd]
        -z      Ignore images smaller than this size (kb)
        -m      Ignore images with a dimension smaller than this (pixels)
        -d      Scan and add to database all images on this directory.

info

Use it to dump data associated to images in a database. You may specify images by their file name, full path filename or internal image id. (See the browse command to learn how to discover what's in a database.

From the info command help output:

Switches:
        -m      Dump all metadata for this image.
Parameters:
        -i      Image id
        -p      Image filename (full path - slow)
        -f      Image filename
Optional parameters:
        -b      Database to use. [~/.imgseek/img-db.iqd]
        -d      Dump this metadata field.

query

Query images by content by supplying a source query image and the max number of results desired.

From the query command help output:

Switches:
        [None]
Parameters:
        -i      Image id
        -p      Image filename (full path)
        -f      Image filename
Optional parameters:
        -r      Number of results [10]
        -b      Database to use. [~/.imgseek/img-db.iqd]

browse

Use the browse command to list database contents. Listings will be printed as comma separated values, with a proper description header.

From the browse command help output:

Switches:
        -F      List all images on database
        -G      List all groups
        -V      List all volumes
Parameters:
        [None]
Optional parameters:
        [None]