Imported Upstream version 0.6.1
[debian/confclerk.git] / data / confclerk.1
1 .\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
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 turned on, 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 .nr rF 0
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{
60 .    if \nF \{
61 .        de IX
62 .        tm Index:\\$1\t\\n%\t"\\$2"
63 ..
64 .        if !\nF==2 \{
65 .            nr % 0
66 .            nr F 2
67 .        \}
68 .    \}
69 .\}
70 .rr rF
71 .\" ========================================================================
72 .\"
73 .IX Title "CONFCLERK 1"
74 .TH CONFCLERK 1 "2014-09-11" "Version 0.6.1" "Offline conference scheduler"
75 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
76 .\" way too many mistakes in technical documents.
77 .if n .ad l
78 .nh
79 .SH "NAME"
80 ConfClerk \- offline conference schedule application
81 .SH "SYNOPSIS"
82 .IX Header "SYNOPSIS"
83 \&\fBconfclerk\fR
84 .SH "DESCRIPTION"
85 .IX Header "DESCRIPTION"
86 \&\fBConfClerk\fR is an application written in Qt, which makes conference
87 schedules available offline.  It displays the conference schedule
88 from various views, supports searches on various items (speaker, speech topic,
89 location, etc.) and enables you to select favorite events and create your own
90 schedule.
91 .PP
92 At the moment \fBConfClerk\fR is able to import schedules in \s-1XML\s0 format created
93 by the PentaBarf conference management system (or frab) used by e.g. \s-1FOSDEM,\s0
94 DebConf, FrOSCon, Grazer Linuxtage, and the \s-1CCC.\s0
95 .PP
96 ConfClerk is targeted at mobile devices like the Nokia N810 and N900 but
97 works on any system running Qt.
98 .SH "OPTIONS"
99 .IX Header "OPTIONS"
100 None.
101 .SH "CONFIGURATION"
102 .IX Header "CONFIGURATION"
103 The configuration can be done via the graphical interface.
104 .PP
105 The configuration is saved in the default QSettings location, i.e.:
106 .IP "Linux" 4
107 .IX Item "Linux"
108 \&\fI~/.config/Toastfreeware/ConfClerk.conf\fR
109 .IP "Windows" 4
110 .IX Item "Windows"
111 In the registry (search for the Toastfreeware key, should be at
112 \&\fIHKEY_CURRENT_USER\eSoftware\eToastfreeware\eConfClerk\fR).
113 .IP "Other \s-1OS\s0" 4
114 .IX Item "Other OS"
115 Cf. the QSettings documentation at 
116 <http://doc.qt.nokia.com/stable/qsettings.html#locations\-where\-application\-settings\-are\-stored>.
117 .SH "FILES"
118 .IX Header "FILES"
119 \&\fBConfClerk\fR keeps its database in the location proposed by the \s-1XDG\s0 Base
120 Directory specification <http://standards.freedesktop.org/basedir\-spec/basedir\-spec\-latest.html>:
121 .PP
122 So the configuration (see \*(L"\s-1CONFIGURATION\*(R"\s0) is stored at
123 \&\fI~/.config/Toastfreeware/ConfClerk.conf\fR and the database is kept at
124 \&\fI~/.local/share/data/Toastfreeware/ConfClerk/ConfClerk.sqlite\fR.
125 .SH "COPYRIGHT AND LICENSE"
126 .IX Header "COPYRIGHT AND LICENSE"
127 .SS "Main code"
128 .IX Subsection "Main code"
129 .Vb 4
130 \&    Copyright (C) 2010 Ixonos Plc.
131 \&    Copyright (C) 2011\-2014, Philipp Spitzer <philipp@toastfreeware.priv.at>
132 \&    Copyright (C) 2011\-2014, gregor herrmann <gregor@toastfreeware.priv.at>
133 \&    Copyright (C) 2011\-2014, Stefan Strahl <stefan@toastfreeware.priv.at>
134 \&
135 \&    This program is free software; you can redistribute it and/or modify
136 \&    it under the terms of the GNU General Public License as published by
137 \&    the Free Software Foundation; either version 2 of the License, or
138 \&    (at your option) any later version.
139 \&
140 \&    This program is distributed in the hope that it will be useful,
141 \&    but WITHOUT ANY WARRANTY; without even the implied warranty of
142 \&    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
143 \&    GNU General Public License for more details.
144 \&
145 \&    You should have received a copy of the GNU General Public License along
146 \&    with this program; if not, write to the Free Software Foundation, Inc.,
147 \&    51 Franklin Street, Fifth Floor, Boston, MA 02110\-1301 USA.
148 .Ve
149 .SS "Additional resources"
150 .IX Subsection "Additional resources"
151 .IP "data/confclerk.*:" 4
152 .IX Item "data/confclerk.*:"
153 .Vb 1
154 \&    Copyright (C) 2011, Christian Kling <kling_christian@gmx.at>
155 \&
156 \&    This program is free software; you can redistribute it and/or modify
157 \&    it under the terms of the GNU General Public License as published by
158 \&    the Free Software Foundation; either version 2 of the License, or
159 \&    (at your option) any later version.
160 .Ve
161 .IP "icons/*" 4
162 .IX Item "icons/*"
163 All icons are taken from the Debian package gnome-icon-theme, which contains
164 the following notice (as of 2011\-06\-24):
165 .Sp
166 .Vb 12
167 \&    Copyright © 2002\-2008:
168 \&      Ulisse Perusin <uli.peru@gmail.com>
169 \&      Riccardo Buzzotta <raozuzu@yahoo.it>
170 \&      Josef Vybíral <cornelius@vybiral.info>
171 \&      Hylke Bons <h.bons@student.rug.nl>
172 \&      Ricardo González <rick@jinlabs.com>
173 \&      Lapo Calamandrei <calamandrei@gmail.com>
174 \&      Rodney Dawes <dobey@novell.com>
175 \&      Luca Ferretti <elle.uca@libero.it>
176 \&      Tuomas Kuosmanen <tigert@gimp.org>
177 \&      Andreas Nilsson <nisses.mail@home.se>
178 \&      Jakub Steiner <jimmac@novell.com>
179 \&
180 \&    GNOME icon theme is distributed under the terms of either
181 \&    GNU LGPL v.3 or Creative Commons BY\-SA 3.0 license.
182 .Ve
183 .IP "src/icons/favourite*, src/icons/alarm*, src/icons/collapse*, src/icons/expand*:" 4
184 .IX Item "src/icons/favourite*, src/icons/alarm*, src/icons/collapse*, src/icons/expand*:"
185 .Vb 2
186 \&    Copyright (C) 2012, Philipp Spitzer <philipp@toastfreeware.priv.at>
187 \&    Copyright (C) 2012, Stefan Strahl <stefan@toastfreeware.priv.at>
188 \&
189 \&    This program is free software; you can redistribute it and/or modify
190 \&    it under the terms of the GNU General Public License as published by
191 \&    the Free Software Foundation; either version 2 of the License, or
192 \&    (at your option) any later version.
193 .Ve