Unify @ref and @command usage

[nncp.git] / doc / admin.texi

diff --git a/doc/admin.texi b/doc/admin.texi
index 11c26ecd570b8c42dd0fdd5855eab68c3603bebc..47e0e3e1c0a9ac8812bb805e92660657bef0b5b3 100644 (file)
--- a/doc/admin.texi
+++ b/doc/admin.texi
@@ -1,4 +1,5 @@
 @node Administration
+@cindex administration
 @unnumbered Administration
 
 NNCP uses following files/directories you should be aware of:
@@ -22,13 +23,16 @@ NNCP uses following files/directories you should be aware of:
 
     It can contain @file{.nock} files: fully downloaded, but still not
     checksummed. Can be checksummed (with @file{.nock} extension removing)
-    with @command{nncp-check -nock}.
+    with @command{@ref{nncp-check} -nock}.
 
     Also it can contain @file{seen/} and @file{hdr/} subdirectories,
     that should be cleaned too from time to time.
 
-    All of that cleaning tasks can be done with @ref{nncp-rm} utility.
+    All of that cleaning tasks can be done with @command{@ref{nncp-rm}} utility.
 
+    @cindex shared spool
+    @cindex setgid
+    @pindex umask
     @anchor{Shared spool}
     If you want to share single spool directory with multiple grouped
     Unix users, then you can @command{setgid} it and assure that umask
@@ -47,6 +51,7 @@ $ echo 'umask: "007"' >> /usr/local/etc/nncp.hjson
     @ref{Log} file, for example @file{/var/spool/nncp/log}. It should be
     rotated. Choose you own preferable way to do it.
 
+    @pindex newsyslog
     Example @url{https://www.newsyslog.org/manual.html, newsyslog}'s entry:
 @example
 /var/spool/nncp/log            644     7       100     *       BCYN
@@ -54,17 +59,21 @@ $ echo 'umask: "007"' >> /usr/local/etc/nncp.hjson
 
 @item
     Optional @ref{CfgIncoming, incoming} directories where uploaded
-    files are stored. Probably you want to run @ref{nncp-reass} from
-    time to time to reassemble all chunked uploads. Example crontab
+    files are stored. Probably you want to run @command{@ref{nncp-reass}}
+    from time to time to reassemble all chunked uploads. Example crontab
     entry:
 
 @example
 */1    *       *       *       *       nncp-reass -all -noprogress
 @end example
 
+@pindex daemontools
+@pindex supervise
+@pindex multilog
 @item
-    Possibly long running @ref{nncp-daemon}, @ref{nncp-caller},
-    @ref{nncp-toss}, @ref{nncp-check} daemons. As all software, they can
+    Possibly long running @command{@ref{nncp-daemon}},
+    @command{@ref{nncp-caller}}, @command{@ref{nncp-toss}},
+    @command{@ref{nncp-check}} daemons. As all software, they can
     fail and you should place them under some supervisor control.
 
     For example you can use @url{http://cr.yp.to/daemontools.html,
@@ -90,14 +99,17 @@ EOF
 # mv /var/service/.nncp-toss /var/service/nncp-toss
 @end example
 
+@pindex inetd
 @item
-    @ref{nncp-daemon} can also be run as
+    @command{@ref{nncp-daemon}} can also be run as
     @url{https://en.wikipedia.org/wiki/Inetd, inetd} service on UUCP's port:
 
 @example
 uucp   stream  tcp6    nowait  nncpuser        /usr/local/bin/nncp-daemon      nncp-daemon -quiet -ucspi
 @end example
 
+@cindex UCSPI
+@pindex tcpserver
 @item
     Or it can be also run as a @command{daemontools} daemon under
     @url{http://cr.yp.to/ucspi-tcp.html, UCSPI-TCP}. In the example