TICKR(1)

🌈 NAME 🌈

okay bestie, gather round — this is tickr, a GTK-based, highly graphically-customizable Feed Ticker. it's a General Commands Manual page, she's giving main character energy, and yes she will scroll your RSS across your desktop like a TV news bar 💅

---

✨ SYNOPSIS ✨

tickr [-help, -h, -? / -version, -v / -license, -l]
[-dumpfontlist / -dumpconfig / -dumperrorcodes]
[-instance-id=n / -no-ui]
[-connect-timeout=n / -sendrecv-timeout=n]
[options (-name[=value])...]
[resource (URL or file name)]

---

💖 DESCRIPTION 💖

so Tickr is a GTK-based RSS/Atom reader that takes your feeds and just... glides them across your Desktop as one smooth scrolling line. exactly like the TV stations do it. iconic behavior honestly 🎀

you can open feed links in your favourite Browser, and the Graphics are highly customizable — like, go off, make it yours.

---

🦋 OPTIONS 🦋

okay this is the big one, no skimming, bestie, every single flag is here 👑

• help — Get help page
• version — Print out version number
• license — Print out license
• dumpfontlist — Send list of available fonts to stdout
• dumpconfig — Send content of config file to stdout
• dumperrorcodes — Send error codes and strings to stdout
• instance-id=n — n = 1 to 99 — use this when launching several instances simultaneously, each instance using its own config and dump files. ⚠️ to be effective, instance-id must be the 1st argument
• no-ui — Disable opening of UI elements which can modify settings and/or URL list/selection. ⚠️ to be effective, no-ui must be the 1st or 2nd argument
• -connect-timeout=n — n = 1 to 60 (seconds) — Override default connect timeout value (= 5 seconds), useful if proxy or slow internet link
• -sendrecv-timeout=n — Same as above for send/recv timeout (default value = 1 second)
• delay=n — Delay in milliseconds (-> speed = K / delay)
• shiftsize=n — Shift size in pixels (-> speed = K x shift size)
• fgcolor=#rrggbbaa — Foreground 32-bit hexa color
• bgcolor=#rrggbbaa — Background 32-bit hexa color
• setgradientbg=[y/n] — Set gradient background
• bgcolor2=#rrggbbaa — Background 32-bit hexa color2
• fontname='fontname' — Font name
• fontsize=n — Font size (can't be > 200)
• disablescreenlimits=[y/n] — Allow win_x, win_y and win_w to be greater than screen dimensions
• win_x=n — Window position - x
• win_y=n — Window position - y
• win_w=n — Window width
• win_h=n — Window height (compute font size if > 0)
• windec=[y/n] — Window decoration
• alwaysontop=[y/n] — Window always-on-top
• fullscreen=[y/n] — Fullscreen mode (experimental)
• wintransparency=n — Actually window opacity from 1 to 10 (0 = none -> 10 = full)
• iconintaskbar=[y/n] — Icon in taskbar
• winsticky=[y/n] — Visible on all user desktops
• shadow=[y/n] — Apply shadow to text
• shadowoffset_x=n — Shadow x offset in pixels
• shadowoffset_y=n — Shadow y offset in pixels
• shadowfx=n — Shadow effect (0 = none -> 10 = full)
• linedelimiter='str' — String to be appended at end of line
• specialchars=[y/n] — Enable or disable special characters. This is only useful when resource is a file, not an URL
• newpgchar=c — ´New page' special character
• tabchar=c — ´Tab' (8 spaces) special character
• rssrefresh=n — Refresh rate in minutes = delay before reloading resource (URL or text file.) 0 = never force reload. Otherwise, apply only if no TTL inside feed or if resource is text file. (Actually, in multiple selections mode, all feeds are always reloaded sequentially, because there is no caching involved)
• revsc=[y/n] — Reverse scrolling (= L to R)
• feedtitle=[y/n] — Show or hide feed title
• feedtitledelimiter='str' — String to be appended after feed title
• itemtitle=[y/n] — Show or hide item title
• itemtitledelimiter='str' — String to be appended after item title
• itemdescription=[y/n] — Show or hide item description
• itemdescriptiondelimiter='str' — String to be appended after item description
• nitemsperfeed=n — Read N items max per feed (0 = no limit)
• rmtags=[y/n] — Strip html tags
• uppercasetext=[y/n] — Set all text to upper case
• homefeed='str' — Set URL as 'homefeed' = homepage (from command line, not automatically saved, so a little bit useless...)
• openlinkcmd='str' — ´Open in Browser' command line: Application that will open active link (may require path.) Most likely will invoke your favourite browser
• openlinkargs='str' — ´Open in Browser' optional arguments
• clock=[l/r/n] — Clock location: left / right / none
• clocksec=[y/n] — Show seconds
• clock12h=[y/n] — 12h time format
• clockdate=[y/n] — Show date
• clockaltdateform=[y/n] — Use alternative date format, ie 'Mon 01 Jan' instead of 'Mon Jan 01'
• clockfontname='fontname' — Clock font name
• clockfontsize=n — Clock font size (can't be > Tickr height)
• clockfgcolor=#rrggbbaa — Clock foreground 32-bit hexa color
• clockbgcolor=#rrggbbaa — Clock background 32-bit hexa color
• setclockgradientbg=[y/n] — Set clock gradient background
• clockbgcolor2=#rrggbbaa — Clock background 32-bit hexa color2
• disablepopups=[y/n] — Disable error/warning popup windows
• pauseonmouseover=[y/n] — Pause Tickr on mouseover
• disableleftclick=[y/n] — Disable left-click
• mousewheelaction=[s/f/n] — Mouse wheel acts on: (Tickr-)speed / feed(-in-list) / none (use <ctrl> + mouse wheel for alternative action)
• sfeedpickerautoclose=[y/n] — Selected feed picker window closes when pointer leaves area
• enablefeedordering=[y/n] — Enable feed re-ordering (by user)
• useauth=[y/n] — Use HTTP basic authentication
• user='str' — User
• psw='str' — Password (never saved)
• useproxy=[y/n] — Connect through proxy
• proxyhost='str' — Proxy host
• proxyport='str' — Proxy port
• useproxyauth=[y/n] — Use proxy authentication
• proxyuser='str' — Proxy user
• proxypsw='str' — Proxy password (never saved)

---

🎀 NOTES 🎀

🖱️ Mouse usage:

• To open the main menu, right-click inside Tickr area.
• You can import feed subscriptions from another feed reader with ´File > Import Feed List (OPML)'.
• To add a new feed, open 'File > Feed Organizer (RSS/Atom)', then look for 'New Feed -> Enter URL' at the bottom of the window, click 'Clear' and type or paste the feed URL.
• To open a link in your browser, left-click on text.
• Use mouse wheel to either adjust Tickr scrolling speed or open the ´Selected Feed Picker' window to quickly move between selected feeds (use <ctrl> + mouse wheel for alternative action.)
• Basically, use 'File > Feed Organizer (RSS|Atom)' to manage your feed list, select feeds, subscribe to new ones, and 'Edit > Preferences' to tweak Tickr appearance and behaviour.

📁 Local resources:

• file:///path/file_name is considered an URL and will be XML-parsed, ie a RSS or Atom format is expected.
• /path/file_name will be processed as a non-XML text file, ie the file will be read 'as is'.

---

You can set your favourite browser in the Full Settings window. Otherwise, the system default one will be looked for.

Tickr parses command line arguments and looks for option(s) then for one resource, the rest of the line is ignored. It also reads configuration file 'tickr-conf' located in /home/<user_name>/.tickr/ if it exists (or ´tickr-conf<n>' if an instance id has been set to n.) See FILES.

Command line options override configuration file ones which override default ones. — the hierarchy is real, bestie, respect the chain 🫶

---

💜 FILES 💜

~/.tickr/tickr-conf
~/.tickr/tickr-conf<n>
~/.tickr/tickr-url-list
~/.tickr/tickr-url-list<n>

---

😭 REPORTING BUGS 😭

Please, report tickr bugs to either Emmanuel Thomas-Maurin <manutm007@gmail.com> or Debian.

(not me asking you to file a bug report but like, respectfully, do it 💖)

---

👑 AUTHOR 👑

Tickr was written by Emmanuel Thomas-Maurin <manutm007@gmail.com>.

This manual page was written by Emmanuel Thomas-Maurin <manutm007@gmail.com>, for the Debian project (and may be used by others).

---

and that's the whole page, periodt 🎀 TICKR(1) from the General Commands Manual — dated Apr 20, 2021. slay, go scroll some feeds, mwah 💅✨🌸