xref: /illumos-gate/usr/src/lib/libexacct/demo/README (revision d0b3c59ba652f183eeec1414dd9fbdc56bf05cc8)
1#
2# CDDL HEADER START
3#
4# The contents of this file are subject to the terms of the
5# Common Development and Distribution License, Version 1.0 only
6# (the "License").  You may not use this file except in compliance
7# with the License.
8#
9# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10# or http://www.opensolaris.org/os/licensing.
11# See the License for the specific language governing permissions
12# and limitations under the License.
13#
14# When distributing Covered Code, include this CDDL HEADER in each
15# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16# If applicable, add the following below this CDDL HEADER, with the
17# fields enclosed by brackets "[]" replaced with your own identifying
18# information: Portions Copyright [yyyy] [name of copyright owner]
19#
20# CDDL HEADER END
21#
22
23Copyright 2002 Sun Microsystems, Inc.  All rights reserved.
24Use is subject to license terms.
25
26#ident	"%Z%%M%	%I%	%E% SMI"
27
281. Introduction
29
30This directory contains  source code for the "exdump"  utility that uses
31libexacct to print the content  of extended accounting files produced by
32the kernel.
33
34This  utility   demonstrates  how  developers  can  use   the  libexacct
35programming API to extract  extended accounting data. libexacct(3LIB) is
36the only interface for reading and  writing  files  in  variable  length
37general-purpose accounting file format  used  by  the  kernel  to  store
38various types of accounting data.
39
402. Configuration
41
42Exdump can be compiled as either a 32-bit or 64-bit application; because
43exacct is endian-neutral, exdump can read exacct files from either SPARC
44or Intel sources on SPARC or Intel platforms. exdump prints one line for
45each record it encounters in the exacct file.
46
47The Makefile contained in this directory is set up to use the C compiler
48(cc) and lint  utility found in your  $PATH.  If you wish  to change the
49configuration, edit  the CC  and LINT macro  definitions in  Makefile to
50point to the appropriate pathnames.
51
523. Targets
53
54The Makefile in this directory supports the following targets:
55
56	make all (default)	- build exdump executable
57	make lint		- run lint against exdump
58	make clean		- remove object files
59	make clobber		- remove objects, and lint files
60
61To  build the  exdump,  execute  "make" in  this  directory.  This  will
62execute the default "make all" target.
63
644. References
65
66Exacct files:	/var/adm/exacct/proc, /var/adm/exacct/task
67Man pages:	acctadm(1M), libexacct(3LIB)
68Documentation:	"System Administration Guide:
69		Resource Management and Network Services"
70		"System Administration Guide: IP Services"
71