The workout-timer Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The workout-timer Reference Manual

This is the workout-timer Reference Manual, version 1.0.6, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 04:45:09 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

workout-timer

workout-timer is a trivial workout timer written in Common Lisp. Its behavior can be configured with various invocation flags, but its default mode is to offer a 7-minute workout. Being written in Common Lisp, it is pretty easy to modify for anyone who knows how to program in Lisp.

workout-timer has only been tested on Linux (using SBCL, but any other implementation should do). All its dependencies are in Quicklisp. Its main dependency is mixalot which itself depends on various C libraries that may or may not configuration tweaks to work on other operating systems. Its invocation script relies on cl-launch.

On Ubuntu, I notably had to:

apt-get install sbcl cl-launch libvorbis-dev

Invocation

From a Unix shell command-line, you can invoke it with:

./workout-timer

Get its version with:

./workout-timer -V

Usage with:

./workout-timer -h

Implicit default behavior:

./workout-timer -v 1.0 -w 30 -p 10 \
  -e "Jumping jack" -e "Wall sit" -e "Push-up" -e "Abdominal crunch" \
  -e "Step-up onto chair" -e "Squat" -e "Triceps dip on chair" -e "Plank" \
  -e "High knees running in place" -e "Lunge" -e "Push-up and rotation" -e "Side plank"

Or, from the SBCL (SLIME) REPL:

(load "~/quicklisp/setup.lisp")
(ql:quickload "workout-timer")
(workout-timer:mix-it :volume 1.0 :work-seconds 30 :pause-seconds 10)

Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.


Next: , Previous: , Up: Systems   [Contents][Index]

2.1 workout-timer

Author

Francois-Rene Rideau

Home Page

http://cliki.net/workout-timer

Source Control

(:git "https://gitlab.common-lisp.net/frideau/workout-timer.git")

License

MIT

Description

Workout timer

Long Description

Workout timer with clock ticks and gongs
programmed for a 7-minute workout but you can modify it to suit your own workout

Version

1.0.6

Dependencies
Source

workout-timer.asd (file)


Previous: , Up: Systems   [Contents][Index]

2.2 workout-timer/timer

Dependencies
Source

workout-timer.asd (file)

Component

lisp.lisp (file)


Next: , Previous: , Up: Top   [Contents][Index]

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 workout-timer.asd

Location

workout-timer.asd

Systems

Previous: , Up: Lisp files   [Contents][Index]

3.1.2 workout-timer/timer/lisp.lisp

Parent

workout-timer/timer (system)

Location

timer.lisp

Packages

workout-timer/timer

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 workout-timer/timer

Source

lisp.lisp (file)

Nickname

workout-timer

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Functions

Function: end-mixer ()
Package

workout-timer/timer

Source

lisp.lisp (file)

Function: entry-point ()
Package

workout-timer/timer

Source

lisp.lisp (file)

Function: main ARGS
Package

workout-timer/timer

Source

lisp.lisp (file)

Function: mix-it &key WORK-SECONDS PAUSE-SECONDS EXERCISES VOLUME
Package

workout-timer/timer

Source

lisp.lisp (file)

Function: start-mixer ()
Package

workout-timer/timer

Source

lisp.lisp (file)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Special variables

Special Variable: *bell*
Package

workout-timer/timer

Source

lisp.lisp (file)

Special Variable: *buzzer*
Package

workout-timer/timer

Source

lisp.lisp (file)

Special Variable: *click*
Package

workout-timer/timer

Source

lisp.lisp (file)

Special Variable: *current-time*
Package

workout-timer/timer

Source

lisp.lisp (file)

Special Variable: *gong*
Package

workout-timer/timer

Source

lisp.lisp (file)

Special Variable: *mixer*
Package

workout-timer/timer

Source

lisp.lisp (file)

Special Variable: *version*
Package

workout-timer/timer

Source

lisp.lisp (file)

Special Variable: +workout-timer-option-spec+
Package

workout-timer/timer

Source

lisp.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Functions

Function: add-sample SAMPLE
Package

workout-timer/timer

Source

lisp.lisp (file)

Function: bell ()
Package

workout-timer/timer

Source

lisp.lisp (file)

Function: buzzer ()
Package

workout-timer/timer

Source

lisp.lisp (file)

Function: click ()
Package

workout-timer/timer

Source

lisp.lisp (file)

Function: countdown N &key CLICK
Package

workout-timer/timer

Source

lisp.lisp (file)

Function: get-samples &optional VOLUME
Package

workout-timer/timer

Source

lisp.lisp (file)

Function: get-vorbis-length-rate X
Package

workout-timer/timer

Source

lisp.lisp (file)

Function: get-vorbis-sample X &key MIXER VOLUME
Package

workout-timer/timer

Source

lisp.lisp (file)

Function: gong ()
Package

workout-timer/timer

Source

lisp.lisp (file)

Function: integer-digits N &optional BASE

Given a non-negative integer N, return how many digits it takes to write n in given BASE

Package

workout-timer/timer

Source

lisp.lisp (file)

Function: integer-length* INTEGER &optional BASE
Package

workout-timer/timer

Source

lisp.lisp (file)

Function: my-workout &key WORK-SECONDS PAUSE-SECONDS EXERCISES SILENTP
Package

workout-timer/timer

Source

lisp.lisp (file)

Function: oggfile X
Package

workout-timer/timer

Source

lisp.lisp (file)

Function: parse-double-float STRING

Parse STRING as a DOUBLE-FLOAT number.

Package

workout-timer/timer

Source

lisp.lisp (file)

Function: pn X &optional TYPE
Package

workout-timer/timer

Source

lisp.lisp (file)

Function: show-help ()
Package

workout-timer/timer

Source

lisp.lisp (file)

Function: show-picture ()
Package

workout-timer/timer

Source

lisp.lisp (file)

Function: show-version ()
Package

workout-timer/timer

Source

lisp.lisp (file)

Function: vsleep &optional N
Package

workout-timer/timer

Source

lisp.lisp (file)

Function: workout-timer &key WORK-SECONDS PAUSE-SECONDS EXERCISES VOLUME HELP VERSION
Package

workout-timer/timer

Source

lisp.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   W  
Index Entry  Section

F
File, Lisp, workout-timer.asd: The workout-timer<dot>asd file
File, Lisp, workout-timer/timer/lisp.lisp: The workout-timer/timer/lisp<dot>lisp file

L
Lisp File, workout-timer.asd: The workout-timer<dot>asd file
Lisp File, workout-timer/timer/lisp.lisp: The workout-timer/timer/lisp<dot>lisp file

W
workout-timer.asd: The workout-timer<dot>asd file
workout-timer/timer/lisp.lisp: The workout-timer/timer/lisp<dot>lisp file

Jump to:   F   L   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   A   B   C   E   F   G   I   M   O   P   S   V   W  
Index Entry  Section

A
add-sample: Internal functions

B
bell: Internal functions
buzzer: Internal functions

C
click: Internal functions
countdown: Internal functions

E
end-mixer: Exported functions
entry-point: Exported functions

F
Function, add-sample: Internal functions
Function, bell: Internal functions
Function, buzzer: Internal functions
Function, click: Internal functions
Function, countdown: Internal functions
Function, end-mixer: Exported functions
Function, entry-point: Exported functions
Function, get-samples: Internal functions
Function, get-vorbis-length-rate: Internal functions
Function, get-vorbis-sample: Internal functions
Function, gong: Internal functions
Function, integer-digits: Internal functions
Function, integer-length*: Internal functions
Function, main: Exported functions
Function, mix-it: Exported functions
Function, my-workout: Internal functions
Function, oggfile: Internal functions
Function, parse-double-float: Internal functions
Function, pn: Internal functions
Function, show-help: Internal functions
Function, show-picture: Internal functions
Function, show-version: Internal functions
Function, start-mixer: Exported functions
Function, vsleep: Internal functions
Function, workout-timer: Internal functions

G
get-samples: Internal functions
get-vorbis-length-rate: Internal functions
get-vorbis-sample: Internal functions
gong: Internal functions

I
integer-digits: Internal functions
integer-length*: Internal functions

M
main: Exported functions
mix-it: Exported functions
my-workout: Internal functions

O
oggfile: Internal functions

P
parse-double-float: Internal functions
pn: Internal functions

S
show-help: Internal functions
show-picture: Internal functions
show-version: Internal functions
start-mixer: Exported functions

V
vsleep: Internal functions

W
workout-timer: Internal functions

Jump to:   A   B   C   E   F   G   I   M   O   P   S   V   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *   +  
S  
Index Entry  Section

*
*bell*: Internal special variables
*buzzer*: Internal special variables
*click*: Internal special variables
*current-time*: Internal special variables
*gong*: Internal special variables
*mixer*: Internal special variables
*version*: Internal special variables

+
+workout-timer-option-spec+: Internal special variables

S
Special Variable, *bell*: Internal special variables
Special Variable, *buzzer*: Internal special variables
Special Variable, *click*: Internal special variables
Special Variable, *current-time*: Internal special variables
Special Variable, *gong*: Internal special variables
Special Variable, *mixer*: Internal special variables
Special Variable, *version*: Internal special variables
Special Variable, +workout-timer-option-spec+: Internal special variables

Jump to:   *   +  
S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   P   S   W  
Index Entry  Section

P
Package, workout-timer/timer: The workout-timer/timer package

S
System, workout-timer: The workout-timer system
System, workout-timer/timer: The workout-timer/timer system

W
workout-timer: The workout-timer system
workout-timer/timer: The workout-timer/timer system
workout-timer/timer: The workout-timer/timer package

Jump to:   P   S   W