A CLI todo manager
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

38 lines
736 B

  1. .\" Man page for the todo utility ./todo.1
  2. .TH TODO 1
  3. .SH NAME
  4. todo \- manages a todo stack
  5. .SH SYNOPSIS
  6. .B todo
  7. .IR command " [" option "]"
  8. .SH DESCRIPTION
  9. .P
  10. .B todo
  11. is a small utility to manage a todo stack. It can push onto the stack, read the top element, and pop the top element.
  12. .SH OPTIONS
  13. .TP
  14. .BI push " task"
  15. Pushes a new task on the user's todo stack.
  16. .TP
  17. .B peek
  18. Outputs the task at the top of the stack.
  19. Does not alter the stack.
  20. .TP
  21. .B pop
  22. Outputs the task at the top of the stack, then pops it off.
  23. .SH EXIT STATUS
  24. .TP
  25. .B 0
  26. Operation successful.
  27. .TP
  28. .B 1
  29. General error
  30. .TP
  31. .B 2
  32. Todo stack underflow on a \fBpop\fR command or a \fBpeek\fR command.
  33. .SH FILES
  34. .TP
  35. .B $HOME/.local/share/todostack
  36. The user's todo stack.
  37. .SH