Wittenoom and Associates/Machiavelli Systems
--------------------------------------------

[273,200]		DECUS C Documentation

This account was created for the purpose of documenting the libraries in 
[273,201]. There are command files to build documentation, and runoff header
files for each of the documents in [273,201]. These command files have been 
generalized so that they will document any set of routines with the DECUS 'C
documentation standard.

	MAKDOC.CMD	This command file creates a manual for a specified set
			of routines.
			Format :
				@MAKDOC lisfil
			LISFIL is a file containing a list of functions to be
			placed in the document. The name of the file is carried
			through to be used as :
				1. Name of document header files
					[lisfil]1ST.RNO
					[lisfil]HDR.RNO
				2. Name of the created .RNO and .DOC files
					[lisfil].RNO
					[lisfil].DOC
				3. Name of the Function index file output
					[lisfil].IND
				4. The device name and uic specified in the list
				   File spec. is used as the default for the
				   'C source file specification.
			The account you are logged into is the account that
			the output files are created on.
		This function assumes that all source files are 'C, perhaps
		someone would modify it to copy with macro source files as 
		well [very little to change].


	MAKFNLIS.CMD
		This command file creates A .IND file as above, without the
		documentation the same rules for the file name apply as above


	LSTNOTDOC.CMD
		This command file is meant to find un-documented files...
		It FAILED ... would someone please fix it.


	FNAMEPARS.CMD
		This command file gets a file name passed to it and strips it 
		into it's various componants.
		Is called by
		.SETS DEFDEV "defualt device name including colon"
		.SETS DEFUIC "default uic including brackets"
		.SETS DEFEXT "default file extension including period"
		@FNAMEPARS/LO filename
		;	DEV 	has resolved device name
		;	UIC 	has resolved uic
		;	FILE 	has file name
		;	EXT 	has resolved file extension
		;	FILNAM	has composite file name with resolved items



	BATDOC.CMD
		This command file creates a command file to submit to the batch
		to create documentation. The format is
		@BATDOC lisfile destin
		Where lisfile is the listing file to search through same as
		MAKDOC, and destin is the device/uic specification of where
		the documentation is to be put



	GO.CMD
		This command file changes the default device/uic. Format is :
		@GO DEV:[UIC]
		Brackets are not nessacerry for the uic, and the uic may be 
		spaced apart from the device.


	*.DOC
		These are the documentation for the lirarys in [273,201]


	*.IND
		Indexes for the functions in the lirarys in [273,201]


	*HDR.RNO
		This is the header file placed before the index of a document
		for the particular libraries.


	*1ST.RNO
		This is the header placed at the front of the documentation for
		the particular libraries.


	*.TSK
		These are the programs used to extract the documentation from
		the libraries, and make them into a runoff file.
		[ DECUS C distribution ]

