Mention libcurses and libreadline in the manual.

This commit is contained in:
Guus Sliepen 2012-11-11 18:45:40 +01:00
parent 0ee139e914
commit 6ec4596557

View file

@ -340,6 +340,8 @@ having them installed, configure will give you an error message, and stop.
* zlib::
* lzo::
* libevent::
* libcurses::
* libreadline::
@end menu
@ -473,6 +475,51 @@ make sure you build development and runtime libraries (which is the
default).
@c ==================================================================
@node libcurses
@subsection libcurses
@cindex libcurses
For the "tincctl top" command, tinc requires a curses library.
If this library is not installed, you wil get an error when running the
configure script. You can either install a suitable curses library, or disable
all functionality that depends on a curses library by using the
"--disable-curses" option when running the configure script.
There are several curses libraries. It is recommended that you install
"ncurses" (@url{http://invisible-island.net/ncurses/}),
however other curses libraries should also work.
In particular, "PDCurses" (@url{http://pdcurses.sourceforge.net/})
is recommended if you want to compile tinc for Windows.
You can use your operating system's package manager to install this if
available. Make sure you install the development AND runtime versions
of this package.
@c ==================================================================
@node libreadline
@subsection libreadline
@cindex libevent
For the "tincctl" command's shell functionality, tinc uses the readline library.
If this library is not installed, you wil get an error when running the
configure script. You can either install a suitable readline library, or
disable all functionality that depends on a readline library by using the
"--disable-readline" option when running the configure script.
You can use your operating system's package manager to install this if
available. Make sure you install the development AND runtime versions
of this package.
If you have to install libreadline manually, you can get the source code from
@url{http://www.gnu.org/software/readline/}. Instructions on how to configure,
build and install this package are included within the package. Please make
sure you build development and runtime libraries (which is the default).
@c
@c
@c