From owner-freebsd-ports  Sun Apr 23 13: 1:10 2000
Delivered-To: freebsd-ports@freebsd.org
Received: from columbus.cris.net (columbus.cris.net [212.110.128.65])
	by hub.freebsd.org (Postfix) with ESMTP
	id C683C37BA7A; Sun, 23 Apr 2000 13:00:47 -0700 (PDT)
	(envelope-from phantom@scorpion.crimea.ua)
Received: (from uucp@localhost)
	by columbus.cris.net (8.9.3/8.9.3) with UUCP id XAA02986;
	Sun, 23 Apr 2000 23:00:19 +0300 (EEST)
Received: (from phantom@localhost)
	by scorpion.crimea.ua (8.8.8/8.8.5+ssl+keepalive) id WAA12383;
	Sun, 23 Apr 2000 22:01:52 +0400 (MSD)
Date: Sun, 23 Apr 2000 22:01:52 +0400
From: Alexey Zelkin <phantom@cris.crimea.ua>
To: John Estess <jestess@wcnet.net>
Cc: doc@FreeBSD.ORG, ports@FreeBSD.ORG
Subject: Re: cscope man page in text
Message-ID: <20000423220152.A12018@scorpion.crimea.ua>
Reply-To: Alexey Zelkin <phantom@cris.crimea.ua>
References: <Pine.BSF.4.21.0004231822230.4517-100000@localhost.localdomain>
Mime-Version: 1.0
Content-Type: text/plain; charset=us-ascii
X-Mailer: Mutt 0.95.7i
In-Reply-To: <Pine.BSF.4.21.0004231822230.4517-100000@localhost.localdomain>
X-Operating-System: FreeBSD 2.2.7-RELEASE i386
Sender: owner-freebsd-ports@FreeBSD.ORG
Precedence: bulk
X-Loop: FreeBSD.org

hi,

On Sun, Apr 23, 2000 at 06:23:50PM -0500, John Estess wrote:

I suggest to read mdoc(7), mdoc.samples(7) manpages and take a look
to /usr/share/examples/mdoc/

> .Op [options]

.Op options

will be rendered to

"
[options]
"

> .Op [file . . . ]

Same. It should look like

"
.Op file...
"

> .Nm
> examines the C (.c and .h), lex (.l), and yacc (.y) source files in the

In mdoc terms that sentence should look like:

"
.Nm
examines the C
.Pq "\&.c and \&.h" ,
lex
.Pq \&.l ,
and yacc
.Pq \&.y
source files in the
"

> by default, to locate functions, function calls, macros, variables, and
> preprocessor symbols in the files.
>    
> .Nm

Try to not to use empty lines. You'll get same effect with ".Pp" macro. And
it's correct.

> ``Issuing Subsequent Requests,'' below.)

``xx'' should be repaced with

"
.Dq xx
"

> Look in incdir (before looking in INCDIR, the standard place for header files,
> normally
> .Pa /usr/include
> ) for any #include files whose names do not begin with ``/'' and that are not

This ".Pa" case should be changed to:

"
.Pa /usr/include )
for any ...
"

> Line-oriented interface (see ``Line-Oriented Interface'' below).

".Dq" again ...

> .Nm
> , including when you build the cross-reference file,

".Nm" is parsable macro and you can use such combination:

"
.Nm Ns ,
"

note: Ns -- no space macro. It's just no-op, but useful no-op :)

> .Nm
> .

"
.Nm Ns .
"

> .Pp         
> The 
> .Fl I
> ,
> .Fl p
> ,
> .Fl q
> , and
> .Fl T

"
.Pp
The
.Fl I ,
.Fl p ,
.Fl q ,
and
.Fl T
"

looks more elegant, IMHO :)

> the -F option.

the
.Fl F
option.

> Start an interactive shell (type ^d to return to
> .Nm 
> ).

.Nm Ns ) .

> escape it by typing a \ (backslash) first.

This string will be rendered to

"
escape it by typing a (backslash) first.
"

because `\' is escape symbol. You need to replace `\' symbol with `\e'.

> with -f.

"
with
.Fl f .
"

> Standard directory for #include files (usually /usr/include).
                                                 ^^^^^^^^^^^^ == .Pa

> .Sh COPYRIGHT
  ^^^^^^^^^^^^^

It should be replaced with ".Sh AUTHORS" (by style).

> 17 April 2000 The Santa Cruz Operation, Inc. 

;-)


-- 
/* Alexey Zelkin                       && phantom@cris.net    */
/* Tavric National University          && phantom@crimea.edu  */
/* http://www.ccssu.crimea.ua/~phantom && phantom@FreeBSD.org */


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