]> Cypherpunks.ru repositories - nncp.git/blobdiff - doc/cfg/index.texi
Unify @ref and @command usage
[nncp.git] / doc / cfg / index.texi
index b1261a894ddd7dc8424785001e7869e67d735976..1fbca4945efb285b62deb7b56bde58d17eb6d3b9 100644 (file)
@@ -1,9 +1,11 @@
 @node Configuration
+@cindex configuration file
 @unnumbered Configuration file
 
+@cindex Hjson
 NNCP uses single file configuration file in @url{https://hjson.org/,
 Hjson} format (see also section about @ref{Configuration directory,
-directory layout}) . Initially it is created with @ref{nncp-cfgnew}
+directory layout}) . Initially it is created with @command{@ref{nncp-cfgnew}}
 command and at minimum it can look like this:
 
 @verbatim
@@ -30,6 +32,10 @@ neigh: {
 }
 @end verbatim
 
+@cindex JSON
+@pindex hjson-cli
+@pindex gojq
+@pindex gjo
 Do not forget that Hjson can be safely converted to JSON and vice versa
 (loosing formatting and comments of course). By default
 @command{hjson-cli} utility from @code{github.com/hjson/hjson-go} is
@@ -44,11 +50,11 @@ need to add single key to the @code{neigh} section similar to the "self".
 Whole configuration file can be separated on five sections:
 
 @menu
-* General options: CfgGeneral.
-* Self-node keypairs: CfgSelf.
-* Notifications: CfgNotify.
-* Neighbours: CfgNeigh.
-* Areas: CfgAreas.
+* General options: CfgGeneral
+* Self-node keypairs: CfgSelf
+* Notifications: CfgNotify
+* Neighbours: CfgNeigh
+* Areas: CfgAreas
 
 You can optionally convert it to directory layout
 * Configuration directory::