.Dd Created:2025-10-12|Updated:2025-11-23|
.de ocsi
\\$*
,
..
.de oxr
.ocsi .Xr \\$*
..
.de oit
.It
\\$*
..
.de obdi
.Bl -dash -compact
.oit \\$*
..
.de obdl
.Bd -literal -compact
\\$*
..
.de onote
.Bl -hang -compact
.oit \\$*
.El
..
.de ocomm
.Bl -diag -compact
.oit \\$*
.El
..
.de opsy
.Pp
.Sy - \\$*
..
.de obc
.Bl -column \\$*
..
.de obc2
.obc opt desc
..
.de obc3
.obc option arguments description
..
.Dt MDOC oh
.Os OpenBSD 7.8 , linux|
.Nm mdoc
.Nd usage
.Bl -hang -compact
.oit WIP: This document is a work in progress, it does not have all examples.
.oit NOTE: The results in these examples are affected by the site css, the results would be different on the terminal or with a different css.
.El
.Sh LISTS
List have the following format:
.Bd -literal -compact
\&.Bl -[TYPE]
\&.It
item
\&.El
.Ed
The item needs to be in the following line, some list can have the item or extra information in-line, those will be specified.
.Bl -column -offset indent ".Sy Type " ".Sy Result "
.It Li Sy Type Ta | Result
.It Sx dash Ta | - 
.It Sx bullet Ta | \(bu
.It Sx enum Ta | 1,2,3\&.\&.\&.
.El
.Ss Columnated list
.Dl \&.Bl -column string1 string2
.obdi string : defines the width of the column by using the length of the string.
.oit strings can be quoted if it contains spaces.
.oit Any number of strings can be used.
.El
.Dl \&.It col1 \&Ta col2
.obdi The contents of the line as specified in the It line.
.oit The cells are separated by Ta.
.oit To specify the headers, add Sy to the cell to set the bold font in the first item.
.El
.Sh LITERAL_DISPLAY
.Ss Single line
.obc3
.It Sy Macro Ta | Sy Description Ta | Sy Usage Ta | Sy Result
.It \&Li Ta | literal display font Ta | \&Li words Ta | Li words
.It \&Ql Ta | inline quoted literal display Ta | \&Ql words Ta | Ql words
.El
.El
.Sh ESCAPING
If a character is not displayed, it may be need to be escaped.
Most chracters or words conflicting with mdoc commands can be escaped adding \e& before the required character or command.
.obc2
.It \&" Ta |  \e&\&"
.It \&. Ta |  \e&\&.
.It \e Ta |  \ee
.It \&No Ta |  \e&No
.El
.Sh TODO
.obdi Review this document on OpenBSD 7.8 release.
.oit Add lists definitions: inset, diag, hang, ohang, tag.
.El
.Sh SEE ALSO
.oxr documentation oh
.oxr mandoc oh
.oxr roff oh
.Xr mdoc_list_examples oh
.opsy examples:
.In /man/manoh
.opsy OpenBSD manpages:
.oxr mdoc 7
.Xr mandoc_char 7
.El
.Sh AUTHORS
.An -nosplit
.Xr ohazot oh |
.Xr about oh |
.Lk https://ohazot.com ohazot.com
.Aq Mt admin@ohazot.com