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