antix19
authorMichael Wagner <michael@wagnertech.de>
Fri, 26 Mar 2021 21:16:42 +0000 (22:16 +0100)
committerMichael Wagner <michael@wagnertech.de>
Fri, 26 Mar 2021 21:16:42 +0000 (22:16 +0100)
Test/.dummy [new file with mode: 0644]
debian/.dummy [new file with mode: 0644]
doc/mdoc-extract.1 [new file with mode: 0644]
doc/mdoku.7 [new file with mode: 0644]

diff --git a/Test/.dummy b/Test/.dummy
new file mode 100644 (file)
index 0000000..e69de29
diff --git a/debian/.dummy b/debian/.dummy
new file mode 100644 (file)
index 0000000..e69de29
diff --git a/doc/mdoc-extract.1 b/doc/mdoc-extract.1
new file mode 100644 (file)
index 0000000..2d95034
--- /dev/null
@@ -0,0 +1,38 @@
+.\" Manpage for mdoc-extract.
+.\" Contact mail@wagnertech.de to correct errors or typos.
+.TH MDOC-EXTRACT 1 "27 Jan 2020" Linux "Linux Manual"
+.SH NAME
+mdoc-extract \- mdoc extraction tool
+.SH SYNOPSIS
+.B mdoc-extract
+INPUT CLASS
+.SH DESCRIPTION
+.PP
+mdoc-extract reads an input xml file and builds an output tex file. Elements in the input file can be
+labeled by 
+.I include
+or
+.I exclude
+tags. The value of these tags is the class name from which on this advise is valid. Advices are inherited 
+to subclasses. Subclasses are named by "base.sub". Advices for "base.sub" are valid for CLASS=base.sub, 
+CLASS=base.sub.subsub and so on, but not for CLASS=base.
+.TP
+\fBINPUT\fR
+Input xml file name
+.TP
+\fBCLASS\fR
+Production class name
+.SH FILES
+Input file is expected with this format:
+.nf
+<document>
+  <text>This text is always used</text>
+  <text include="base.sub">This text appears only in "base.sub" 
+     and its subclasses</text>
+  <text exclude="base.sub">This text does not appear in "base.sub"
+     and its subclasses</text>
+</document>
+.fi
+.SH AUTHOR
+Michael Wagner (michael@wagnertech.de)
+
diff --git a/doc/mdoku.7 b/doc/mdoku.7
new file mode 100644 (file)
index 0000000..38cc2a5
--- /dev/null
@@ -0,0 +1,17 @@
+.\" Manpage for mdoc.
+.\" Contact mail@wagnertech.de to correct errors or typos.
+.TH MDOKU 7 "27 Jan 2020" Linux "Linux Manual"
+.SH NAME
+mdoku \- Documentation Suite
+.SH SYNOPSIS
+.B mdoku
+.SH DESCRIPTION
+mdoku documentation suite brings some useful tools:
+.TP
+mdoc-extract
+extracts documentation parts in some object oriented manner.
+.SH SEE ALSO
+mdoc-extract (1)
+.SH AUTHOR
+Michael Wagner (michael@wagnertech.de)
+