3rd-party/xfpt/doc/xfpt.1

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