scc-plugin(1)



NAME


	scc-plugin - template for a user module

RELEASE


	scc	1.23.185

SYNOPSIS


	scc-plugin

DESCRIPTION


	This program can be used as a starting point to write user modules
	for SCC. To extend the collection of data by scc-collect, copy this
	script to the directory /opt/scc/bin/scc_modules and name it
	scc_9999_u_NAME, where 9999 is a four-digit number specifying the
	order in which scc-collect executes the modules. Refer to the manual
	page of scc-collect for more details concerning modules.

	Data should be produced on stdout. Refer to scc(4) for a description
	of the layout of the data in a snapshot.

ARGUMENTS


	Use the -a option of scc-collect to provide this module with
	arguments. Another possibility to add dynamic behavior to this script
	is by using the file /etc/opt/scc/conf/scc-localize.

DIAGNOSTICS


	Any errors detected by this program should be produced on stdout
	in the following format:

		fix:messages::<message>

EXAMPLE


	The following code records the DNS-data of our domain:

		sed -e "s/^/fix:network:DNS mycom.com::/" /var/named/db.mycom

	Copy scc-plugin to scc_modules/scc_0500_u_dns and add this code at 
	the end of the new script and run:

		scc -e dns

COPYRIGHT


	scc-plugin is free software under the terms of the GNU General Public 
	License. Copyright (C) 2001-2004 Open Challenge B.V.,
	2004-2005 OpenEyeT Professional Services, 2005-2015 QNH.

FILES


	/opt/scc/bin/scc_modules - directory for modules
	/var/opt/scc/data - directory for data files
	/var/opt/scc/data/plugin_data - directory checked by scc-log
		for output of modules

SEE ALSO


	scc(1), scc-cmp(1), scc-collect(1), scc-log(1), scc-log2html(1),
	scc-plugin(1), scc-snap2html(1), scc(4), scc(5)

VERSION


	$Revision: 5564 $