Home Explore Help
Register Sign In
jadedctrl
/
farend
mirror of https://git.xwx.moe/c/farend
Watch 1
Star 0
Fork 0
Files Issues 0 Wiki
Branch: master
Branches Tags
farend
/
README.txt

README.txt 2.8 KB
Permalink History Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061 
  1. ===============================================================================
    2. 

  2. FAREND(.SH)
    3. 

  3. ===============================================================================
    4. 

  4. 

  5. Farend is a very simple todo-list program in shell.
    6. 

  6. It doesn't manage your todo-list; it can't delete, add, or edit events.
    7. 

  7. All it does is *display* them in a friendly way, ordered by earliest to latest.
    8. 

  8. 

  9. By default, it will print a report listing “TODAY”'s events, followed by the
    10. 

  10. events of the following seven days. Anything not happening today— or in 7 days—
    11. 

  11. is ignored.
    12. 

  12. 

  13. The idea is that it'll just take your todo-list text file, which you may fill
    14. 

  14. up with as many events as you want, and only print the immediately relevant
    15. 

  15. ones.
    16. 

  16. 

  17. 

  18. ————————————————————————————————————————
    19. 

  19. TODO FILE
    20. 

  20. ————————————————————————————————————————
    21. 

  21. TODO files are formatted like this:
    22. 

  22. 

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

  24. 

  25. You can use wildcard in any of the date slots; if you don't know the specific
    26. 

  26. date, to signfify it happens all day (*:*), to signify it's yearly (*-MM-DD),
    27. 

  27. etc etc.
    28. 

  28. 

  29. 

  30. ————————————————————————————————————————
    31. 

  31. USAGE
    32. 

  32. ————————————————————————————————————————
    33. 

  33. -l $LIMIT      | The amount of days you'd like to print events in advance (7)
    34. 

  34. -d $DIVIDER    | Set the divider string under headers (default is 40 "-" chars)
    35. 

  35. -T $TODAY_MSG  | Set the header title for today's events ("TODAY")
    36. 

  36. -L $LATER_MSG  | Set the header title to non-today upcoming events  ("NEXT")
    37. 

  37. -q             | Print upcoming events without dividers or headers ($*_MSG)
    38. 

  38. -h             | Print the help message
    39. 

  39. 

  40. $ farend -l 100 -q /tmp/todo
    41. 

  41. # Will print upcoming events for the next 100 days, without headers or anything
    42. 

  42. # … usage goes on along those lines.
    43. 

  43. 

  44. 

  45. ————————————————————————————————————————
    46. 

  46. UTILS
    47. 

  47. ————————————————————————————————————————
    48. 

  48. The "utils/" folder contains some stuff I personally find useful that's related
    49. 

  49. to the project.
    50. 

  50. 

  51. Right now, it just contains `ccal`, a frontend to `cal` that portably
    52. 

  52. highlights the current day (since it's not builtin in many versions).
    53. 

  53. 

  54. 

  55. ————————————————————————————————————————
    56. 

  56. BORING STUFF
    57. 

  57. ————————————————————————————————————————
    58. 

  58. License is GPLv3-- check COPYING.txt.
    59. 

  59. Author is Jaidyn Ann <jadedctrl@teknik.io>
    60. 

  60. Sauce is at https://git.xwx.moe/farend.git
    61. 

  61.