User Manual:Downloading & Installing
From KLFWiki
Contents |
Download Instructions
Download KLatexFormula by following the quick links on the downloads page or browse all available downloads at http://sourceforge.net/projects/klatexformula/files/
You can browse the Changelog for more information on changes between different versions.
You can download some additional plugins for KLatexFormula: browse available extensions. These plugins are provided as rcc extensions, that can be directly installed in KLatexFormula's settings dialog in the Add-Ons tab.
Install instructions - Binaries
If you find a binary for your system, run for it.
The following binaries are known to be available:
- Mac OS X
- MS Windows
- OpenSUSE packages
- Ubuntu package
- Fedora packages
- Debian packages
- Mandriva packages
- Gentoo: ebuild contributed by mrbit
Binaries for Mac OS X and MS Windows can be downloaded from the Download Page, or from the links below. Packages for various linux distributions are often provided simply via the distribution's package manager.
I would like to express many thanks to all third-party contributors who have provided effort into packaging KLatexFormula for various systems. (If I failed to mention some packages please feel free to edit this page to add links to your packages too.)
Mac OS X Binary
You will need to install Latex and ghostscript by some means (eg. Texshop, fink, ...). Usually if you can run LaTeX, this means you installed something like MacTeX, so you probably have everything you need already.
KLatexformula for Mac OS X is available on the downloads page.
MS Windows Installer
Download the windows installer from the Downloads Page and follow the wizard instructions.
Don't forget to install Latex and GS. These are included for example in MikTeX.
Linux Distribution Packages
Packages for several major distributions are available through the distribution's package manager.
Install instructions - Compiling From Source
Make sure you have read the User Manual:System Requirements and especially installed all relevant development packages (gcc, g++, make, cmake, qt4, etc.)
The Short Story
This section explains (briefly) the commands to execute in a terminal to install KLatexFormula for all users on your system. You will need to have administrative rights to install.
Open a terminal, and change to the directory where you downloaded the source archive. Then extract the source archive with the following commands:
> tar xvfz klatexformula-3.2.0.tar.gz > cd klatexformula-3.2.0/
Then run the following commands:
> mkdir build > cd build > cmake .. > make > sudo make install
And you're done! If nothing went wrong, you can launch klatexformula by selecting its menu entry in the system menu, or with the command:
> klatexformula
If you are new to klatexformula, you can have a look at the User Manual:30-Second Get Started Overview, or look at the User Manual Homepage.
The Long Story
This section explains how to build KLatexFormula from source, with custom compilation options, and installation locations. Although the build system is normally capable of detecting correctly many settings and providing a reasonable default configuration, it is highly flexible and customizable.
As of klatexformula 3.2, CMake is used as build system. You need cmake program installed to compile KLatexFormula (just to compile, not to run it). The CMake script will guess most settings and display informative output. You can re-run cmake as many times as needed with the relevant options (eg. -DVARNAME=<value>) to tune the build process as wanted. Minimum CMake version required is 2.6.4.
Untar the source archive and enter the untarred archive directory
> tar xvfz klatexformula-3.2.0.tar.gz > cd klatexformula-3.2.0
Make a build directory, and enter it
> mkdir build > cd build
Run CMake (note the two dots)
> cmake .. (command-line interface) or > cmake-gui .. (graphical interface) or > ccmake .. (ncurses console interface)
Check the output of the CMake script. This build script should be clever enough to detect reasonable values for required settings. If you are unsure and just want to have klatexformula running, then as long as no error occurred, proceed to the following step ('make'). Otherwise you can fine-tune your build by changing cmake variable values, see User Manual:CMake compilation options. For example, to change the installation directory to /usr/local (default is /usr), run
> cmake .. -DCMAKE_INSTALL_PREFIX=/usr/local
You may run cmake as many times as necessary to configure the build system to your needs.
Once the build system is set up as you like, run 'make' to compile the source code
> make
install klatexformula (requires administrator password for system directory install)
> sudo make install Password: or > make install
You're done! If nothing went wrong, you can launch klatexformula with:
> klatexformula
If you want a brief introduction to KLatexFormula's features, have a look at User Manual:30-Second Get Started Overview.
Uninstalling KLatexFormula
You installed KLatexFormula by running something like
> sudo make install
To uninstall klatexformula, an uninstall target is provided. Simply type
> sudo make uninstall
Install instructions - From Source (old klatexformula version 3.1)
Untar the archive
> tar xvfz klatexformula-3.1.1.tar.gz
Then enter the directory and run qmake
> cd klatexformula-3.1.1 > qmake
check the output generated by qmake. You have the possibility to pass extra compilation options at this stage. To pass an option, use the syntax
> qmake OPTION=value
you may run qmake any number of times you want until you have the correct setup. A typical run on 64-bit Ubuntu 9.04 (where qmake is /usr/bin/qmake-qt4) where we want a shared klfbackend library could look like:
> qmake-qt4 QMAKE=/usr/bin/qmake-qt4 BACKEND_SHAREDORSTATIC=dll BACKEND_INSTALLDIR=/usr/local BACKEND_LIBDIR=lib64
or from version 3.1.2 on:
> qmake-qt4 QMAKE=/usr/bin/qmake-qt4 BACKEND_SHAREDORSTATIC=dll BACKEND_INSTALLDIR=/usr/local BACKEND_INSTALLLIBDIR=/usr/lib64
a full list of compilation options you can pass to qmake are detailed on the page User Manual:Qmake compilation options.
Once qmake has run and your settings are exactly as you wish, compile the program:
> make
And upon success of make you can install with
> su Password: > make install
or on systems with sudo:
> sudo make install
If compilation fails, decrypt the error message and good luck :-| Check also the system requirements
