diff options
Diffstat (limited to 'usr.bin/vgrind')
| -rw-r--r-- | usr.bin/vgrind/vgrind.1 | 18 | ||||
| -rw-r--r-- | usr.bin/vgrind/vgrindefs.5 | 15 |
2 files changed, 22 insertions, 11 deletions
diff --git a/usr.bin/vgrind/vgrind.1 b/usr.bin/vgrind/vgrind.1 index 6c0b43518c87..d509517338ee 100644 --- a/usr.bin/vgrind/vgrind.1 +++ b/usr.bin/vgrind/vgrind.1 @@ -66,7 +66,8 @@ The .Nm utility runs in two basic modes, filter mode (see the .Fl f -option) or regular mode. In filter mode +option) or regular mode. +In filter mode .Nm acts as a filter in a manner similar to .Xr tbl 1 . @@ -81,10 +82,12 @@ starts processing ends processing .El .Pp -These lines are formatted as described above. The output from this +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 +for output. +There need be no particular ordering with .Xr eqn 1 or .Xr tbl 1 . @@ -119,7 +122,8 @@ forces filter mode specifies a particular header to put on every output page (default is the file name) .It Fl l -specifies the language to use. Currently known are +specifies the language to use. +Currently known are .Tn PASCAL .Pq Fl l Ns Ar p , .Tn MODEL @@ -198,7 +202,8 @@ followed: 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. +asterisk. +The parenthesized arguments must also be on the same line. .Pp For .Tn PASCAL @@ -218,7 +223,8 @@ name comment mechanisms will fail. 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 -your program you should use tabs. This is somewhat inevitable since the +your program you should use tabs. +This is somewhat inevitable since the font used by .Nm is variable width. diff --git a/usr.bin/vgrind/vgrindefs.5 b/usr.bin/vgrind/vgrindefs.5 index 5ecbd7f85616..1bf73aecde4b 100644 --- a/usr.bin/vgrind/vgrindefs.5 +++ b/usr.bin/vgrind/vgrindefs.5 @@ -74,7 +74,8 @@ The following table names and describes each field. .Pp Non-comments are required to describe a certain context where a sequence that would normally start a comment loses its special -meaning. A typical example for this can be found in Perl, where +meaning. +A typical example for this can be found in Perl, where comments are normally starting with .Ql # , while the string @@ -95,7 +96,8 @@ if ifdef ifndef include undef: .Ed .Pp Note that the first field is just the language name (and any variants -of it). Thus the C language could be specified to +of it). +Thus the C language could be specified to .Xr vgrind 1 as "c" or "C". .Pp @@ -132,7 +134,8 @@ a delimiter (space, tab, newline, start of line) .It \ea matches any string of symbols (like .* in lex) .It \ep -matches any alphanumeric name. In a procedure definition (pb) the string +matches any alphanumeric name. +In a procedure definition (pb) the string that matches this symbol is used as the procedure name. .It () grouping @@ -148,11 +151,13 @@ string delimiter in a string by escaping it. .El .Pp Unlike other regular expressions in the system, these match words -and not characters. Hence something like "(tramp|steamer)flies?" +and not characters. +Hence something like "(tramp|steamer)flies?" would match "tramp", "steamer", "trampflies", or "steamerflies". .Sh KEYWORD LIST The keyword list is just a list of keywords in the language separated -by spaces. If the "oc" boolean is specified, indicating that upper +by spaces. +If the "oc" boolean is specified, indicating that upper and lower case are equivalent, then all the keywords should be specified in lower case. .Sh FILES |