summaryrefslogtreecommitdiffstatshomepage
path: root/mdocml.1
diff options
context:
space:
mode:
authorKristaps Dzonsons <kristaps@bsd.lv>2008-11-22 18:34:06 +0000
committerKristaps Dzonsons <kristaps@bsd.lv>2008-11-22 18:34:06 +0000
commit0c023dc23d3930756004b7517582d0e5bb5c5b68 (patch)
treefdaf9852981935ce89aed75794f24a012f5644be /mdocml.1
parentc67f46c29b1a4c6f2a2ea1b05e055c371da2d020 (diff)
downloadmandoc-0c023dc23d3930756004b7517582d0e5bb5c5b68.tar.gz
mandoc-0c023dc23d3930756004b7517582d0e5bb5c5b68.tar.zst
mandoc-0c023dc23d3930756004b7517582d0e5bb5c5b68.zip
Putting md_run and friends into libmdocml (needs work to be useful).
Diffstat (limited to 'mdocml.1')
-rw-r--r--mdocml.134
1 files changed, 23 insertions, 11 deletions
diff --git a/mdocml.1 b/mdocml.1
index 205ad47a..ad46bba4 100644
--- a/mdocml.1
+++ b/mdocml.1
@@ -3,23 +3,35 @@
.\" The following requests are required for all man pages.
.\"
.\" Remove `\&' from the line below.
-.Dd $\&Mdocdate$
-.Dt NAME SECTION#
+.Dd $Mdocdate: November 22 2008 $
+.Dt mdocml 1
.Os
.Sh NAME
-.Nm program
-.Nd one line about what it does
+.Nm mdocml
+.Nd compile manpage source into mark-up language
.Sh SYNOPSIS
-.\" For a program: program [-abc] file ...
-.Nm program
-.Op Fl abc
-.Ar
+.Nm mdocml
+.Op Fl o Ar outfile
+.Op Ar infile
.Sh DESCRIPTION
The
.Nm
-utility processes files ...
-something
-something.
+utility compiles manpage source into a mark-up language. Its arguments
+are as follows:
+.Bl -tag -width "-o outfile"
+.It Fl o Ar outfile
+Place output in
+.Ar outfile ,
+which may be
+.Qq -
+for standard output. The default is standard output.
+.It Ar infile
+Read input from
+.Ar infile ,
+which may be
+.Qq -
+for standard input. The default is standard input.
+.El
.\" The following requests should be uncommented and used where appropriate.
.\" This next request is for sections 2, 3, and 9 function return values only.
.\" .Sh RETURN VALUES