diff --git a/Makefile b/Makefile index 7c8b7b9..c40b8a6 100644 --- a/Makefile +++ b/Makefile @@ -4,6 +4,7 @@ PREFIX ?= /usr/local INSTALL ?= install BINDIR ?= $(PREFIX)/bin +MANDIR ?= $(PREFIX)/share/man CFLAGS += -Wall LDLIBS += -lm @@ -18,6 +19,8 @@ clean: install: $(INSTALL) -d $(DESTDIR)$(BINDIR) $(INSTALL) -t $(DESTDIR)$(BINDIR) bpm bpm-graph bpm-tag + $(INSTALL) -d $(DESTDIR)$(MANDIR)/man1 + $(INSTALL) -t $(DESTDIR)$(MANDIR)/man1 bpm.1 bpm-graph.1 bpm-tag.1 dist: mkdir -p dist diff --git a/bpm-graph.1 b/bpm-graph.1 new file mode 100644 index 0000000..fc52e84 --- /dev/null +++ b/bpm-graph.1 @@ -0,0 +1 @@ +.so man1/bpm-graph.1 diff --git a/bpm-tag.1 b/bpm-tag.1 new file mode 100644 index 0000000..e1948fb --- /dev/null +++ b/bpm-tag.1 @@ -0,0 +1 @@ +.so man1/bpm.1 diff --git a/bpm.1 b/bpm.1 new file mode 100644 index 0000000..5046fdf --- /dev/null +++ b/bpm.1 @@ -0,0 +1,70 @@ +.TH BPM "1" + +.SH NAME +bpm-tools \- calculate the tempo of music files + +.SH SYNOPSIS +.B bpm-tag +[\fIoptions\fR] \fIfile\fR + +.B bpm-graph +\fIfile\fR + +.B bpm +[\fIoptions\fR] < \fIfile.raw\fR + +.SH DESCRIPTION + +The +.B bpm-tools +commands are used to automatically calculate the tempo (in +beats-per-minute) of music, optionally displaying an analysis +and adding it to file 'tags'. + +The +.B bpm +command implements the algorithm on raw data, but +the most commonly used command is +.B bpm-tag. + +.SH OPTIONS + +Options are described by the commands themselves. Use one of the +following for more information: +.sp +.RS +bpm-tag -h + +bpm-graph -h + +bpm -h +.RE + +.SH EXAMPLES + +.P +Tag a file with its tempo: +.sp +.RS +bpm-tag "Daft Punk - Get Lucky.mp3" +.RE + +.P +Calculate and display the tempo of a file without modifying it: +.sp +.RS +bpm-tag -f -n "Gwen Guthrie - Padlock.flac" +.RE + +.P +Tag a file, with a hint to look for a fast tempo: +.sp +.RS +bpm-tag -m 120 -x 200 "Roni Size - Brown Paper Bag.oga" +.RE + +.SH HOMEPAGE +http://www.pogo.org.uk/~mark/bpm-tools/ + +.SH AUTHOR +Mark Hills