Skip to content

JadedCtrl/farend

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

7 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

===============================================================================
FAREND(.SH)
===============================================================================

Farend is a very simple todo-list program in shell.
It doesn't manage your todo-list; it can't delete, add, or edit events.
All it does is *display* them in a friendly way, ordered by earliest to latest.

By default, it will print a report listing β€œTODAY”'s events, followed by the
events of the following seven days. Anything not happening todayβ€” or in 7 daysβ€”
is ignored.

The idea is that it'll just take your todo-list text file, which you may fill
up with as many events as you want, and only print the immediately relevant
ones.


β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”
TODO FILE
β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”
TODO files are formatted like this:

	YYYY-MM-DD HH:MM Event description goes here.

You can use wildcard in any of the date slots; if you don't know the specific
date, to signfify it happens all day (*:*), to signify it's yearly (*-MM-DD),
etc etc.


β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”
USAGE
β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”
-l $LIMIT      | The amount of days you'd like to print events in advance (7)
-d $DIVIDER    | Set the divider string under headers (default is 40 "-" chars)
-T $TODAY_MSG  | Set the header title for today's events ("TODAY")
-L $LATER_MSG  | Set the header title to non-today upcoming events  ("NEXT")
-q             | Print upcoming events without dividers or headers ($*_MSG)
-h             | Print the help message

$ farend -l 100 -q /tmp/todo
# Will print upcoming events for the next 100 days, without headers or anything
# … usage goes on along those lines.


β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”
UTILS
β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”
The "utils/" folder contains some stuff I personally find useful that's related
to the project.

Right now, it just contains `ccal`, a frontend to `cal` that portably
highlights the current day (since it's not builtin in many versions).


β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”
BORING STUFF
β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”β€”
License is GPLv3-- check COPYING.txt.
Author is Jaidyn Ann <jadedctrl@posteo.at>
Sauce is at https://hak.xwx.moe/jadedctrl/farend