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