'\" t
.\"     Title: AMINER
.\"    Author: Markus Wurzenberger <markus.wurzenberger@ait.ac.at>
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 10/13/2023
.\"    Manual: logdata-anomaly-miner User Manual
.\"    Source: logdata-anomaly-miner
.\"  Language: English
.\"
.TH "AMINER" "1" "10/13/2023" "logdata-anomaly-miner" "logdata-anomaly-miner User Man"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
aminer \- lightweight tool for log checking, log analysis
.SH "SYNOPSIS"
.HP \w'\fBaminer\fR\ 'u
\fBaminer\fR \fB\-\-Config|\-\-config|\-c\ \fR\fB\fIfile\fR\fR \fB[OPTIONS]\&.\&.\&.\fR
.SH "DESCRIPTION"
.PP
This manual page documents briefly the
\fBaminer\fR
command\&. For more details see packaged documentation at /usr/share/doc/logdata\-anomaly\-miner\&.
.SH "OPTIONS"
.PP
\fB\-\-config, \-c \fR\fB\fIfile\fR\fR
.RS 4
Specify the configuration file, otherwise /etc/aminer/config\&.py is used\&. See /etc/aminer/template_config\&.py or /etc/aminer/template_config\&.yml for configuration file templates and examples\&.
.RE
.PP
\fB\-\-daemon, \-D\fR
.RS 4
With this parameter, aminer will detach from the terminal and daemonize\&. When not in foreground mode, aminer will also change the working directory to /, hence relative path in configuration file will not work\&.
.RE
.PP
\fB\-\-stat, \-s \fR\fB\fIstat\-level\fR\fR
.RS 4
Set the statistic logging level\&. Possible stat\-levels are 0 for no statistics, 1 (default) for normal statistic level and 2 for verbose statistics\&.
.RE
.PP
\fB\-\-debug, \-d \fR\fB\fIdebug\-level\fR\fR
.RS 4
Set the debug logging level\&. Possible debug\-levels are 0 for no debugging, 1 (default) for normal output (INFO and above), 2 for printing all debug information\&.
.RE
.PP
\fB\-\-run\-analysis\fR
.RS 4
INTERNAL PARAMETER \- DO NOT USE\&. It is just documented here for completeness\&.
.RE
.PP
\fB\-\-restore, \-R \fR\fB\fIbackup\-directory\fR\fR
.RS 4
Restores the persistence directory from
\fIbackup\-directory\fR\&.
.RE
.PP
\fB\-\-clear, \-C\fR
.RS 4
With this parameter all persisted data in config_properties[\*(AqCore\&.PersistenceDir\*(Aq] is deleted\&. USE THIS PARAMETER CAREFULLY\&. IT DELETES ALL SUB\-DIRECTORIES OF THE PERSISTENCE DIRECTORY\&.
.RE
.PP
\fB\-\-remove, \-r \fR\fB\fIdirectory\fR\fR
.RS 4
Remove persisted data of one Detector\&.
.sp
\fBExample 1: \fR\-\-remove NewMatchPathDetector
.sp
\fBExample 2: \fR\-\-remove NewMatchPathDetector \-\-remove EventCorrelationDetector
.RE
.PP
\fB\-\-from\-begin, \-f\fR
.RS 4
With this parameter all live data in config_properties[\*(AqCore\&.PersistenceDir\*(Aq]/AnalysisChild/RepositioningData is deleted\&.
.RE
.PP
\fB\-\-help, \-h\fR
.RS 4
Prints the help\-screen
.RE
.PP
\fB\-\-version, \-v\fR
.RS 4
Prints the version\-string
.RE
.SH "FILES"
.PP
/etc/aminer/config\&.py
.RS 4
The main configuration file for the aminer daemon\&. See /etc/aminer/template_config\&.py and /etc/aminer/template_config\&.yml for configuration file templates and examples\&.
.RE
.SH "BUGS"
.PP
Report bugs via your distribution\*(Aqs bug tracking system\&. For bugs in the the software trunk, report via at
\m[blue]\fB\%https://github.com/ait-aecid/logdata-anomaly-miner/issues\fR\m[]\&.
.PP
At startup, aminer will quite likely print out some security warnings to increase transparency\&. They are here just to remind you of the limitations the current implementation\&. They should be the same as for nearly all other programs on your platform, just that others do not tell you\&. See the source code documentation for a short explanation, why a given part of the implementation is not that secure as it could be when leveraging the security features a platform could provide you\&.
.SH "SEE ALSO"
.PP
\fBaminerremotecontrol\fR(1)
.SH "AUTHOR"
.PP
\fBMarkus Wurzenberger\fR <\&markus\&.wurzenberger@ait\&.ac\&.at\&>
.RS 4
Wrote this manpage for the Debian system\&.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2016 Markus Wurzenberger
.br
.PP
This manual page was written for the Debian system (and may be used by others)\&.
.PP
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 3\&.
.PP
On Debian systems, the complete text of the GNU General Public License can be found in
/usr/share/common\-licenses/GPL\&.
.sp