Content-type: text/html Man page of efeudoc

efeudoc

Section: User Commands (1)
Index Return to Main Contents
 

NAME

efeudoc - document generator

 

SYNOPSIS

efeudoc--help[=type] ] [ --version ] [ --info[=entry] ] [ --debug[=mode] ] [ --verbose ] [ -I dir ] [ -T type ] [ -C cfg ] [ -H hdr ] [ -0 ] [ -u ] [ -r name ] [ -d ] [ -t ] [ -l ] [ -p ] [ --pdf ] [ -h ] [ -o aus ] file(s)

 

DESCRIPTION

The command efeudoc is a document generator with different output formats (LaTeX, HTML, roff, ...). The EFEU interpreter language (see esh(1)) is used in commands, so you can directly integrate data evaluation or create tables from data cubes directly in your document.

The document prozessor efeudoc uses a plain text input format that allows you to write the document similar to the desired output and tries to use controls as less as possible.

To demonstrate this, the following example shows you the construction of a bullet list:

The code

Text before list.
*       List entry with a paragraph containing
        more than one line of text to show the behavior
        of indentation.
*       Another list entry

        This is the second paragraph of this entry.
Text after list.

creates the output:

Text before list.

*
List entry with a paragraph containing more than one line of text to show the behavior of indentation.
*
Another list entry

This is the second paragraph of this entry. Text after list.

 

Options

The following options and arguments are accepted by efeudoc:

--help[=type]
create command usage. The optional parameter type determines the formatting and output of the description.
term
display on terminal (default)
raw
output raw data for efeudoc
man
output nroff/troff source for man
lp
send postscript data to lpr

--version
show version information
--info[=entry]
show command information
--debug[=mode]
set debug level for command See for details.
--verbose
set debug level to .info.
-I dir
append dir to the search path for configuration files. The default setting is ".:/home/efeu/www/efeu-3.3-1/lib/efeudoc:/usr/local/lib/efeudoc:/usr/lib/efeudoc:/lib/efeudoc".
-T type
document type, ? gives a listing.
-C cfg
configuration file
-H hdr
evaluates hdr before any input file.
-0
suppress document head
-u
Use UTF8 coding in sources
-r name
create target rule for make
-d
create dependence
-t
terminal output
-l
LaTeX document
-p
PostScript document over LaTeX
--pdf
PDF document over LaTeX
-h
html document
-o aus
output file
file(s)
input file(s)
 

DOCUMENT SYNTAX

This section needs to be written

 

COMMANDS

This sections contains a list of all predefined commands of efeudoc.

The following notation is used in command syntax:

*
If there are different methods of parameter handling, all of them are given. Every calling variant starts with the command name.
*
Any argument in brackets like [arg] or braces like {arg} is optional and may be omitted. The brackets and braces are part of the syntax.
*
Any argument without braces in the same line as the command name is terminated by the next linefeed.
*
Indented dots in a line means that the argument of the previous line may be continued with indented lines.
*
Any argument in its own line is ended by the next empty line.
\addflag
document flags

The command \addflag expands the flags for document processing. The interpretation of the flags depends of the actual output driver.

\addsrc
expand source list with single file
\addsrc file
\addsrclist
expand source list with files of directory tree
\addsrclist dir
\appendix
appendix
\appendix [short form] title
The command \appendix starts a new appendix.
\author
list of authors
\bfitem
boldface item
\bfitem tag
The command starts a new description entry with a bold face item tag.
\bibitem
bibliography entry
\bibliography
start bibliography
\br
line break

The command \br causes a line break.

\caption
figure or table caption
\caption [short form] title
The command sets the title for a figure or table.
\chap
chapter
\chap [toc entry] title
    ...
\cite
cite bibliography entry
\cmdinclude
include script file
\cmdinclude "name" \cmdinclude <name>
\code
code environment

The command \code starts the code environment. Inside this environment, the default font is typewriter.

\config
load configuration file
\config name
The command \config loads the configuration file name.
\Copyright
caption COPYRIGHT
\date
set date

The command \date sets the date for the document.

\delsrc
remove files from source list
\delsrc pattern
\Description
caption DESCRIPTION
\Diagnostics
caption DIAGNOSTICS
\docfile
get path of document file
\docfile name
\docfile {name}
The command searches the file name relating to the current document path and returns the path name if found.
\end
end current environment

The command \end closes the current environment.

\endall
end all environments

The command \endall closes all open environments.

\endlist
end list

The command \endlist closes the current list environment.

\Environment
caption ENVIRONMENT
\Errors
caption ERRORS
\eval
evaluate expression
\eval expr
\eval {expr}
The command \eval evaluates expr and inserts the result at current position.

Example: \eval{3*5} results in 15.

\Example
caption EXAMPLE
\Examples
caption EXAMPLES
\fig
figure
\fig [pos]
The command \fig starts a new figure environment.
\Files
caption FILES
\getsrc
insert files of source list
\getsrc [cmd] pattern list
\geval
evaluate expression global
\geval expr
\geval {expr}
This command acts like \eval but new variables are created global.
\hang
hanging paragraphs

The command \hang starts a region with hanging paragraphs.

\head
headline in manual pages
\head [toc entry] title
    ...
\hmode
start paragraph, horizontal mode
\hmode
The command \hmode starts a new paragraph, if none is opened.
\if
conditional block
\include
include file
\include [flags] name
The command \include inserts file name at current position. The following control flags could be used:
verbatim
verbatim text without interpretation of special characters. Tabulators are replaced by spaces.
latex
plain LaTeX text.
html
plain HTML text
man
plain manpage text
ignore
load text but ignore output
eval
evaluate file with EFEU command interpreter
geval
evaluate file with EFEU command interpreter, new variables are created global.

\index
index entry
\index [entry]{text}
The command \index creates an index entry entry to the text text. If entry is missing, text would be used.
\intro
introduction

The command \intro starts the introduction

\item
roman item
\item tag
The command starts a new description item with a roman tag.
\ititem
italic item
\ititem tag
The command starts a new description entry with a italic item tag.
\label
set label
\label {name}
\langpar
language dependent paragraph
\langpar
par
Experimental, may be changed.
\latex
LaTeX code
\latex [alt] {code} \latex [alt] code
The command allows to insert latex code code for the latex driver. All other drivers use alt instead.
\lmark
bibliographical reference

The command \lmark creates a bibliography mark.

\lof
list of figures

The command \lof creates a list of tables.

\lot
list of tables

The command \lot creates a list of figures.

\margin
marginal note
\margin [left] {note}
\mark
footnote mark

The command \mark creates a footnote mark.

\math
mathematic typesetting
\math {formular}
\mchap
manpage chapter
\mchap [number] title
    ...
\mkmf
create makefile and insert
\mkmf imakefile
The command \mkmf calls mkmf with the given Imakefile and inserts the created Makefile in verbatim mode.
\mksource
create sourcefile
\mksource file
The command \mksource calls mksource with the given script and includes the created files in verbatim mode.
\mpage
manual page entry
\mpage [num] name
The command \mpage starts a new manpage with name name for section num. This command is automatic inserted in every file witch prefix starts with a digit.
\mref
manual page reference
\mref {arg}
\ms_example
execute mksource example
\ms_example name example script \\end
The command \ms_example calls mksource with the given example script and includes it together with all created files in verbatim mode.
\n
line feed
\n
The command \n writes a linefeed back to the input stream.
\Name
Name section of manpage with caption NAME
\Name [toc entry] title
    ...
\Name [toc entry]
one line title
\newpage
page break

The command \newpage causes a page break.

\note
footnote
\note [mark] {note}
\Notes
caption NOTES
\package
LaTeX packages

The command \package loades the LaTeX package name if the LaTeX driver is used.

\par
end paragraph, vertical mode
\par
The command \par finishes the current paragraph.
\para
paragraph
\part
part
\part [toc entry] title
    ...
\pipe
include output of command
\pipe [flags] cmd     ...
The command \pipe inserts the output of the command cmd at current position. The flags are the same as in \include.
\pop
remove command table

The command \pop removes the lowest table from the table stack.

\pref
page ref
\preface
preface

The command \preface starts the preface

\printindex
index

The command \printindex creates the index.

\printsrclist
print source list
\printsrclist fmt
\proto
function prototype
\proto prototype
The command \proto shows the prototype of a function of the EFEU interpreter language.
\push
new command table

The command \push cerates a new table for commands, macros and vars and pushes it to the table stack.

\quote
quoting

The command \quote starts a region with quoted (indented) text.

\ref
refer label
\relax
idle command

the command \relax does nothing

\rem
comment
\rem comment
The command \rem writes a commend to the output file.
\sec
section
\sec [toc entry] title
    ...
\SeeAlso
caption SEE ALSO
\shead
subheadline in manual pages
\shead [toc entry] title
    ...
\spage
partial page
\spage [margin] flags
The command \spage starts a partial page, obsolete.
\src2doc
create manual page from source
\src2doc [flags] pattern list
\srcinclude
include files of source list
\srcinclude pattern list
\ssec
subsection
\ssec [toc entry] title
    ...
\style
document style

The command \style sets the style of the document.

\Synopsis
caption SYNOPSIS
\t
tabulator key
\t
The command \t writes a tabulator key back to the input stream.
\tab
tabular
\tab [pos] fmt
tab lines
The command \tab starts a tabular with vertikal adjustment pos and column format fmt. The tabular ends by the first empty line.
\table
table
\table [pos]
The command \table starts a new table environment.
\thedate
get date

The command \thedate fetches the actual setting of the date.

\title
document title
\title [toc entry] title
subtitle
If the document is not startet, the command sets the document title, else it starts a new chapter. The optional argument toc entry is only used in the later case. The subtitle is ignored in the later case.
\toc
table of contents

The command \toc creates a table of contents.

\ttitem
typewriter item

The command starts a new description entry with a typewriter item tag.

\url
reference to uniform resource locator
\url |url| {label}
\vref
combinated reference (page and value)
\vspace
vertical adjustment
\vspace offset
The command \vspace closes the current paragraph and performs a vertical shift of offset lines.
\Warnings
caption WARNINGS

 

MACROS

This sections contains a list of all predefined macros of efeudoc.
@if
conditional expression
@if (expr,ifpart,elsepart)
@MSExample
include mksource example
@MSExample (name,text)
The makro @MSExample includes a mksource example script and the target file(s), where name is the name of the script and text is the separating text between source and target file(s).
@PRM
reference to the Programmer''s Reference Manual
 

ENVIRONMENT

APPLPATH
path for configuration files.
LANG
locale information
 

SEE ALSO

esh(1).

 

COPYRIGHT

Copyright (C) 1999 Erich Frühstück


 

Index

NAME
SYNOPSIS
DESCRIPTION
Options
DOCUMENT SYNTAX
COMMANDS
MACROS
ENVIRONMENT
SEE ALSO
COPYRIGHT

This document was created by man2html, using the manual pages.
Time: 09:44:47 GMT, December 18, 2011