Skip site navigation (1)Skip section navigation (2)
Date:      Tue, 25 Apr 2000 08:45:42 -0500
From:      Mike Pritchard <mpp@mppsystems.com>
To:        John Estess <jestess@wcnet.net>
Cc:        doc@FreeBSD.ORG
Subject:   Re: last time for mdoc corrections
Message-ID:  <20000425084542.A50322@mppsystems.com>
In-Reply-To: <Pine.BSF.4.21.0004250712290.2757-100000@localhost.localdomain>; from jestess@wcnet.net on Tue, Apr 25, 2000 at 07:29:27AM -0500
References:  <Pine.BSF.4.21.0004250712290.2757-100000@localhost.localdomain>

next in thread | previous in thread | raw e-mail | index | archive | help
On Tue, Apr 25, 2000 at 07:29:27AM -0500, John Estess wrote:
> 
> Please help correct these problems:
> 
> 1) under .Ss Issuing subsequent requests, I end up with the sentence "If
> the search is..." skipping two lines. Why? How do I stop that from
> happening?

I think this is just a bladly placed page break :-(.
  
> 2) under header Line-Orientated Interface, using
> .Fl l stops groff in its tracks. How do I mark options later in the
> page (not in a .It line)? Please test before answering.
> 
> 3) I need a period after cscope in
> deviate from this form will not be recognized by
> .Nm   (which is cscope)
> Yes, I tried .Nm Ns . and .Nm . and .Nm \&.

Items 2 and 3 were both being caused by a bad list.  In one section
you are using .Bl (begin list) to define a literal table of
text.  The .Bd (begin display) macro is better suited for this.  
The attached patch fixes this, and one spelling problem and one 
minor mdoc nit.  If you had redirected stderr when trying to use
the .Fl macro (and some variations of .Nm), you would have noticed
the groff generated one error, which is what clued me in that
there was probably a table/some macro that didn't properly clean itself up.

I also noticed that you have a lot of trailing whitespace on some
of the macro calls.  These should probably be trimmed (I didn't do
so in my patch, so that it would be obvious what I really changed).

Note:  I might have missed some places where you wanted to use
.Fl, but couldn't because groff was croaking due to the table
problem.

-Mike
-- 
Mike Pritchard
mpp@FreeBSD.org or mpp@mppsystems.com


--- cscope.1.orig	Tue Apr 25 08:21:39 2000
+++ cscope.1	Tue Apr 25 08:33:49 2000
@@ -153,34 +153,24 @@
 .Nm
 will display this menu:
 .Pp
-.Bl -inset -offset -indent -compact
-.It   
+.Bd -literal -offset indent
 Find this C symbol:
-.It
 Find this function definition:
-.It
 Find functions called by this function:
-.It
 Find functions calling this function:
-.It
 Find this text string:
-.It
 Change this text string:
-.It
 Find this egrep pattern:
-.It
 Find this file:
-.It
 Find files #including this file:
-.El
+.Ed
 .Pp   
 Press the <Tab> key repeatedly to move to the desired input field,
 type the text to search for, and then press the <Return> key.
-.Pp   
+.Pp
 .Ss Issuing subsequent requests
-.Pp Ns
-If the search is successful,
-any of these single-charactor commands can be used:
+.Pp
+If the search is successful, any of these single-character commands can be used:
 .Bl -tag -width  <Space> -offset indent
 .It Sy 1-9
 Edit the file referenced by the given line number.
@@ -229,8 +219,7 @@
 Rebuild the cross-reference.
 .It Sy !
 Start an interactive shell (type ^d to return to
-.Nm
-).
+.Nm Ns ) .
 .It Sy ^l
 Redraw the screen.
 .It Sy ?
@@ -273,8 +262,7 @@
 .It !
 Start an interactive shell (type ^d
 to return to
-.Nm
-).
+.Nm Ns ) .
 .It ^l
 Redraw the screen.
 .It ?
@@ -293,7 +281,9 @@
 .Pp
 .Ss Line-Oriented interface
 .Pp
-The -l option lets you use
+The
+.Fl l
+option lets you use
 .Nm
 where a screen-oriented interface would not be useful, for example,
 from another screen-oriented program.
@@ -304,10 +294,16 @@
 search pattern, for example, ``lmain'' finds the definition of the
 main function.
 .Pp
-If you just want a single search, instead of the -l option use the -L
-and -num pattern options, and you won't get the >> prompt.
+If you just want a single search, instead of the
+.Fl l
+option use the
+.Fl L
+and
+.Fl num
+pattern options, and you won't get the >> prompt.
 .Pp  
-For -l,
+For
+.Fl l ,
 .Nm
 outputs the number of reference lines
 .Nm
@@ -354,7 +350,9 @@
 Temporary file directory, which defaults to /var/tmp.
 .It Ev VIEWER
 Preferred file display program (such as less),
-which overrides EDITOR (see above).
+which overrides
+.Ev EDITOR
+(see above).
 .It Ev VPATH
 A colon-separated list of directories, each of which has the
 same directory structure below it. If VPATH is set,


To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20000425084542.A50322>