>Number:         9145
>Category:       misc
>Synopsis:       Corrections to mdoc.samples(7); mostly typos.
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    misc-bug-people (Misc Bug People)
>State:          open
>Class:          change-request
>Submitter-Id:   net
>Arrival-Date:   Sat Jan  8 02:00:01 2000
>Last-Modified:
>Originator:     Richard Rauch
>Organization:
  "I probably don't know what I'm talking about."  --rkr@rkr.kcnet.com
>Release:        1.4.1
>Environment:
	
System: NetBSD rkr.kcnet.com 1.4.1 NetBSD 1.4.1 (olibGENERIC) #3: Tue Nov 30 01:09:25 CST 1999 root@rkr.kcnet.com:/usr/src/sys/arch/i386/compile/olibGENERIC i386


>Description:
	Several places in /usr/src/share/man/man7/mdoc.samples.7
	contain typos and small grammar errors.  Some of the problems
	result in *roff code being executed rather than presented;
	at least one probably slipped by on a TTY, but shows up as
	problem if you render the PostScript output.

	I wasn't sure of the proper Category...
>How-To-Repeat:
	cd /usr/src/share/man/man7
	groff -Tps -mdoc.samples.7 | lpr -Pps
	Look at pages:
     10: Interactive Commands typos .Li in places
     17: .Pp in descriptive paragraph uses default font.
     18: ``placing up'' (apparent grammar problem)
         ``used'' scans ambiguously; ``formerly prevented'' reads more cleanly
         Punctuation in the list of types-of-displays
         .D1 code/discussion uses .Dl
     [...]
>Fix:
	The following was generated by checking a copy in with RCS
	ci(1), editing/checking then generating a context diff.

	There are some problems that I saw but did not touch, since
	the original intention didn't seem clear enough.  I believe
	the changes to all be for the better, but hopefully someone
	with a more expert eye will do a side-by-side comparison of
	the changes.

*** mdoc.samples.7	2000/01/08 05:43:05	1.1
--- mdoc.samples.7	2000/01/08 08:59:37
***************
*** 1152,1158 ****
  .Ql \&.Ic
  macro designates an interactive or internal command.
  .Pp
! .Dl Usage: .Li argument ... \*(Pu
  .Bl -tag -width ".Ic setenv , unsetenvxx" -compact -offset 14n
  .It Li \&.Ic :wq
  .Ic :wq
--- 1152,1158 ----
  .Ql \&.Ic
  macro designates an interactive or internal command.
  .Pp
! .Dl Usage: .Ic command ... \*(Pu
  .Bl -tag -width ".Ic setenv , unsetenvxx" -compact -offset 14n
  .It Li \&.Ic :wq
  .Ic :wq
***************
*** 2032,2038 ****
  .Ss Paragraphs and Line Spacing.
  .Bl -tag -width 6n
  .It \&.Pp
! The \&.Pp paragraph command may
  be used to specify a line space where necessary.
  The macro is not necessary after a
  .Ql \&.Sh
--- 2032,2040 ----
  .Ss Paragraphs and Line Spacing.
  .Bl -tag -width 6n
  .It \&.Pp
! The
! .Ql \&.Pp
! paragraph command may
  be used to specify a line space where necessary.
  The macro is not necessary after a
  .Ql \&.Sh
***************
*** 2181,2190 ****
  .Sx What's in a name ) ,
  the keep prevented
  .Xr nroff
! from placing up the
  flag and the argument
  on separate lines.
! (Actually, the option macro used to prevent this from occurring,
  but was dropped when the decision (religious) was made to force
  right justified margins in
  .Xr troff
--- 2183,2192 ----
  .Sx What's in a name ) ,
  the keep prevented
  .Xr nroff
! from placing the
  flag and the argument
  on separate lines.
! (Actually, the option macro formerly prevented this from occurring,
  but was dropped when the decision (religious) was made to force
  right justified margins in
  .Xr troff
***************
*** 2194,2204 ****
  .Fl line
  option needs to be added.)
  .Ss Examples and Displays
! There are six types of displays, a quickie one line indented display
! .Ql \&.D1 ,
! a quickie one line literal display
! .Ql \&.Dl ,
! and block literal, block filled, block unfilled, and block ragged which use
  the
  .Ql \&.Bd
  begin-display
--- 2196,2206 ----
  .Fl line
  option needs to be added.)
  .Ss Examples and Displays
! There are six types of displays: a quickie, one-line indented display
! .Ql \&.D1 ;
! a quickie, one-line literal display
! .Ql \&.Dl ;
! and block-literal, block-filled, block-unfilled, and block-ragged which use
  the
  .Ql \&.Bd
  begin-display
***************
*** 2211,2220 ****
  (D-one) Display one line of indented text.
  This macro is parsed, but it is not callable.
  .Pp
! .Dl Fl ldghfstru
  .Pp
  The above was produced by:
! .Li \&.Dl Fl ldghfstru .
  .It Li \&.Dl
  (D-ell)
  Display one line of indented
--- 2213,2222 ----
  (D-one) Display one line of indented text.
  This macro is parsed, but it is not callable.
  .Pp
! .D1 Fl ldghfstru
  .Pp
  The above was produced by:
! .Li \&.D1 \&Fl ldghfstru .
  .It Li \&.Dl
  (D-ell)
  Display one line of indented
***************
*** 2229,2239 ****
  Its default font is set to
  constant width (literal) however
  it is parsed and will recognized other macros.
! It is not callable however.
  .Pp
  .Dl % ls -ldg /usr/local/bin
  .Pp
! The above was produced by
  .Li \&.Dl % ls -ldg /usr/local/bin .
  .It Li \&.Bd
  Begin-display.
--- 2231,2241 ----
  Its default font is set to
  constant width (literal) however
  it is parsed and will recognized other macros.
! It is not callable.
  .Pp
  .Dl % ls -ldg /usr/local/bin
  .Pp
! The above was produced by:
  .Li \&.Dl % ls -ldg /usr/local/bin .
  .It Li \&.Bd
  Begin-display.
***************
*** 2251,2258 ****
  .Pp
  .Dl ".Bd display-type [-offset offset_value] [-compact]"
  .Pp
! The display-type must be one of the following four types and
! may have an offset specifier for indentation:
  .Ql \&.Bd .
  .Pp
  .Bl -tag -width "file file_name  " -compact
--- 2253,2261 ----
  .Pp
  .Dl ".Bd display-type [-offset offset_value] [-compact]"
  .Pp
! The display-type must be one of the four types
! .Fl ( ragged , unfilled , filled , literal )
! and may have an offset specifier for indentation:
  .Ql \&.Bd .
  .Pp
  .Bl -tag -width "file file_name  " -compact
***************
*** 2405,2415 ****
  Bullet two here.
  .El
  .Pp
! .It Fl tag
  .It Fl diag
  .It Fl hang
  .It Fl ohang
! .It Fl inset
  These list-types collect arguments specified with the
  .Ql \&.It
  macro and create a label which may be
--- 2408,2418 ----
  Bullet two here.
  .El
  .Pp
! .It Fl inset
  .It Fl diag
  .It Fl hang
  .It Fl ohang
! .It Fl tag
  These list-types collect arguments specified with the
  .Ql \&.It
  macro and create a label which may be
***************
*** 2472,2478 ****
  \&.El
  .Ed
  .Pp
! Here is a hanged list with just one item:
  .Bl -hang -offset indent
  .It Em Hanged
  labels appear similar to tagged lists when the
--- 2475,2481 ----
  \&.El
  .Ed
  .Pp
! Here is a hanged list with just two items:
  .Bl -hang -offset indent
  .It Em Hanged
  labels appear similar to tagged lists when the
***************
*** 2595,2607 ****
  .Bd -literal -offset indent
  \&.Bl -column "String" "Nroff" "Troff" -offset indent
  \&.It Sy "String" Ta Sy "Nroff" Ta Sy "Troff"
! \&.It Li "<=" Ta \&<\&= Ta \*(<=
! \&.It Li ">=" Ta \&>\&= Ta \*(>=
  \&.El
  .Ed
  .Sh PREDEFINED STRINGS
! The following strings are predefined as may be used by
! preceding with the troff string interpreting sequence
  .Ql \&\e*(xx
  where
  .Em xx
--- 2598,2610 ----
  .Bd -literal -offset indent
  \&.Bl -column "String" "Nroff" "Troff" -offset indent
  \&.It Sy "String" Ta Sy "Nroff" Ta Sy "Troff"
! \&.It Li "<=" Ta \e&<\e&= Ta \e*(<=
! \&.It Li ">=" Ta \e&>\e&= Ta \e*(>=
  \&.El
  .Ed
  .Sh PREDEFINED STRINGS
! The following strings are predefined and may be used by
! preceding them with the troff string interpreting sequence
  .Ql \&\e*(xx
  where
  .Em xx
***************
*** 2861,2867 ****
  .Pp
  The method used to prevent header and footer page
  breaks (other than the initial header and footer) when using
! nroff occasionally places an unsightly partially filled line (blank)
  at the would be bottom of the page.
  .Pp
  If the outer-most list definition doesn't have a
--- 2864,2871 ----
  .Pp
  The method used to prevent header and footer page
  breaks (other than the initial header and footer) when using
! .Xr nroff
! occasionally places an unsightly partially filled line (blank)
  at the would be bottom of the page.
  .Pp
  If the outer-most list definition doesn't have a
>Audit-Trail:
>Unformatted: