Mercurial > trustbridge

annotate doc/apidoc/mainpage.dox @ 1255:2a1aa9df8f11

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
(issue133) Improve API documentation
author Andre Heinecke <andre.heinecke@intevation.de>
date Thu, 25 Sep 2014 17:58:12 +0200
parents 6d840341bc25
children
rev   line source
1254
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
1 /**
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
2 \mainpage TrustBridge
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
3
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
4 \section Copyright
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
5
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
6 Copyright (C) 2014 by Bundesamt für Sicherheit in der Informationstechnik
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
7 Software engineering by Intevation GmbH
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
8
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
9 This file is Free Software under the GNU GPL (v>=2)
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
10 and comes with ABSOLUTELY NO WARRANTY!
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
11 See licenses/README.txt for more information.
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
12
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
13 \section Introduction
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
14
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
15 TrustBridge is a is a root certificate installer for Windows and Linux,
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
16 contracted by the German Federal Office for Information Security (BSI).
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
17 It should be able to be installed with or without root access rights.
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
18
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
19 The orignal target platforms are Windows NT > 6.0 (Vista and later) and
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
20 Ubuntu GNU/Linux 14.4 both 32 and 64 bit.
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
21
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
22 Certificates are installed under Windows in the Windows System store and
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
23 using the Mozilla NSS library into the certificate databases used by
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
24 firefox and thunderbird.
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
25
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
26 Under GNU/Linux the NSS-Shared DB, used for example by Chrome(ium) is
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
27 accessed additionally to the Thunderbird and Firefox stores.
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
28
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
29 \section Installation
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
30
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
31 See the file \ref INSTALL for build instructions for Linux and Windows.
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
32
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
33 \section Documentation
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
34 For API (what you are reading now) documentation build the target "doc"
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
35 (requires doxygen).
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
36
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
37 The (German) user help documentation is available in the TrustBridge
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
38 client/admin application. The source files are placed in "doc/help".
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
39
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
40 \section Contact
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
41 For additional information or custom modifications please contact:
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
42
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
43 Intevation GmbH <intevation@intevation.de>
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
44 Neuer Graben 17
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
45 49074 Osnabrück, Germany
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
46
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
47 The public development platform can be found at:
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
48 https://wald.intevation.org/projects/trustbridge/
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
49
6d840341bc25 (issue113) Add mainpage and improve doxyfile
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
50 */
http://wald.intevation.org/projects/trustbridge/