$Id: README,v 1.4 1996/12/07 20:16:26 hans Exp $

README for acctsum 0.1

Copyright

Acctsum is public domain. It was hacked together in 3 hours, so why
should it be copyrighted?

What Is It?

The acctsum package consists mainly of a shell script that evaluates
your accounting file and summarizes the information in it by days,
weekdays, months, and years. It normally mails its results to the
system administrator. It is intended to be run by cron once per day.

There's a second shell script that reports your ISDN usage and truncates
the ISDN log file. It is intended to be run by cron once per month.

Features

* Keeps your accounting file small. The accounting file is truncated
  after it is evaluated.

* Summarizes processes and their CPU usage by day, day of week, month,
  and year.

* Can mail the summary to the system administrator.

* Sorts the summary by programs and by users.

* Calculates ISDN fees.

Deficiencies

* Nothing prevents two copies of the scripts running simultanously,
  screwing up the results. But this will probably never happen if
  you're careful.

* No graphical output yet. But I'm looking into xvgr for this.

Sample Output

The following is a shortened sample of the mail that is sent to
the administrator. It contains the number of calls, the total
real time, and the total CPU time per program and per user.
The format of the columns is explained in the GNU accounting
utilities documentation.

Program Summary
===============
   30775  140943.69re     223.96cp
    1070       1.30re     103.46cp   cc1
     ...          ...          ...   ...
       1       0.00re       0.00cp   slist*
       1       0.00re       0.00cp   pqlist*

User summary
============
            30775  140943.69re     223.96cp
root        29104  140934.89re     220.50cp
news         1359       0.26re       2.08cp
hans          267       6.78re       1.33cp
cvsadmin       43       1.75re       0.03cp
uucp            2       0.01re       0.01cp

Prerequisites

You need to have accounting in the kernel enabled.
You also need the accounting tools (acct-1.3.73.tar.gz or newer)
to enable accounting (normally done during system startup)
and the GNU Accounting Utilities (beta release 6.2 or newer)
to produce the reports.

To use account.isdn, you need the isdn4linux package and the isdnlog
package.

acct-1.3.73.tar.gz is available from sunsite.unc.edu or its mirrors
in directory /pub/linux/system/Admin/accounts
The GNU Accounting Utilities are available from prep.mit.ai.edu
The isdn stuff is available from ftp.franken.de

Installation

See the file INSTALL for installation instructions.

Things To Do

See the file TODO for possible enhancements.

Author

Hans-Joachim Baader (hans@grumbeer.inka.de)

