1mpexpand(n)                  Documentation toolbox                 mpexpand(n)
2
3
4
5______________________________________________________________________________
6

NAME

8       mpexpand - Markup processor
9

SYNOPSIS

11       mpexpand ?-module module? format infile|- outfile|-
12
13       mpexpand.all ?-verbose? ?module?
14
15______________________________________________________________________________
16

DESCRIPTION

18       This manpage describes a processor / converter for manpages in the doc‐
19       tools format as specified in doctools_fmt. The processor is based  upon
20       the package doctools.
21
22       mpexpand ?-module module? format infile|- outfile|-
23              The  processor takes three arguments, namely the code describing
24              which formatting to generate as the output, the file to read the
25              markup from, and the file to write the generated output into. If
26              the infile is "-" the processor will read from stdin. If outfile
27              is "-" the processor will write to stdout.
28
29              If  the option -module is present its value overrides the inter‐
30              nal definition of the module name.
31
32              The currently known output formats are
33
34              nroff  The processor generates *roff output, the standard format
35                     for unix manpages.
36
37              html   The  processor  generates  HTML  output, for usage in and
38                     display by web browsers.
39
40              tmml   The processor generates  TMML  output,  the  Tcl  Manpage
41                     Markup Language, a derivative of XML.
42
43              latex  The processor generates LaTeX output.
44
45              wiki   The  processor  generates  Wiki  markup  as understood by
46                     wikit.
47
48              list   The processor extracts the information provided  by  man‐
49                     page_begin.
50
51              null   The processor does not generate any output.
52
53       mpexpand.all ?-verbose? ?module?
54              This  command uses mpexpand to generate all possible output for‐
55              mats for all manpages in the current directory. The manpages are
56              recognized  through  the extension ".man". If -verbose is speci‐
57              fied the command will list its actions before executing them.
58
59              The module information is passed to mpexpand.
60

NOTES

62       Possible future formats are plain text, pdf and postscript.
63

BUGS, IDEAS, FEEDBACK

65       This document, and the package it describes, will  undoubtedly  contain
66       bugs  and  other problems.  Please report such in the category doctools
67       of the Tcllib Trackers [http://core.tcl.tk/tcllib/reportlist].   Please
68       also  report any ideas for enhancements you may have for either package
69       and/or documentation.
70
71       When proposing code changes, please provide unified diffs, i.e the out‐
72       put of diff -u.
73
74       Note  further  that  attachments  are  strongly  preferred over inlined
75       patches. Attachments can be made by going  to  the  Edit  form  of  the
76       ticket  immediately  after  its  creation, and then using the left-most
77       button in the secondary navigation bar.
78

SEE ALSO

80       expander(n), format(n), formatter(n)
81

KEYWORDS

83       HTML, TMML, conversion, manpage, markup, nroff
84

CATEGORY

86       Documentation tools
87

89       Copyright (c) 2002 Andreas Kupries <andreas_kupries@users.sourceforge.net>
90       Copyright (c) 2003 Andreas Kupries <andreas_kupries@users.sourceforge.net>
91
92
93
94
95tcllib                                1.0                          mpexpand(n)
Impressum