next up previous contents
Next: Высокоуровневое описание архитектур утилит. Up: Описание интерфейсов утилит. Previous: Интерфейс ngindex.   Contents

Интерфейс ngfilter.

Программа фильтр представляет собой консольную утилиту, которая осуществляет отбор значений из базы данных BerkeleyDB по заданным критериям и выводит набор удовлетворяющих записей. Поддерживаются длинная и короткая формы записи опций. При запуске необходимо обязательно указать каталог, в котором заранее были построены индексные файлы с помощью утилиты ngindex, на основе которых программа ngfilter будет осуществлять поиск необходимых записей, а также указать файл-шаблон, на основе которого программа будет формировать записи.

Формат вызова программы: ngfilter [опции [параметры]] -d <dirname> -t <template>

Список опций программы:

-d, -db-dir {dirname}
Имя директории, из которой будут прочитаны файлы базы данных в формате BerkeleyDB. Обязательная опция.
-t, -template {template}
Имя файла шаблона с описанием внутренней структуры записи о потоке. Обязательная опция.
-V, -version
Вывод версии программы. Необязательная опция.
-h, -help Вывод справки по опциям. Необязательная опция.
-c, -criterion
Указываем имя входного файла с критериями для выборки. По умолчанию программа берёт файл ngfilter.conf из текущего каталога.
-v, -verbose
Режим выдачи подробной информации о работе программы на стандартный поток вывода. Необязательная опция.
-o, -output
Указать файл, в который будет записан результат выборки. По умолчанию результат выводится на стандартный поток вывода. Необязательная опция.

Формат вывода сообщений о версии и подсказки по использованию:

  1. $ ngfilter -version
    ngfilter (ngfilter tools) 1.1

  2. $ ngfilter -h
    ngfilter usage: ngfilter [options [parameters]] -t <template> -d <dirname>
    
    -d, --db-dir {dirname}     Database directory
    -t, --template {template}  Template file name
    -V, --version              Print program version
    -h, --help                 Print this information
    -c, --criterion {filename} Set manualy file name with search criterion. 
                               Default file is ngfilter.conf
    -v, --verbose              Show process information. Default it 
                               is hidden.
    -o, --output {filename}    Set manualy file name where program will 
                               output results.
    



Aleks Sherikov 2006-05-23