Commits

Trevor Caira  committed 471dcf5

Automated commit message

  • Participants
  • Parent commits 5c74e53

Comments (0)

Files changed (1)

 Concepts
 ~~~~~~~~
 
-Timebook maintains a list of *timesheets* -- distinct lists timed
+Timebook maintains a list of *timesheets* -- distinct lists of timed
 *periods*. Each period has a start and end time, with the exception of the
 most recent period, which may have no end time set. This indicates that
 this period is still running. Timesheets containing such periods are
 
 Interactions with timebook are performed through the ``t`` command on
 the command line. ``t`` is followed by one of timebook's subcommands.
-Often used subcommands include ``start``, ``stop``, ``switch``,
-``info``, ``list`` and ``show``. Commands may be abbreviated as long as
-they are unambiguous: thus ``t switch foo`` and ``t sw foo`` are
-identical. Likewise, commands which display timesheets accept
-abbreviated timesheet names. ``t show f`` is thus equivalent to ``t show
-foo`` if ``foo`` is the only timesheet which begins with "f". Note that
-this does not apply to ``t switch``, since this command also creates
-timesheets. (Using the earlier example, if ``t switch f`` is entered, it
-would thus be ambiguous whether a new timesheet ``f`` or switching to
-the existing timesheet ``foo`` was desired).
+Often used subcommands include ``in``, ``out``, ``switch``, ``now``,
+``list`` and ``display``. Commands may be abbreviated as long as they
+are unambiguous: thus ``t switch foo`` and ``t s foo`` are identical.
+With the default command set, no two commands share the first same
+letter, thus it is only necessary to type the first letter of a command.
+Likewise, commands which display timesheets accept abbreviated timesheet
+names. ``t display f`` is thus equivalent to ``t display foo`` if
+``foo`` is the only timesheet which begins with "f". Note that this does
+not apply to ``t switch``, since this command also creates timesheets.
+(Using the earlier example, if ``t switch f`` is entered, it would thus
+be ambiguous whether a new timesheet ``f`` or switching to the existing
+timesheet ``foo`` was desired).
 
 Usage
 ~~~~~
 The basic usage is as follows::
 
   $ t switch writing
-  $ t start document timebook
-  $ t stop
+  $ t in document timebook
+  $ t out
 
 The first command, ``t switch writing``, switches to the timesheet
-"writing" (or creates it if it does not exist). ``t start document
+"writing" (or creates it if it does not exist). ``t in document
 timebook`` creates a new period in the current timesheet, and annotates
 it with the description "document timebook". Note that this command
 would be in error if the ``writing`` timesheet was already active.
-Finally, ``t stop`` records the current time as the end time for the
+Finally, ``t out`` records the current time as the end time for the
 most recent period in the ``writing`` timesheet.
 
-To display the current timesheet, invoke the ``t show`` command::
+To display the current timesheet, invoke the ``t display`` command::
 
-  $ t show
+  $ t display
   Timesheet writing:
   Day            Start      End        Duration   Notes
   Mar 14, 2009   19:53:30 - 20:06:15   0:12:45    document timebook
 periods beginning in the day. In the last row, the total time tracked in
 the timesheet is shown.
 
-To get a complete listing of commands, see the output of ``t --help``.
+Commands
+~~~~~~~~
+
+**alter**
+  Inserts a note associated with the currently active period in the
+  timesheet.
+
+  usage: ``t alter NOTES...``
+
+  aliases: *write*
+
+**backend**
+  Run an interactive database session on the timebook database. Requires
+  the sqlite3 command.
+
+  usage: ``t backend``
+
+  aliases: *shell*
+
+**display**
+  Display a given timesheet. If no timesheet is specified, show the
+  current timesheet.
+
+  usage: ``t display [TIMESHEET]``
+
+  aliases: *show*
+
+**format**
+  Export the current sheet as a comma-separated value format
+  spreadsheet.  If the final entry is active, it is ignored.
+
+  If a specific timesheet is given, display the same information for
+  that timesheet instead.
+
+  usage: ``t format [--start DATE] [--end DATE] [TIMESHEET]``
+
+  aliases: *csv*, *export*
+
+**in**
+  Start the timer for the current timesheet. Must be called before out.
+  Notes may be specified for this period. This is exactly equivalent to
+  ``t in; t alter NOTES``
+
+  usage: ``t in [--switch TIMESHEET] [NOTES...]``
+
+  aliases: *start*
+
+**kill**
+  Delete a timesheet. If no timesheet is specified, delete the current
+  timesheet and switch to the default timesheet.
+
+  usage: ``t kill [TIMESHEET]``
+
+  aliases: *delete*
+
+**list**
+  List the available timesheets.
+
+  usage: ``t list``
+
+  aliases: *ls*
+
+**now**
+  Print the current sheet, whether it's active, and if so, how long it
+  has been active and what notes are associated with the current period.
+
+  If a specific timesheet is given, display the same information for
+  that timesheet instead.
+
+  usage: ``t now [--simple] [TIMESHEET]``
+
+  aliases: *info*
+
+**out**
+  Stop the timer for the current timesheet. Must be called after in.
+
+  usage: ``t out [--verbose] [TIMESHEET]``
+
+  aliases: *stop*
+
+**running**
+  Print all active sheets and any messages associated with them.
+
+  usage: ``t running``
+
+  aliases: *active*
+
+**switch**
+  Switch to a new timesheet. this causes all future operation (except
+  switch) to operate on that timesheet. The default timesheet is called
+  "default".
+
+  usage: ``t switch TIMESHEET``
 }}}