summaryrefslogtreecommitdiff
path: root/usr.bin/vgrind
diff options
context:
space:
mode:
authorAaron Campbell <aaron@cvs.openbsd.org>2000-03-14 14:58:28 +0000
committerAaron Campbell <aaron@cvs.openbsd.org>2000-03-14 14:58:28 +0000
commit96210b552abc81426a18b2ef15b867a9eeab4e87 (patch)
treefa6fe9da32bb8d4b0c3c2714267bda30221930cd /usr.bin/vgrind
parente1f503677d44446ce65750011a5f31a05bece8b6 (diff)
Finish off cleanup usr.bin/ man pages.
Diffstat (limited to 'usr.bin/vgrind')
-rw-r--r--usr.bin/vgrind/vgrind.122
-rw-r--r--usr.bin/vgrind/vgrindefs.543
2 files changed, 45 insertions, 20 deletions
diff --git a/usr.bin/vgrind/vgrind.1 b/usr.bin/vgrind/vgrind.1
index 9c78d7ce3a0..d2117e08e44 100644
--- a/usr.bin/vgrind/vgrind.1
+++ b/usr.bin/vgrind/vgrind.1
@@ -1,4 +1,4 @@
-.\" $OpenBSD: vgrind.1,v 1.6 2000/03/06 03:17:40 aaron Exp $
+.\" $OpenBSD: vgrind.1,v 1.7 2000/03/14 14:58:25 aaron Exp $
.\" $NetBSD: vgrind.1,v 1.4 1994/11/17 08:28:04 jtc Exp $
.\"
.\" Copyright (c) 1980, 1990, 1993
@@ -65,7 +65,8 @@ page as it is encountered.
.Nm
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 .
@@ -80,10 +81,11 @@ starts processing
ends processing
.El
.Pp
-These lines are formatted as described above. The output from this
-filter can be passed to
+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 .
@@ -117,7 +119,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
@@ -194,7 +197,8 @@ vfontedpr assumes that a certain programming style is 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
@@ -214,8 +218,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
-font used by
+your program you should use tabs.
+This is somewhat inevitable since the font used by
.Nm
is variable width.
.Pp
diff --git a/usr.bin/vgrind/vgrindefs.5 b/usr.bin/vgrind/vgrindefs.5
index 3219f7635b3..06422e9d17c 100644
--- a/usr.bin/vgrind/vgrindefs.5
+++ b/usr.bin/vgrind/vgrindefs.5
@@ -1,4 +1,4 @@
-.\" $OpenBSD: vgrindefs.5,v 1.7 1999/07/09 13:35:30 aaron Exp $
+.\" $OpenBSD: vgrindefs.5,v 1.8 2000/03/14 14:58:25 aaron Exp $
.\" $NetBSD: vgrindefs.5,v 1.3 1994/11/17 08:28:07 jtc Exp $
.\"
.\" Copyright (c) 1989, 1991, 1993
@@ -84,9 +84,13 @@ 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".
+as
+.Qq c
+or
+.Qq C .
.Pp
Entries may continue onto multiple lines by giving a \e as the last
character of a line.
@@ -98,15 +102,21 @@ some particular feature
and string
capabilities which give a regular expression or
keyword list.
-.Sh REGULAR EXPRESSIONS
+.Sh REGULAR EXPRESSIONS
.Nm vgrindefs
uses regular expression which are very similar to those of
.Xr ex 1
and
.Xr lex 1 .
-The characters `^', `$', `:' and `\e'
+The characters
+.Ql ^ ,
+.Ql $ ,
+.Ql \&: ,
+and
+.Ql \e
are reserved characters and must be
-"quoted" with a preceding
+.Dq quoted
+with a preceding
.Ql \e
if they
are to be included as normal characters.
@@ -121,7 +131,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.
@@ -136,12 +147,22 @@ This is typically used for languages (like C) which can include the
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?"
-would match "tramp", "steamer", "trampflies", or "steamerflies".
+Unlike other regular expressions in the system, these match words
+and not characters.
+Hence something like
+.Dq (tramp|steamer)flies?
+would match
+.Dq tramp ,
+.Dq steamer ,
+.Dq trampflies ,
+or
+.Dq 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
+.Dq oc
+boolean is specified, indicating that upper
and lower case are equivalent, then all the keywords should be
specified in lower case.
.Sh FILES