pomodoro

A simple pomodoro timer
git clone git://nocebo.space/pomodoro
Log | Files | Refs | LICENSE

pomodoro.1 (1212B)


      1 .Dd Dec 09, 2017
      2 .Dt POMODORO 1
      3 .Os
      4 .Sh NAME
      5 .Nm pomodoro
      6 .Nd pomodoro timer
      7 .Sh SYNOPSIS
      8 .Nm pomodoro
      9 .Op Fl b Ar break_period
     10 .Op Fl l Ar logfile
     11 .Op Fl p Ar pomodoro_period
     12 .Op Fl v
     13 .Sh DESCRIPTION
     14 .Nm
     15 is a simple pomodoro timer.
     16 .Nm
     17 has two modes of operation: interactive mode and direct mode. By default
     18 .Nm
     19 will run in interactive mode if no argument is provided. In interactive mode, 
     20 pomodoro period will last for 25 minutes and break period will last for 5 
     21 minutes. Every 3 pomodoros will be rewarded with a 30-minute break.
     22 In direct mode, user is allowed to pass in desired values for both pomodoro and
     23 break periods.
     24 .Sh OPTIONS
     25 .Bl -tag -width Ds
     26 .It Fl b Ar break_period
     27 Set break period in minutes.
     28 .It Fl l Ar logfile
     29 Log file location.
     30 By default this is
     31 .Pa ~/.pomodoro
     32 .It Fl p Ar pomodoro_period
     33 Set pomodoro period in minutes.
     34 .It Fl v
     35 Show program version.
     36 .El
     37 .Sh CONFIGURATION
     38 You can specify the location where pomodoro should place a log.
     39 The primary use for this is to plot a productivity chart.
     40 .Sh RATIONALE
     41 Users who practice pomodoro technique might find 
     42 .Nm
     43 useful.
     44 .Sh PORTABILITY
     45 It currently only works on OpenBSD.
     46 .Sh Authors
     47 .An Naveen Narayanan Aq Mt zerous@nocebo.space