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
38 lines
736 B
.\" Man page for the todo utility ./todo.1
|
|
.TH TODO 1
|
|
|
|
.SH NAME
|
|
todo \- manages a todo stack
|
|
.SH SYNOPSIS
|
|
.B todo
|
|
.IR command " [" option "]"
|
|
.SH DESCRIPTION
|
|
.P
|
|
.B todo
|
|
is a small utility to manage a todo stack. It can push onto the stack, read the top element, and pop the top element.
|
|
.SH OPTIONS
|
|
.TP
|
|
.BI push " task"
|
|
Pushes a new task on the user's todo stack.
|
|
.TP
|
|
.B peek
|
|
Outputs the task at the top of the stack.
|
|
Does not alter the stack.
|
|
.TP
|
|
.B pop
|
|
Outputs the task at the top of the stack, then pops it off.
|
|
.SH EXIT STATUS
|
|
.TP
|
|
.B 0
|
|
Operation successful.
|
|
.TP
|
|
.B 1
|
|
General error
|
|
.TP
|
|
.B 2
|
|
Todo stack underflow on a \fBpop\fR command or a \fBpeek\fR command.
|
|
.SH FILES
|
|
.TP
|
|
.B $HOME/.local/share/todostack
|
|
The user's todo stack.
|
|
.SH
|