]> Cypherpunks.ru repositories - gogost.git/blobdiff - download.texi
Parametrized version in documentation
[gogost.git] / download.texi
index 390d3cc7940e29a789723db57bb62384338cb0b6..df68b9da2b8ac4c18f86d433150c96a368eb9d41 100644 (file)
@@ -4,22 +4,22 @@
 Preferable way is to download tarball with the signature from
 website and, for example, run tests with benchmarks:
 
-@verbatim
-$ wget http://gogost.cypherpunks.ru/gogost-4.1.0.tar.xz
-$ wget http://gogost.cypherpunks.ru/gogost-4.1.0.tar.xz.sig
-$ gpg --verify gogost-4.1.0.tar.xz.sig gogost-4.1.0.tar.xz
-$ xz -d < gogost-4.1.0.tar.xz | tar xf -
-$ make -C gogost-4.1.0 all bench
-$ echo hello world | ./gogost-4.1.0/streebog256
+@example
+$ [fetch|wget] http://gogost.cypherpunks.ru/gogost-@value{VERSION}.tar.xz
+$ [fetch|wget] http://gogost.cypherpunks.ru/gogost-@value{VERSION}.tar.xz.sig
+$ gpg --verify gogost-@value{VERSION}.tar.xz.sig gogost-@value{VERSION}.tar.xz
+$ xz -d < gogost-@value{VERSION}.tar.xz | tar xf -
+$ make -C gogost-@value{VERSION} all bench
+$ echo hello world | gogost-@value{VERSION}/streebog256
 f72018189a5cfb803dbe1f2149cf554c40093d8e7f81c21e08ac5bcd09d9934d
-@end verbatim
+@end example
 
 And then you can include its source code in your project for example
 like this:
 
-@verbatim
+@example
 $ mkdir -p myproj/src
-$ cp -r gogost-4.1.0/src/go.cypherpunks.ru myproj/src
+$ cp -r gogost-@value{VERSION}/src/go.cypherpunks.ru myproj/src
 $ export GOPATH=$PWD/myproj
 $ cd myproj/src
 $ cat > main.go <<EOF
@@ -32,25 +32,29 @@ import (
     "go.cypherpunks.ru/gogost/v4/gost34112012256"
 )
 
-func main() {
+func main() @{
     h := gost34112012256.New()
-    h.Write([]byte("hello world"))
+    h.Write([]byte("hello world\n"))
     fmt.Println(hex.EncodeToString(h.Sum(nil)))
-}
+@}
 EOF
 $ go run main.go
-c600fd9dd049cf8abd2f5b32e840d2cb0e41ea44de1c155dcd88dc84fe58a855
-@end verbatim
-
-GoGOST is also @command{go get}-able. For example to use
-@command{streebog256} utility:
-@verbatim
-$ go get go.cypherpunks.ru/gogost/cmd/streebog256
-@end verbatim
+f72018189a5cfb803dbe1f2149cf554c40093d8e7f81c21e08ac5bcd09d9934d
+@end example
 
 @multitable {XXXXX} {XXXX-XX-XX} {XXXX KiB} {link sign} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx}
 @headitem Version @tab Date @tab Size @tab Tarball @tab SHA256 checksum @tab Streebog-256 checksum
 
+@item @ref{Release 4.2.0, 4.2.0} @tab 2019-10-18 @tab 57 KiB
+@tab @url{gogost-4.2.0.tar.xz, link} @url{gogost-4.2.0.tar.xz.sig, sign}
+@tab @code{07B44D64 E99924D2 612F9161 037EAFCE 191911B3 B2A9748F 6D340BB7 FBF8EF5A}
+@tab @code{6fc059688e4cf121c3af4a5b3bbb13661478c5df91de5f6f2da89f64486d5977}
+
+@item @ref{Release 4.1.0, 4.1.0} @tab 2019-10-03 @tab 55 KiB
+@tab @url{gogost-4.1.0.tar.xz, link} @url{gogost-4.1.0.tar.xz.sig, sign}
+@tab @code{F2FEF2E0 ADEB5742 FA2B3338 64E8B91B 3CCAA97D 5BA62177 21E08A11 F1FA8133}
+@tab @code{72e0d52aa25158ab1bb45e5498ce703b516c616b71101b74d5ee259f516c4e91}
+
 @item @ref{Release 4.0, 4.0} @tab 2019-08-12 @tab 56 KiB
 @tab @url{gogost-4.0.tar.xz, link} @url{gogost-4.0.tar.xz.sig, sign}
 @tab @code{4899B930 2110C9A9 592821D6 B206146F 2A66FC5A 3DEE9D6E 11F5EA51 72FEE6E6}
@@ -80,7 +84,7 @@ $ go get go.cypherpunks.ru/gogost/cmd/streebog256
 
 You @strong{have to} verify downloaded tarballs integrity and
 authenticity to be sure that you retrieved trusted and untampered
-software. @url{https://www.gnupg.org/, The GNU Privacy Guard} is used
+software. @url{https://www.gnupg.org/, GNU Privacy Guard} is used
 for that purpose.
 
 For the very first time it is necessary to get signing public key and
@@ -98,16 +102,37 @@ uid   GoGOST releases <gogost at cypherpunks dot ru>
 @item @url{https://lists.cypherpunks.ru/mailman/listinfo/gost, gost} maillist
 
 @item
-@verbatim
+@example
 $ gpg --auto-key-locate dane --locate-keys gogost at cypherpunks dot ru
 $ gpg --auto-key-locate wkd --locate-keys gogost at cypherpunks dot ru
-@end verbatim
+@end example
 
 @item
 @verbatiminclude PUBKEY.asc
 
 @end itemize
 
-You can obtain development source code by cloning
-@url{http://git-scm.com/, Git}
-@url{https://git.cypherpunks.ru/cgit.cgi/gogost.git/}.
+GoGOST is also @command{go get}-able. For example to use
+@command{streebog256} utility:
+
+@example
+$ go get go.cypherpunks.ru/gogost/cmd/streebog256
+@end example
+
+@code{go.cypherpunks.ru} uses @url{https://www.cacert.org/, CACert.org}
+certificate authority, that is not included by default in some operating
+system distributions and probably you have to install it in your system,
+because @command{go get} uses HTTPS connections. If you have issues
+using either @code{sum.golang.org} or @code{proxy.golang.org}, then you
+can disable their usage with @env{GOPRIVATE=go.cypherpunks.ru/gogost}
+environment variable.
+
+Also you can use @code{replace} feature inside your @file{go.mod}, like:
+
+@example
+require go.cypherpunks.ru/gogost/v4 v@value{VERSION}
+replace go.cypherpunks.ru/gogost/v4 => /home/stargrave/gogost-@value{VERSION}/src/go.cypherpunks.ru/gogost/v4
+@end example
+
+You can obtain development source code with
+@command{git clone git://git.cypherpunks.ru/gogost.git}.