clipt

 

Index

NAME
SYNOPSIS
DESCRIPTION
OPTIONS
FILES
AVAILABILITY
COPYRIGHT AND LEGAL ISSUES
AUTHOR
DOWNLOAD

 

NAME

clipt - CLI Pomodoro Timer  

SYNOPSIS

clipt [-c <command>]
clipt [<server options>]
 

DESCRIPTION

clipt is CLI (Command Line Interface) Pomodoro Timer written in C. Although the name mentions command line, it is flexible enough to be equipped with and support a GUI. It's a multi-user program that allows every user of the system have their own Pomodoro timer.

To learn more about Pomodoro Timer, refer to http://en.wikipedia.org/wiki/Pomodoro_Technique

Running clipt without any options ( or any options except -c ) enters it into server mode, where it becomes a daemon. While in server mode, it can be interacted with through its Unix Domain Socket interface. The daemon creates and listens on a socket called ".clipt.sock" under the user's home directory. It makes the socket only accessible by the user. Daemon settings can be saved in a file called ".clipt.rc" under the user's home directory. These settings are loaded every time clipt runs. However, command line options take priority and override them.

Passing -c (--command) to clipt makes it the client to the daemon. Refer to option -c below to learn more about the commands that can be sent to the daemon.  

OPTIONS

-w, --work minutes
Specifies duration of work period in minutes
-b, --break minutes
Specifies duration of break period in minutes
-l, --long minutes
Specifies duration of the long break period in minutes(
-a, --long_after minutes
Number of pomodors (work periods) to run before taking a long break
-q, --quit pomodoros
Number of pomodors to run before quitting
-r, --run script
Specifies the full path to the script that runs after each phase. It gets passed three arguments [w|b|l] ([work|break|long-break]), length of the period in minutes, and ttyname.
-n, --nodaemon
Do NOT become a daemon (default is to become a daemon)
-c, --cmd command
Pass the command to the running daemon. Here are the commands you can pass to the daemon: pause (to pause the timer), resume (to resume a paused timer), reset (restart from the current period), work (to start a work period), break (to start a break period), status (shows the current status of the timer), quit (to make the daemon quit)
-h, --help
Display the usage and help screen.
-v, --version
Display the version number.
 

FILES

Each user can save their settings into a file called .clipt.rc under their home directory. This file has a very simple format, where each setting is stored in its own line and key and values are separated by a white space, such as:

work 25
break 5
long_break 10
long_break_after 4
quit_after 16
script /usr/local/bin/cliptnotify.sh  

AVAILABILITY

clipt is tested on many different variations of Linux, Cygwin (1.5.x), NetBSD 6.1, and FreeBSD 10.1.

Please feel free to send us your patches to get tgc working on other platforms.  

COPYRIGHT AND LEGAL ISSUES

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

Disclaimer:

Pomodoro Technique(R) and Pomodoro(TM) are registered and filed trademarks owned by Francesco Cirillo. clipt is not affiliated by, associated with nor endorsed by Francesco Cirillo.

This program is provided with no warranty of any kind, either expressed or implied. It is the responsibility of the user (you) to fully research and comprehend the usage of this program. As with any tool, it can be misused, either intentionally or unintentionally. THE AUTHOR(S) IS(ARE) NOT RESPONSIBLE FOR ANYTHING YOU DO WITH THIS PROGRAM or anything that happens because of your use (or misuse) of this program.  

AUTHOR

clipt is written by Faraz.V (farazv _AT_ users.sourceforge.net)

 

DOWNLOAD

clipt can be downloaded from here


This document was created by man2html, using the manual pages.
March 21, 2015