xref: /illumos-gate/usr/src/lib/libexacct/demo/README (revision bbf215553c7233fbab8a0afdf1fac74c44781867)
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
261. Introduction
27
28This directory contains  source code for the "exdump"  utility that uses
29libexacct to print the content  of extended accounting files produced by
30the kernel.
31
32This  utility   demonstrates  how  developers  can  use   the  libexacct
33programming API to extract  extended accounting data. libexacct(3LIB) is
34the only interface for reading and  writing  files  in  variable  length
35general-purpose accounting file format  used  by  the  kernel  to  store
36various types of accounting data.
37
382. Configuration
39
40Exdump can be compiled as either a 32-bit or 64-bit application; because
41exacct is endian-neutral, exdump can read exacct files from either SPARC
42or Intel sources on SPARC or Intel platforms. exdump prints one line for
43each record it encounters in the exacct file.
44
45The Makefile contained in this directory is set up to use the C compiler
46(cc) and lint  utility found in your  $PATH.  If you wish  to change the
47configuration, edit  the CC  and LINT macro  definitions in  Makefile to
48point to the appropriate pathnames.
49
503. Targets
51
52The Makefile in this directory supports the following targets:
53
54	make all (default)	- build exdump executable
55	make lint		- run lint against exdump
56	make clean		- remove object files
57	make clobber		- remove objects, and lint files
58
59To  build the  exdump,  execute  "make" in  this  directory.  This  will
60execute the default "make all" target.
61
624. References
63
64Exacct files:	/var/adm/exacct/proc, /var/adm/exacct/task
65Man pages:	acctadm(8), libexacct(3LIB)
66Documentation:	"System Administration Guide:
67		Resource Management and Network Services"
68		"System Administration Guide: IP Services"
69