summaryrefslogtreecommitdiff
path: root/source/directories.rst
diff options
context:
space:
mode:
authorJan Dittberner <jandd@cacert.org>2018-11-09 17:34:19 +0100
committerJan Dittberner <jandd@cacert.org>2018-11-09 17:34:19 +0100
commitc45018910c57d0993c04f36dde7b28084765251a (patch)
tree6cabe3c6f2519f2d10e62d2efc9da61e417ca0a0 /source/directories.rst
parent56a05a6aa3ca685bc96f919472d1a8a91f22e25f (diff)
parent778c0155c81f00e07695ff5671089ebb31b258de (diff)
downloadcacert-codedocs-c45018910c57d0993c04f36dde7b28084765251a.tar.gz
cacert-codedocs-c45018910c57d0993c04f36dde7b28084765251a.tar.xz
cacert-codedocs-c45018910c57d0993c04f36dde7b28084765251a.zip
Merge branch 'GuKKDevel'
Diffstat (limited to 'source/directories.rst')
-rw-r--r--source/directories.rst328
1 files changed, 314 insertions, 14 deletions
diff --git a/source/directories.rst b/source/directories.rst
index 3cba141..b5c46f0 100644
--- a/source/directories.rst
+++ b/source/directories.rst
@@ -21,7 +21,7 @@ Directory :file:`cgi-bin`
The `cgi-bin` directory contains
-.. index:: php
+.. index:: PHP
.. _cgi-bin-siteseal-cgi:
@@ -32,7 +32,7 @@ The `cgi-bin` directory contains
.. todo: check whether this is linked anywhere or can be removed
-.. index:: commmodule
+.. index:: commModule
.. index:: Perl
.. index:: bash
@@ -189,10 +189,81 @@ This directory contains the CommModule that is implemented in Perl:
:ref:`client.pl <commmodule-client-pl>` above
.. todo:: remove unused file (usbclient.pl)
+
+.. index:: includes
+.. index:: PHP
Directory :file:`includes`
==============================
+.. _includes-.cvsignore:
+
+.. sourcefile: includes/.cvsignore
+
+- :file:`.cvsignore` includes the parameters for CVS, which files to ignore by versioning
+
+.. _includes-.directory:
+
+.. sourcefile: includes/.gitignore
+
+- :file:`.gitignore` includes the parameters for GIT, which files to ignore by versioning
+
+.. _includes-about_menu.php:
+
+.. 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
+
+- :file:`about_menu.php` is a part (<div>) of a PHP-Page, containing most of the CAcert-related links.
+
+.. _includes-account_stuff.php:
+
+.. sourcefile: includes/account_stuff.php
+
+- :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
+
+- :file:`general_stuff.php`
+
+.. _includes-general.php:
+
+.. sourcefile: includes/general.php
+
+- :file:`general.php`
+
+.. _includes-keygen.php:
+
+.. sourcefile: includes/keygen.php
+
+- :file:`keygen.php`
+
+.. _includes-loggedin.php:
+
+.. sourcefile: includes/loggedin.php
+
+- :file:`loggedin.php`
+
.. _includes-mysql-php:
.. _includes-mysql-php-sample:
@@ -230,23 +301,252 @@ Directory :file:`includes`
This file is parsed by :ref:`CommModule/client.pl <commmodule-client-pl>`
format changes might break the CommModule code.
+
+.. _includes-notary.inc.php:
-Directory :file:`www`
+.. sourcefile: includes/notary.inc.php
+
+- :file:`notary.inc.php`
+
+.. _includes-shutdown.php:
+
+.. sourcefile: includes/shutdown.php
+
+- :file:`shutdown.php`
+
+.. _includes-sponsorinfo.php:
+
+.. sourcefile: includes/sponsorinfo.php
+
+- :file:`sponsorinfo.php`
+
+.. _includes-tverify_stuff.php:
+
+.. sourcefile: includes/tverify_stuff.php
+
+- :file:`tverify_stuff.php`
+
+.. index:: includes/lib
+.. index:: PHP
+
+Directory :file:`includes/lib`
+==============================
+
+.. _includes-lib-account.php:
+
+.. sourcefile: includes/lib/account.php
+
+- :file:`account.php`
+
+.. _includes-lib-check_weak_key.php:
+
+.. sourcefile: includes/lib/check_weak_key.php
+
+- :file:`check_weak_key.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
+
+- :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`
+=======================
+
+This directory only contains other (sub-) directorys, structured according to specific topics.
+
+.. 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/.htaccess
+
+- :file:`.htaccess`
+
+.. _stamp-index.php:
+
+.. sourcefile: stamp/index.php
+
+- :file:`index.php`
+
+.. _stamp-old_showlogo.php.broken:
+
+.. sourcefile: stamp/old_showlogo.php.broken
+
+- :file:`old_showlogo.php.broken`
+
+.. _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
+
+- :file:`CAverify.png`
+
+Directory :file:`tmp`
=====================
-This contains the PHP code that is the entry point to the application:
+.. _tmp-Makefile:
-.. _www-sealgen-php:
+.. sourcefile: tmp/Makefile
-- :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>`
+- :file:`Makefile`
-Directory :file:`www/images`
-============================
-.. _www-images-secured-png:
-- :file:`secured.png` is a small image used by
- :ref:`www/sealgen.php <www-sealgen-php>`
+.. index:: tverify
+
+Directory :file:`tverify`
+=========================
+
+.. _tverify-favicon.ico:
+
+.. sourcefile: tverify/favicon.ico
+
+- :file:`favicon.ico`
+
+.. _tverify-.htaccess:
+
+.. sourcefile: tverify/.htaccess
+
+- :file:`.htaccess`
+
+.. _tverify-index:
+
+.. sourcefile: tverify/index
+
+- :file:`index`
+
+.. _tverify-index.php:
+
+.. sourcefile: tverify/index.php
+
+- :file:`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>`
+
+.. Directory :file:`www/images`
+.. ============================
+..
+.. .. _www-images-secured-png:
+..
+.. - :file:`secured.png` is a small image used by
+.. :ref:`www/sealgen.php <www-sealgen-php>`