The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
App-JobLog-1.042
River stage zero No dependents
3 ++
/ App::JobLog::Command::edit

NAME

App::JobLog::Command::edit - edit the log

VERSION

version 1.042

SYNOPSIS

 houghton@NorthernSpy:~$ job edit --help
 job <command>
 
 job edit [--validate] [-c <date and time>]
        -c --close-task --close  add a "DONE" line to the log at the specified
                                moment
        -v --validate           check log for errors, commenting out any found
        --help                  this usage screen
 houghton@NorthernSpy:~$ job today
 Monday,  7 March, 2011
   8:01 am - ongoing  4.56  bar, foo  something to add; and still more                                                                                                  
 
   TOTAL HOURS 4.56
   bar         4.56
   foo         4.56
 houghton@NorthernSpy:~$ job e --close today at 8:05
 houghton@NorthernSpy:~$ job t
 Monday,  7 March, 2011
   8:01 - 8:05 am  0.05  bar, foo  something to add; and still more                                                                                                  
 
   TOTAL HOURS 0.05
   bar         0.05
   foo         0.05
 houghton@NorthernSpy:~$ job e

A text editor opens up displaying the log. Appropriate edits are performed. The user saves and quits.

 saved backup log in /home/houghton/.joblog/log.bak
 log is valid
 houghton@NorthernSpy:~$

DESCRIPTION

Generally you won't have need to modify the log except through App::JobLog::Command::add, App::JobLog::Command::done, App::JobLog::Command::modify, or App::JobLog::Command::resume. There will sometimes be glitches, though: you will be away from the log when you do something or you will quit for the day without having punched out with App::JobLog::Command::done. This is when you need App::JobLog::Command::edit.

Most of the time you will simply need to add a missing DONE line -- the --close option. For this you need no text editor external to App::JobLog itself. If you need a full function editor you will need to define the editor parameter using App::JobLog::Command::configure. Then invoke this command without any options or arguments.

When you invoke the editor, App::JobLog reviews the log after you save, commenting out ill-formed lines and emitting warnings.

SEE ALSO

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.