README
¶
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<meta name="generator" content=
"HTML Tidy for HTML5 for Linux version 5.7.45" />
<!-- 2023-08-14 Mon 07:08 -->
<meta http-equiv="Content-Type" content=
"text/html; charset=utf-8" />
<meta name="viewport" content=
"width=device-width, initial-scale=1" />
<title>rssc - rss customizer</title>
<meta name="author" content="Salih Muhammed" />
<meta name="generator" content="Org Mode" />
<style>
<![CDATA[
#content { max-width: 60em; margin: auto; }
.title { text-align: center;
margin-bottom: .2em; }
.subtitle { text-align: center;
font-size: medium;
font-weight: bold;
margin-top:0; }
.todo { font-family: monospace; color: red; }
.done { font-family: monospace; color: green; }
.priority { font-family: monospace; color: orange; }
.tag { background-color: #eee; font-family: monospace;
padding: 2px; font-size: 80%; font-weight: normal; }
.timestamp { color: #bebebe; }
.timestamp-kwd { color: #5f9ea0; }
.org-right { margin-left: auto; margin-right: 0px; text-align: right; }
.org-left { margin-left: 0px; margin-right: auto; text-align: left; }
.org-center { margin-left: auto; margin-right: auto; text-align: center; }
.underline { text-decoration: underline; }
#postamble p, #preamble p { font-size: 90%; margin: .2em; }
p.verse { margin-left: 3%; }
pre {
border: 1px solid #e6e6e6;
border-radius: 3px;
background-color: #f2f2f2;
padding: 8pt;
font-family: monospace;
overflow: auto;
margin: 1.2em;
}
pre.src {
position: relative;
overflow: auto;
}
pre.src:before {
display: none;
position: absolute;
top: -8px;
right: 12px;
padding: 3px;
color: #555;
background-color: #f2f2f299;
}
pre.src:hover:before { display: inline; margin-top: 14px;}
/* Languages per Org manual */
pre.src-asymptote:before { content: 'Asymptote'; }
pre.src-awk:before { content: 'Awk'; }
pre.src-authinfo::before { content: 'Authinfo'; }
pre.src-C:before { content: 'C'; }
/* pre.src-C++ doesn't work in CSS */
pre.src-clojure:before { content: 'Clojure'; }
pre.src-css:before { content: 'CSS'; }
pre.src-D:before { content: 'D'; }
pre.src-ditaa:before { content: 'ditaa'; }
pre.src-dot:before { content: 'Graphviz'; }
pre.src-calc:before { content: 'Emacs Calc'; }
pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
pre.src-fortran:before { content: 'Fortran'; }
pre.src-gnuplot:before { content: 'gnuplot'; }
pre.src-haskell:before { content: 'Haskell'; }
pre.src-hledger:before { content: 'hledger'; }
pre.src-java:before { content: 'Java'; }
pre.src-js:before { content: 'Javascript'; }
pre.src-latex:before { content: 'LaTeX'; }
pre.src-ledger:before { content: 'Ledger'; }
pre.src-lisp:before { content: 'Lisp'; }
pre.src-lilypond:before { content: 'Lilypond'; }
pre.src-lua:before { content: 'Lua'; }
pre.src-matlab:before { content: 'MATLAB'; }
pre.src-mscgen:before { content: 'Mscgen'; }
pre.src-ocaml:before { content: 'Objective Caml'; }
pre.src-octave:before { content: 'Octave'; }
pre.src-org:before { content: 'Org mode'; }
pre.src-oz:before { content: 'OZ'; }
pre.src-plantuml:before { content: 'Plantuml'; }
pre.src-processing:before { content: 'Processing.js'; }
pre.src-python:before { content: 'Python'; }
pre.src-R:before { content: 'R'; }
pre.src-ruby:before { content: 'Ruby'; }
pre.src-sass:before { content: 'Sass'; }
pre.src-scheme:before { content: 'Scheme'; }
pre.src-screen:before { content: 'Gnu Screen'; }
pre.src-sed:before { content: 'Sed'; }
pre.src-sh:before { content: 'shell'; }
pre.src-sql:before { content: 'SQL'; }
pre.src-sqlite:before { content: 'SQLite'; }
/* additional languages in org.el's org-babel-load-languages alist */
pre.src-forth:before { content: 'Forth'; }
pre.src-io:before { content: 'IO'; }
pre.src-J:before { content: 'J'; }
pre.src-makefile:before { content: 'Makefile'; }
pre.src-maxima:before { content: 'Maxima'; }
pre.src-perl:before { content: 'Perl'; }
pre.src-picolisp:before { content: 'Pico Lisp'; }
pre.src-scala:before { content: 'Scala'; }
pre.src-shell:before { content: 'Shell Script'; }
pre.src-ebnf2ps:before { content: 'ebfn2ps'; }
/* additional language identifiers per "defun org-babel-execute"
in ob-*.el */
pre.src-cpp:before { content: 'C++'; }
pre.src-abc:before { content: 'ABC'; }
pre.src-coq:before { content: 'Coq'; }
pre.src-groovy:before { content: 'Groovy'; }
/* additional language identifiers from org-babel-shell-names in
ob-shell.el: ob-shell is the only babel language using a lambda to put
the execution function name together. */
pre.src-bash:before { content: 'bash'; }
pre.src-csh:before { content: 'csh'; }
pre.src-ash:before { content: 'ash'; }
pre.src-dash:before { content: 'dash'; }
pre.src-ksh:before { content: 'ksh'; }
pre.src-mksh:before { content: 'mksh'; }
pre.src-posh:before { content: 'posh'; }
/* Additional Emacs modes also supported by the LaTeX listings package */
pre.src-ada:before { content: 'Ada'; }
pre.src-asm:before { content: 'Assembler'; }
pre.src-caml:before { content: 'Caml'; }
pre.src-delphi:before { content: 'Delphi'; }
pre.src-html:before { content: 'HTML'; }
pre.src-idl:before { content: 'IDL'; }
pre.src-mercury:before { content: 'Mercury'; }
pre.src-metapost:before { content: 'MetaPost'; }
pre.src-modula-2:before { content: 'Modula-2'; }
pre.src-pascal:before { content: 'Pascal'; }
pre.src-ps:before { content: 'PostScript'; }
pre.src-prolog:before { content: 'Prolog'; }
pre.src-simula:before { content: 'Simula'; }
pre.src-tcl:before { content: 'tcl'; }
pre.src-tex:before { content: 'TeX'; }
pre.src-plain-tex:before { content: 'Plain TeX'; }
pre.src-verilog:before { content: 'Verilog'; }
pre.src-vhdl:before { content: 'VHDL'; }
pre.src-xml:before { content: 'XML'; }
pre.src-nxml:before { content: 'XML'; }
/* add a generic configuration mode; LaTeX export needs an additional
(add-to-list 'org-latex-listings-langs '(conf " ")) in .emacs */
pre.src-conf:before { content: 'Configuration File'; }
table { border-collapse:collapse; }
caption.t-above { caption-side: top; }
caption.t-bottom { caption-side: bottom; }
td, th { vertical-align:top; }
th.org-right { text-align: center; }
th.org-left { text-align: center; }
th.org-center { text-align: center; }
td.org-right { text-align: right; }
td.org-left { text-align: left; }
td.org-center { text-align: center; }
dt { font-weight: bold; }
.footpara { display: inline; }
.footdef { margin-bottom: 1em; }
.figure { padding: 1em; }
.figure p { text-align: center; }
.equation-container {
display: table;
text-align: center;
width: 100%;
}
.equation {
vertical-align: middle;
}
.equation-label {
display: table-cell;
text-align: right;
vertical-align: middle;
}
.inlinetask {
padding: 10px;
border: 2px solid gray;
margin: 10px;
background: #ffffcc;
}
#org-div-home-and-up
{ text-align: right; font-size: 70%; white-space: nowrap; }
textarea { overflow-x: auto; }
.linenr { font-size: smaller }
.code-highlighted { background-color: #ffff00; }
.org-info-js_info-navigation { border-style: none; }
#org-info-js_console-label
{ font-size: 10px; font-weight: bold; white-space: nowrap; }
.org-info-js_search-highlight
{ background-color: #ffff00; color: #000000; font-weight: bold; }
.org-svg { }
]]>
</style>
<script>
<![CDATA[
window.MathJax = {
tex: {
ams: {
multlineWidth: '85%'
},
tags: 'ams',
tagSide: 'right',
tagIndent: '.8em'
},
chtml: {
scale: 1.0,
displayAlign: 'center',
displayIndent: '0em'
},
svg: {
scale: 1.0,
displayAlign: 'center',
displayIndent: '0em'
},
output: {
font: 'mathjax-modern',
displayOverflow: 'overflow'
}
};
]]>
</script>
<script id="MathJax-script" async="async" src=
"https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
</head>
<body>
<div id="content" class="content">
<h1 class="title">rssc - rss customizer</h1>
<p>rssc provides a real-time, self-hostable regex-oriented
customization service for atom, rss and json feeds.</p>
<div id="outline-container-org8e7e0c0" class="outline-2">
<h2 id="org8e7e0c0">Usage</h2>
<div class="outline-text-2" id="text-org8e7e0c0">
<p>rssc uses get request parameters to read user’s preferences.
following are the supported parameters:</p>
<ul class="org-ul">
<li><code>src</code>: the source URL of the feeds. Example:
<a href="https://hnrss.org/newest">https://hnrss.org/newest</a></li>
<li><code>t</code>: the type of desired source, can be
<code>rss</code>, <code>atom</code> or <code>json</code>.</li>
<li><code>descriptionf</code>: regular expression filter to filter
feeds based on the description property.</li>
<li><code>titlef</code>: regular expression filter to filter feeds
based on the title property.</li>
<li><code>contentf</code>: regular expression filter to filter
feeds based on the content property.</li>
<li><code>net</code>: boolean (1 or 0) (default to 0 when omitted)
whether to use the .NET engine regex instead of Go’s.</li>
</ul>
<p>All regex should be valid <a href=
"https://github.com/google/re2/wiki/Syntax">RE2 regex syntax</a>
(in case of <code>net</code>, see <a href=
"https://learn.microsoft.com/en-us/dotnet/standard/base-types/regular-expression-language-quick-reference">
MS’ Regular Expression Language</a>).</p>
</div>
</div>
<div id="outline-container-org20e3089" class="outline-2">
<h2 id="org20e3089">Examples</h2>
<div class="outline-text-2" id="text-org20e3089">
<p>Replace <a href=
"https://rssc.fly.dev/">https://rssc.fly.dev/</a> in the following
examples with your instance of rssc (can be a
<code>localhost:8080</code> if self-hosted).</p>
<ul class="org-ul">
<li>
<p>Get Edward Snowden tweets that mention the CIA:</p>
<p><a href=
"https://rssc.fly.dev/rss?src=https://nitter.lacontrevoie.fr/Snowden/rss&descriptionf=CIA">
https://rssc.fly.dev/rss?src=https://nitter.lacontrevoie.fr/Snowden/rss&descriptionf=CIA</a></p>
</li>
<li>
<p>Get all new feeds that contain the word “emacs” but not the word
“vim”, and not posted by user lr0 (hnrss.org does not provide a
creator/author property, so the author filter here is only for a
demonstration purpose.):</p>
<p><a href=
"https://rssc.fly.dev/rss?src=https://hnrss.org/newest?q=emacs&titlef=%5E(?!.*%5Cbvim%5Cb).*%5CbEmacs%5Cb.*&net=1&authorf=%5E(?!.*%5Cblr0%5Cb).*$">
https://rssc.fly.dev/rss?src=https://hnrss.org/newest?q=emacs&titlef=^(?!.*\bvim\b).*\bEmacs\b.*&net=1&authorf=^(?!.*\blr0\b).*$</a></p>
<p>Note that <code>net</code> is used here because RE2 does not
support lookarounds.</p>
</li>
<li>
<p>Get only posts about OpenAI from 4chan’s g board:</p>
<p><a href=
"https://rssc.fly.dev/rss?src=https://boards.4channel.org/g/index.rss&titlef=Open%5Cs?AI%7COpenAI">
https://rssc.fly.dev/rss?src=https://boards.4channel.org/g/index.rss&titlef=Open\s?AI|OpenAI</a></p>
</li>
<li>
<p>Get geopolitical updates from your favorite hacker and skip all
free software movement goody propaganda:</p>
<p><a href=
"https://rssc.fly.dev/rss?src=https://stallman.org/rss/rss.xml&contentf=%5E(?=.*(?:palestine%7Csyria%7Cegypt%7Ciraq%7Cisrael%7Calgeria%7Cmorocco))(?!.*(?:linux%7Cgnu%7Csoftware%7Cprogramming%7Cprogram)).*$&net=1">
https://rssc.fly.dev/rss?src=https://stallman.org/rss/rss.xml&contentf=^(?=.*(?:palestine|syria|egypt|iraq|israel|algeria|morocco))(?!.*(?:linux|gnu|software|programming|program)).*$&net=1</a></p>
</li>
<li>
<p>Get BBC middle east updates that’s only related to
Palestine:</p>
<p><a href=
"https://rssc.fly.dev/rss?src=http://feeds.bbci.co.uk/news/world/middle_east/rss.xml&titlef=(?i)palestine%7Cpalestinian%7Cgaza">
https://rssc.fly.dev/rss?src=http://feeds.bbci.co.uk/news/world/middle_east/rss.xml&titlef=(?i)palestine|palestinian|gaza</a></p>
</li>
</ul>
</div>
</div>
<div id="outline-container-org84dfde3" class="outline-2">
<h2 id="org84dfde3">Notes</h2>
<div class="outline-text-2" id="text-org84dfde3">
<ul class="org-ul">
<li>RE2 is much safer that the .NET Regex, that’s to say, all the
good features that .NET engine enables you to use come with a risk
cost and ends up enabling <a href=
"https://github.com/dlclark/regexp2#catastrophic-backtracking-and-timeouts">
catastrophic backtracking</a>, therefore a timeout of 5 seconds is
currently enabled on fly.dev instance when using
<code>net=1</code>.</li>
</ul>
</div>
</div>
</div>
<div id="postamble" class="status">
<p class="author">Author: Salih Muhammed</p>
<p class="date">Created: 2023-08-14 Mon 07:08</p>
</div>
</body>
</html>
Documentation
¶
There is no documentation for this package.
Source Files
Click to show internal directories.
Click to hide internal directories.