source: confclerk_git/data/confclerk.pod @ f374273

Last change on this file since f374273 was 30edeb7, checked in by gregor herrmann <gregor@…>, 5 years ago

Mention new location of database file under Qt5 in docs.

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