1 .\" Copyright (c) 1980, 1990, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
12 .\" 3. Neither the name of the University nor the names of its contributors
13 .\" may be used to endorse or promote products derived from this software
14 .\" without specific prior written permission.
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" @(#)vgrind.1 8.1 (Berkeley) 6/6/93
36 .Nd grind nice listings of programs
44 .Op Fl l Ns Ar language
54 utility formats the program sources specified as arguments
55 on the command line in a nice style using
57 Comments are placed in italics, keywords in bold face,
58 and the name of the current function is listed down the margin of each
59 page as it is encountered.
63 utility runs in two basic modes, filter mode (see the
65 option) or regular mode.
68 acts as a filter in a manner similar to
70 The standard input is passed directly to the standard output except
71 for lines bracketed by the
81 These lines are formatted as described above.
83 filter can be passed to
86 There need be no particular ordering with
93 accepts input files, processes them, and passes them to the postprocessor
100 passes any lines beginning with a decimal point without conversion.
105 forces input to be taken from standard input (default if
109 forces output to the (wide) Versatec printer rather than the (narrow)
112 specifies an alternate language definitions
114 .Pa /usr/share/misc/vgrindefs )
118 specifies a particular header to put on every output page (default is
121 specifies the language to use.
139 .Pq Fl l Ns Ar mod2 ,
141 .Pq Fl l Ns Ar yacc ,
148 .Pq Fl l Ns Ar perl .
150 forces no keyword bolding
154 to post-process the output,
157 .It Fl s Ar pointsize
158 specifies a point size to use on output (exactly the same as the argument
161 similar to the same option in
163 causing formatted text to go to the standard output
165 outputs the index file in a ``pretty'' format.
166 The index file itself is produced whenever
168 is run with a file called
170 in the current directory.
171 The index of function
172 definitions can then be run off by giving
181 .Bl -tag -width /usr/share/misc/vgrindefsxx -compact
183 file where source for index is created
184 .It Pa /usr/share/tmac/tmac.vgrind
186 .It Pa /usr/libexec/vfontedpr
188 .It Pa /usr/share/misc/vgrindefs
189 language descriptions
200 The vfontedpr preprocessor assumes that a certain programming style is
205 \- function names can be preceded on a line only by spaces, tabs, or an
207 The parenthesized arguments must also be on the same line.
211 \- function names need to appear on the same line as the keywords
218 \- function names need to appear on the same line as the keywords
221 If these conventions are not followed, the indexing and marginal function
222 name comment mechanisms will fail.
224 More generally, arbitrary formatting styles for programs mostly look bad.
225 The use of spaces to align source code fails miserably; if you plan to
227 your program you should use tabs.
228 This is somewhat inevitable since the
235 in recognizing functions should be used here.
237 Filter mode does not work in documents using the
242 (So what use is it anyway?)