cSvn CGI Script

cSvn CGI Script – is a web frontend for Subversion™ Repositories

115 Commits   0 Branches   5 Tags   |
Index: README.md
===================================================================
--- README.md	(revision 30)
+++ README.md	(revision 31)
@@ -151,7 +151,7 @@
 
 If you configured access to your repositories on behalf system user named **svn**, then it would
 be good to grant permissions to **svn** user to acces to the directory */var/lib/csvn/* which is
-a home of **csvnd** daemon:
+a home of [**csvnd(8)**](https://csvn.radix.pro/csvn/trunk/doc/csvnd.8.md) daemon:
 
 ```Bash
   $ chown -R svn:svn /var/lib/csvn
@@ -396,7 +396,8 @@
 
 ## Configuring SVN Repositories
 
-A detailed description of the configuration file format can be found in the **csvnrc(5)** manual page:
+A detailed description of the configuration file format can be found in the
+[**csvnrc(5)**](https://csvn.radix.pro/csvn/trunk/doc/csvnrc.5.md) manual page:
 
 ```Bash
 $ man 5 csvnrc
Index: doc/csvnd.8.md
===================================================================
--- doc/csvnd.8.md	(nonexistent)
+++ doc/csvnd.8.md	(revision 31)
@@ -0,0 +1,83 @@
+
+# [cSvn Daemon](https://csvn.radix.pro/csvn/trunk/doc/csvnd.8.md)
+
+## Table of Contents
+
+* [Options](#options)
+* [Grammar](#grammar)
+* [See Also](#see-also)
+
+In order to not load the CGI script with unnecessary functionality and speed up its work,
+information about the list of repositories is transmitted to it in binary form through
+shared memory (see: */dev/shm/csvn.bcf*).
+
+Binary Config File (**BCF**) format is similar to the simplified implementation of the **COFF**
+and is described in the header file [*/usr/include/csvn/bcf.h*](https://csvn.radix.pro/csvn/trunk/csvn/bcf.h).
+
+On startup, the daemon parses the */etc/csvnrc* configuration file and stores its binary form
+in shared memory. In addition, the binary form is saved in the daemon's home directory,
+by default it is the file */var/lib/csvn/csvn.bcf*.
+
+**csvnd(8)** daemon rereads the [**csvnrc(5)**](https://csvn.radix.pro/csvn/trunk/doc/csvnrc.8.md)
+configuration file upon arrival of the **-HUP** signal and, in addition, can be configured to monitor
+changes in the configuration file using the `--inotify` option. If the `--inotify` option is specified,
+then after editing the file */ets/csvnrc* and saving it to disk, the **csvnd** daemon will reread
+*/etc/csvnrc* file as if it received the **-HUP** signal.
+
+The work of the **csvnd(8)** daemon's can be monitored by the log, which it leaves in the
+*/var/log/csvnd.log* file. There you can also observe messages about errors that are detected
+in */ets/csvnrc* file, if any.
+
+To start the daemon during system boot, can be used the start/stop script */etc/rc.d/rc.csvnd*.
+
+
+## Options
+
+> **-h,--help**
+>> Display help information.
+
+> **-v,--version**
+>> Display the version of **cSvn** daemon.
+
+> **-d,--daemonize**
+>> Run in background as a daemon.
+
+> **-i,--inotify**
+>> Notify about configuration changes. If this option is set then **csvnd(8)** daemon selects changes
+>> made in */etc/csvnrc* config file and reread configuration when changes is done. Without this option
+>> rereading configuration file can be done by sending **-HUP** to the **csvnd(8)** process.
+
+> **-b,--bcf=<BCF_FILE>**
+>> Binary config file. Default: */var/lib/csvn/csvn.bcf*.
+
+> **-c,--config=<CONFIG_FILE>**
+>> Config file. Default: */etc/csvnrc*.
+
+> **-l,--log=<LOG_FILE>**
+>> Log file. Default: */var/log/csvnd.log*.
+
+> **-p,--pid=<PID_FILE>**
+>> Log file. Default: */var/run/csvnd.pid*.
+
+> **-t,--test**
+>> Test the config file and exit.
+
+
+## Grammar
+
+The grammar of the language describing the cSvn songfiguration is simple
+[parse.y](https://https://csvn.radix.pro/csvn/trunk/csvnd/parse.y). File */etc/csvnrc*
+allows you to set variable values and create repository lists as named structures.
+
+Any variables can be defined in the */etc/csvnrc* file, but only variables with
+reserved names will be used by the **cSvn** CGI script.
+
+In addition, if a variable already defined at the global level is specified in the
+description of a repository, then within this repository this variable will have a local
+value. In other words, within the repository, global variables can be overridden.
+
+
+## See Also
+
+> [**csvnrc(5)**](https://csvn.radix.pro/csvn/trunk/doc/csvnrc.8.md)
+
Index: doc/csvnrc.5.md
===================================================================
--- doc/csvnrc.5.md	(nonexistent)
+++ doc/csvnrc.5.md	(revision 31)
@@ -0,0 +1,3 @@
+
+# [csvnrc(5)](https://csvn.radix.pro/csvn/trunk/doc/csvnrc.5.md)
+