third-party-mirrors/spek
1
0
Fork 0
mirror of https://github.com/alexkay/spek.git synced 2025-04-17 17:12:19 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add a man page

Browse Source
This commit is contained in:
Alexander Kojevnikov 2011-03-24 22:49:51 +08:00
parent 1256c41eba
commit 79cdc49778
6 changed files with 72 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -24,6 +24,7 @@ intltool-merge.in
intltool-update.in
libtool
ltmain.sh
man/spek.1
missing
mkinstalldirs
omf.make

5
Makefile.am
View File

@ -2,9 +2,10 @@
SUBDIRS = \
data \
man \
po \
src \
vapi \
po
vapi
EXTRA_DIST = \
intltool-extract.in \

2
configure.ac
View File

@ -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

2
dist/README vendored
View File

@ -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 по-русски.

2
man/Makefile.am Normal file
View File

@ -0,0 +1,2 @@
man1_MANS = spek.1
EXTRA_DIST = spek.1

63
man/spek.1.in Normal file
View File

@ -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