From 4d9049dc1a57ccbf0ff9fa2642282a30e875e9e1 Mon Sep 17 00:00:00 2001 From: "Ondrej Zajicek (work)" Date: Thu, 3 Jan 2019 17:11:56 +0100 Subject: [PATCH] Doc: README and INSTALL update Minor cleanups, updates and clarifications. Also removes (incomplete and well-known) build steps from README, as they are better described in INSTALL. --- INSTALL | 14 +++++++++++--- README | 18 ++++-------------- 2 files changed, 15 insertions(+), 17 deletions(-) diff --git a/INSTALL b/INSTALL index a0b107ef..7bb8ded9 100644 --- a/INSTALL +++ b/INSTALL @@ -7,13 +7,15 @@ $ make Default location for configuration file is /usr/local/etc/bird.conf and for control socket is /usr/local/var/run/bird.ctl . You can change that -by --sysconfdir and --localstatedir configure options. +by --prefix, --sysconfdir and --runstatedir configure options, e.g.: + +$ ./configure --prefix=/usr --sysconfdir=/etc --runstatedir=/run To compile current development BIRD source code from Git repository, you also need Git (to download the source code) and Autoconf (to generate the configure script and associated files using 'autoreconf' tool): -$ git clone git://git.nic.cz/bird.git +$ git clone https://gitlab.labs.nic.cz/labs/bird/ $ cd bird $ autoreconf @@ -32,9 +34,15 @@ For compiling BIRD you need these programs and libraries: - Flex - ncurses library - - GNU Readline library (2.1 or newer) + - GNU Readline library + - libssh library (optional, for RPKI-Router protocol) For compiling BIRD documentation you also need: - Linuxdoc-Tools - LaTeX + +Note that build scripts for BIRD documentation expects 'nsgmls' from +James Clark's SP suite, while modern distributions use 'onsgmls' from +OpenSP suite. It is possible to build BIRD documentation with OpenSP +tools, but it requires manually tweaking paths in doc/sgml2* scripts. diff --git a/README b/README index 7b8fbf2e..6ff691e8 100644 --- a/README +++ b/README @@ -6,7 +6,7 @@ (c) 1998--2008 Martin Mares (c) 1998--2000 Pavel Machek (c) 1998--2008 Ondrej Filip - (c) 2009--2017 CZ.NIC z.s.p.o. + (c) 2009--2019 CZ.NIC z.s.p.o. ================================================================================ @@ -48,20 +48,10 @@ How to install BIRD ftp://bird.network.cz/pub/bird/redhat/ o From source code of the latest stable release version ftp://bird.network.cz/pub/bird/ - o From source code of the actual development version - git://git.nic.cz/bird.git + o From current development code in Git repository https://gitlab.labs.nic.cz/labs/bird/ -How to install BIRD from source code ------------------------------------- - - $ ./configure - $ make - $ su - # make install - # vi /usr/local/etc/bird.conf - -See the file INSTALL for more information about installation from source code. +See the file INSTALL for information about installation from source code. Documentation ============= @@ -69,7 +59,7 @@ Documentation Online documentation is available at http://bird.network.cz/?get_doc or as HTML files in the doc directory, you can install it by `make install-docs' and rebuild it by `make docs', but you'll need SGMLtools and LaTeX to be installed -on your machine. You can also download a neatly formatted PostScript version as +on your machine. You can also download a neatly formatted PDF version as a separate archive (bird-doc-*.tar.gz) from ftp://bird.network.cz/pub/bird/ User support