From 813d8dd0203a6972bdc09b5cd124964c1ceca065 Mon Sep 17 00:00:00 2001 From: gregor herrmann Date: Sat, 25 Jun 2011 19:35:18 +0000 Subject: [PATCH] Create a simple man page. --- ChangeLog | 8 +++ confclerk.pro | 8 ++- data/confclerk.pod | 119 +++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 133 insertions(+), 2 deletions(-) create mode 100644 data/confclerk.pod diff --git a/ChangeLog b/ChangeLog index 30d307b..33b96ad 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,11 @@ +2011-06-25 gregoa + + * README, TODO: Add URLs for FOSDEM 2011, DebConf 2010, and 27C3 to + README instead of TODO. + * TODO, src/fosdem.sql, src/schedule.en.xml: Remove the remaining + last two fosdem files. + * ChangeLog, README, TODO: Update contact info. + 2011-06-25 philipp * BUGS: Bugs are now reported in the trac system. diff --git a/confclerk.pro b/confclerk.pro index 0b06b89..8f2160c 100644 --- a/confclerk.pro +++ b/confclerk.pro @@ -13,7 +13,7 @@ SUBDIRS = src VERSION = 0.5.0 QMAKE_DISTCLEAN += src/bin/*.a -QMAKE_EXTRA_TARGETS += tarball icon changelog release +QMAKE_EXTRA_TARGETS += changelog icon man release tarball changelog.target = ChangeLog changelog.commands = \ @@ -24,6 +24,10 @@ icon.target = data/$${TARGET}.png icon.commands = convert data/$${TARGET}.svg data/$${TARGET}.png icon.depends = data/$${TARGET}.svg +man.target = data/$${TARGET}.1 +man.commands = pod2man --utf8 --center=\"Offlince conference scheduler\" --release=\"Version $${VERSION}\" data/$${TARGET}.pod > data/$${TARGET}.1 +man.depends = data/$${TARGET}.pod + release.depends = tarball tarball.target = $${TARGET}-$${VERSION}.tar.gz @@ -37,4 +41,4 @@ tarball.commands = \ $${TARGET}-$${VERSION}/Makefile ; \ tar -cz --exclude=.svn -f $$tarball.target $${TARGET}-$${VERSION} ; \ $(DEL_FILE) -r $${TARGET}-$${VERSION} -tarball.depends = changelog icon distclean +tarball.depends = changelog icon man distclean diff --git a/data/confclerk.pod b/data/confclerk.pod new file mode 100644 index 0000000..8606e2a --- /dev/null +++ b/data/confclerk.pod @@ -0,0 +1,119 @@ +=encoding utf8 + +=head1 NAME + +ConfClerk - offline conference scheduler + +=head1 SYNOPSIS + +B + +=head1 DESCRIPTION + +B is an application written in Qt, which makes conference +schedules available offline. It displays the conference schedule +from various views, support searches on various items (speaker, speech topic, +location, etc.) and enables you to select favorite events and create your own +schedule. + +At the moment B is able to import schedules in XML format created by +the PentaBarf conference management system used by e.g. FOSDEM, DebConf, and +the CCC. + +ConfClerk is targetted at mobile devices like the Nokia N810 and N900 but +works on any sytem running Qt. + +=head1 OPTIONS + +None. + +=head1 CONFIGURATION + +The configuration can be done via the graphical interface. + +The configuration is saved in the default QSettings location, i.e.: + +=over + +=item Linux + +F<~/.config/Toastfreeware/ConfClerk.conf> + +=item Windows + +In the registry (search for the Toastfreeware key, should be at +F). + +=item Other OS + +Cf. the QSettings documentation at +L. + +=back + +=head1 FILES + +B keeps its database in the location proposed by the XDG Base +Directory specification L: + +So the configuration (see L) is stored at +F<~/.config/Toastfreeware/ConfClerk.conf> and the database is kept at +F<~/.local/share/data/Toastfreeware/ConfClerk/ConfClerk.sqlite>. + +=head1 COPYRIGHT AND LICENSE + +=head2 Main code + + Copyright (C) 2010 Ixonos Plc. + Copyright (C) 2011, Philipp Spitzer + Copyright (C) 2011, gregor herrmann + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +=head2 Additional resources + +=over + +=item data/confclerk.*: + + Copyright (C) 2011, Christian Kling + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + +=item icons/* + +All icons are taken from the Debian package gnome-icon-theme, which contains +the following notice (as of 2011-06-24): + + Copyright © 2002-2008: + Ulisse Perusin + Riccardo Buzzotta + Josef Vybíral + Hylke Bons + Ricardo González + Lapo Calamandrei + Rodney Dawes + Luca Ferretti + Tuomas Kuosmanen + Andreas Nilsson + Jakub Steiner + + GNOME icon theme is distributed under the terms of either + GNU LGPL v.3 or Creative Commons BY-SA 3.0 license. + +=back -- 2.39.5