summaryrefslogtreecommitdiffstatshomepage
path: root/mandoc.1
diff options
context:
space:
mode:
authorKristaps Dzonsons <kristaps@bsd.lv>2009-03-23 09:42:43 +0000
committerKristaps Dzonsons <kristaps@bsd.lv>2009-03-23 09:42:43 +0000
commitca91d8f3ace59249bb9ba5e96567d230e6a0afde (patch)
tree04f4b2b3286ee0dd1cc72fb57d29ab410b45eec6 /mandoc.1
parente91f4bd4ab69ad8613319f946e49cdd019cb80f1 (diff)
downloadmandoc-ca91d8f3ace59249bb9ba5e96567d230e6a0afde.tar.gz
mandoc-ca91d8f3ace59249bb9ba5e96567d230e6a0afde.tar.zst
mandoc-ca91d8f3ace59249bb9ba5e96567d230e6a0afde.zip
More manual documentation fixed/improved.
Diffstat (limited to 'mandoc.1')
-rw-r--r--mandoc.141
1 files changed, 28 insertions, 13 deletions
diff --git a/mandoc.1 b/mandoc.1
index 40bffea7..8cc56b2b 100644
--- a/mandoc.1
+++ b/mandoc.1
@@ -1,4 +1,4 @@
-.\" $Id: mandoc.1,v 1.6 2009/03/22 19:08:53 kristaps Exp $
+.\" $Id: mandoc.1,v 1.7 2009/03/23 09:42:43 kristaps Exp $
.\"
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@openbsd.org>
.\"
@@ -16,7 +16,7 @@
.\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: March 22 2009 $
+.Dd $Mdocdate: March 23 2009 $
.Dt mandoc 1
.Os
.\" SECTION
@@ -118,14 +118,19 @@ and
.El
.\" PARAGRAPH
.Pp
-Note that reserved words may occur in streams of text, so the following:
+Note that reserved words only register as such as if they appear as
+standalone tokens, either in parsed lines or streams of text. Thus, the
+following fragment:
.Bd -literal -offset XXXX
this self is not that of the waking , empirically real man
.Ed
.\" PARAGRAPH
.Pp
\&...correctly adjusts the comma spacing to
-.Qq this self is not that of the waking , empirically real man .
+.Dq this self is not that of the waking , empirically real man .
+However, if the comma were part of
+.Dq ,empirically ,
+it would not.
.\" SUB-SECTION
.Ss Output Formats
The
@@ -193,18 +198,28 @@ mode doesn't yet know how to display the following:
The \-hang
.Sq \&Bl
list is not yet supported.
+.El
+.Pp
+Other macros still aren't supported by virtue of nobody complaining
+about their absence. Please report any omissions: this is a work in
+progress.
+.Pp
+The following list documents differences between traditional
+.Xr nroff 1
+output and
+.Nm :
+.Pp
+.Bl -bullet -compact
+.It
+A list of display following
+.Sq \&Ss
+does not assert a prior vertical break, just as it doesn't with
+.Sq \&Sh .
+.It
+Special characters don't follow the current font style.
.\" LIST-ITEM
.It
The \-literal and \-unfilled
.Sq \&Bd
displays types are synonyms, as are \-filled and \-ragged.
-.\" LIST-ITEM
-.It
-The
-.Sq \&Bd
-macro doesn't process \-compact .
.El
-.Pp
-Other macros still aren't supported by virtue of nobody complaining
-about their absence. Please report any omissions: this is a work in
-progress.