Documentation
From QTermWiki
Main Page | Downloads | Scripts | Documentation | Development | Bug Report | Screenshots | FAQ | Help us | About
Welcome to QTerm, a BBS client in Linux, QTerm serves as a replacement of telnet, and provide many features useful when you are browsing a BBS site, such as mouse support, article download, anti-idle. It has a address book where you can store your favorite site addresses. And thanks to the power of Qt, QTerm have no problem converting between GB and BIG5.
This document is for getting you started in a few minutes. It may not answer all of your questions. If you have problems, please read FAQ and search your problem with google.
Contents |
Requirements
- Since QTerm is written in Qt, To run QTerm you need a working X environment with Qt 4.2 or above.
- If you want sound support, you should install Qt with Phonon support.
- For the SSH support, you need OpenSSL package.
- If you want to compile QTerm, you need the development package of X, Qt, OpenSSL (optional).
Getting QTerm
Download the latest source from our download page. Currently the stable version is 0.4, but the code is very old and outdated. On the other side the unstable version is almost stable enough for everyday use, so we recommend using the unstable version.
Usually we will provide binary packages: rpm ,deb etc, you can easily install them just like other packages. But because of the lacking of man power, you might need to download the source package and compile it by yourself. Don't be afraid, we will show you how to compile QTerm in the following part.
If you enjoy hunting bugs and committing patches, the SVN source is your best choice. You can find instructions in the download page too.
Configuring QTerm
Suppose you need to compile QTerm by yourself, the first thing you need to do is unpacking the source package and configuring QTerm:
tar zxvf qterm-0.5.6.tar.bz2 cd qterm-0.5.6 mkdir build cd build cmake ..
By default, QTerm will be installed to /usr/local, if you want to install it to some other place, use the following option
cmake .. -DCMAKE_INSTALL_PREFIX=/the/new/path
There are a few other useful variables to control the configuration process:
QTERM_ENABLE_SSH
Enable/disable SSH support (default: ON)
QTERM_ENABLE_DBUS
Enable/disable DBus support (default: ON)
QTERM_ENABLE_SCRIPT
Enable/disable script support (default: ON)
QTERM_ENABLE_PHONON
Enable/disable Phonon support (default: ON)
QTERM_ENABLE_SCRIPT_DEBUGGER
Enable/disable script debugger support (default: OFF)
For example, if you want to install QTerm to /usr/local/qterm and enable script debugger, you can run cmake with
cmake .. -DCMAKE_INSTALL_PREFIX=/usr/local/qterm -DQTERM_ENABLE_SCRIPT_DEBUGGER=ON
Compiling QTerm
Now you can start the compilation by typing
make
You can install QTerm with
make install
provided that you have write permission in the installation directory.
If all went well, you can run QTerm by typing
qterm