commit 02d51abc710f4284c768b4a8e3b62e2ceca017d0
parent ce55a7e74c7b8aeb6ef2b656586d454eb5493dec
Author: sin <sin@2f30.org>
Date: Thu, 21 Nov 2013 16:15:19 +0000
Add initial manpage
Diffstat:
2 files changed, 24 insertions(+), 0 deletions(-)
diff --git a/Makefile b/Makefile
@@ -1,4 +1,5 @@
PREFIX = /usr/local
+MANPREFIX = $(PREFIX)/man
CFLAGS = -I/usr/local/include
LDFLAGS = -L/usr/local/lib
@@ -10,9 +11,12 @@ all: $(BIN)
install: all
install -d $(DESTDIR)$(PREFIX)/bin
install $(BIN) $(DESTDIR)$(PREFIX)/bin/$(BIN)
+ install -d $(DESTDIR)$(MANPREFIX)/man1
+ install spectrum.1 $(DESTDIR)$(MANPREFIX)/man1
uninstall:
rm -f $(DESTDIR)$(PREFIX)/bin/$(BIN)
+ rm -f $(DESTDIR)$(MANPREFIX)/man1/spectrum.1
clean:
rm -f $(BIN)
diff --git a/spectrum.1 b/spectrum.1
@@ -0,0 +1,20 @@
+.TH SPECTRUM 1
+.SH NAME
+spectrum \- curses audio visualizer
+.SH SYNOPSIS
+.B spectrum [ \-hcp ] [ fifo ]
+.SH DESCRIPTION
+.B spectrum
+performs a discrete fourier transform and plots the spectrogram in real time
+using curses. The current implementation expects the input stream to be 44.1kHz,
+16-bit little endian and 2 channels. The default fifo path is `/tmp/audio.fifo'.
+.SH OPTIONS
+.TP
+.B \-h
+Show usage line.
+.TP
+.B \-c
+Enable color support.
+.TP
+.B \-p
+Enable falling peaks.