FRUNDIS(1)

NAME
frundis - exporting tool for the frundis markup language

SYNOPSIS
frundis -T format [-as] [-o output-file] [path]

DESCRIPTION
The frundis program reads an UTF-8 encoded file given by path, or standard input if no file is given as argument, written in the frundis language as documented in frundis_syntax(5), and exports it to LaTeX, XHTML or EPUB.

The options are as follows:

-a  When exporting to XHTML, output only one file, instead of a directory with one file per part or chapter, and implies also that -s is no longer the default.

-o output-file
    Specify the name of an output file, instead of printing to stdout. In the case of exporting to EPUB, and XHTML unless -a is specified, this option is mandatory and specifies the name of a new directory that will contain all the necessary files. For EPUB, zipping has to be done manually after.

-s  Specify that a standalone document should be produced. This is the default for XHTML and EPUB output formats.

-T format
    Specify the format in which to export. The format argument can be latex, xhtml or epub.

ENVIRONMENT
frundis uses the following environment variables:

FRUNDISLIB
    This variable can be used to specify a colon separated list of directories in which to search for frundis included source files.

FILES
examples/
    This directory available in the root of the distribution contains examples for easy customization of output.
examples/stylesheet.css
    Example stylesheet for easy customization of XHTML and EPUB output formats.
examples/preamble.tex
    Example of preamble for LaTeX for easy customization.

EXAMPLES
To print simple XHTML without headers:

    $ frundis -a -T xhtml input.frundis > output.html

To print a standalone XHTML:

    $ frundis -a -s -T xhtml input.frundis > output.html

To create a directory with XHTML files and an index:

    $ frundis -T xhtml -o output-dir input.frundis

To create an EPUB file, assuming the zip program from http://infozip.sourceforge.net/ is installed:

    $ frundis -T epub -o output-dir input.frundis
    $ cd output-dir
    $ zip -X0 ../my-epub.epub mimetype
    $ zip -Xur9D ../my-epub.epub *

To produce a LaTeX document without a preamble:

    $ frundis -T latex input.frundis > output.tex

To produce a complete LaTeX document:

    $ frundis -s -T latex input.frundis > output.tex

DIAGNOSTICS
Standard error messages have the following form:

    frundis:file:lnum:level:message

The file field specifies the name of the source file in which an error was encountered. It can be stdin when reading from standard input. The lnum field specifies the number of the line in the source file where the error has been detected. The level field can be warning for deprecated features or error prone uses, error for partially recoverable errors, or fatal for errors that stop processing. The message field provides further details on the nature of the error.

The file and lnum fields appear only when it makes sense.

SEE ALSO
frundis_syntax(5)