David F. Houghton > App-JobLog-1.031 > App::JobLog::Command::add

Download:
App-JobLog-1.031.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  1
View/Report Bugs
Module Version: 1.031   Source  

NAME ^

App::JobLog::Command::add - log an event

VERSION ^

version 1.031

SYNOPSIS ^

 houghton@NorthernSpy:~$ job add --help
 job <command>
 
 job add <description of event>
        -t --tag          tag the event; multiple tags are acceptable; e.g.,
                          -t foo -t bar -t quux
        -T --clear-tags   inherit no tags from preceding event; this is
                          equivalent to -t ""; this option has no effect if
                          any tag is specified
        --help            this usage screen
 houghton@NorthernSpy:~$ job add -T -t foo -t bar -t quux Staring into the Abyss.
 houghton@NorthernSpy:~$ job a Getting stared back at.

DESCRIPTION ^

App::JobLog::Command::add is the command you'll use most often. It appends an event to the log.

TAGS

You may optionally attach categories to tasks with tags. Any string can be a tag but to make the output readable you'll want them to be short. Also, in the logs tags are delimited by whitespace and separated from the timestamp and description by colons, so these characters will be escaped with a slash. If you edit the log by hand and forget to escape these characters the log will still parse but you will be surprised by the summaries you get.

You may specify multiple tags, but each one needs its own --tag flag.

If you don't specify otherwise the new event will inherit the tags of the previous event, so you will need to apply the --clear-tags option to prevent this. The reasoning behind this feature is that you change tags seldom but change tasks often so inheriting tags by default saves labor.

SEE ALSO ^

App::JobLog::Command::done, App::JobLog::Command::resume, App::JobLog::Command::modify

AUTHOR ^

David F. Houghton <dfhoughton@gmail.com>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2011 by David F. Houghton.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

syntax highlighting: