Add man page

This commit is contained in:
Mark Hills 2013-05-21 21:21:28 +01:00
parent b3cea166c1
commit 015bbd47aa
4 changed files with 75 additions and 0 deletions

View File

@ -4,6 +4,7 @@ PREFIX ?= /usr/local
INSTALL ?= install INSTALL ?= install
BINDIR ?= $(PREFIX)/bin BINDIR ?= $(PREFIX)/bin
MANDIR ?= $(PREFIX)/share/man
CFLAGS += -Wall CFLAGS += -Wall
LDLIBS += -lm LDLIBS += -lm
@ -18,6 +19,8 @@ clean:
install: install:
$(INSTALL) -d $(DESTDIR)$(BINDIR) $(INSTALL) -d $(DESTDIR)$(BINDIR)
$(INSTALL) -t $(DESTDIR)$(BINDIR) bpm bpm-graph bpm-tag $(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: dist:
mkdir -p dist mkdir -p dist

1
bpm-graph.1 Normal file
View File

@ -0,0 +1 @@
.so man1/bpm-graph.1

1
bpm-tag.1 Normal file
View File

@ -0,0 +1 @@
.so man1/bpm.1

70
bpm.1 Normal file
View File

@ -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 <mark@xwax.org>