software.frrobert.com Git - lace/blob - README.md

   1 Forked from https://gitlab.com/uoou/dotfiles/-/blob/master/stow/bin/home/drew/.local/bin/lace
   2
   3 Lace is a small script to interlace Gemini Capsule micro blogs.
   4
   5 Enhancements made to the original lace with this fork.
   6
   7 The original lace would not run on Linux distributions running sed 3.7 or on Termux on Android.
   8
   9 Lace can now run on either a standard Linux distributions running sed 3.7, Termux on android, and UserLAnd on Android.  Sed, date, openssl, curl, less are dependencies that need to be installed.
  10
  11 The original script showed how long ago a entry was posted. Lace now shows how long ago a post occurred and the date and time of the post.
  12
  13 ### Directions
  14
  15 There are three bash scripts that make up the lace family, lace, laced, and lacedreader.
  16
  17 lace is a standalone program.
  18
  19 To use lace put it in your path and make it executable
  20
  21 lace will read subscriptions
  22
  23 lace nope will read subscriptions without less
  24
  25 lace subs will list subscriptions\n"
  26
  27 lace sub nickname url will - add subscription, e.g.:lace sub Drew gemini://friendo.monster/tiny.gmi
  28
  29 lace unsub nickname will remove subscription, e.g.:lace unsub Drew
  30
  31 lace update will redownload script to location of current script (might need sudo, depending on location)
  32
  33 ---------------------------------------------
  34 laced and lacereader are programs designed to be used together.
  35
  36 To use laced and lacereader put both programs in your path and make them executable
  37
  38 laced is designed to be executed as a cron job.  Rather than running lace and waiting for all the micro blogs to be downloaded and sorted your can run laced as a cron job.  laced will store the downloaded and sorted microblogs in a file.  lacedreader is designed to read the file and present the file to you in less.
  39
  40 laced has the option of "laced strict" lace and lacedadds color codes that less uses to present colors to the user.  lace and laced are programs that are meant to be hacked on to meet your needs.  I added the strict option to not add the color codes which an not Gemini compliant.  This way if you want to configure your Gemini browser to open the file, the file will appear as valid Gemini.
  41
  42 For lace to read microblogs they should be in the following format. You do not need to use UTC but is the peferred format.  You can use other formats such as EST or EDT and lace will do it best to calculate the time since not all time zone code abbreviations are unique.
  43
  44 # Fr. Robert's Microblog
  45
  46 ## Tue 18 May 2021 19:31 UTC
  47 I have joined the Fediverse my instance is at https://social.frrobert.com/channel/frrobert
  48
  49 ## Tue 18 May 2021 19:29 UTC
  50 @Toby there is there is an additional program call khard that is a contact list that works with pim utils.  It was developed by someone else but it works fine with vdirsyncer.  I have been using all the programs for several years and I second your endorsement of them.
  51
  52 ## Mon 17 May 2021 19:32 UTC
  53 =>gemini://frrobert.net/log/trendythoughts-2021-05-16-1607.gmi This week's Trendy Thoughts are out
  54
  55 ----------------
  56
  57 How lace results appear.
  58
  59 8 hours ago
  60 Tue 18 May 2021 04:22:00 PM EDT
  61 🚀 hexdsl (hexdsl.co.uk)
  62 I like cheese, like, more than most
  63
  64 18 hours ago
  65 Tue 18 May 2021 03:31:00 PM EDT
  66 ☦ frrobert (frrobert.net)
  67 I have joined the Fediverse my instance is at https://social.frrobert.com/channel/frrobert
  68
  69 19 hours ago
  70 Tue 18 May 2021 03:29:00 PM EDT
  71 ☦ frrobert (frrobert.net)
  72 @Toby there is there is an additional program call khard that is a contact list that works with pim utils.  It was developed by someone else but it works fine with vdirsyncer.  I have been using all the programs for several years and I second your endorsement of them.
  73
  74 25 hours ago
  75 Tue 18 May 2021 09:12:18 AM EDT
  76 🐘 Adele (adele.work)
  77 Hey, I test my online tinylog editor ! It works with a simple gemini browser !
  78
  79
  80 ### Favicons
  81
  82 Lace may show the actual code for a favicon rather than the icon itself depending on the version of GNU less and/or fonts installed. If this happens you can either install a font that supports the favicon or comment out the following line in the script.
  83
  84 ```
  85 fav=$(openssl s_client -crlf -quiet -connect "$domain:1965" <<<"gemini://$domain/favicon.txt" 2>/dev/null | sed -e '1d')
  86 ```
  87 Since favicons are not part of the Gemini standard, you may not want favicons to display.  Commenting out the above line of code will prevent favicons from displaying.
  88
  89 ### Updates
  90
  91 2012-05-?? I added the strict option to laced.  If you use laced strict the file that is created is a true gemini formatted file without the color codes used by the lacedreader.
  92
  93 2021-05-03 I added laced and lacedreader.  laced will download microblogs but will not open them for reading.  It is designed to be used with crontab. lacedreader is the reader to be used with the laced.
  94
  95 2021-04-28 I added the logic that if the server times out on the first connect to skip the second connect.
  96
  97 2021-04-27 I added a timeout variable in that is used with the timeout command to timeout connecting after a designated time to an unresponsive server.  If the value for the variable is a number it is in seconds if it is a number followed by a m then it is in minutes.
  98
  99 ### Post about original script.
 100
 101 https://friendo.monster/posts/a-script-to-interleave-tiny-gemini-logs.html
 102