spek/man/spek.1.in
Alexander Kojevnikov 27aac665eb Update the manpage
2011-04-23 18:50:51 +08:00

65 lines
1.8 KiB
Groff

.\" 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+E show the preferences dialog
Ctrl+Q quit
.br
F1 show the about dialog
.SH FILES
.I ~/.config/spek/preferences
.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