ohazot_mandoc

       _                    _
  ___ | |__   __ _ _______ | |_
 / _ \| '_ \ / _` |_  / _ \| __|
| (_) | | | | (_| |/ / (_) | |_
 \___/|_| |_|\__,_/___\___/ \__|

mandoc — options

OPTIONS

mandoc outputs to stdout, it can be redirected to a file.

mandoc -T html -O
  includes=[PATH]/%I,man=[PATH]/%N[%S].html,style=[PATH_TO_CSS] [INPUT_MDOC]
  > [OUTPUT_HTML]

-T [FORMAT]: select the output html,man,ascii,markdown,locale,utf,pdf,ps.
style=[PATH]: relative/absolute path to the css.

includes

Translate .In macro to PATH/[INCLUDE_NAME]:

includes=[PATH]/%I

Eg.:

.In somename

Translates to PATH/somename.

man

man=[PATH]/%N[%S]

N is replaced by the name, and S for the section eg.: ssh.1.
a fallback format can be given, if the corresponding file does not exist in the current directory, it will use the second format:

man=[PATH]/%N[%S];[PATH|URL]/%N[%S]

Example:

man=/%N.html;https://man.openbsd.org/%N.%S

.Xr roff oh

will be translated to ohazot.com/roff.html

.Xr roff 7

will be translated to https://man.openbsd.org/roff.7

OPENBSD 7.8

Up to OpenBSD 7.7 the output displayed the footer as:

Operating_System Date
  Operating_System

mdoc macros:

Os Dd Os

As of 7.8 the footer is displayed as:

Operating_System Date
  Document_Title(Document_Section)

mdoc macros:

Os Dd Dt

MARKDOWN

Tables should be reviewed when exporting to markdown as they are not converted to markdown tables but code.

This has been testted on OpenBSD 7.8, this is still occurs.

mdoc

.Bl -column header1 header2
.It Sy header1 Ta header2
.It cell1 Ta cell2
.El

mandoc conversion to markdown

	**header1** **header2**
	cell1      cell2
	row2       row2 - cell2

Correct conversion to markdown

|header1|header2|
|-------|-------|
|cell1|cell2  |
|row2|row2 - cell2|

TODO

Review this document on OpenBSD 7.8 release.

AUTHORS

ohazot | about | ohazot.com <admin@ohazot.com>