spek/man/spek.1
2023-01-16 19:08:40 -08:00

77 lines
1.9 KiB
Groff

.\" Automatically generated by Pandoc 2.9.2.1
.\"
.TH "SPEK" "1" "2023-01-09" "User\[cq]s Guide" "Version 0.8.5"
.hy
.SH NAME
.PP
Spek - Acoustic Spectrum Analyser
.SH SYNOPSIS
.PP
\f[C]spek\f[R] [\f[I]OPTION\f[R] \f[I]\&...\f[R]] [\f[I]FILE\f[R]]
.SH DESCRIPTION
.PP
\f[I]Spek\f[R] generates a spectrogram for the input audio file.
.SH OPTIONS
.TP
\f[B]\f[CB]-h\f[B]\f[R], \f[B]\f[CB]--help\f[B]\f[R]
Output the help message then quit.
.TP
\f[B]\f[CB]-V\f[B]\f[R], \f[B]\f[CB]--version\f[B]\f[R]
Output version information then quit.
.SH KEYBINDINGS
.SS Notes
.PP
On OS X use the Command key instead of Ctrl.
.SS Menu
.TP
\f[B]\f[CB]Ctrl-O\f[B]\f[R]
Open a new file.
.TP
\f[B]\f[CB]Ctrl-S\f[B]\f[R]
Save the spectrogram as an image file.
.TP
\f[B]\f[CB]Ctrl-E\f[B]\f[R]
Show the preferences dialog.
.TP
\f[B]\f[CB]F1\f[B]\f[R]
Open online manual in the browser.
.TP
\f[B]\f[CB]Shift-F1\f[B]\f[R]
Show the about dialog.
.SS Spectrogram
.TP
\f[B]\f[CB]c\f[B]\f[R], \f[B]\f[CB]C\f[B]\f[R]
Change the audio channel.
.TP
\f[B]\f[CB]f\f[B]\f[R], \f[B]\f[CB]F\f[B]\f[R]
Change the DFT window function.
.TP
\f[B]\f[CB]l\f[B]\f[R], \f[B]\f[CB]L\f[B]\f[R]
Change the lower limit of the dynamic range in dBFS.
.TP
\f[B]\f[CB]p\f[B]\f[R], \f[B]\f[CB]P\f[B]\f[R]
Change the palette.
.TP
\f[B]\f[CB]s\f[B]\f[R], \f[B]\f[CB]S\f[B]\f[R]
Change the audio stream.
.TP
\f[B]\f[CB]u\f[B]\f[R], \f[B]\f[CB]U\f[B]\f[R]
Change the upper limit of the dynamic range in dBFS.
.TP
\f[B]\f[CB]w\f[B]\f[R], \f[B]\f[CB]W\f[B]\f[R]
Change the DFT window size.
.SH FILES
.TP
\f[I]\[ti]/.config/spek/preferences\f[R]
The configuration file for \f[I]Spek\f[R], stored in a simple INI
format.
.SH AUTHORS
.PP
Alexander Kojevnikov <alexander@kojevnikov.com>.
Other contributors are listed in the LICENCE.md file distributed with
the source code.
.SH DISTRIBUTION
.PP
The latest version of \f[I]Spek\f[R] may be downloaded from
<https://www.spek.cc>.