annotate doc/mainpage.dox @ 37:b574990e90a5

Update Format spec for additional handling
author Andre Heinecke <andre.heinecke@intevation.de>
date Fri, 15 Apr 2016 15:15:44 +0200
parents 49cd5cc0b072
children
rev   line source
0
49cd5cc0b072 Initial commit of project template (based on RetraceIT)
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
1 /**
49cd5cc0b072 Initial commit of project template (based on RetraceIT)
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
2 \mainpage RetraceIT
49cd5cc0b072 Initial commit of project template (based on RetraceIT)
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
3
49cd5cc0b072 Initial commit of project template (based on RetraceIT)
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
4 \section Copyright
49cd5cc0b072 Initial commit of project template (based on RetraceIT)
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
5
49cd5cc0b072 Initial commit of project template (based on RetraceIT)
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
6 Copyright (C) 2015 by ETH Zürich
49cd5cc0b072 Initial commit of project template (based on RetraceIT)
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
7 Software engineering by Intevation GmbH
49cd5cc0b072 Initial commit of project template (based on RetraceIT)
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
8
49cd5cc0b072 Initial commit of project template (based on RetraceIT)
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
9 This file is Free Software under the GNU GPL (v>=2)
49cd5cc0b072 Initial commit of project template (based on RetraceIT)
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
10 and comes with ABSOLUTELY NO WARRANTY!
49cd5cc0b072 Initial commit of project template (based on RetraceIT)
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
11 See LICENSE.txt for details.
49cd5cc0b072 Initial commit of project template (based on RetraceIT)
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
12
49cd5cc0b072 Initial commit of project template (based on RetraceIT)
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
13 \section Introduction
49cd5cc0b072 Initial commit of project template (based on RetraceIT)
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
14
49cd5cc0b072 Initial commit of project template (based on RetraceIT)
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
15 RetraceIT is a tool to view recorded login sessions. The record data
49cd5cc0b072 Initial commit of project template (based on RetraceIT)
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
16 consists of a metadata.csv file that cotains additional information
49cd5cc0b072 Initial commit of project template (based on RetraceIT)
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
17 and serveral screenshots (taken with user consent) of the recorded
49cd5cc0b072 Initial commit of project template (based on RetraceIT)
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
18 session.
49cd5cc0b072 Initial commit of project template (based on RetraceIT)
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
19
49cd5cc0b072 Initial commit of project template (based on RetraceIT)
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
20 The orignal target platforms are Windows NT > 6.1 (Seven and later) and
49cd5cc0b072 Initial commit of project template (based on RetraceIT)
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
21 GNU/Linux and MacOS.
49cd5cc0b072 Initial commit of project template (based on RetraceIT)
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
22
49cd5cc0b072 Initial commit of project template (based on RetraceIT)
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
23 \section Installation
49cd5cc0b072 Initial commit of project template (based on RetraceIT)
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
24
49cd5cc0b072 Initial commit of project template (based on RetraceIT)
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
25 See the file \ref INSTALL for build instructions for Linux and Windows.
49cd5cc0b072 Initial commit of project template (based on RetraceIT)
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
26
49cd5cc0b072 Initial commit of project template (based on RetraceIT)
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
27 \section Documentation
49cd5cc0b072 Initial commit of project template (based on RetraceIT)
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
28 For API (what you are reading now) documentation build the target "doc"
49cd5cc0b072 Initial commit of project template (based on RetraceIT)
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
29 (requires doxygen).
49cd5cc0b072 Initial commit of project template (based on RetraceIT)
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
30
49cd5cc0b072 Initial commit of project template (based on RetraceIT)
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
31 \section Contact
49cd5cc0b072 Initial commit of project template (based on RetraceIT)
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
32 For additional information or custom modifications please contact:
49cd5cc0b072 Initial commit of project template (based on RetraceIT)
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
33
49cd5cc0b072 Initial commit of project template (based on RetraceIT)
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
34 Intevation GmbH <intevation@intevation.de>
49cd5cc0b072 Initial commit of project template (based on RetraceIT)
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
35 Neuer Graben 17
49cd5cc0b072 Initial commit of project template (based on RetraceIT)
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
36 49074 Osnabrück, Germany
49cd5cc0b072 Initial commit of project template (based on RetraceIT)
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
37
49cd5cc0b072 Initial commit of project template (based on RetraceIT)
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
38 The public development platform can be found at:
49cd5cc0b072 Initial commit of project template (based on RetraceIT)
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
39 https://wald.intevation.org/projects/retraceit/
49cd5cc0b072 Initial commit of project template (based on RetraceIT)
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
40
49cd5cc0b072 Initial commit of project template (based on RetraceIT)
Andre Heinecke <andre.heinecke@intevation.de>
parents:
diff changeset
41 */
This site is hosted by Intevation GmbH (Datenschutzerklärung und Impressum | Privacy Policy and Imprint)