-
Notifications
You must be signed in to change notification settings - Fork 1
NOAFtodo manpage
GregTheMadMonk edited this page Jan 31, 2021
·
7 revisions
NOAFTODO(1) NOAFtodo man page NOAFTODO(1)
NAME
NOAFtodo A TODO manager No-One-Asked-For.
SYNOPSIS
noaftodo [OPTIONS]
noaftodo -d [OPTIONS]
naoftodo -r
noaftodo -h
DESCRIPTION
NOAFtodo is a simple ncurses TODO-manager. Also includes a deamon for
tracking task dues and completion.
OPTIONS
-C, --command
execute a command
-c, --config
specify config file
-d, --daemon
start daemon
-h, --help
print help message
-I, --interpreter
start in interpreter mode
-k, --kill-daemon
kill daemon
-l, --list
specify list file
-p, --pure
use pure output. No intents, no time, just text
-r, --refire
if daemon is running, re-fire startup events (like, notifica‐
tions)
-v, --verbose
print all messages
-V, --version
print program version
COMMAND MODE
COMMANDS
:cmd.backspace
removes character before command line cursor
:cmd.clear
clears command line
:cmd.curs.end
move command line cursor to the end of the line
:cmd.curs.home
move command line cursor to the beginning of the line
:cmd.curs.left
move command line curor to the left
:cmd.curs.right
move command line cursor to the right
:cmd.curs.word.end
move command line cursor to the end of the word
:cmd.curs.word.home
move command line cursor to the beginning of the word
:cmd.delete
removes the character under command line cursor
:cmd.history.down
go one command down (later) in command history
:cmd.history.up
go one command up (earlier) in command history
:cmd.send
sends input from command line for execution
:timeline.focus_closest
same as timeline.focus, but prior to it selects closest entry to
current position on TIMELINE
:timeline.focus
focus selected entry in TIMELINE mode
:timeline.next
select next entry on the timeline
:timeline.prev
select previous entry on the timeline
:timeline.scale_down
scale down timeline
:timeline.scale_up
scale up timeline
:a <due> <title> <description>[ <id>]
add or override a task. If <id> is not specified, a new task is
created. If not, a task with <id> will be overriden.
:alias <command>
create an alias for command.
:bind <key> <command> <mode> <autoexec>
bind <key> to <command>. <mode> speciifes, which modes use this
bind (mask, see noaftodo_cui.h for MODE_* values). If <autoexec>
is "true", execute command on key hit, otherwise just go into
command mode with it. Running as just "bind <key>" removes a
bind.
:!<command>
execute shell command
:!!<command>
execute shell command, don't track output (for lauching programs
that have a TUI or something
:d
remove selected task.
:echo[ args...]
print the following in status.
:exec <filename>[ script]
execute a config file. Execute default config with "exec de‐
fault". With "script" cvars from config are not set as default
:if <true|false> <do-if-true>[ <do-if-false>]
simple if expression
:lclear
clear list.
:load <filename>
load the list file
:math <num1> <op> <num2>[ <name>]
calculate math expression (+,-,/,*,=,<,>,min,max) and write to
cvar <name>. If <name> is not specifed, just print the result
out
:q
exit the program.
:save[ <filename>]
force the list save. If <filename> is not specified, override
opened file.
:setmeta[ <name1> <value1>[ <name2> <value2>[ ...]]]
set task meta. If no arguments are specified, clear task meta.
To add properties to meta, use "setmeta %meta% <name1>
<value1>...". "setmeta <name>" will erase only <name> meta prop‐
erty
:set <name>[ <value>]
set cvar value. If <value> is not specified, reset cvar to de‐
fault value.
:ver <VERSION>
is used to specify config version to notify about possible out‐
dated config files.
CONSOLE VARIABLES
%cmd.contexec%
regex filter for commands to be executed continiously. It means
that if the command in the input matches the filter, it will be
executed without user action. Useful for filtering commands or
everywhere else where it is needed to see the "preview" of what
the user is typing.
%charset.timeline.line%
character for horizontal line in TIMELINE mode
%charset.timeline.marker_now%
timeline marker at current time
%charset.timeline.marker%
TIMELINE marker (displayed where a vertical line crosses hori‐
zontal)
%charset.timeline.rarrow%
cute right arrow at the end of horizontal line indicating the
flow of time
%charset.timeline.vline%
character to draw vertical lines in TIMELINE mode with
%charset.timeline.vline_now%
character to draw vertical line indicating current time in TIME‐
LINE mode with
%timeline.position%
position (in units, relative to current time) of the timeline
%timeline.unit%
length (in minutes) of a TIMELINE mode unit
%allow_root%
allows program to be run as root user on UNIX systems. Will do
nothing on single-user systems like Haiku (check is disabled
there)
%autorun_daemon%
automatically start/stop a background daemon (if not already
runnning) on program start/quit
%charset.box_light.h%
thin box horizontal line character
%charset.box_light%
thin box drawing characters (vertical line, horizontal line,
left top, right top, left bottom, right bottom corners)
%charset.box_light.v%
thin box vertical line character
%charset.box_ligth.corn1%
thin box top left corner character
%charset.box_ligth.corn2%
thin box top right corner character
%charset.box_ligth.corn3%
thin box bottom left corner character
%charset.box_ligth.corn4%
thin box bottom right corner character
%charset.box_strong.corn1%
thick box top left corner character
%charset.box_strong.corn2%
thick box top right corner character
%charset.box_strong.corn3%
thick box bottom left corner character
%charset.box_strong.corn4%
thick box bottom right corner character
%charset.box_strong.h%
thick box horizontal line character
%charset.box_strong%
thick box drawing characters (vertical line, horizontal line,
left top, right top, left bottom, right bottom corners)
%charset.box_strong.v%
thick box vertical line character
%charset.separators.details%
separator between DETAILS fields
%charset.separators.row%
NORMAL mode separator between rows
%charset.separators.row.offset%
how much to shift %charset.separators.row% offset each time it
is printed
%charset.separators%
between rows, status fields, DETAILS mode fields)
%charset.separators.status%
separator between status fields
%colors.entry_coming%
upcoming entry color
%colors.entry_completed%
completed entry color
%colors.entry_due%
due entry color
%colors.entry_failed%
failed entry color
%colors.status%
status bar color
%colors.title%
table title color
%comp%
selected entrypletion (true or false)
%desc%
selected entry's description
%det.cols%
"columns" (or better fields) to display as entry information in
DETAILS mode
%due%
selected entry's due (in command-line format)
%filter.coming%
show/hide upcoming enties
%filter.complete%
show/hide completed enties
%filter.empty%
show/hide lists without visible entries
%filter%
entry flag filter integer. Will be deprecated soon
%filter.failed%
show/hide failed enties
%filter.nodue%
show/hide nodue enties
%filter.uncat%
show/hide uncategorized entries
%first_v_id%
the id of the first entry that is visible. Read-only
%first_v_list%
the index of the first visible list
%frameshift_multistr%
animate multistr cvars (even I don't really know how this works)
%halfdelay_time%
screen update time. Can be sets to 0 for no automatic screen up‐
dates
%id%
selected entry ID (as displayed in NORMAL mode, don't confuse
with entry EIDs)
%last_v_list%
the index of the last visible list
%lat_v_id%
the id of the last entry that is visible. Read-only
%livi.cols%
LISTVIEW mode columns
%livi.regex_filter%
LISTVIEW mode list regex filter
%livi.status_fields%
status fields to display in LISTVIEW mode
%meta%
selected entry's meta string. Read-only. Access individual meta
properties via%meta.property_name% cvars and :setmeta command
%mode%
program UI mode integer
%norm.cols.all%
NORMAL mode columns when viewving entries from all lists
%norm.cols%
NORMAL mode columns when viewving a specific list
%norm.regex_filter%
NORMAL mode entry regex filter
%norm.status_fields%
status fields to display in NORMAL mode
%numbuffer%
service number buffer
%on_daemon_launch_action%
command to run when daemon is started
%on_task_coming_action%
command to run when task becomes upcoming
%on_task_completed_action%
command to run when a task becomes completed
%on_task_due_action%
command to run when a task due comes
%on_task_edited_action%
command to run if a task was edited
%on_task_failed_action%
command to run when a task becomes failed
%on_task_new_action%
command to run when a new task is added
%on_task_removed_action%
command to run when a task is removed
%on_task_uncompleted_action%
command to run when task stops being completed
%parent%
selected entry's parent list index
%pname%
selected list's name. If no list is selected, read-only and re‐
turns "All lists"
%ret%
previous command return value
%sort_by%
string indicating enrtry sort order for NORMAL mode
%tag_filter%
current list's index. -1 for all lists
%tag_filter_v%
same as %tag_filter%, but if set to an invisible list's index,
will cycle through the lists until the first visible one
%title%
selected entry's title
%VER%
program version
NORMAL MODE COLUMNS
NORMAL mode columns are specified in "norm.cols.all" and "norm.cols"
cvars (for when all lists/only one list is viewed correspondingly). You
can also set some NORMAL mode columns to display their values with
"det.cols".
D
shows task description
d
shows task due
f
shows task flags
i
shows task ID (as referred by UI, don't confuse with task unique
ID)
l
shows what list the task is attached to
r
remaining time until task due
t
shows task title
LISTVIEW MODE COLUMNS
LISTVIEW mode columns are set in "det.cols" cvar.
e
shows the amount of entries attached to the list
f
shows list flags
i
shows list number (aka ID)
p
shows the precentge of completed entries on the list
t
shows list title
STATUS FIELDS
Status fields are specified in "norm.status_fields" and "livi.sta‐
tus_fields" cvars for NORMAL and LISTVIEW correspondingly.
f
shows filters
i
shows selected task ID and a total amount of entries
l
shows current list name
m
shows current mode (NORMAL|LISTVIEW|DETAILS|HELP)
P
shows the amount of completed entries on the list against the
total amount of attached entries
p
shows the percentage of completed entries on a current list
s
shows status value (output of commands)
TROUBLESHOOTING
CONFIG VERSION MISMATCH
Means that your config is declared for the other vesion of noaftodo. Go
through list file and all config files you have included, and replace
config version numbers in all "ver " commands (also, you would probably
need to update some commands in configs. For this, see program changel‐
ogs on Github: https://github.com/GregTheMadMonk/noaftodo).
LIST VERSION MISMATCH
Open NOAFtodo. If list loaded correctly, re-save it to another location
with ":save <filename>" (just ":save" won't work in safemode!). <file‐
name> could be the same as the list you have loaded, if you are a brave
one. Program will save the list in correct format. If the list wasn't
loaded correctly, you will have to modify it manually. Sad(
EPILOGUE
Apology for bad english and probably not very useful manpage. <3
Y'all! Peace!
1.4.6 January 2021 NOAFTODO(1)