cSvn CGI Script

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

115 Commits   0 Branches   5 Tags   |
Index: doc/csvnrc.5.md
===================================================================
--- doc/csvnrc.5.md	(revision 62)
+++ doc/csvnrc.5.md	(revision 63)
@@ -75,245 +75,271 @@
 
 There is a set of variable names used by **cSvn** CGI Script.
 
-> **svn-utc-offset**
->> The integer or string value of UTC offset on the SVN server where repositories are published.
->> For example:
 
->> ```dts
->> svn-utc-offset = +0300; /* Europe/Moscow time zone */
->> ```
+#### svn-utc-offset
 
+The integer or string value of UTC offset on the SVN server where repositories are published.
+For example:
 
-> **checkout-prefix-readonly**
->> The checkout prefix for readonly access to the repository. The value of this variable should
->> has **path** type without leadinfg dir-separator. Example declaration:
+```dts
+svn-utc-offset = +0300; /* Europe/Moscow time zone */
+```
 
->> ```dts
->> checkout-prefix-readonly = 'svn://example.com';
->> checkout-prefix-readonly = 'https://svn.example.com/svn';
->> ```
 
->> Please note that **svn** protocol works match quickly.
+#### checkout-prefix-readonly
 
+The checkout prefix for readonly access to the repository. The value of this variable should
+has **path** type without leadinfg dir-separator. Example declaration:
 
-> **checkout-prefix**
->> The checkout prefix for readwrite access to the repository. The value of this variable should
->> has **path** type without leadinfg dir-separator. Example declaration:
+```dts
+checkout-prefix-readonly = 'svn://example.com';
+checkout-prefix-readonly = 'https://svn.example.com/svn';
+```
 
->> ```dts
->> checkout-prefix = 'svn+ssh://svn@example.com';
->> ```
+Please note that **svn** protocol works match quickly.
 
->> This means the access on behalf **svn** system user.
 
+#### checkout-prefix
 
-> **branches**
->> The name of directory where branches is places. Default value is *'branches'*.
+The checkout prefix for readwrite access to the repository. The value of this variable should
+has **path** type without leadinfg dir-separator. Example declaration:
 
-> **trunk**
->> The name of the *trunk* directory. Default value is *'trunks'*.
+```dts
+checkout-prefix = 'svn+ssh://svn@example.com';
+```
 
-> **tags**
->> The name of directory where tags are saved. Default value is *'tags'*.
->> Example declarations of directory names:
+This means the access on behalf **svn** system user.
 
->> ```dts
->> branches = 'branches';
->> trunk    = 'trunk';
->> tags     = 'tags';
->> ```
 
+#### branches
 
-> **snapshots**
->> The extension of snapshot tarballs. Default value: *'tar.xz'*. Example declaration:
+The name of directory where branches is places. Default value is *'branches'*.
 
->> ```dts
->> snapshots = 'tar.xz';
->> ```
+#### trunk
 
->> Currently snapshot variable is not used by **cSvn** CGI Script.
+The name of the *trunk* directory. Default value is *'trunks'*.
 
+#### tags
 
-> **css**
->> The full name of the CSS style sheet relative to the directory where cSvn CGI Sctipt is installed.
->> Example declaration:
+The name of directory where tags are saved. Default value is *'tags'*.
+Example declarations of directory names:
 
->> ```dts
->> css = '/.csvn/css/csvn.css';
->> ```
+```dts
+branches = 'branches';
+trunk    = 'trunk';
+tags     = 'tags';
+```
 
 
-> **logo**
->> Url which specifies the source of an image which will be used as a logo (i.e right banner)
->> on **cSvn** pages. Default value: *'/.csvn/pixmaps/csvn-banner-280x280.png'*. The path to the
->> **logo** also should be set relative to the directory where **cSvn** CGI Script is installed.
->> Example declaration:
+#### snapshots
 
->> ```dts
->> logo = '/.csvn/pixmaps/csvn-banner-280x280.png';
->> ```
+The extension of snapshot tarballs. Default value: *'tar.xz'*. Example declaration:
 
+```dts
+snapshots = 'tar.xz';
+```
 
-> **logo-alt**
->> The string used in HTML as a 'alt' property of the right banner <img> tag.
->> Default value: *"Example.org"*. Example declaration:
+Currently snapshot variable is not used by **cSvn** CGI Script.
 
->> ```dts
->> logo-alt = "Example.org";
->> ```
 
+#### css
 
-> **logo-link**
->> The string used in HTML as a 'href' property of the right banner image link <a> tag.
->> Default value: *"https://example.org"*. Example declaration:
+The full name of the CSS style sheet relative to the directory where cSvn CGI Sctipt is installed.
+Example declaration:
 
->> ```dts
->> logo-link = "https://example.org";
->> ```
+```dts
+css = '/.csvn/css/csvn.css';
+```
 
 
-> **main-menu-logo**
->> Url which specifies the source of an image which will be used as a logo of the main menu item
->> on **cSvn** pages. Default value: *'/.csvn/pixmaps/logo/SVN-logo-white-744x744.svg'*. The path
->> to the *main-menu-logo* also should be set relative to the directory where **cSvn** CGI Script
->> is installed. Example declaration:
+#### logo
 
->> ```dts
->> main-menu-logo = '/.csvn/pixmaps/logo/SVN-logo-white-744x744.svg';
->> ```
+Url which specifies the source of an image which will be used as a logo (i.e right banner)
+on **cSvn** pages. Default value: *'/.csvn/pixmaps/csvn-banner-280x280.png'*. The path to the
+**logo** also should be set relative to the directory where **cSvn** CGI Script is installed.
+Example declaration:
 
+```dts
+logo = '/.csvn/pixmaps/csvn-banner-280x280.png';
+```
 
-> **favicon-path**
->> The directory name of the *favicon.ico* file without leadind dir-separator.
->> Default value: *'/.csvn/pixmaps/favicon'*. Example declaration:
 
->> ```dts
->> favicon-path = '/.csvn/pixmaps/favicon';
->> ```
+#### logo-alt
 
->> This directory name used for finding additional images declared in the HTML **header** of all
->> **cSvn** pages.
+The string used in HTML as a 'alt' property of the right banner <img> tag.
+Default value: *"Example.org"*. Example declaration:
 
+```dts
+logo-alt = "Example.org";
+```
 
-> **syntax-highlight-css**
->> The base name of the CSS style sheet file used for syntax highlighting.
->> Default value: *'_csvn.css'*. Example declaration:
 
->> ```dts
->> syntax-highlight-css = '_csvn.css';
->> ```
+#### logo-link
 
->> **cSvn** CGI Script uses [highlight.js](https://highlightjs.org/) installed into
->> `/.csvn/.engines/highlight/${hljs-version}/{css,js}` directories where the default
->> *_csvn.css* file is palced too.
+The string used in HTML as a 'href' property of the right banner image link <a> tag.
+Default value: *"https://example.org"*. Example declaration:
 
+```dts
+logo-link = "https://example.org";
+```
 
-> **header**
->> The content of the file specified with this option will be included verbatim at the top of all pages.
->> Default value: *'/.csvn/html/header.html'*.
 
-> **footer**
->> The content of the file specified with this option will be included verbatim at the bottom of all pages.
->> Default value: *'/.csvn/html/footer.html'*. Examle of the **header** and the **footer** declarations:
+#### main-menu-logo
 
->> ```dts
->> header = '/.csvn/html/header.html';
->> footer = '/.csvn/html/footer.html';
->> ```
+Url which specifies the source of an image which will be used as a logo of the main menu item
+on **cSvn** pages. Default value: *'/.csvn/pixmaps/logo/SVN-logo-white-744x744.svg'*. The path
+to the *main-menu-logo* also should be set relative to the directory where **cSvn** CGI Script
+is installed. Example declaration:
 
->> The **header** and the **footer** files used as template where **cSvn** CGI Script substitute
->> placeholders such as `${variable-name}` by their values. For example the `${css}` placeholder
->> will be replaced by the value of **css** variable declared in the **/etc/csvnrc** config file.
+```dts
+main-menu-logo = '/.csvn/pixmaps/logo/SVN-logo-white-744x744.svg';
+```
 
 
-> **page-size**
->> The **string** or **int** variable which set the length of the repositories list or logs that shown
->> in one page by the **cSvn** CGI Script. Default value: 200. Example declaration:
+#### favicon-path
 
->> ```dts
->> page-size = 50; /* 10 ... 200 may be string or integer. Default value is page-size = 200 */
->> ```
+The directory name of the *favicon.ico* file without leadind dir-separator.
+Default value: *'/.csvn/pixmaps/favicon'*. Example declaration:
 
-> **owner**
->> The *string** variable used in the HTML header of all **cSvn** pages and also in the *Owner* colon
->> of the repository list. Default value: *"Andrey V.Kosteltsev"*.
+```dts
+favicon-path = '/.csvn/pixmaps/favicon';
+```
 
-> **author**
->> The **string** variable used in the HTML header of all cSvn pages. Default value: *"Andrey V.Kosteltsev"*.
->> Example declarations of the **owner** and the **author** variables:
+This directory name used for finding additional images declared in the HTML **header** of all
+**cSvn** pages.
 
->> ```dts
->> owner  = "John Smith";
->> author = "John Smith";
->> ```
 
+#### syntax-highlight-css
 
-> **title**
->> The **string** variable used in the HTML header of all **cSvn** pages as a page title.
->> Default value: *"SVN Repositories"*. Example declaration:
+The base name of the CSS style sheet file used for syntax highlighting.
+Default value: *'_csvn.css'*. Example declaration:
 
->> ```dts
->> title  = "Example.org SVN Repositories";
->> ```
+```dts
+syntax-highlight-css = '_csvn.css';
+```
 
+**cSvn** CGI Script uses [highlight.js](https://highlightjs.org/) installed into
+`/.csvn/.engines/highlight/${hljs-version}/{css,js}` directories where the default
+*_csvn.css* file is palced too.
 
-> **description**
->> The **string** variable used in the HTML header of all **cSvn** pages as a page description.
->> Default value: *"Subversion repositories hosted at Solar System, Earth"*.
->> Example declaration:
 
->> ```dts
->> description  = "Subversion repositories hosted at example.org (St.-Petersburg)";
->> ```
+#### header
 
->> For a long description the value of this **string** variable can be splitted in the C-style
->> by following way:
+The content of the file specified with this option will be included verbatim at the top of all pages.
+Default value: *'/.csvn/html/header.html'*.
 
->> ```dts
->> description  = "Subversion repositories"
->>                " hosted at example.org "
->>                "(St.-Petersburg)";
->> ```
+#### footer
 
+The content of the file specified with this option will be included verbatim at the bottom of all pages.
+Default value: *'/.csvn/html/footer.html'*. Examle of the **header** and the **footer** declarations:
 
-> **keywords**
->> The **string** variable contains space separated keywords used in the HTML header of all **cSvn**
->> pages as a page keywords. Default value: *"cSvn repositories"*. Example declaration:
+```dts
+header = '/.csvn/html/header.html';
+footer = '/.csvn/html/footer.html';
+```
 
->> ```dts
->> keywords = "cSvn CGI Subversion Repositories scm SVN";
->> ```
+The **header** and the **footer** files used as template where **cSvn** CGI Script substitute
+placeholders such as `${variable-name}` by their values. For example the `${css}` placeholder
+will be replaced by the value of **css** variable declared in the **/etc/csvnrc** config file.
 
 
-> **copyright-notice**
->> The **string** variable used in the HTML footer of all **cSvn** pages as a *Copyright Notice*.
->> Default value: *"By using any website materials you agree to indicate source."*.
->> Example declaration:
+#### page-size
 
->> ```dts
->> copyright-notice = "By using any materials you agree with ...";
->> ```
+The **string** or **int** variable which set the length of the repositories list or logs that shown
+in one page by the **cSvn** CGI Script. Default value: 200. Example declaration:
 
+```dts
+page-size = 50; /* 10 ... 200 may be string or integer. Default value is page-size = 200 */
+```
 
-> **copyright**
->> The **string** variable used in the HTML footer of all **cSvn** pages as a *Copyright*.
->> Default value: *"© 2020 Andrey V.Kosteltsev. All Rights Reserved."*.
->> Example declaration:
+#### owner
 
->> ```dts
->> copyright = "© John Smith (explorer), 1580 - 1631.";
->> ```
+The **string** variable used in the HTML header of all **cSvn** pages and also in the *Owner* colon
+of the repository list. Default value: *"Andrey V.Kosteltsev"*.
 
+#### author
 
-> **home-page**
->> The URL of the home page of the project. Default value: *"https://example.org"*.
->> Example declaration:
+The **string** variable used in the HTML header of all cSvn pages. Default value: *"Andrey V.Kosteltsev"*.
+Example declarations of the **owner** and the **author** variables:
 
->> ```dts
->> home-page = "https://main-site-of-the-project.org";
->> ```
+```dts
+owner  = "John Smith";
+author = "John Smith";
+```
 
 
+#### title
+
+The **string** variable used in the HTML header of all **cSvn** pages as a page title.
+Default value: *"SVN Repositories"*. Example declaration:
+
+```dts
+title  = "Example.org SVN Repositories";
+```
+
+
+#### description
+
+The **string** variable used in the HTML header of all **cSvn** pages as a page description.
+Default value: *"Subversion repositories hosted at Solar System, Earth"*.
+Example declaration:
+
+```dts
+description  = "Subversion repositories hosted at example.org (St.-Petersburg)";
+```
+
+For a long description the value of this **string** variable can be splitted in the C-style
+by following way:
+
+```dts
+description  = "Subversion repositories"
+               " hosted at example.org "
+               "(St.-Petersburg)";
+```
+
+
+#### keywords
+
+The **string** variable contains space separated keywords used in the HTML header of all **cSvn**
+pages as a page keywords. Default value: *"cSvn repositories"*. Example declaration:
+
+```dts
+keywords = "cSvn CGI Subversion Repositories scm SVN";
+```
+
+
+#### copyright-notice
+
+The **string** variable used in the HTML footer of all **cSvn** pages as a *Copyright Notice*.
+Default value: *"By using any website materials you agree to indicate source."*.
+Example declaration:
+
+```dts
+copyright-notice = "By using any materials you agree with ...";
+```
+
+
+#### copyright
+
+The **string** variable used in the HTML footer of all **cSvn** pages as a *Copyright*.
+Default value: *"© 2020 Andrey V.Kosteltsev. All Rights Reserved."*.
+Example declaration:
+
+```dts
+copyright = "© John Smith (explorer), 1580 - 1631.";
+```
+
+
+#### home-page
+
+The URL of the home page of the project. Default value: *"https://example.org"*.
+Example declaration:
+
+```dts
+home-page = "https://main-site-of-the-project.org";
+```
+
+
 ### Repository Declaration
 
 The **/etc/csvnrc** config file should contains at least one repository declaration to be shown