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