commit 79cdc49778dbb1066a95f168a9544fb472021b76
parent 1256c41eba3f35b2b3b8fe0256aa8732d725a986
Author: Alexander Kojevnikov <alexander@kojevnikov.com>
Date: Thu, 24 Mar 2011 22:49:51 +0800
Add a man page
Diffstat:
6 files changed, 73 insertions(+), 3 deletions(-)
diff --git a/.gitignore b/.gitignore
@@ -24,6 +24,7 @@ intltool-merge.in
intltool-update.in
libtool
ltmain.sh
+man/spek.1
missing
mkinstalldirs
omf.make
diff --git a/Makefile.am b/Makefile.am
@@ -2,9 +2,10 @@
SUBDIRS = \
data \
+ man \
+ po \
src \
- vapi \
- po
+ vapi
EXTRA_DIST = \
intltool-extract.in \
diff --git a/configure.ac b/configure.ac
@@ -54,6 +54,8 @@ AC_CONFIG_FILES([
data/icons/32x32/Makefile
data/icons/48x48/Makefile
data/icons/scalable/Makefile
+ man/Makefile
+ man/spek.1
po/Makefile.in
src/Makefile
vapi/Makefile
diff --git a/dist/README b/dist/README
@@ -1,7 +1,7 @@
Spek release checklist
==============================================================================
- * Bump the version numbers in configure.ac, spek.1, spek.wxs, web/version.
+ * Bump the version number in configure.ac.
* `cd po && gmake update-po && tx push -s`.
* `tx pull -a` and commit with correct `--author`s.
* Review translations, translate what I can, Ich spreek un peu по-русски.
diff --git a/man/Makefile.am b/man/Makefile.am
@@ -0,0 +1,2 @@
+man1_MANS = spek.1
+EXTRA_DIST = spek.1
+\ No newline at end of file
diff --git a/man/spek.1.in b/man/spek.1.in
@@ -0,0 +1,63 @@
+.\" Copyright (C) 2011 Alexander Kojevnikov <alexander@kojevnikov.com>
+.\"
+.\" Spek is free software: you can redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as published by
+.\" the Free Software Foundation, either version 3 of the License, or
+.\" (at your option) any later version.
+.\"
+.\" Spek is distributed in the hope that it will be useful,
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+.\" GNU General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU General Public License
+.\" along with Spek. If not, see <http://www.gnu.org/licenses/>.
+.\"
+.TH SPEK "1" "" "Spek @VERSION@"
+.SH NAME
+Spek \- Acoustic Spectrum Analyser
+.SH SYNOPSIS
+.B spek
+.RI [OPTION...] " " [FILE]
+.SH DESCRIPTION
+.B Spek
+helps to analyse your audio files by showing their spectrogram.
+It uses
+.B FFmpeg
+to decode audio files and as such supports all popular lossy
+and lossless file formats.
+.SH OPTIONS
+.TP
+.B \-h, --help
+Output a longer help message then quit. (Any discrepancies
+between this man page and the output of
+.B spek --help
+should be reported as a documentation bug.)
+.TP
+.B \-V, --version
+Output version information then quit.
+.SH KEYBINDINGS
+Global keybindings for
+.BR Spek :
+.P
+Ctrl+O open a new file
+.br
+Ctrl+S save the spectrogram as an image file
+.br
+Ctrl+Q quit
+.br
+F1 show the about dialog
+.SH FILES
+.I ~/.config/spek/config.ini
+.RS
+The configuration file for Spek, stored in a simple INI format.
+.RE
+.SH AUTHOR
+Alexander Kojevnikov <alexander@kojevnikov.com>
+.SH DISTRIBUTION
+The latest version of
+.B Spek
+may be downloaded from
+.UR http://www.spek-project.org/
+<http://www.spek\-project.org/>
+.UE
