summaryrefslogtreecommitdiffstatshomepage
path: root/mdoc.3
diff options
context:
space:
mode:
authorKristaps Dzonsons <kristaps@bsd.lv>2009-02-23 15:19:47 +0000
committerKristaps Dzonsons <kristaps@bsd.lv>2009-02-23 15:19:47 +0000
commit208a41e586edfd25d5c60acb38932f689d5d1a43 (patch)
tree91e785ccb282fa8cf1d8d7f09cefe3e3c09ab793 /mdoc.3
parent6a4217540b7dab72e441d0fb427eed052d3d0581 (diff)
downloadmandoc-208a41e586edfd25d5c60acb38932f689d5d1a43.tar.gz
mandoc-208a41e586edfd25d5c60acb38932f689d5d1a43.tar.zst
mandoc-208a41e586edfd25d5c60acb38932f689d5d1a43.zip
Adding revamped webpage.
Diffstat (limited to 'mdoc.3')
-rw-r--r--mdoc.321
1 files changed, 15 insertions, 6 deletions
diff --git a/mdoc.3 b/mdoc.3
index ae2e12c3..059d8cf5 100644
--- a/mdoc.3
+++ b/mdoc.3
@@ -1,4 +1,4 @@
-.\" $Id: mdoc.3,v 1.8 2009/02/23 12:45:19 kristaps Exp $
+.\" $Id: mdoc.3,v 1.9 2009/02/23 15:19:47 kristaps Exp $
.\"
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
.\"
@@ -99,7 +99,7 @@ Both functions (see
and variables (see
.Sx Variables )
may use the following types:
-.Bl -ohang
+.Bl -ohang -offset "XXXX"
.\" LIST-ITEM
.It Vt struct mdoc
An opaque type defined in
@@ -120,7 +120,7 @@ for details.
.\" SUBSECTION
.Ss Functions
Function descriptions follow:
-.Bl -ohang
+.Bl -ohang -offset "XXXX"
.\" LIST-ITEM
.It Fn mdoc_alloc
Allocates a parsing structure. The
@@ -165,7 +165,7 @@ return 0, the data will be incomplete.
.\" SUBSECTION
.Ss Variables
The following variables are also defined:
-.Bl -ohang
+.Bl -ohang -offset "XXXX"
.\" LIST-ITEM
.It Va mdoc_macronames
An array of string-ified token names.
@@ -213,7 +213,7 @@ field).
The tree itself is arranged according to the following normal form,
where capitalised non-terminals represent nodes.
.Pp
-.Bl -tag -width "ELEMENTXX" -compact
+.Bl -tag -width "ELEMENTXX" -compact -offset "XXXX"
.\" LIST-ITEM
.It ROOT
\(<- mnode+
@@ -272,7 +272,7 @@ Note that, if the last line of the file isn't newline-terminated, this
will truncate the file's last character (see
.Xr fgetln 3 ) .
Further, this example does not error-check nor free memory upon failure.
-.Bd -literal
+.Bd -literal -offset "XXXX"
struct mdoc *mdoc;
struct mdoc_node *node;
char *buf;
@@ -318,6 +318,7 @@ is the default
.Xr groff 1
system bundled with
.Ox .
+.\" PARAGRAPH
.Pp
Un-implemented: the
.Sq \&Xc
@@ -327,12 +328,19 @@ macros aren't handled when used to span lines for the
.Sq \&It
macro. Such usage is specifically discouraged in
.Xr mdoc.samples 7 .
+.\" PARAGRAPH
.Pp
Bugs: when
.Sq \&It \-column
is invoked, whitespace is not stripped around
.Sq \&Ta
or tab-character separators.
+.\" PARAGRAPH
+.Pp
+Bugs: elements within columns for
+.Sq \&It \-column
+are not yet supported.
+.\" PARAGRAPH
.Pp
Incompatible: the
.Sq \&At
@@ -340,6 +348,7 @@ macro only accepts a single parameter. Furthermore, several macros
.Pf ( Sq \&Pp ,
.Sq \&It ,
and possibly others) accept multiple arguments with a warning.
+.\" PARAGRAPH
.Pp
Incompatible: only those macros specified by
.Xr mdoc.samples 7