From 0bd0df22eeee485331353a9c31a54b81257317f9 Mon Sep 17 00:00:00 2001 From: Lars Wirzenius Date: Sun, 28 Apr 2013 09:51:06 +0100 Subject: Build manual page --- desktop-cronish.1.in | 62 ++++++++++++++++++++++++++++++++++++++++++++++++++++ setup.py | 20 ++++++++++++++++- 2 files changed, 81 insertions(+), 1 deletion(-) create mode 100644 desktop-cronish.1.in diff --git a/desktop-cronish.1.in b/desktop-cronish.1.in new file mode 100644 index 0000000..2024c3b --- /dev/null +++ b/desktop-cronish.1.in @@ -0,0 +1,62 @@ +.\" Copyright 2013 Lars Wirzenius +.\" +.\" 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 3 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, see . +.\" +.TH DESKTOP-CRONISH 1 +.SH NAME +desktop-cronish \- run periodic jobs in a desktop session +.SH SYNOPSIS +.SH DESCRIPTION +.BB desktop-cronish +runs periodic jobs in a desktop session. +It can be used to run +.BR offlineimap (1), +for example. +.SH OPTIONS +.SH EXAMPLE +To run +.BR offlineimap (1) +every minute, +and +.BR wotsap (1) +every week, +create the following file and call it foo.cronish: +.PP +.nf +.RS +offlineimap: + interval: 60 + timeout: 120 + command: offlineimap -u quiet + +wotsap: + trigger-file: /home/liw/.wotsapdb + trigger-age: 604800 + command: /home/liw/bin/update-wotsap +.RE +.fi +.PP +When you log into your desktop, open a terminal and run the following +command: +.PP +.nf +.RS +desktop-cronish foo.cronish +.RE +.fi +.PP +The command will run indefinitely, until you kill it with control-C. +.SH "SEE ALSO" +.BR fixme (1), +.BR fixme (7). diff --git a/setup.py b/setup.py index 995a3b8..0a46bfc 100644 --- a/setup.py +++ b/setup.py @@ -15,7 +15,22 @@ # with this program; if not, write to the Free Software Foundation, Inc., # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. -from distutils.core import setup +from distutils.core import setup, Extension +from distutils.command.build import build +import cliapp + + +class Build(build): + + def run(self): + build.run(self) + print 'building manpages' + for x in ['desktop-cronish']: + with open('%s.1' % x, 'w') as f: + cliapp.runcmd( + ['python', x, '--generate-manpage=%s.1.in' % x], + stdout=f) + setup(name='desktop-cronish', version='0.0', @@ -24,4 +39,7 @@ setup(name='desktop-cronish', author_email='liw@liw.fi', url='http://liw.fi/desktop-cronish/', scripts=['desktop-cronish'], + cmdclass={ + 'build': Build, + }, ) -- cgit v1.2.1