'\" t
.\"     Title: ATHEIST
.\"    Author: Cleto Mart\('in <cleto.martin@gmail.com>
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 02/24/2019
.\"    Manual: atheist User Manual
.\"    Source: atheist
.\"  Language: English
.\"
.TH "ATHEIST" "1" "02/24/2019" "atheist" "atheist User Manual"
.\" -----------------------------------------------------------------
.\" * 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"
atheist \- a general prupose test framework\&.
.SH "SYNOPSIS"
.HP \w'\fBatheist\fR\ 'u
\fBatheist\fR [\fBoptions\fR] {{\fIdirectory\fR\ |\ \fIfile\fR}}
.SH "DESCRIPTION"
.PP
\fBatheist\fR
allows you to specify the behaviour of your tests in a declarative way using many data structures (such us Tasks, Conditions, Daemons, etc\&.) and provides detailed statistic results\&. The main idea is that the programmer may describes the test behaviour in a
\&.test
file and
\fBatheist\fR
runs every tests found\&. It is possible to check and prepare the system by writting setup and teardown files that are executed after and before each test\&.
.PP
Each test is represented by Task object which have many configuration attributes such us execution delay, termination signal expected and many others\&. Tasks have pre and post conditions that are been checked at execution time\&. You may save the test output and compose Conditions objects to assure concrete states of the system during the tests execution\&.
.PP
\fBatheist\fR
free all resources used by the user automatically at the end of the execution\&. See the Atheist manual for more information about data structures and tools provided by the framework\&.
.PP
This manual page was written for the Debian distribution because the original program does not have a manual page\&. Instead, it has documentation in the GNU
\fBinfo\fR(1)
format; see below\&.
.SH "OPTIONS"
.PP
\fB\-a \fR\fB\fIARGS\fR\fR, \fB\-\-task\-args=\fR\fB\fIARGS\fR\fR
.RS 4
Colon\-separated arguments for the tasks\&.
.RE
.PP
\fB\-b \fR\fB\fIPATH\fR\fR, \fB\-\-base\-dir=\fR\fB\fIPATH\fR\fR
.RS 4
Change working directory\&.
.RE
.PP
\fB\-C\fR, \fB\-\-clean\-only\fR
.RS 4
Execute nothing, only remove generated files\&.
.RE
.PP
\fB\-d\fR, \fB\-\-describe\fR
.RS 4
Execute nothing, only describe tasks\&.
.RE
.PP
\fB\-\-dirty\fR
.RS 4
Do not remove generated files after task execution\&.
.RE
.PP
\fB\-e\fR, \fB\-\-stderr\fR
.RS 4
Print task process stderr\&.
.RE
.PP
\fB\-f\fR, \fB\-\-out\-on\-fail\fR
.RS 4
Print task output only if it fails\&.
.RE
.PP
\fB\-g\fR, \fB\-\-gen\-template\fR
.RS 4
Generate a TaskCase file template with default values\&.
.RE
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
Show the help message\&.
.RE
.PP
\fB\-i \fR\fB\fILEVEL\fR\fR, \fB\-\-report\-detail=\fR\fB\fILEVEL\fR\fR
.RS 4
Report verbosity (0:nothing, [1:case], 2:task, 3:condition)\&.
.RE
.PP
\fB\-j\fR, \fB\-\-skip\-hooks\fR
.RS 4
Skip _setup and _teardown files\&.
.RE
.PP
\fB\-k\fR, \fB\-\-keep\-going\fR
.RS 4
Continue even with failed tasks\&.
.RE
.PP
\fB\-l\fR, \fB\-\-list\fR
.RS 4
Execute nothing, only list tasks names\&.
.RE
.PP
\fB\-r \fR\fB\fIRANDOM\fR\fR, \fB\-\-random=\fR\fB\fIRANDOM\fR\fR
.RS 4
Run taskcases in random order using the specified seed\&.
.RE
.PP
\fB\-o\fR, \fB\-\-stdout\fR
.RS 4
Print task stdout\&.
.RE
.PP
\fB\-p \fR\fB\fIPATH\fR\fR, \fB\-\-plugin\-dir=\fR\fB\fIPATH\fR\fR
.RS 4
A directory containing plugins\&.
.RE
.PP
\fB\-q\fR, \fB\-\-quiet\fR
.RS 4
Do not show result summary nor warnings, only totals\&.
.RE
.PP
\fB\-s \fR\fB\fIINLINE\fR\fR, \fB\-\-script=\fR\fB\fIINLINE\fR\fR
.RS 4
Specifies command line script\&.
.RE
.PP
\fB\-t\fR, \fB\-\-time\-tag\fR
.RS 4
Include time info in the logs\&.
.RE
.PP
\fB\-u\fR, \fB\-\-until\-failure\fR
.RS 4
Repeat test until it fails\&.
.RE
.PP
\fB\-v\fR, \fB\-\-verbose\fR
.RS 4
Incresse verbosity\&.
.RE
.PP
\fB\-\-version\fR
.RS 4
Atheist version\&.
.RE
.PP
\fB\-w \fR\fB\fIWORKERS\fR\fR, \fB\-\-workers=\fR\fB\fIWORKERS\fR\fR
.RS 4
number of simultaneous Tasks (deafult:1) 0:auto\-select\&.
.RE
.PP
\fB\-x \fR\fB\fICOMMAND\fR\fR, \fB\-\-exec=\fR\fB\fICOMMAND\fR\fR
.RS 4
Exec COMMAND like in "Test(COMMAND, shell=True)"\&.
.RE
.PP
\fB\-\-case\-time\fR
.RS 4
Print case execution time in reports\&.
.RE
.PP
\fB\-\-cols=\fR\fB\fIWIDTH\fR\fR
.RS 4
Terminal width (in chars)\&.
.RE
.PP
\fB\-\-config=\fR\fB\fIFILE\fR\fR
.RS 4
Alternate config file\&.
.RE
.PP
\fB\-\-disable\-bar\fR
.RS 4
Don\*(Aqt show progress bar\&.
.RE
.PP
\fB\-\-ignore=\fR\fB\fIPATTERN\fR\fR
.RS 4
files to ignore (glob patterns) separated with semicolon\&.
.RE
.PP
\fB\-\-log=\fR\fB\fILOG\fR\fR
.RS 4
Log to specified filename\&.
.RE
.PP
\fB\-\-plain\fR
.RS 4
Avoid color codes in console output\&.
.RE
.PP
\fB\-\-save\-stdout\fR
.RS 4
Save stdout of all tasks\&.
.RE
.PP
\fB\-\-save\-stderr\fR
.RS 4
Save stderr of all tasks\&.
.RE
.PP
\fB\-\-notify\-jabber=\fR\fB\fIJABBER\fR\fR
.RS 4
Notify failed tasks to the given jabber account\&.
.RE
.PP
\fB\-\-notify\-smtp=\fR\fB\fIMAIL\fR\fR
.RS 4
notify failed taks to the given email address\&.
.RE
.SH "AUTHOR"
.PP
\fBCleto Mart\('in\fR <\&cleto\&.martin@gmail\&.com\&>
.RS 4
Wrote this manpage for the Debian system\&.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2009 Cleto Mart\('in
.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 or (at your option) any later version published by the Free Software Foundation\&.
.PP
On Debian systems, the complete text of the GNU General Public License can be found in
/usr/share/common\-licenses/GPL\-3\&.
.sp