]> wagnertech.de Git - mDoc.git/blob - doc/mdoc-extract.1
Bugfix 126
[mDoc.git] / doc / mdoc-extract.1
1 .\" Manpage for mdoc-extract.
2 .\" Contact mail@wagnertech.de to correct errors or typos.
3 .TH MDOC-EXTRACT 1 "08 Dez 2021" Linux "Linux Manual"
4 .SH NAME
5 mdoc-extract \- mdoc extraction tool
6 .SH SYNOPSIS
7 .B mdoc-extract
8 INPUT CLASS
9 .SH DESCRIPTION
10 .PP
11 mdoc-extract reads an input xml file and builds an output tex file. Elements in the input file can be
12 labeled by 
13 .I include
14 or
15 .I exclude
16 tags. The value of these tags is the class name from which on this advise is valid. Advices are inherited 
17 to subclasses. Subclasses are named by "base.sub". Advices for "base.sub" are valid for CLASS=base.sub, 
18 CLASS=base.sub.subsub and so on, but not for CLASS=base. There can also be more than one class in an advice.
19 These classes are separated by ":".
20 .TP
21 \fBINPUT\fR
22 Input xml file name
23 .TP
24 \fBCLASS\fR
25 Production class name
26 .SH FILES
27 Input file is expected with this format:
28 .nf
29 <document>
30   <text>This text is always used</text>
31   <text include="base.sub:otherbase">This text appears only in "base.sub" 
32      and its subclasses as well as for "otherbase" and its subclasses.</text>
33   <text exclude="base.sub">This text does not appear in "base.sub"
34      and its subclasses</text>
35 </document>
36 .fi
37 .SH AUTHOR
38 Michael Wagner (michael@wagnertech.de)
39