Add various documentation indices

[nncp.git] / doc / building.texi

diff --git a/doc/building.texi b/doc/building.texi
index 03eda87e2e85d88bc52bc87cecd7bb88c9d5282e..b788da615d1d91921ec1bfa70c27553af45af1cd 100644 (file)
--- a/doc/building.texi
+++ b/doc/building.texi
@@ -1,4 +1,5 @@
 @node Build-instructions
+@cindex building
 @section Build instructions
 
 Make sure that Go is installed. For example to install it from packages:
@@ -19,12 +20,19 @@ $ cd nncp-@value{VERSION}
 $ redo all
 @end example
 
+@pindex info
 After that you should get various @command{bin/nncp-*} binaries and
 @command{bin/hjson-cli} command (only for your convenience, not
 necessary installation). For example, documentation for
 @command{nncp-bundle} command can be get with
 @command{info doc/nncp.info -n nncp-bundle}.
 
+@pindex redo
+@pindex apenwarr/redo
+@pindex apenwarr/do
+@pindex redo-c
+@pindex baredo
+@pindex goredo
 It uses @url{http://cr.yp.to/redo.html, redo} build system for that
 examples. You can use one of its various implementations, or at least
 minimalistic POSIX shell @command{contrib/do} (just replace
@@ -35,13 +43,46 @@ in tarball. Following ones are tested to work with:
 from that project), @url{https://github.com/leahneukirchen/redo-c, redo-c},
 @url{https://github.com/gotroyb127/baredo, baredo}.
 
-There is @command{install} target respecting @env{$DESTDIR}. It will
-install binaries and info-documentation:
+@vindex PREFIX
+@vindex DESTDIR
+@vindex GO
+@vindex MAKEINFO
+@vindex PLANTUML
+@vindex PREFIX
+@vindex SENDMAIL
+@vindex CFGPATH
+@vindex SPOOLPATH
+@vindex LOGPATH
+@vindex BINDIR
+@vindex INFODIR
+@vindex DOCDIR
+@file{config} file contains some environment variables that are
+respected during installation:
+@env{$PREFIX},
+@env{$DESTDIR},
+@env{$GO},
+@env{$MAKEINFO},
+@env{$PLANTUML},
+@env{$PREFIX},
+@env{$SENDMAIL},
+@env{$CFGPATH},
+@env{$SPOOLPATH},
+@env{$LOGPATH},
+@env{$BINDIR},
+@env{$INFODIR},
+@env{$DOCDIR}.
+
+There is @command{install} target for binaries and info-documentation
+installation:
 
 @example
 # PREFIX=/usr/local redo install
 @end example
 
+@vindex nofsnotify
+@cindex kqueue
+@cindex epoll
+@vindex GO_CFLAGS
 NNCP depends on @code{github.com/fsnotify/fsnotify} library, that is
 solely relies on OS-specific mechanisms. There is possibility that you
 have either broken or unsupported ones. You can still build NNCP with
@@ -52,4 +93,5 @@ usage at all:
 $ GO_CFLAGS="-tags nofsnotify" redo ...
 @end example
 
+@vindex noyggdrasil
 You can also disable Yggdrasil support with @code{-tags noyggdrasil}.