New upstream version 0.6.4
[debian/confclerk.git] / data / confclerk.1
1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings.  \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 .    ds -- \(*W-
28 .    ds PI pi
29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
31 .    ds L" ""
32 .    ds R" ""
33 .    ds C` ""
34 .    ds C' ""
35 'br\}
36 .el\{\
37 .    ds -- \|\(em\|
38 .    ds PI \(*p
39 .    ds L" ``
40 .    ds R" ''
41 .    ds C`
42 .    ds C'
43 'br\}
44 .\"
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
46 .ie \n(.g .ds Aq \(aq
47 .el       .ds Aq '
48 .\"
49 .\" If the F register is >0, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
53 .\"
54 .\" Avoid warning from groff about undefined register 'F'.
55 .de IX
56 ..
57 .if !\nF .nr F 0
58 .if \nF>0 \{\
59 .    de IX
60 .    tm Index:\\$1\t\\n%\t"\\$2"
61 ..
62 .    if !\nF==2 \{\
63 .        nr % 0
64 .        nr F 2
65 .    \}
66 .\}
67 .\" ========================================================================
68 .\"
69 .IX Title "CONFCLERK 1"
70 .TH CONFCLERK 1 "2017-08-30" "Version 0.6.4" "Offline conference scheduler"
71 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
72 .\" way too many mistakes in technical documents.
73 .if n .ad l
74 .nh
75 .SH "NAME"
76 ConfClerk \- offline conference schedule application
77 .SH "SYNOPSIS"
78 .IX Header "SYNOPSIS"
79 \&\fBconfclerk\fR
80 .SH "DESCRIPTION"
81 .IX Header "DESCRIPTION"
82 \&\fBConfClerk\fR is an application written in Qt, which makes conference
83 schedules available offline.  It displays the conference schedule
84 from various views, supports searches on various items (speaker, speech topic,
85 location, etc.) and enables you to select favorite events and create your own
86 schedule.
87 .PP
88 At the moment \fBConfClerk\fR is able to import schedules in \s-1XML\s0 format created
89 by the PentaBarf conference management system (or frab) used by e.g. \s-1FOSDEM,\s0
90 DebConf, FrOSCon, Grazer Linuxtage, and the \s-1CCC.\s0
91 .PP
92 ConfClerk is targeted at mobile devices like the Nokia N810 and N900 but
93 works on any system running Qt.
94 .SH "OPTIONS"
95 .IX Header "OPTIONS"
96 None.
97 .SH "CONFIGURATION"
98 .IX Header "CONFIGURATION"
99 The configuration can be done via the graphical interface.
100 .PP
101 The configuration is saved in the default QSettings location, i.e.:
102 .IP "Linux" 4
103 .IX Item "Linux"
104 \&\fI~/.config/Toastfreeware/ConfClerk.conf\fR
105 .IP "Windows" 4
106 .IX Item "Windows"
107 In the registry (search for the Toastfreeware key, should be at
108 \&\fIHKEY_CURRENT_USER\eSoftware\eToastfreeware\eConfClerk\fR).
109 .IP "Other \s-1OS\s0" 4
110 .IX Item "Other OS"
111 Cf. the QSettings documentation at 
112 <http://doc.qt.nokia.com/stable/qsettings.html#locations\-where\-application\-settings\-are\-stored>.
113 .SH "FILES"
114 .IX Header "FILES"
115 \&\fBConfClerk\fR keeps its database in the location proposed by the \s-1XDG\s0 Base
116 Directory specification <http://standards.freedesktop.org/basedir\-spec/basedir\-spec\-latest.html>:
117 .PP
118 So the configuration (see \*(L"\s-1CONFIGURATION\*(R"\s0) is stored at
119 \&\fI~/.config/Toastfreeware/ConfClerk.conf\fR and the database is kept at
120 \&\fI~/.local/share/data/Toastfreeware/ConfClerk/ConfClerk.sqlite\fR (Qt4)
121 \&\fI~/.local/share/Toastfreeware/ConfClerk/ConfClerk.sqlite\fR (Qt5).
122 .SH "COPYRIGHT AND LICENSE"
123 .IX Header "COPYRIGHT AND LICENSE"
124 .SS "Main code"
125 .IX Subsection "Main code"
126 .Vb 4
127 \&    Copyright (C) 2010 Ixonos Plc.
128 \&    Copyright (C) 2011\-2017, Philipp Spitzer <philipp@toastfreeware.priv.at>
129 \&    Copyright (C) 2011\-2017, gregor herrmann <gregor@toastfreeware.priv.at>
130 \&    Copyright (C) 2011\-2017, Stefan Strahl <stefan@toastfreeware.priv.at>
131 \&
132 \&    This program is free software; you can redistribute it and/or modify
133 \&    it under the terms of the GNU General Public License as published by
134 \&    the Free Software Foundation; either version 2 of the License, or
135 \&    (at your option) any later version.
136 \&
137 \&    This program is distributed in the hope that it will be useful,
138 \&    but WITHOUT ANY WARRANTY; without even the implied warranty of
139 \&    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
140 \&    GNU General Public License for more details.
141 \&
142 \&    You should have received a copy of the GNU General Public License along
143 \&    with this program; if not, write to the Free Software Foundation, Inc.,
144 \&    51 Franklin Street, Fifth Floor, Boston, MA 02110\-1301 USA.
145 .Ve
146 .SS "Additional resources"
147 .IX Subsection "Additional resources"
148 .IP "data/confclerk.*:" 4
149 .IX Item "data/confclerk.*:"
150 .Vb 1
151 \&    Copyright (C) 2011, Christian Kling <kling_christian@gmx.at>
152 \&
153 \&    This program is free software; you can redistribute it and/or modify
154 \&    it under the terms of the GNU General Public License as published by
155 \&    the Free Software Foundation; either version 2 of the License, or
156 \&    (at your option) any later version.
157 .Ve
158 .IP "icons/*" 4
159 .IX Item "icons/*"
160 All icons are taken from the Debian package gnome-icon-theme, which contains
161 the following notice (as of 2011\-06\-24):
162 .Sp
163 .Vb 12
164 \&    Copyright © 2002\-2008:
165 \&      Ulisse Perusin <uli.peru@gmail.com>
166 \&      Riccardo Buzzotta <raozuzu@yahoo.it>
167 \&      Josef Vybíral <cornelius@vybiral.info>
168 \&      Hylke Bons <h.bons@student.rug.nl>
169 \&      Ricardo González <rick@jinlabs.com>
170 \&      Lapo Calamandrei <calamandrei@gmail.com>
171 \&      Rodney Dawes <dobey@novell.com>
172 \&      Luca Ferretti <elle.uca@libero.it>
173 \&      Tuomas Kuosmanen <tigert@gimp.org>
174 \&      Andreas Nilsson <nisses.mail@home.se>
175 \&      Jakub Steiner <jimmac@novell.com>
176 \&
177 \&    GNOME icon theme is distributed under the terms of either
178 \&    GNU LGPL v.3 or Creative Commons BY\-SA 3.0 license.
179 .Ve
180 .IP "src/icons/favourite*, src/icons/alarm*, src/icons/collapse*, src/icons/expand*:" 4
181 .IX Item "src/icons/favourite*, src/icons/alarm*, src/icons/collapse*, src/icons/expand*:"
182 .Vb 2
183 \&    Copyright (C) 2012\-2017, Philipp Spitzer <philipp@toastfreeware.priv.at>
184 \&    Copyright (C) 2012\-2017, Stefan Strahl <stefan@toastfreeware.priv.at>
185 \&
186 \&    This program is free software; you can redistribute it and/or modify
187 \&    it under the terms of the GNU General Public License as published by
188 \&    the Free Software Foundation; either version 2 of the License, or
189 \&    (at your option) any later version.
190 .Ve