commit 72142860284ba0a492b29b6fe3539c7589dc1766
parent e7f37e5e2bbdddbc74bf8ba1f4c6ad9ec8e435dc
Author: Alexander Kojevnikov <alexander@kojevnikov.com>
Date: Wed, 19 Sep 2012 21:31:36 -0700
web: HTML version of the man page
Diffstat:
5 files changed, 147 insertions(+), 28 deletions(-)
diff --git a/Makefile.am b/Makefile.am
@@ -43,7 +43,11 @@ DISTCLEANFILES = \
intltool-merge \
intltool-update
-.PHONY: upload
+.PHONY: man upload
+
+man:
+ mandoc -man -Thtml -Ostyle=style.css man/spek.1 > web/man-@VERSION@.html
+ sed -e 's#<i>\(http://[^<]*\)</i>#<i><a href="\1">\1</a></i>#g' -i '' web/man-@VERSION@.html
upload:
rsync -avhz web/nginx.conf server:spek
diff --git a/man/spek.1.in b/man/spek.1.in
@@ -1,4 +1,4 @@
-.\" Copyright (C) 2011 Alexander Kojevnikov <alexander@kojevnikov.com>
+.\" Copyright (C) 2011-2012 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
@@ -13,30 +13,24 @@
.\" 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@"
+.TH SPEK "1" "2012-09-19" "Spek @VERSION@" ""
.SH NAME
Spek \- Acoustic Spectrum Analyser
.SH SYNOPSIS
.B spek
-[OPTION...] " " [FILE]
+[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.
+generates a spectrogram for the input audio file.
.SH OPTIONS
.TP
.BR \-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.)
+Output the help message then quit.
.TP
.BR \-V , " --version"
Output version information then quit.
.SH KEYBINDINGS
+.SS Menu
.TP
.B Ctrl-O
Open a new file.
@@ -52,6 +46,7 @@ Quit.
.TP
.B F1
Show the about dialog.
+.SS Spectrogram
.TP
.BR Ctrl-up , " Ctrl-down"
Change the lower limit of the dynamic range in dBFS.
@@ -62,10 +57,11 @@ Change the upper limit of the dynamic range in dBFS.
.TP
.I ~/.config/spek/preferences
The configuration file for Spek, stored in a simple INI format.
-.SH AUTHOR
-Alexander Kojevnikov <alexander@kojevnikov.com>
+.SH AUTHORS
+Alexander Kojevnikov <alexander@kojevnikov.com>. Other contributors are listed
+in the AUTHORS.md file distributed with the source code.
.SH DISTRIBUTION
The latest version of
.B Spek
may be downloaded from
-.IR http://spek\-project.org/ .
+.IR http://spek\-project.org .
diff --git a/web/index.html b/web/index.html
@@ -5,18 +5,7 @@
<title>Spek – Free Acoustic Spectrum Analyzer / Spectrogram Viewer</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<link rel="alternate" type="application/atom+xml" title="Spek Project News Feed" href="http://versia.com/category/spek/feed/atom/" />
- <style type="text/css">
- body {font-family: sans-serif; font-size: 11pt; width: 760px; margin: 20px auto; padding: 0;}
- h1, h2 {font-weight: bold;}
- h1 {font-size: 16pt;}
- h2 {font-size: 12pt;}
- img {border-style: none; outline: none;}
- #screenshots {width: 100%;}
- #screenshots td {width: 33%;}
- #download {width: 100%;}
- .dld_col {width: 33%; font-size: smaller;}
- .dld_link {vertical-align: top; padding-left: 0.5em; line-height: 1.4;}
- </style>
+ <link rel="stylesheet" href="style.css" />
</head>
<body>
<h1>Spek – Acoustic Spectrum Analyser<img src="spek.png" width="160" height="96" alt="Spek logo" style="float:right;"/></h1>
diff --git a/web/man-0.8.0.html b/web/man-0.8.0.html
@@ -0,0 +1,120 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta name="resource-type" content="document">
+<link rel="stylesheet" href="style.css" type="text/css" media="all">
+<title>
+SPEK(1)</title>
+</head>
+<body>
+<div class="mandoc">
+<table summary="Document Header" class="head" width="100%">
+<col width="30%">
+<col width="30%">
+<col width="30%">
+<tbody>
+<tr>
+<td class="head-ltitle">
+SPEK(1)</td>
+<td class="head-vol" align="center">
+</td>
+<td class="head-rtitle" align="right">
+SPEK(1)</td>
+</tr>
+</tbody>
+</table>
+<div class="section">
+<h1>NAME</h1> Spek - Acoustic Spectrum Analyser</div>
+<div class="section">
+<h1>SYNOPSIS</h1> <b>spek</b> [OPTION...] [FILE]</div>
+<div class="section">
+<h1>DESCRIPTION</h1> <b>Spek</b> generates a spectrogram for the input audio file.</div>
+<div class="section">
+<h1>OPTIONS</h1><dl>
+<dt>
+<b>-h</b>,<b> --help</b></dt>
+<dd>
+Output the help message then quit.</dd>
+</dl>
+<dl>
+<dt>
+<b>-V</b>,<b> --version</b></dt>
+<dd>
+Output version information then quit.</dd>
+</dl>
+</div>
+<div class="section">
+<h1>KEYBINDINGS</h1><div class="subsection">
+<h2>Menu</h2><dl>
+<dt>
+<b>Ctrl-O</b></dt>
+<dd>
+Open a new file.</dd>
+</dl>
+<dl>
+<dt>
+<b>Ctrl-S</b></dt>
+<dd>
+Save the spectrogram as an image file.</dd>
+</dl>
+<dl>
+<dt>
+<b>Ctrl-E</b></dt>
+<dd>
+Show the preferences dialog.</dd>
+</dl>
+<dl>
+<dt>
+<b>Ctrl-Q</b></dt>
+<dd>
+Quit.</dd>
+</dl>
+<dl>
+<dt>
+<b>F1</b></dt>
+<dd>
+Show the about dialog.</dd>
+</dl>
+</div>
+<div class="subsection">
+<h2>Spectrogram</h2><dl>
+<dt>
+<b>Ctrl-up</b>,<b> Ctrl-down</b></dt>
+<dd>
+Change the lower limit of the dynamic range in dBFS.</dd>
+</dl>
+<dl>
+<dt>
+<b>Ctrl-Shift-up</b>,<b> Ctrl-Shift-down</b></dt>
+<dd>
+Change the upper limit of the dynamic range in dBFS.</dd>
+</dl>
+</div>
+</div>
+<div class="section">
+<h1>FILES</h1><dl>
+<dt>
+<i>~/.config/spek/preferences</i></dt>
+<dd>
+The configuration file for Spek, stored in a simple INI format.</dd>
+</dl>
+</div>
+<div class="section">
+<h1>AUTHORS</h1> Alexander Kojevnikov <alexander@kojevnikov.com>. Other contributors are listed in the AUTHORS.md file distributed with the source code.</div>
+<div class="section">
+<h1>DISTRIBUTION</h1> The latest version of <b>Spek</b> may be downloaded from <i><a href="http://spek-project.org">http://spek-project.org</a></i>.</div>
+<table summary="Document Footer" class="foot" width="100%">
+<col width="50%">
+<col width="50%">
+<tr>
+<td class="foot-date">
+2012-09-19</td>
+<td class="foot-os" align="right">
+Spek 0.8.0</td>
+</tr>
+</table>
+</div>
+</body>
+</html>
+
diff --git a/web/style.css b/web/style.css
@@ -0,0 +1,10 @@
+body {font-family: sans-serif; font-size: 11pt; width: 760px; margin: 20px auto; padding: 0;}
+h1, h2 {font-weight: bold;}
+h1 {font-size: 16pt;}
+h2 {font-size: 12pt;}
+img {border-style: none; outline: none;}
+#screenshots {width: 100%;}
+#screenshots td {width: 33%;}
+#download {width: 100%;}
+.dld_col {width: 33%; font-size: smaller;}
+.dld_link {vertical-align: top; padding-left: 0.5em; line-height: 1.4;}
