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

Интерфейс ngindex.

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

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

где filenames - имена файлов с информацией о потоках в формате Netflow.

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

-d, -db-dir {dirname}
Имя директории, в которой будут сохранены файлы базы данных в формате BerkeleyDB. Обязательная опция.
-h, -help
Вывод справки по опциям. Необязательная опция.
-t, -template {template}
Имя файла шаблона с описанием внутренней структуры записи о потоке. Обязательная опция.
-v, -verbose
Режим выдачи подробной информации о работе программы в стандартный поток вывода. Необязательная опция.
-V, -version
Вывод версии программы. Необязательная опция.
-w, -infunc {function name}
Указывается имя функции для разбора файлов, хранящих потоки. Необязательная опция. По умолчанию используется функция для разбора файлов в формате flow-tools, с данными Netflow версии 5.

В случае ошибки в опциях или возникновения ошибки в процессе работы на стандартный поток ошибок происходит вывод поясняющего сообщения. В случае успешного завершения работы создается директория, содержащая файлы базы данных.

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

  1. $ ngindex -version
    ngindex (ngfilter tools) 0.1

  2. $ ngindex -h
    ngindex usage: ngindex [options [parameters]] 
                  -t <template> -d <dirname> <filenames>
    
    -d, --db-dir  {dirname}       Output database directory
    -h, --help                    Print this information
    -t, --template {template}     Template file name
    -v, --verbose                 Verbose mode
    -V, --version                 Print program version
    -w, --infunc {function name}  Parse function
    



Aleks Sherikov 2006-05-23