linkulator2/linkulator.1.html

92 lines
4.5 KiB
HTML
Executable File
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<html>
<head>General Commands Manual - LINKULATOR(1)</title></head>
<body bgcolor="#efefef">
<p>LINKULATOR(1)</p>
<p><b>NAME</b></p>
<blockquote>linkulator - a link aggregator for small, multi-user pubnixes (including tildes)</blockquote>
<p><b>SYNOPSIS</b></p>
<blockquote>linkulator [options]</blockquote>
<p><b>DESCRIPTION</b></p>
<blockquote>
<p>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.</p>
<p>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.</p>
</blockquote>
<p><b>USING LINKULATOR</b></p>
<blockquote>
<p>Linkulator is designed to make basic usage self-explanatory. Start the program by typing <b>/path/to/linkulator.sh</b> and a menu will appear at the bottom of the screen describing commands for viewing categories of links ([<b>#</b>]), posting links (<b>p</b>), searching through posts (<b>s</b>), or quitting (<b>q</b>). Other menus will allow you to move back a level (<b>m</b>), reply to a post (<b>r</b>), or view a link in the user-configured browser (<b>b</b>).</p>
</blockquote>
<p><b>OPTIONS</b></p>
<blockquote>
<b>-h, --help</b>
<blockquote>Display the help text.</blockquote>
</blockquote>
<p><b>CONFIGURATION AND CUSTOMIZATION</b></p>
<blockquote>
<p><b>Default Path settings</b></p>
<p>In the case where you have a custom location for user home directories, or want to change where Linkulator stores user data, Linkulators default settings can be easily changed to support this. The following options are found in the file config.py in the class DefaultPaths.</p>
<p><b>User home directory location</b></p>
<p><i>String all_homedir_pattern</i></p>
<p>Customise user home directory hierarchy. Default is /home/*/ to support a standard structure like /home/username/</p>
<p>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*/*/</p>
<p><b>Data directory name</b></p>
<p><i>String datadir</i></p>
<p>Customise the name of the directory where user data is stored. Default is .linkulator.</p>
<p><b>Data file</b></p>
<p><i>String datafile</i></p>
<p>Customise the name of the file where user links and replies are stored. Default is linkulator.data</p>
<p><b>Ignore file</b></p>
<p><i>String ignorefile</i></p>
<p>Customise the name of the file where ignored users are stored. Default is ignore</p>
<p><b>Settings file</b></p>
<p><i>String settingsfile</i></p>
<p>Customise the name of the file where user settings are stored. Default is linkulatorrc</p>
</blockquote>
<p><b>NOTES</b></p>
<blockquote>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 <i>ignore</i> files.</blockquote>
<p><b>BUGS</b></p>
<blockquote>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: <a href="https://tildegit.org/cmccabe/linkulator2">https://tildegit.org/cmccabe/linkulator2</a></blockquote>
<p><b>AUTHORS, INCLUDING YOU?</b></p>
<blockquote>Linkulator 2.0 was originally developed by cmccabe of <a href="https://rawtext.club">rawtext.club</a>, asdf of <a href="https://tilde.town">tilde.town</a> and sloum of <a href="gopher://colorfield.space">colorfield.space</a>. 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: <a href="https://tildegit.org/cmccabe/linkulator2">https://tildegit.org/cmccabe/linkulator2</a></blockquote>
<p>January 2020 - Version 2.0.0 - LINKULATOR(1)</p>
</body>
</html>