markdown2man(1)

markdown2man1

Convert a markdown document into an mdoc manual page

Usage

mkd2man [-h] [-d date] [-s section] [-t title] [file]

Overview

mkd2man utility reads file and generates mdoc(7) input from markdown source. If unspecified, file is taken to be standard input.

The options are as follows:

-d, --date

set the document date (‘Dd’) to date( preferrably in "Month Day, Year" format). If unspecified, mkd2man uses the file modification date or current date if reading is from standard input or if stat(2) fails.

-h, --help

display help text.

-s, --section

set the document section (‘Dt’) to section. If unspecified, mkd2man uses 1.

-t, --title

set the document title (‘Dt’) to title. If unspecified, mkd2man uses the suffix-stripped filename part of file. When reading is from stdin the title must be specified.

Exit status

The mkd2man utility exits 0 on success, and >0 if an error occurs.

Releases

Unchanged in 5 releases since Debian 9 (Stretch).

  1. 9–13

Authors

mkd2man was written by Natasha "Kerensikova" Porte ⟨[email protected]⟩ and Baptiste Daroussin ⟨[email protected]⟩. Manual page was originally written by Massimo Manghi ⟨[email protected]⟩, and rewritten to mdoc format by Svyatoslav Mishyn ⟨[email protected]⟩.

From libsoldout-utils 1.4-7+b1 in Debian 13 (Trixie). Parsed by carta from the page's mdoc source.