'\" t .\" Title: AMINER .\" Author: Markus Wurzenberger .\" Generator: DocBook XSL Stylesheets v1.79.1 .\" Date: 10/02/2018 .\" Manual: logdata-anomaly-miner User Manual .\" Source: logdata-anomaly-miner .\" Language: English .\" .TH "AMINER" "1" "10/02/2018" "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\ \fR\fB\fIfile\fR\fR [\fB\-\-Foreground\fR] [\fB\-\-RunAnalysis\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 with long options starting with two dashes (`\-\*(Aq)\&. A summary of options is included below\&. For a complete description, see the \fBinfo\fR(1) files\&. .PP \fB\-\-Config \fR\fB\fIfile\fR\fR .RS 4 Specify the configuration file, otherwise /etc/aminer/config\&.py is used\&. See /etc/aminer/config\&.py\&.template for configuration file template, /usr/share/doc/logdata\-anomaly\-miner/demo for examples\&. .RE .PP \fB\-\-Foreground\fR .RS 4 With this parameter, AMiner will not 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\-\-RunAnalysis\fR .RS 4 INTERNAL PARAMETER \- DO NOT USE\&. It is just documented here for completeness\&. .RE .SH "FILES" .PP /etc/aminer/config\&.py .RS 4 The main configuration file for the AMiner daemon\&. See /etc/aminer/config\&.py\&.template for configuration file template, /usr/share/doc/logdata\-anomaly\-miner/demo for 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://bugs.launchpad.net/logdata-anomaly-miner/+filebug\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