[unix-history] / .ref-BSD-3 / usr / man / man1 / vgrind.1

.TH VGRIND 1 10/15/79
.UC
.SH NAME
vgrind \- grind nice listings of C programs for the versatec
.SH SYNOPSIS
.B vgrind
[
.B \-nx
] [
.B \-h
header
]
name ...
.SH DESCRIPTION
.I Vgrind
formats the C programs which are arguments in a nice style using
.I troff
(1).  Comments are placed in italics, keywords in bold face,
and the name of the current function is listed down the margin of each
page as it is encountered.
.PP
The
.B \-h
option specifies a header to be placed at the top of each page.
If the program is not C source, but should be framed like the output
of
.I vgrind,
the
.B \-n
option should be specified.
.PP
To create an index, it is only necessary to create an empty file
.I index
in the current directory.  As you run
.I vgrind,
the index will be automatically kept up to date.
The index of function definitions can then be run off via
giving
.I vgrind
the
.B \-x
option and the file
.I index
as argument.
.SH FILES
.ta 2i
index	file where source for index is created
.br
/usr/lib/tmac/tmac.vgrind	macro package
.br
/usr/lib/vfontedpr		preprocessor
.SH AUTHOR
William Joy
.SH SEE ALSO
vtroff(1)
.SH BUGS
Vfontedpr assumes that a certain programming style is followed:
functions begin with the name of the function in column one, and lines
defining functions end with a ).  The function name is followed
immediately by a ``('' with no intervening space.
If this convention is not followed, the indexing and marginal function
name comment mechanisms will fail.
.sp
More generally, arbitrary formatting styles for C programs mostly look bad.
The use of spaces to align source code fails miserably; if you plan to
.I vgrind
your program you should use tabs.  This is somewhat inevitable since the
font used by
.I vgrind
is variable width.
Commit	Line	Data
65279b5c BJ	1	.TH VGRIND 1 10/15/79
	2	.UC
	3	.SH NAME
	4	vgrind \- grind nice listings of C programs for the versatec
	5	.SH SYNOPSIS
	6	.B vgrind
	7	[
	8	.B \-nx
	9	] [
	10	.B \-h
	11	header
	12	]
	13	name ...
	14	.SH DESCRIPTION
	15	.I Vgrind
	16	formats the C programs which are arguments in a nice style using
	17	.I troff
	18	(1). Comments are placed in italics, keywords in bold face,
	19	and the name of the current function is listed down the margin of each
	20	page as it is encountered.
	21	.PP
	22	The
	23	.B \-h
	24	option specifies a header to be placed at the top of each page.
	25	If the program is not C source, but should be framed like the output
	26	of
	27	.I vgrind,
	28	the
	29	.B \-n
	30	option should be specified.
	31	.PP
	32	To create an index, it is only necessary to create an empty file
	33	.I index
	34	in the current directory. As you run
	35	.I vgrind,
	36	the index will be automatically kept up to date.
	37	The index of function definitions can then be run off via
	38	giving
	39	.I vgrind
	40	the
	41	.B \-x
	42	option and the file
	43	.I index
	44	as argument.
	45	.SH FILES
	46	.ta 2i
	47	index file where source for index is created
	48	.br
	49	/usr/lib/tmac/tmac.vgrind macro package
	50	.br
	51	/usr/lib/vfontedpr preprocessor
	52	.SH AUTHOR
	53	William Joy
	54	.SH SEE ALSO
	55	vtroff(1)
	56	.SH BUGS
	57	Vfontedpr assumes that a certain programming style is followed:
	58	functions begin with the name of the function in column one, and lines
	59	defining functions end with a ). The function name is followed
	60	immediately by a ``('' with no intervening space.
	61	If this convention is not followed, the indexing and marginal function
	62	name comment mechanisms will fail.
	63	.sp
	64	More generally, arbitrary formatting styles for C programs mostly look bad.
65	The use of spaces to align source code fails miserably; if you plan to
66	.I vgrind
67	your program you should use tabs. This is somewhat inevitable since the
68	font used by
69	.I vgrind
70	is variable width.