src/usr.bin/vgrind/vgrind.1 - diff

Return to vgrind.1 CVS log

Up to [local] / src / usr.bin / vgrind

Diff for /src/usr.bin/vgrind/Attic/vgrind.1 between version 1.3 and 1.4

version 1.3, 1998/10/30 00:24:42

version 1.4, 1999/06/05 01:21:46

Line 36

.\"

.Dd June 6, 1993

.Dt VGRIND 1

.Os BSD 4

.Os

.Sh NAME

.Nm vgrind

.Nd grind nice listings of programs

.Sh SYNOPSIS

.Nm vgrind

.Op Fl

.Op Fl W

.Op Fl d Ar file

.Op Fl f

Line 54

.Op Fl x

.Ar name Ar ...

.Sh DESCRIPTION

.Nm vgrind

.Nm

formats the program sources which are arguments

in a nice style using

.Xr 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

.Nm vgrind

.Nm

runs in two basic modes, filter mode (see the

.Fl f

option) or regular mode. In filter mode

.Nm vgrind

.Nm

acts as a filter in a manner similar to

.Xr tbl 1 .

The standard input is passed directly to the standard output except

for lines bracketed by the

.Em troff-like

macros:

.Bl -tag -width Ds

Line 81

.El

.Pp

These lines are formatted as described above. The output from this

filter can be passed to

.Xr troff 1

for output. There need be no particular ordering with

.Xr eqn 1

.Xr tbl 1 .

.Pp

In regular mode

.Nm vgrind

.Nm

accepts input files, processes them, and passes them to

.Xr troff 1

for output.

.Pp

In both modes

.Nm vgrind

.Nm

passes any lines beginning with a decimal point without conversion.

.Pp

The options are:

.Bl -tag -width Ar

.It Fl

Forces input to be taken from standard input (default if

.Fl f

is specified).

Line 150

.Xr troff 1

causing formatted text to go to the standard output

.It Fl x

Outputs the index file in a ``pretty'' format.

Outputs the index file in a

The index file itself is produced whenever

.Dq pretty

.Nm vgrind

format.

is run with a file called

The index file itself is produced whenever

.Nm

is run with a file called

.Pa index

in the current directory.

The index of function

definitions can then be run off by giving

.Nm vgrind

.Nm

the

.Fl x

option and the file

Line 184

Line 186

.Sh BUGS

vfontedpr assumes that a certain programming style is followed:

.Pp

For

.Tn C

\- function names can be preceded on a line only by spaces, tabs, or an

asterisk. The parenthesized arguments must also be on the same line.

Line 206

Line 208

.Pp

More generally, arbitrary formatting styles for programs mostly look bad.

The use of spaces to align source code fails miserably; if you plan to

.Nm vgrind

.Nm

your program you should use tabs. This is somewhat inevitable since the

font used by

.Nm vgrind

.Nm

is variable width.

.Pp

The mechanism of