- CONFIGURATION AND ENVIRONMENT
- EXIT STATUS
- SEE ALSO
- BUGS AND LIMITATIONS
- LICENSE AND COPYRIGHT
buzzsaw - The BuzzSaw log file processing suite.
This documentation refers to buzzsaw version 0.12.0
buzzsaw help buzzsaw help import buzzsaw import [--readall] [--configfile foo.yaml]
This is a command-line tool which allows you to issue various commands to the BuzzSaw log file processing suite.
There are two built-in commands:
- help [command name]
If you call the
helpcommand with no arguments it will list all the supported commands. If you also specify a particular command name it will show all the available command-line options for that specific command.
This command gives a list of all available commands.
The following standard commands are each implemented with a separate Perl module. For full documentation you need to read the perldoc for the specific module. They are all in the
BuzzSaw::Cmd namespace. It is possible to extend this list with extra, locally supplied, commands with Perl modules in the same namespace.
Note that it is possible to use the shortest unique name for a command rather than typing the whole thing.
- import - BuzzSaw::Cmd::Import
Scans sets of logs for events of interest and stores them in a database.
CONFIGURATION AND ENVIRONMENT
Many of these commands can be configured via configuration files as well as via their command line options. The configuration files are typically stored in the
/etc/buzzsaw directory. You should read the documentation for the individual Perl modules to see what files are examined.
After successfully running a command it will exit with code zero. An error will result in a non-zero error code.
This is the list of platforms on which we have tested this software. We expect this software to work on any Unix-like platform which is supported by Perl.
BUGS AND LIMITATIONS
Please report any bugs or problems (or praise!) to email@example.com, feedback and patches are also always very welcome.
Stephen Quinney <firstname.lastname@example.org>
LICENSE AND COPYRIGHT
Copyright (C) 2012 University of Edinburgh. All rights reserved.
This library is free software; you can redistribute it and/or modify it under the terms of the GPL, version 2 or later.