jschlatow / taskopen

Tool for taking notes and open urls with taskwarrior
GNU General Public License v2.0
364 stars 31 forks source link

Manpage #52

Closed jschlatow closed 11 years ago

jschlatow commented 11 years ago

and documentation in general.

linuxcaffe commented 11 years ago

Notes:

taskopen(1) User Manuals taskopen(1)

NAME taskopen - A companion application for taskwarrior, that facilitates opening annotations.

SYNOPSIS taskopen [options] [id|filter1 filter2 ... filterN] [\label]

DESCRIPTION Any task in taskwarrior can have zero-or-more annotations. Taskopen can filter, list and open these annotations, and can determine several things about them, based on clues found in the format. An annotation can be a line of text, it can be a link to a file, a link to a program, or a link to a website. Each annotation can have a "label", which is a leading word with a colon and a space ( label: < space > ) and the label can be used to filter and/or sort the listings, and (in a future version) it can be used as to specify how the annotation should be handled. If the annotation starts with [label: ]Notes, then taskopen will open (creating if necessary) a text note that is specific to the task, and is named UUID.txt (where UUID is replaced with the actual task uuid). Taskopen can be custom-configured by editing the .taskopenrc file.

OPTIONS (to be expanded) -a: active tasks (clears the EXCLUDE filter) -aa: all tasks, including completed and deleted tasks (very slow) -b: batch mode, processes every annotation in the list -c < filepath > : configuration file alternate (taskopenrc file specified by 'filepath') -D: Delete the annotation -e: edit file with EDITOR -f ['regex']: files only, i.e. annotations matching '.|\/|~' [and of 'regex' type] -F ['regex']: Files hidden [of 'regex' type]; inverse of -f -h: help text (you are looking at an expanded version of it) -i ['cmd']: interleave the results of executing "cmd file/path" with annotation listings -I ['cmd']: interleave the results of executing "cmd _ids" with annotation listings -l: list-only mode, lists annotations and exits. opens nothing. -L: List-exe mode, shows command line that would be used for each item, and exits. -m 'regex': matching 'regex' annotations only -M 'regex': Matching 'regex' annotations hidden -n: notes files only, i.e. annotations matching 'Notes' -N: Notes files hidden; inverse of -n -r: raw mode, opens the annotation text with your EDITOR -s 'key1+,key2-': Sort annotations by the given key which can be a taskwarrior field or 'annot', 'label', 'entry', 'size', 'type', 'time', 'mtime' or 'atime' -t: text-based annotations only (excludes any link-type annotation) -T: Text-based annotations hidden (shows only link-type annotations) -v: version info - terse -V: Verbose version, licensing, configuration and debug info -x ['cmd']: Execute file, optionally prepend cmd to the command line -X ['cmd']: Execute "cmd _ids" for each annotation.

FILTERS

LABELS

EXAMPLES

FILES

BUGS

HISTORY

AUTHOR

SEE Also