Update copyright notices.
[toast/confclerk.git] / data / confclerk.pod
1 =encoding utf8
2
3 =head1 NAME
4
5 ConfClerk - offline conference schedule application
6
7 =head1 SYNOPSIS
8
9 B<confclerk>
10
11 =head1 DESCRIPTION
12
13 B<ConfClerk> is an application written in Qt, which makes conference
14 schedules available offline.  It displays the conference schedule
15 from various views, supports searches on various items (speaker, speech topic,
16 location, etc.) and enables you to select favorite events and create your own
17 schedule.
18
19 At the moment B<ConfClerk> is able to import schedules in XML format created
20 by the PentaBarf conference management system (or frab) used by e.g. FOSDEM,
21 DebConf, FrOSCon, Grazer Linuxtage, and the CCC.
22
23 ConfClerk is targeted at mobile devices like the Nokia N810 and N900 but
24 works on any system running Qt.
25
26 =head1 OPTIONS
27
28 None.
29
30 =head1 CONFIGURATION
31
32 The configuration can be done via the graphical interface.
33
34 The configuration is saved in the default QSettings location, i.e.:
35
36 =over
37
38 =item Linux
39
40 F<~/.config/Toastfreeware/ConfClerk.conf>
41
42 =item Windows
43
44 In the registry (search for the Toastfreeware key, should be at
45 F<HKEY_CURRENT_USER\Software\Toastfreeware\ConfClerk>).
46
47 =item Other OS
48
49 Cf. the QSettings documentation at 
50 L<http://doc.qt.nokia.com/stable/qsettings.html#locations-where-application-settings-are-stored>.
51
52 =back
53
54 =head1 FILES
55
56 B<ConfClerk> keeps its database in the location proposed by the XDG Base
57 Directory specification L<http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html>:
58
59 So the configuration (see L</"CONFIGURATION">) is stored at
60 F<~/.config/Toastfreeware/ConfClerk.conf> and the database is kept at
61 F<~/.local/share/data/Toastfreeware/ConfClerk/ConfClerk.sqlite>.
62
63 =head1 COPYRIGHT AND LICENSE
64
65 =head2 Main code
66
67     Copyright (C) 2010 Ixonos Plc.
68     Copyright (C) 2011-2014, Philipp Spitzer <philipp@toastfreeware.priv.at>
69     Copyright (C) 2011-2014, gregor herrmann <gregor@toastfreeware.priv.at>
70     Copyright (C) 2011-2014, Stefan Strahl <stefan@toastfreeware.priv.at>
71
72     This program is free software; you can redistribute it and/or modify
73     it under the terms of the GNU General Public License as published by
74     the Free Software Foundation; either version 2 of the License, or
75     (at your option) any later version.
76
77     This program is distributed in the hope that it will be useful,
78     but WITHOUT ANY WARRANTY; without even the implied warranty of
79     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
80     GNU General Public License for more details.
81
82     You should have received a copy of the GNU General Public License along
83     with this program; if not, write to the Free Software Foundation, Inc.,
84     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
85
86 =head2 Additional resources
87
88 =over
89
90 =item data/confclerk.*:
91
92     Copyright (C) 2011, Christian Kling <kling_christian@gmx.at>
93
94     This program is free software; you can redistribute it and/or modify
95     it under the terms of the GNU General Public License as published by
96     the Free Software Foundation; either version 2 of the License, or
97     (at your option) any later version.
98
99 =item icons/*
100
101 All icons are taken from the Debian package gnome-icon-theme, which contains
102 the following notice (as of 2011-06-24):
103
104     Copyright © 2002-2008:
105       Ulisse Perusin <uli.peru@gmail.com>
106       Riccardo Buzzotta <raozuzu@yahoo.it>
107       Josef Vybíral <cornelius@vybiral.info>
108       Hylke Bons <h.bons@student.rug.nl>
109       Ricardo González <rick@jinlabs.com>
110       Lapo Calamandrei <calamandrei@gmail.com>
111       Rodney Dawes <dobey@novell.com>
112       Luca Ferretti <elle.uca@libero.it>
113       Tuomas Kuosmanen <tigert@gimp.org>
114       Andreas Nilsson <nisses.mail@home.se>
115       Jakub Steiner <jimmac@novell.com>
116
117     GNOME icon theme is distributed under the terms of either
118     GNU LGPL v.3 or Creative Commons BY-SA 3.0 license.
119
120 =item src/icons/favourite*, src/icons/alarm*, src/icons/collapse*, src/icons/expand*:
121
122     Copyright (C) 2012, Philipp Spitzer <philipp@toastfreeware.priv.at>
123     Copyright (C) 2012, Stefan Strahl <stefan@toastfreeware.priv.at>
124
125     This program is free software; you can redistribute it and/or modify
126     it under the terms of the GNU General Public License as published by
127     the Free Software Foundation; either version 2 of the License, or
128     (at your option) any later version.
129
130 =back