summaryrefslogtreecommitdiff
path: root/3rd-party/xfpt/doc/xfpt.1
blob: 756c231fef993793edb38b6db9de58e3269fc29f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
.TH XFPT 1
.SH NAME
xfpt - make XML from plain text
.SH SYNOPSIS
.B xfpt [options] [source file]
.
.SH DESCRIPTION
.rs
.sp
\fBxfpt\fP converts a marked up text file to XML. The markup is simple and
consists of lines that begin with a dot ("directive lines") and sequences in
the text that begin with an ampersand ("flags"). The flag sequences are not
built-in, but are defined by directives. As well as the in-built directives,
macros can be used to implement higher level concepts. A standard set of macros 
and flags that generate DocBook XML is provided. There is a full description in
the \fBxfpt\fP specification, which is distributed as a PDF file, an HTML file, 
and as \Bxfpt\fP source.
.
.SH OPTIONS
.rs
.TP 10
\fB-help\fP
This causes \fBxfpt\fP to output its "usage" information and then exit.
.TP
\fB-o\fP \fIfile\fP
This specifies the output file. The default is the standard output if no source 
file is given, and the source file name with a \fI.xml\fP extension otherwise.
.TP
\fB-S\fP \fIdirectory\fP
This specifies an alternative "share" directory in which to find standard 
configuration files.
.TP
\fB-v\fP
Output the \fBxfpt\fP version and exit.
.
.SH AUTHOR
.rs
.sp
Philip Hazel
.br
University Computing Service
.br
Cambridge CB2 3QG, England.
.P
.in 0
Last updated: 22 March 2007
.br
Copyright (c) 2007 University of Cambridge.