summaryrefslogtreecommitdiff
path: root/desktop-cronish.1.in
diff options
context:
space:
mode:
Diffstat (limited to 'desktop-cronish.1.in')
-rw-r--r--desktop-cronish.1.in62
1 files changed, 62 insertions, 0 deletions
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 <liw@liw.fi>
+.\"
+.\" 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 <http://www.gnu.org/licenses/>.
+.\"
+.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).