aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMattias Andrée <m@maandree.se>2026-02-22 14:37:25 +0100
committerMattias Andrée <m@maandree.se>2026-02-22 14:37:25 +0100
commitdeb939689ef825687d09bf93600d465f4e6e98ab (patch)
tree1650ef24eeb19c83119ee43e8d96481c89614b64
parentchange license, replace info with man, simplify makefile (diff)
downloadsysrss-deb939689ef825687d09bf93600d465f4e6e98ab.tar.gz
sysrss-deb939689ef825687d09bf93600d465f4e6e98ab.tar.bz2
sysrss-deb939689ef825687d09bf93600d465f4e6e98ab.tar.xz
Signed-off-by: Mattias Andrée <m@maandree.se>
-rw-r--r--README15
-rwxr-xr-xsysrss16
-rw-r--r--sysrss.116
3 files changed, 24 insertions, 23 deletions
diff --git a/README b/README
index 66e1aa9..2d71c90 100644
--- a/README
+++ b/README
@@ -5,9 +5,10 @@ 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 lets the user set up routines, written in Python 3, that run
+ periodically to generate entries in an RSS feed that the user can
+ syndicate to in his RSS aggregator (an 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).
@@ -24,15 +25,15 @@ OPERANDS
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.
+ user. It contains the tasks that shall be run periodically.
+ It is a Python 3 file.
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
+ interval, function)), where title is what 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 string returned by your function shall be the message of
the generated RSS news item. If the empty string is returned, no
news item is generated.
diff --git a/sysrss b/sysrss
index a4cf98f..1ecdfd9 100755
--- a/sysrss
+++ b/sysrss
@@ -103,7 +103,7 @@ class SysRSS:
if not os.path.isfile(self.root + 'log'):
with open(self.root + 'log', 'wb') as file:
file.flush()
- printf('Created log file, %s, it contains ever thing that have ever happend, ever.\n', self.root + 'log')
+ printf('Created log file, %s, it contains everthing that has ever happend, ever.\n', self.root + 'log')
flush()
if not os.path.isfile(self.root + 'maintenance.rss'):
@@ -123,7 +123,7 @@ class SysRSS:
file.write('</rss>\n'.encode('utf-8'))
file.write('\n'.encode('utf-8'))
file.flush()
- printf('Created rss file, %s, your should set you news feed aggregator to syndicate this file.\n', self.root + 'maintenance.rss')
+ printf('Created rss file, %s, you should set your news feed aggregator to syndicate this file.\n', self.root + 'maintenance.rss')
flush()
self.pubdate = date
self.publish('Welcome to SysRSS', 'This is going to be so awesome! 😄 \n\nEx animo\nSysRSS\n\n')
@@ -156,13 +156,13 @@ class SysRSS:
file.write('# -*- mode: python, coding: utf-8 -*-\n'.encode('utf-8'))
file.write('\n'.encode('utf-8'))
file.write('# self.sites (alternatively sites) is a list that you\n'.encode('utf-8'))
- file.write('# should fill with Site:s, a site descripts a subsystem\n'.encode('utf-8'))
+ file.write('# should fill with Site:sM a site describes a subsystem\n'.encode('utf-8'))
file.write('# that generates updates. Site\'s constructor takes 3\n'.encode('utf-8'))
file.write('# arguments: name, interval, implementation. The first\n'.encode('utf-8'))
- file.write('# `name` is the name of the subsystme, it is displayed\n'.encode('utf-8'))
+ file.write('# `name` is the name of the subsystem; it is displayed\n'.encode('utf-8'))
file.write('# as the title on all updates. `interval` is the number\n'.encode('utf-8'))
- file.write('# is minutes between update checks. `implementation` is\n'.encode('utf-8'))
- file.write('# function or functor that returns an update message,\n'.encode('utf-8'))
+ file.write('# of minutes between update checks. `implementation` is\n'.encode('utf-8'))
+ file.write('# a function or functor that returns an update message,\n'.encode('utf-8'))
file.write('# or an empty string if there are no updates.\n'.encode('utf-8'))
file.write('\n'.encode('utf-8'))
file.flush()
@@ -185,7 +185,7 @@ class SysRSS:
with open(self.root + 'log', 'ab') as file:
file.write(addendum)
file.flush()
- printf('The feed log as been updated with %s.\n', system)
+ printf('The feed log has been updated with %s.\n', system)
with open(self.root + 'tmp', 'wb') as file:
file.write('<?xml version="1.0" encoding="utf-8"?>\n'.encode('utf-8'))
@@ -203,7 +203,7 @@ class SysRSS:
file.write('\n'.encode('utf-8'))
file.flush()
Popen(['mv', self.root + 'tmp', self.root + 'maintenance.rss']).wait()
- printf('The feed as been updated with %s.\n', system)
+ printf('The feed has been updated with %s.\n', system)
'''
diff --git a/sysrss.1 b/sysrss.1
index 30fd58d..bf8afdd 100644
--- a/sysrss.1
+++ b/sysrss.1
@@ -1,15 +1,15 @@
-.TH SYSRSS 1
+.TH SYSRSS 1 SYSRSS
.SH NAME
-sysrss \- Let your system generate a maintenance notification RSS
+sysrss \- Let your system generate a maintenance notification RSS feed
.SH SYNOPSIS
.B sysrss
.SH DESCRIPTION
.B 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
+lets the user set up routines, written in Python 3, that run
+periodically to generate entries in an RSS feed that the user
+can syndicate to in his RSS aggregator (an e-mail client can
usually do this).
.PP
.B sysrss
@@ -30,19 +30,19 @@ None.
.TP
.IB $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.
+It contains the tasks that shall be run periodically. It is a Python 3 file.
To add a task, write a function that doesn't have any parameters but
returns a string, then run
.IR "self.sites.append(Site(title, interval, function))" ,
where
.I title
-is the that the generated RSS news item should have,
+is what the generated RSS news item should have,
.I interval
is the number of minutes between each run of the job, and
.I function
is the name of your function.
-The string returned by the your function shall be the
+The string returned by your function shall be the
message of the generated RSS news item. If the empty string
is returned, no news item is generated.