diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 50 |
1 files changed, 49 insertions, 1 deletions
@@ -1 +1,49 @@ -Let your system generate a maintenance notification RSS +NAME + sysrss - Let your system generate a maintenance notification RSS + +SYNOPSIS + sysrss + +DESCRIPTION + sysrss lets the user setup routines, written in Python 3, that run + periodically to generate entires in an RSS feed that the use can + syndicate to in his RSS aggregator (e-mail client can usually do this). + + sysrss runs in the foreground, and should be daemonised externally + (unless you actually want it in the foreground). + + sysrss runs as a user process, meaning that each user using it must + have their own instance started individually. + +OPTIONS + None. + +OPERANDS + None. + +FILES + $HOME/.sysrss/sites + Created when the program is started for the first time by the + user. It contains the tasks that shall be ran periodically. + It's a Python 3. + + To add a task, write a function that doesn't have any parameters + but returns a string, then run self.sites.append(Site(title, + interval, function)), where title is the that the generated RSS + news item should have, interval is the number of minutes between + each run of the job, and function is the name of your function. + The string returned by the your function shall be the message of + the generated RSS news item. If the empty string is returned, no + news item is generated. + + $HOME/.sysrss/log + Log file. + + $HOME/.sysrss/maintenance.rss + RSS-feed to add to your RSS aggregator to get your notifications. + + $HOME/.sysrss/tmp + Reserved temporary file. + +SEE ALSO + None. |