summaryrefslogtreecommitdiff
path: root/source/directories.rst
diff options
context:
space:
mode:
authorJan Dittberner <jandd@cacert.org>2018-11-09 18:38:45 +0100
committerJan Dittberner <jandd@cacert.org>2018-11-09 18:38:45 +0100
commit2b6e2746c514e786ac4dcfe201f7d2a5464dba89 (patch)
treedb636b2e198579729eb4148869bf967bab122150 /source/directories.rst
parentc45018910c57d0993c04f36dde7b28084765251a (diff)
downloadcacert-codedocs-2b6e2746c514e786ac4dcfe201f7d2a5464dba89.tar.gz
cacert-codedocs-2b6e2746c514e786ac4dcfe201f7d2a5464dba89.tar.xz
cacert-codedocs-2b6e2746c514e786ac4dcfe201f7d2a5464dba89.zip
Use new directives and link relations
Diffstat (limited to 'source/directories.rst')
-rw-r--r--source/directories.rst603
1 files changed, 227 insertions, 376 deletions
diff --git a/source/directories.rst b/source/directories.rst
index b5c46f0..df84658 100644
--- a/source/directories.rst
+++ b/source/directories.rst
@@ -14,6 +14,17 @@ The root directory contains
.. _GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Documentation for subdirectories
+ :name: directorytoc
+
+ DIR-pages
+ DIR-scripts
+ DIR-www
+
+
.. index:: cgi-bin
Directory :file:`cgi-bin`
@@ -23,14 +34,16 @@ The `cgi-bin` directory contains
.. index:: PHP
-.. _cgi-bin-siteseal-cgi:
+.. sourcefile:: cgi-bin/siteseal.cgi
+ :links:
+ www/sealgen.php
-- :file:`siteseal.cgi` a PHP CGI script that generates some JavaScript code
- to invoke :ref:`sealgen.php <www-sealgen-php>`. The configuration on
- www.cacert.org does not seem to support this script
- https://www.cacert.org/cgi-bin/siteseal.cgi returns a 403 response.
+ a PHP CGI script that generates some JavaScript code to invoke
+ :sourcefile:`sealgen.php <www/sealgen.php>`. The configuration on
+ www.cacert.org does not seem to support this script
+ https://www.cacert.org/cgi-bin/siteseal.cgi returns a 403 response.
-.. todo: check whether this is linked anywhere or can be removed
+ .. todo: check whether this is linked anywhere or can be removed
.. index:: commModule
.. index:: Perl
@@ -41,290 +54,267 @@ Directory :file:`CommModule`
This directory contains the CommModule that is implemented in Perl:
-.. _commmodule-client-pl:
-
-- :file:`client.pl` the :doc:`signer protocol <signer>` client, running
- on the webserver and talking to the server via a serial link.
-
- The style of the Perl code seems a bit inconsistent (mix of uppercase and
- lowercase function names, usage of brackets). The code uses database polling
- in a loop. It might be a better idea to use some kind of queueing (Redis,
- AMQP, ...) to not waste resources when there is nothing to do). Function
- parameters are not named which makes the code hard to read.
-
- The script calls several system binaries that need to be present in
- compatible versions:
-
- - :program:`openssl`
- - :program:`xdelta`
-
- The script uses several Perl standard library modules as well as the
- following third party modules:
-
- .. index:: Perl, thirdparty
-
- - `DBD::mysql <https://metacpan.org/pod/DBD::mysql>`_
- - `DBI <https://metacpan.org/pod/DBI>`_
- - `Device::SerialPort <https://metacpan.org/pod/Device::SerialPort>`_
- - `File::CounterFile <https://metacpan.org/pod/File::CounterFile>`_
-
- The script references several openssl configuration files in the HandleCerts
- function that are not included in the code repository. There are some
- openssl configuration files with similar names in
- https://svn.cacert.org/CAcert/SystemAdministration/signer/
+.. sourcefile:: CommModule/client.pl
+ :uses:
+ includes/mysql.php
- The database password is parsed from
- :ref:`includes/mysql.php <includes-mysql-php>` and relies on the
- exact code that is defined there. Database name, user and host are hardcoded
- in the DBI->connect call.
+ :file:`client.pl` implements the :doc:`signer protocol <signer>` client,
+ running on the webserver and talking to the server via a serial link.
- The script implements the client side of the signer protocol which is
- specified in :doc:`signer`.
+ The style of the Perl code seems a bit inconsistent (mix of uppercase and
+ lowercase function names, usage of brackets). The code uses database polling
+ in a loop. It might be a better idea to use some kind of queueing (Redis,
+ AMQP, ...) to not waste resources when there is nothing to do). Function
+ parameters are not named which makes the code hard to read.
- The script performs the following operations:
+ The script calls several system binaries that need to be present in
+ compatible versions:
- - parse password from :file:`includes/mysql.php`
- - read a list of CRL files and logs their SHA-1 hashes
- - read :file:`serial.conf`, create a Device::SerialPort instance `$portObj`,
- sets serial parameters and saves :file:`serial.conf`
- - run a main loop as long as a file :file:`./client.pl-active` is present.
- The main loop performs the following tasks
+ - :program:`openssl`
+ - :program:`xdelta`
- - handle pending OpenPGP key signing request via ``HandleGPG()``
- - handle pending certificate signing requests:
+ The script uses several Perl standard library modules as well as the
+ following third party modules:
- - personal client certificates via ``HandleCerts(0, 0)``
- - personal server certificates via ``HandleCerts(0, 1)``
- - organization client certificates via ``HandleCerts(1, 0)``
- - organization server certificates via ``HandleCerts(1, 1)``
+ .. index:: Perl, thirdparty
- - handle pending certificate revocation requests
+ - `DBD::mysql <https://metacpan.org/pod/DBD::mysql>`_
+ - `DBI <https://metacpan.org/pod/DBI>`_
+ - `Device::SerialPort <https://metacpan.org/pod/Device::SerialPort>`_
+ - `File::CounterFile <https://metacpan.org/pod/File::CounterFile>`_
- - personal client certificates via ``RevokeCerts(0, 0)``
- - personal server certificates via ``RevokeCerts(0, 1)``
- - organization client certificates via ``RevokeCerts(1, 0)``
- - organization server certificates via ``RevokeCerts(1, 1)``
+ The script references several openssl configuration files in the HandleCerts
+ function that are not included in the code repository. There are some
+ openssl configuration files with similar names in
+ https://svn.cacert.org/CAcert/SystemAdministration/signer/
- - refresh :term:`CRLs <CRL>` via ``RefreshCRLs()`` in every 100st
- iteration
- - send a :ref:`NUL request <signer-nul-request-format>` to keep the signer
- connection alive
- - sleep for 2.7 seconds
+ The database password is parsed from
+ :sourcefile:`includes/mysql.php` and relies on the
+ exact code that is defined there. Database name, user and host are hardcoded
+ in the DBI->connect call.
- There is potential for optimization in the main loop. The CRL update could
- be performed if a certificate has been revoked. The NUL request needs only
- to be sent if no other request has been sent.
+ The script implements the client side of the signer protocol which is
+ specified in :doc:`signer`.
- The script uses a lot of temporary files instead of piping input and
- output to and from external commands.
+ The script performs the following operations:
- .. todo:: describe more in-depth what each of the main loop steps does
+ - parse password from :sourcefile:`includes/mysql.php`
+ - read a list of CRL files and logs their SHA-1 hashes
+ - read :file:`serial.conf`, create a Device::SerialPort instance `$portObj`,
+ sets serial parameters and saves :file:`serial.conf`
+ - run a main loop as long as a file :file:`./client.pl-active` is present.
+ The main loop performs the following tasks
-- :file:`commdaemon` a script to run :ref:`client.pl <commmodule-client-pl>`
- or :ref:`server.pl <commmodule-server-pl>`
+ - handle pending OpenPGP key signing request via ``HandleGPG()``
+ - handle pending certificate signing requests:
- This bash script is automatically restarting the :file:`{script}` given as
- the first parameter as long as a file :file:`{script}-active` exists.
- Informational messages and errors are logged to syslog via
- :command:`logger`.
+ - personal client certificates via ``HandleCerts(0, 0)``
+ - personal server certificates via ``HandleCerts(0, 1)``
+ - organization client certificates via ``HandleCerts(1, 0)``
+ - organization server certificates via ``HandleCerts(1, 1)``
- The script is most probably used to recover from crashed scripts. This
- could be implemented via :command:`supervisor` or :command:`systemd`
- instead of a custom script.
+ - handle pending certificate revocation requests
-- :file:`commmodule` a System V style init script for startup/shutdown of
- CommModule
+ - personal client certificates via ``RevokeCerts(0, 0)``
+ - personal server certificates via ``RevokeCerts(0, 1)``
+ - organization client certificates via ``RevokeCerts(1, 0)``
+ - organization server certificates via ``RevokeCerts(1, 1)``
- On test.cacert.org two slightly different versions are deployed in
- :file:`/etc/init.d` the first version starts
- :ref:`client.pl <commmodule-client-pl>` in
- :file:`/home/cacert/www/CommModule/` and the
- second variant starts :ref:`server.pl <commmodule-server-pl>` in
- :file:`/home/signer/cacert-devel/CommModule/`.
+ - refresh :term:`CRLs <CRL>` via ``RefreshCRLs()`` in every 100st
+ iteration
+ - send a :ref:`NUL request <signer-nul-request-format>` to keep the signer
+ connection alive
+ - sleep for 2.7 seconds
-- :file:`logclean.sh` maintenance script for logfiles generated by CommModule
+ The script uses a lot of temporary files instead of piping input and
+ output to and from external commands.
- The :file:`logclean.sh` script performs log rotation of signer logfiles.
+ .. todo:: describe more in-depth what each of the main loop steps does
- .. todo::
+.. sourcefile:: CommModule/commdaemon
- discuss replacement of this script with :command:`logrotate` and a
- custom logrotate.conf for the signer
+ :file:`commdaemon` is a script to run
+ :sourcefile:`client.pl <CommModule/client.pl>`
+ or :sourcefile:`server.pl <CommModule/server.pl>`.
-- :file:`serial.conf` serial port configuration file
+ This bash script is automatically restarting the :file:`{script}` given as
+ the first parameter as long as a file :file:`{script}-active` exists.
+ Informational messages and errors are logged to syslog via
+ :command:`logger`.
- This file is read and written by both
- :ref:`client.pl <commmodule-client-pl>` and
- :ref:`server.pl <commmodule-server-pl>` therefore both cannot be run from
- the same directory without interfering with each other.
+ The script is most probably used to recover from crashed scripts. This
+ could be implemented via :command:`supervisor` or :command:`systemd`
+ instead of a custom script.
- .. todo::
+.. sourcefile:: CommModule/commmodule
- add a serial.conf template and move the actual serial.conf into
- configuration management
+ :file:`commodule` is a System V style init script for startup/shutdown of
+ CommModule
-.. _commmodule-server-pl:
+ On test.cacert.org two slightly different versions are deployed in
+ :file:`/etc/init.d` the first version starts
+ :sourcefile:`client.pl <CommModule/client.pl>` in
+ :file:`/home/cacert/www/CommModule/` and the
+ second variant starts :sourcefile:`server.pl <CommModule/server.pl>` in
+ :file:`/home/signer/cacert-devel/CommModule/`.
-- :file:`server.pl` the real server, running on the signing server
+.. sourcefile:: CommModule/logclean.sh
- This script implements the signer (server) side of the :doc:`signer
- protocol <signer>` and performs the actual signing operations.
+ :file:`logclean.sh` is a maintenance script for logfiles generated by
+ CommModule.
- The script contains a some code that is duplicated by
- :ref:`client.pl <commmodule-client-pl>`.
+ The :file:`logclean.sh` script performs log rotation of signer logfiles.
- .. note::
+ .. todo::
- The :file:`server.pl` used on test.cacert.org is different from the
- version in the cacert-devel repository. The git origin is recorded as
- `git://git-cacert.it-sls.de/cacert-devel.git` and there are some small
- uncommitted changes too.
+ discuss replacement of this script with :command:`logrotate` and a
+ custom logrotate.conf for the signer
- .. todo::
+.. sourcefile:: CommModule/serial.conf
- get the versions of server.pl on git.cacert.org, the real production
- signer and the cacert-devel repository synchronized
+ `serial.conf` serial port configuration file
-- :file:`usbclient.pl` obsoleted USB version of
- :ref:`client.pl <commmodule-client-pl>` above
+ This file is read and written by both
+ :sourcefile:`client.pl <CommModule/client.pl>` and
+ :sourcefile:`server.pl <CommModule/server.pl>` therefore both cannot be run
+ from the same directory without interfering with each other.
- .. todo:: remove unused file (usbclient.pl)
-
-.. index:: includes
-.. index:: PHP
-
-Directory :file:`includes`
-==============================
+ .. todo::
-.. _includes-.cvsignore:
+ add a serial.conf template and move the actual serial.conf into
+ configuration management
-.. sourcefile: includes/.cvsignore
+.. sourcefile:: CommModule/server.pl
-- :file:`.cvsignore` includes the parameters for CVS, which files to ignore by versioning
+ :file:`server.pl` is the signing server software.
-.. _includes-.directory:
+ This script implements the signer (server) side of the :doc:`signer
+ protocol <signer>` and performs the actual signing operations.
-.. sourcefile: includes/.gitignore
+ The script contains a some code that is duplicated by
+ :sourcefile:`client.pl <CommModule/client.pl>`.
-- :file:`.gitignore` includes the parameters for GIT, which files to ignore by versioning
+ .. note::
-.. _includes-about_menu.php:
+ The :file:`server.pl` used on test.cacert.org is different from the
+ version in the cacert-devel repository. The git origin is recorded as
+ `git://git-cacert.it-sls.de/cacert-devel.git` and there are some small
+ uncommitted changes too.
-.. sourcefile: includes/about_menu.php
- :links: http://blog.cacert.org/
- :links: http://wiki.CAcert.org/
- :links: www/policy/
- :links: //wiki.cacert.org/FAQ/Privileges
- :links: www/index.php?id=47
- :links: www/logos.php
- :links: www/stats.php
- :links: http://blog.CAcert.org/feed/
- :links: www/index.php?id=7
- :links: //wiki.cacert.org/Board
- :links: https://lists.cacert.org/wws
- :links: www/src-lic.php
+ .. todo::
-- :file:`about_menu.php` is a part (<div>) of a PHP-Page, containing most of the CAcert-related links.
+ get the versions of :file:`server.pl` on git.cacert.org, the real
+ production signer and the cacert-devel repository synchronized
-.. _includes-account_stuff.php:
+.. sourcefile:: CommModule/usbclient.pl
-.. sourcefile: includes/account_stuff.php
+ :file:`usbclient.pl` is an obsoleted USB version of
+ :sourcefile:`client.pl <CommModule/client.pl>` above
-- :file:`account_stuff.php`
-
-.. _includes-account.php:
-
-.. sourcefile: includes/account.php
- :uses: includes/about_menu.php
- :uses: .... showheader
-
-- :file:`account.php`
-
-.. _includes-general_stuff.php:
-
-.. sourcefile: includes/general_stuff.php
+ .. todo:: remove unused file (usbclient.pl)
+
+.. index:: includes
+.. index:: PHP
-- :file:`general_stuff.php`
+Directory :file:`includes`
+==========================
-.. _includes-general.php:
+.. sourcefile:: includes/.cvsignore
-.. sourcefile: includes/general.php
+ :file:`.cvsignore` includes the parameters for CVS, which files to ignore by
+ versioning
-- :file:`general.php`
+ .. note:: CVS is long dead, is this still used?
-.. _includes-keygen.php:
+.. sourcefile:: includes/.gitignore
-.. sourcefile: includes/keygen.php
+ :file:`.gitignore` contains file patterns to be ignored by Git.
-- :file:`keygen.php`
+.. sourcefile:: includes/about_menu.php
+ :links:
+ http://blog.cacert.org/
+ http://wiki.CAcert.org/
+ www/policy/
+ //wiki.cacert.org/FAQ/Privileges
+ www/index.php?id=47
+ www/logos.php
+ www/stats.php
+ http://blog.CAcert.org/feed/
+ www/index.php?id=7
+ //wiki.cacert.org/Board
+ https://lists.cacert.org/wws
+ www/src-lic.php
-.. _includes-loggedin.php:
+ :file:`about_menu.php` is a part (<div>) of a PHP-Page, containing most of
+ the CAcert-related links.
-.. sourcefile: includes/loggedin.php
+.. sourcefile:: includes/account_stuff.php
-- :file:`loggedin.php`
+.. sourcefile:: includes/account.php
+ :uses:
+ includes/about_menu.php
+ .... showheader
-.. _includes-mysql-php:
-.. _includes-mysql-php-sample:
+.. sourcefile:: includes/general_stuff.php
-- :file:`mysql.php.sample` is a template for the database connection handling
- code that is meant to be copied to :file:`mysql.php`.
+.. sourcefile:: includes/general.php
- The template defines the MySQL connection as a session variable `mconn` and
- tries to connect to that database. It also defines the session variables
- `normalhostname`, `securehostname` and `tverify`.
+.. sourcefile:: includes/keygen.php
- The template defines a function :php:func:`sendmail` for sending mails.
+.. sourcefile:: includes/loggedin.php
- .. php:function:: sendmail($to, $subject, $message, $from, $replyto="", \
- $toname="", $fromname="", $errorsto="returns@cacert.org", \
- $use_utf8=true)
+.. sourcefile:: includes/mysql.php
- Send an email. The function reimplements functionality that is readily
- available in PHP. The function does not properly escape headers and
- sends raw SMTP commands.
+ :file:`includes/mysql.php` is not contained in the :cacertgit:`cacert-devel`
+ repository but is used by several other files. The file is copied from
+ :sourcefile:`includes/mysql.php.sample` and defines the database connection
+ information.
- :param string $to: recipient email address
- :param string $subject: subject
- :param string $message: email body
- :param string $from: from email address
- :param string $replyto: reply-to email address
- :param string $fromname: unused in the code
- :param string $toname: unused in the code
- :param string $errorsto: email address used for Sender and Errors-To
- headers
- :param bool $use_utf8: decides whether the Content-Type header uses
- a charset parameter of utf-8 or iso-8859-1
+ This file is parsed directly by :sourcefile:`CommModule/client.pl`
+ format changes might break the CommModule code.
- Configuration and actual code are mixed. It would be better to have a
- separate file that just includes configuration.
+.. sourcefile:: includes/mysql.php.sample
- This file is parsed by :ref:`CommModule/client.pl <commmodule-client-pl>`
- format changes might break the CommModule code.
-
-.. _includes-notary.inc.php:
+ :file:`mysql.php.sample` is a template for the database connection handling
+ code that is meant to be copied to :file:`mysql.php`.
-.. sourcefile: includes/notary.inc.php
+ The template defines the MySQL connection as a session variable `mconn` and
+ tries to connect to that database. It also defines the session variables
+ `normalhostname`, `securehostname` and `tverify`.
-- :file:`notary.inc.php`
+ The template defines a function :php:func:`sendmail` for sending mails.
-.. _includes-shutdown.php:
+ .. php:function:: sendmail($to, $subject, $message, $from, $replyto="", \
+ $toname="", $fromname="", $errorsto="returns@cacert.org", \
+ $use_utf8=true)
-.. sourcefile: includes/shutdown.php
+ Send an email. The function reimplements functionality that is readily
+ available in PHP. The function does not properly escape headers and
+ sends raw SMTP commands.
-- :file:`shutdown.php`
+ :param string $to: recipient email address
+ :param string $subject: subject
+ :param string $message: email body
+ :param string $from: from email address
+ :param string $replyto: reply-to email address
+ :param string $fromname: unused in the code
+ :param string $toname: unused in the code
+ :param string $errorsto: email address used for Sender and Errors-To
+ headers
+ :param bool $use_utf8: decides whether the Content-Type header uses
+ a charset parameter of utf-8 or iso-8859-1
-.. _includes-sponsorinfo.php:
+ Configuration and actual code are mixed. It would be better to have a
+ separate file that just includes configuration.
-.. sourcefile: includes/sponsorinfo.php
+.. sourcefile:: includes/notary.inc.php
-- :file:`sponsorinfo.php`
+.. sourcefile:: includes/shutdown.php
-.. _includes-tverify_stuff.php:
+.. sourcefile:: includes/sponsorinfo.php
-.. sourcefile: includes/tverify_stuff.php
+.. sourcefile:: includes/tverify_stuff.php
-- :file:`tverify_stuff.php`
.. index:: includes/lib
.. index:: PHP
@@ -332,150 +322,63 @@ Directory :file:`includes`
Directory :file:`includes/lib`
==============================
-.. _includes-lib-account.php:
-
-.. sourcefile: includes/lib/account.php
-
-- :file:`account.php`
+.. sourcefile:: includes/lib/account.php
-.. _includes-lib-check_weak_key.php:
+.. sourcefile:: includes/lib/check_weak_key.php
-.. sourcefile: includes/lib/check_weak_key.php
+.. sourcefile:: includes/lib/general.php
-- :file:`check_weak_key.php`
+.. sourcefile:: includes/lib/l10n.php
-.. _includes-lib-general.php:
-
-.. sourcefile: includes/lib/general.php
-
-- :file:`general.php`
-
-.. _includes-lib-l10n.php:
-
-.. sourcefile: includes/lib/l10n.php
-
-- :file:`l10n.php`
.. index:: locale
Directory :file:`locale`
========================
-.. index:: C
-
-.. _locale-cv.c:
+.. sourcefile:: locale/cv.c
-.. sourcefile: locale/cv.c
-
-- :file:`cv.c`
-
-.. index:: PHP
-.. _locale-escape_special_chars.php:
-
-.. sourcefile: locale/escape_special_chars.php
-
-- :file:`escape_special_chars.php`
-
-.. index:: bash
-.. _locale-makefile:
-
-.. sourcefile: locale/makefile
-
-- :file:`makefile`
-
-.. index:: pages
-
-Directory :file:`pages`
-=======================
+.. sourcefile:: locale/escape_special_chars.php
-This directory only contains other (sub-) directorys, structured according to specific topics.
+.. sourcefile:: locale/makefile
-.. include:: DIR-pages.rst
.. index:: scripts
.. index:: PHP
.. index:: txt
-Directory :file:`scripts`
-=========================
-
-.. include:: DIR-scripts.rst
-
Directory :file:`stamp`
=======================
-.. _stamp-certdet.php:
-
-.. sourcefile: stamp/certdet.php
-
-- :file:`certdet.php`
-
-.. _stamp-common.php:
-
-.. sourcefile: stamp/common.php
-
-- :file:`common.php`
-
-.. _stamp-displogo.php:
-
-.. sourcefile: stamp/displogo.php
-
-- :file:`displogo.php`
-
-.. _stamp-.htaccess:
+.. sourcefile:: stamp/certdet.php
-.. sourcefile: stamp/.htaccess
+.. sourcefile:: stamp/common.php
-- :file:`.htaccess`
+.. sourcefile:: stamp/displogo.php
-.. _stamp-index.php:
+.. sourcefile:: stamp/.htaccess
-.. sourcefile: stamp/index.php
+.. sourcefile:: stamp/index.php
-- :file:`index.php`
+.. sourcefile:: stamp/old_showlogo.php.broken
-.. _stamp-old_showlogo.php.broken:
+.. sourcefile:: stamp/report.php
-.. sourcefile: stamp/old_showlogo.php.broken
+.. sourcefile:: stamp/showlogo.php
-- :file:`old_showlogo.php.broken`
+.. sourcefile:: stamp/style.css
-.. _stamp-report.php:
-
-.. sourcefile: stamp/report.php
-
-- :file:`report.php`
-
-.. _stamp-showlogo.php:
-
-.. sourcefile: stamp/showlogo.php
-
-- :file:`showlogo.php`
-
-.. _stamp-style.css:
-
-.. sourcefile: stamp/style.css
-
-- :file:`style.css`
Directory :file:`stamp/images`
==============================
-.. _stamp-images-CAverify.png:
-
-.. sourcefile: stamp/images/CAverify.png
+.. sourcefile:: stamp/images/CAverify.png
-- :file:`CAverify.png`
Directory :file:`tmp`
=====================
-.. _tmp-Makefile:
-
-.. sourcefile: tmp/Makefile
-
-- :file:`Makefile`
-
+.. sourcefile:: tmp/Makefile
.. index:: tverify
@@ -483,70 +386,18 @@ Directory :file:`tmp`
Directory :file:`tverify`
=========================
-.. _tverify-favicon.ico:
+.. sourcefile:: tverify/favicon.ico
-.. sourcefile: tverify/favicon.ico
+.. sourcefile:: tverify/.htaccess
-- :file:`favicon.ico`
+.. sourcefile:: tverify/index
-.. _tverify-.htaccess:
-
-.. sourcefile: tverify/.htaccess
-
-- :file:`.htaccess`
-
-.. _tverify-index:
-
-.. sourcefile: tverify/index
-
-- :file:`index`
-
-.. _tverify-index.php:
-
-.. sourcefile: tverify/index.php
-
-- :file:`index.php`
+.. sourcefile:: tverify/index.php
Directory :file:`tverify/index`
===============================
-.. _tverify-index-0.php:
-
-.. sourcefile: tverify/index/0.php
-
-- :file:`0.php`
-
-.. _tverify-index-1.php:
-
-.. sourcefile: tverify/index/1.php
-
-- :file:`1.php`
-
-
-
-
-.. index:: WWW
-.. index:: PHP
-
-Directory :file:`www`
-=====================
-
-This contains the PHP code that is the entry point to the application:
-
-.. include:: DIR-www.rst
-
-.. .. _www-sealgen-php:
-..
-.. - :file:`sealgen.php` generates a small site seal image from
-.. :ref:`www/images/secured.png <www-images-secured-png>`. This could be
-.. replaced with a static image if it is used at all. This is referenced
-.. by :ref:`cgi-bin/siteseal.cgi <cgi-bin-siteseal-cgi>`
+.. sourcefile:: tverify/index/0.php
-.. Directory :file:`www/images`
-.. ============================
-..
-.. .. _www-images-secured-png:
-..
-.. - :file:`secured.png` is a small image used by
-.. :ref:`www/sealgen.php <www-sealgen-php>`
+.. sourcefile:: tverify/index/1.php