X-Git-Url: http://www.git.cypherpunks.ru/?a=blobdiff_plain;f=doc%2Fbuilding.texi;h=7405d39960c463320932f087720bf3a0dbb01d91;hb=bcad9cccd83df2489d13ea211549979a9684df57;hp=afe9f40eb5d40a0ee5d97dee9e524d9a58322375;hpb=1c773d7a2acd7fef4b7b1567b59e1601a79d55fe;p=nncp.git diff --git a/doc/building.texi b/doc/building.texi index afe9f40..7405d39 100644 --- 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: @@ -12,25 +13,70 @@ Make sure that Go is installed. For example to install it from packages: @example $ [fetch|wget] http://www.nncpgo.org/download/nncp-@value{VERSION}.tar.xz -$ [fetch|wget] http://www.nncpgo.org/download/nncp-@value{VERSION}.tar.xz.sig -$ gpg --verify nncp-@value{VERSION}.tar.xz.sig nncp-@value{VERSION}.tar.xz -$ xz --decompress --stdout nncp-@value{VERSION}.tar.xz | tar xf - +$ [fetch|wget] http://www.nncpgo.org/download/nncp-@value{VERSION}.tar.xz.@{asc,sig@} +[verify signature] +$ xz -d < nncp-@value{VERSION}.tar.xz | tar xf - $ cd nncp-@value{VERSION} -$ redo all +[optionally edit config] +$ bin/build @end example -It uses @url{http://cr.yp.to/redo.html, redo} build system for that -examples. You can use either dozen of various implementations, or at -least minimalistic POSIX shell @command{contrib/do} (just replace -@command{redo} with @command{contrib/do} in the example above) included -in tarball. Following ones are tested to work with: -@url{http://www.goredo.cypherpunks.ru/, goredo} (NNCP's author creation), -@url{https://redo.readthedocs.io/, apenwarr/redo} (@code{contrib/do} is -from that project), @url{https://github.com/leahneukirchen/redo-c, redo-c}. +@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}. -There is @command{install} make-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} script for binaries and info-documentation +installation: + +@example +# PREFIX=/usr/local ./install +@end example + +@vindex nofsnotify +@cindex kqueue +@cindex epoll +@vindex GO_CFLAGS +NNCP depends on @code{github.com/fsnotify/fsnotify} library, that solely +relies on OS-specific mechanisms. There is possibility that you have +either broken or unsupported ones. You can still build NNCP with +@code{-tags nofsnotify} build option, to skip @code{fsnotify} library +usage at all: @example -# PREFIX=/usr/local redo install +$ GO_CFLAGS="-tags nofsnotify" bin/build @end example + +@vindex noyggdrasil +You can also disable Yggdrasil support with @code{-tags noyggdrasil}.