Scroll to navigation

eLyXer(1) General Commands Manual eLyXer(1)

NAME

elyxer - convert LyX files to html

SYNOPSIS

elyxer [options] [infile] [outfile]

DESCRIPTION

eLyXer (pronounced elixir) is a LyX to HTML converter. It's written in plain Python and doesn't rely on any kind of TeX to html converters.

COMMON OPTIONS

--help
Display help.
--quiet
Disable all runtime messages.

ADVANCED OPTIONS

--debug
Enable debugging messages (for developers).
--version
Show version number and release date.
--lyxformat
Return the highest supported LyX version that can be converted.

HTML OUTPUT OPTIONS

--title title
Set the generated page title.
--css file.css
Use a custom CSS file.
--embedcss file.css
Embed the CSS file into the HTML output instead of including a separate file.
--html
Output HTML 4.0 instead of the default XHTML.
--unicode
Full unicode output.
--iso885915
Output the document with ISO-8859-15 encoding instead of UTF-8.
--nofooter
Don't include the 'created by eLyXer' footer.
--simplemath
Do not generate fancy math constructions.

IMAGE OUTPUT OPTIONS

--directory image_dir
Look for images in the specified directory.
--destdirectorty dest_dir
Place converted images into this directory.
--forceformat .extension (deprecated)
Starting with eLyXer 1.1.1 this option has been replaced by the --imageformat option.
--imageformat .extension | copy
Force the image output format, default is PNG.
This option is helpful in cases were you'd like to override the automatic conversion to the PNG image format. If you'd like to preserve all images in the original format use the copy command.
--converter inkscape
Use Inkscape as the image converter.
--noconvert
Do not convert images, just use them in the current available format they're stored in.
Be aware that you've to copy your image files to the output directory if you create the html output outside of the source directory.

FOODNOTE OPTIONS

--numberfoot
Label footnotes with numbers instead of letters.
--symbolfoot
Label footnotes with symbols instead of letters, e.g. *, **.
--hoverfoot
Show footnotes as hovering text (default).
--marginfoot
Show footnotes on the page margin.
--endfoot
Show footnotes at the end of the page.
--supfoot
Use superscript for footnote markers (default).
--alignfoot
Use aligned text for footnote markers.
--footnotes number,symbol,hover,margin,end,sup,align
You can specify one or more of the above footnote options as a comma speparated list.

ADVANCED OUTPUT OPTIONS

--splitpart level
Split the resulting webpage at the given level.
--tocfor page
Generate a TOC that points to the given page.
--toc (deprecated)
Create a table of contents.
--target frame
Let all links point to the given frame.
--toctarget page (deprecated)
Generate a TOC that points to the given page.
--notoclabels
Omit the part lables like 'Chapter' in the TOC.
--lowmem
Force on the fly conversion to conserve memory.
 
This is the old behaviour of eLyXer prior to 0.36.
--raw
Generate HTML without header or footer.
--jsmath URL (deprecated)
Use jsMath fomr the given URL to display equations.
--mathjax URL | remote
Use MathJax from the given URL to display equations. If you use --mathjax with the keyword remote instead of an URL you can use the MathJax CDN instead of a local copy.
--googlecharts
Use Google Charts to generate formular images.
--template file
Use a template, put everything into <!--$content-->.
--copyright
Add a copyright notice at the bottom.
--nocopy (deprecated)
Disables the copyright notice at the bottom. With eLyXer 0.99 the default changed to not include a copyright notice. See also --copyright if you would like to have copyright notice printed.

AUTHOR

This manpage was written by Sven Hoexter <sven@timegate.de> for the Debian operating system. eLyXer was written by Alex Fernández <elyxer@gmail.com>.

COPYRIGHT

eLyXer is copyright © 2009-13 Alex Fernández.
 
This manpage is copyright © 2009-13 Sven Hoexter and Alex Fernández.
 
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.
 
This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.

SEE ALSO

On a Debian operating system you can find the full documentation for eLyXer in /usr/share/doc/elyxer/. The website of eLyXer is <http://www.nongnu.org/elyxer/>
August 2011