wmwork/src/wmwork.1.in

   1 .ig
   2 @configure_input@
   3 $Id: wmwork.1.in,v 1.21 2005/02/14 19:14:58 godisch Exp $
   4 .
   5 Copyright (c) 2002-2005 Martin A. Godisch <martin@godisch.de>
   6 ..
   7 .TH WMWORK 1 "January 2005" "The Debian Project" "Version @PACKAGE_VERSION@"
   8 .
   9 .SH NAME
  10 .
  11 wmwork \- keep track of time worked on projects
  12 .
  13 .SH SYNOPSIS
  14 .
  15 .B wmwork
  16 .RI [ options ]
  17 .
  18 .SH DESCRIPTION
  19 .
  20 .B wmwork
  21 provides a monitor on a 64x64 mini window that helps you keeping track of
  22 your time. The idea is based on the program
  23 .I Worklog
  24 written by Truxton King Fulton II. In contrast to
  25 .I Worklog
  26 .B wmwork
  27 is a graphical application designed to work with the WindowMaker dock, but
  28 will work with other window managers as well.
  29 .
  30 .SH OPTIONS
  31 .
  32 .TP
  33 .BR \-d ,\  \-\-days
  34 displays time in ddd.hh:mm instead of hhh:mm:ss. Note that if one timer is
  35 at least 1000 hours large this will be the case anyway.
  36 .TP
  37 .BR \-f ,\  \-\-force
  38 overwrite stale lock files. Use this if
  39 .B wmwork
  40 says that it's already running but it isn't.
  41 .TP
  42 .BR \-h ,\  \-\-help
  43 display a command line summary.
  44 .TP
  45 .BR \-v ,\  \-\-version
  46 display the version number.
  47 .TP
  48 .BI \-\-display= id
  49 set the display to use, e.g.
  50 .RI \-\-display= :0.0 .
  51 .TP
  52 .BI \-\-geometry= pos
  53 set the position of the dock app, e.g.
  54 .RI \-\-geometry= +10+10 .
  55 Note that the size (64x64) is hard-coded and cannot be changed.
  56 .
  57 .SH USAGE
  58 .
  59 When
  60 .B wmwork
  61 is started, the uppermost line shows the accumulated time spent on the
  62 project, identified by a three letter code in the third line. The second
  63 line shows the current time spent on the project and is initially zero.
  64 .PP
  65 The button
  66 .B V
  67 starts the timer, the button
  68 .B ||
  69 pauses it. The button
  70 .B X
  71 stops the timer, saving the accumulated time in
  72 .IR ~/.wmwork/worklog ,
  73 adding the current session time to
  74 .I ~/.wmwork/worklog.XYZ
  75 and resetting the latter.
  76 .PP
  77 The buttons
  78 .B <
  79 and
  80 .B >
  81 switch between the projects found in the file
  82 .IR ~/.wmwork/worklog .
  83 This can be done only if the timer is neither running nor paused.
  84 .
  85 .SH FILES
  86 .
  87 .TP
  88 .B ~/.wmwork/worklog
  89 contains the projects configuration and log summaries.
  90 .PP
  91 Each line has the form
  92 .IR identifier:timestamp[:comment] .
  93 Empty lines and lines beginning with a
  94 .I #
  95 are ignored. Only the first three characters of the (case-insensitive)
  96 identifier are relevant. When
  97 .B wmwork
  98 is overwriting
  99 .I ~/.wmwork/worklog
 100 it cuts the identifiers down that way.
 101 .TP
 102 .B ~/.wmwork/???
 103 contains human readable timestamps for the project
 104 .IR XYZ ,
 105 where
 106 .I XYZ
 107 is the truncated identifier from
 108 .IR ~/.wmwork/worklog .
 109 .PP
 110 Having multiple entries of the same identifier in
 111 .I ~/.wmwork/worklog
 112 is possible. They are counted independently, but will share the same
 113 project file.
 114 .
 115 .SH BUGS
 116 .
 117 Please send any bugs to <@PACKAGE_BUGREPORT@>. Debian users are encouraged
 118 to use the Debian Bug Tracking System <http://bugs.debian.org/wmwork>.
 119 .
 120 .SH AUTHOR
 121 .
 122 .B wmwork
 123 was written by Martin A. Godisch <martin@godisch.de>. It is based on the
 124 program wmppp written by Martijn Pieterse and Antoine Nulle. Thanks to the
 125 following people, who have contributed to wmwork:
 126 .PP
 127 .nf
 128 Adam Lackorzynski <adam@os.inf.tu-dresden.de>
 129 Gordon Fraser <gordon@freakzone.net>
 130 Daniel Tschan <tschan@devzone.ch>
 131 Alexey Dokuchaev <danfe@danfe.ru>
 132 Josep Portella Florit <jpf@sdf.lonestar.org>
 133 Ben Stern <ben.stern@gmail.com>
 134 .fi
 135 .