source: trunk/FACT++/MAINPAGE @ 10242

Last change on this file since 10242 was 10242, checked in by tbretz, 10 years ago
Some tiny updates like typos.
File size: 5.0 KB
Line 
1// **************************************************************************
2/** @mainpage
3
4@brief FACT++ - The FACT slow control software
5
6@author thomas.bretz@epfl.ch et al.
7@version 1.0
8 
9@section install_sec Installation
10
11FACT++ can be downloaded from the svn by
12
13\verbatim
14   svn checkout https://fact.isdc.unige.ch/svn/trunk/FACT++ [localdir]
15\endverbatim
16
17it includes a dim version which is automatically compiled.
18
19For compilation use
20
21\verbatim
22   ./configure
23   make
24\endverbatim
25
26In principle configure also supports
27
28\verbatim
29   make install
30\endverbatim
31
32which would install the package and the libraries in your system,
33although at the moment this is not recommended
34
35@subsection packages Required packages
36
37If you find a new package needed for installation please don't
38hesitate to report it, so that it can be added to the list below.
39
40Packages known to be needed to configure and compile FACT++
41
42<B>Dim:</B>
43- lesstif2, lesstif2-dev (Xm.h)
44
45<B>Libraries:</B>
46- boost-dev (>=V1.40, all)
47- mysql++-dev
48
49<B>Documentation:</B>
50- doxygen
51- graphviz
52- [global] optional (if htags should be used in Doxyfile)
53
54<B>Only for maintainers:</B>
55- autoconf (automake, autotools-dev, m4)
56- autoconf-archive
57- libtool (contains libtoolize
58
59@section Demo Current demonstration programs
60
61- \b dserver2: A virtual board (A TCP/IP server). It is sending a
62  "hello" message after accepting a communication and then in 3s
63  intervals the current UTC time. The board can be set to state 1 or back
64  to state 0 (just as a demonstration)
65- \b dclient5: A control program. It accesses two viratual boards (start them
66  with 'dserver2 5000' and 'dserver2 4001') If both boards are connected the START
67  command can be issued to get them to state 'Running'. In this state
68  an asynchronous time stamp can be requested sending the TIME command.
69  to get back from Running to Connected use STOP.
70- \b test3: a dim console which allows to control all dim servers
71  by sending commands via the dim network.
72- Both, \b dclient5 and \b test3 accept the command line options -c0, -c1, -c2
73  to switch between different console types (or no console in the case of
74  \b dclient5). In the console you get help with 'h' and the available
75  command with 'c' You get the avilable command-line options with --help
76
77First start the two dserver2s. Then start a dclient5 (if you want it
78with console use one of the -c options) and a test3 console (with one
79of the console options if you like) you can now control the hardware
80boards with the START, STOP and TIME commands or stop (Ctrl-C) and
81start one of the programs to see what's happening. In the test3 case
82you first have to \e cd to the server to which you want to talk by \b
83DATA_LOGGER. Don't forget to start \b dns if you want to control dclient5
84from test3 via Dim.
85
86
87@section References
88
89@subsection generalref General references
90- <A HREF="http://www.cplusplus.com/reference">The C++ reference</A>
91- <A HREF="http://www.boost.org">boost.org: The boost C++ libraries</A>
92- <A HREF="http://www.highscore.de/cpp/boost/titelseite.html">Boris Sch&auml;ling: Die Boost C++ Bibliotheken</A>
93- <A HREF="http://cnswww.cns.cwru.edu/php/chet/readline/rltop.html">GNU Readline</A>
94- <A HREF="http://www.gnu.org/software/ncurses">GNU Ncurses</A>
95- <A HREF="http://dim.web.cern.ch/">Distributed Information Management (DIM)</A>
96- <A HREF="http://dim.web.cern.ch/dim/cpp_doc/DimCpp.html">Distributed Information Management (DIM) - C++ reference</A>
97
98@subsection boostref Boost references
99- <A HREF="http://www.boost.org/doc/libs/1_45_0/libs/bind/bind.html">boost::bind (V1.45.0)</A>
100- <A HREF="http://www.boost.org/doc/libs/1_45_0/doc/html/boost_asio.html">boost asio (V1.45.0)</A>
101- <A HREF="http://www.boost.org/doc/libs/1_45_0/doc/html/date_time.html">boost date_time (V1.45.0)</A>
102- <A HREF="http://www.boost.org/doc/libs/1_45_0/doc/html/program_options.html">boost program_options (V1.45.0)</A>
103- <A HREF="http://www.boost.org/doc/libs/1_45_0/libs/filesystem/v3/doc/index.htm">boost filesystem (V1.45.0)</A>
104- <A HREF="http://www.boost.org/doc/libs/1_45_0/libs/regex/doc/html/index.html">boost regex (V1.45.0)</A>
105- <A HREF="http://www.boost.org/doc/libs/1_45_0/libs/system/doc/index.html">boost system (error codes) (V1.45.0)</A>
106- <A HREF="http://www.boost.org/doc/libs/1_45_0/doc/html/thread.html">boost thread (V1.45.0)</A>
107- <A HREF="http://www.boost.org/doc/libs/1_45_0/libs/conversion/lexical_cast.htm">boost lexical_cast (V1.45.0)</A>
108
109@section Available programs
110
111- dns: Dim's domain-name-server (needed for any communication between Dim servers and clients)
112- did: A simple graphical interface to analyse everything in a Dim network
113
114@section Examples
115
116There are a few example programs
117- \b ./argv: Example for usage of the class Configure (command line options, configuration file)
118- \b ./time: Example for the usage of the class Time (time input/output, conversion)
119- \b ./log, \b ./logtime: A simple Dim-Service/-Client combination using MessageDimRX/MessageDimTX
120
121**/
122// **************************************************************************
Note: See TracBrowser for help on using the repository browser.