General Commands Manual - LINKULATOR(1)
LINKULATOR(1)
NAME
linkulator - a link aggregator for small, multi-user pubnixes (including tildes)
SYNOPSIS
linkulator [options]
DESCRIPTION
Linkulator is a link aggregator for small multi-user, shell-based servers like pubnixes. It was inspired by web-based link aggregators like Y Combinator Hacker New and Lobste.rs, with the difference being that Linkulator is designed for the non-web.
Users can submit links along with a title and category, and browse or leave comments about links that have been posted by others. Using the user-configured browser (default is Lynx), users can view links directly in Linkulator. Linkulator has been tested with both html and gopher links, but may work with many other resource types, including file system paths.
USING LINKULATOR
Linkulator is designed to make basic usage self-explanatory. Start the program by typing /path/to/linkulator.sh and a menu will appear at the bottom of the screen describing commands for viewing categories of links ([#]), posting links (p), searching through posts (s), or quitting (q). Other menus will allow you to move back a level (m), reply to a post (r), or view a link in the user-configured browser (b).
OPTIONS
-h, --helpDisplay the help text.
CONFIGURATION AND CUSTOMIZATION
Default Path settings
In the case where you have a custom location for user home directories, or want to change where Linkulator stores user data, Linkulator’s default settings can be easily changed to support this. The following options are found in the file config.py in the class DefaultPaths.
User home directory location
String all_homedir_pattern
Customise user home directory hierarchy. Default is /home/*/ to support a standard structure like /home/username/
For example, you may have home directories in a location like /userdata/(first letter)/(username) i.e. /userdata/a/auser. The glob pattern would need to be updated to /userdata/i*/*/
Data directory name
String datadir
Customise the name of the directory where user data is stored. Default is .linkulator.
Data file
String datafile
Customise the name of the file where user links and replies are stored. Default is linkulator.data
Ignore file
String ignorefile
Customise the name of the file where ignored users are stored. Default is ignore
Settings file
String settingsfile
Customise the name of the file where user settings are stored. Default is linkulatorrc
NOTES
Linkulator was designed with a decentralized data store model, meaning that each user's content is stored in their home directory. Each user has control of their data at all times and can change it at any time. This can be helpful if a user needs to go back and correct typographical errors or to add clarifying langauge to a post. It can also be abused, however. A user could change the meaning of their posts, thereby disrupting the aggregate meaning of link/comment threads. Don't abuse this or you will likely end up on a lot of ignore files.
BUGS
Of course there are bugs. If you find one, please describe it in as much detail as possible and report it via Linkulator's Gitea repo: https://tildegit.org/cmccabe/linkulator2
AUTHORS, INCLUDING YOU?
Linkulator 2.0 was originally developed by cmccabe of rawtext.club, asdf of tilde.town and sloum of colorfield.space. But Linkulator is a collaborative project and contributions from others may have been integrated by the time you are reading this. You can contribute as well! Submit code or issues through TildeGit: https://tildegit.org/cmccabe/linkulator2
January 2020 - Version 2.0.0 - LINKULATOR(1)