commit 7149bd7cebcdf4670a9f4977f385d7945ca5620a
parent 3dfa1171f44957022445598fc7a37a37bdf943b5
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Wed, 25 Oct 2017 16:07:56 +0200
Add the about section
Diffstat:
12 files changed, 128 insertions(+), 77 deletions(-)
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
+about.html
release_notes.html.in
solstice.html
solstice-downloads.html
diff --git a/Makefile b/Makefile
@@ -26,7 +26,7 @@ REMOTE=OVH:www/solstice/
default: all
.PHONY: all
-all: solstice schiff
+all: misc solstice schiff
.PHONY: solstice
solstice:
@@ -66,3 +66,7 @@ publish:
schiff: schiff.html.in
@sh schiff.sh $(SCHIFF-VERSION) $(SCHIFF-SCRIPTS)
+.PHONY: misc
+misc:
+ @sh misc.sh
+
diff --git a/about.html.in b/about.html.in
@@ -0,0 +1,5 @@
+<header>
+ <h1 >|Méso|Star></h2>
+</header>
+
+
diff --git a/misc.sh b/misc.sh
@@ -0,0 +1,31 @@
+#!/bin/bash
+
+# Copyright (C) |Meso|Star> 2017
+#
+# This program 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.
+#
+# This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
+
+set -e
+
+source ./solstice-menu.sh
+
+tput bold; echo ">>> Miscellaneous web pages"; tput sgr0
+echo "Write pgp_signatures.html"
+{
+ print_header About dummy
+ cat about.html.in
+ VERSION=$1 envsubst < pgp_signatures.html.in
+ print_footer
+} > about.html
+
+echo ""
diff --git a/pgp_signature.html.in b/pgp_signature.html.in
@@ -1,68 +0,0 @@
-<h2 id=pgp>PGP signatures</h2>
-
-<p>The Solstice archives are cryptographically signed using <a
-href="https://en.wikipedia.org/wiki/Pretty_Good_Privacy#How_PGP_encryption_works">
-OpenPGP</a>-compliant signatures. Everyone is encouraged to check the integrity
-of the downloaded content by verifying its corresponding signature. The signing
-and verification process ensures that the downloaded files were not modified or
-tampered since their creation and thus prevents anyone to use corrupted files.</p>
-
-<p>On GNU/Linux, the most common way for verifying the PGP signature is to use
-<a href=https://www.gnupg.org/>GnuPG</a>. First ensure that GnuPG is installed
-on your system. Then download the archive and its PGP signature and use the
-<code>gpg2</code> command to check the integrity of the archive against its
-signature.
-
-<pre class="code">
-$ wget www.meso-star.com/solstice/downloads/Solstice-${VERSION}-GNU-Linux.tar.gz
-$ wget www.meso-star.com/solstice/downloads/Solstice-${VERSION}-GNU-Linux.tar.gz.sig
-$ gpg2 --verify Solstice-${VERSION}-GNU-Linux.tar.gz.sig
-</pre>
-
-<p>The first time you may obtain the likely output:</p>
-
-<pre class="code">
-gpg: Signature made Wed 20 Sep 2017 08:28:35 AM CEST using RSA key 7322B68F7896C455
-gpg: Can't check signature: No public key
-</pre>
-
-<p>This means that you do not have the public part of the PGP key used to sign
-the Solstice archive. In the previous example the key identifier is
-<code>7322B68F7896C455</code>. Use <code>gpg2</code> to download this key from
-the PGP keyserver.</p>
-
-<pre class="code">
-$ gpg2 --keyserver hkps://hkps.pool.sks-keyservers.net --recv-keys 7322B68F7896C455
-</pre>
-
-<p>Now you can check the integrity of the archive with respect to the
-previously downloaded public-key.</p>
-
-<pre class="code">
-$ gpg2 --verify Solstice-${VERSION}-GNU-Linux.tar.gz.sig
-gpg: assuming signed data in 'Solstice-0.4.1-GNU-Linux64.tar.gz'
-gpg: Signature made Tue 26 Sep 2017 09:28:40 AM CEST
-gpg: using RSA key 1F494948BAA4F5F4A0AF82FF7322B68F7896C455
-gpg: Good signature from "Vincent Forest (http://www.meso-star.com)
-gpg: <vincent.forest@meso-star.com>" [ultimate]
-gpg: WARNING: This key is not certified with a trusted signature!
-gpg: There is no indication that the signature belongs to the owner.
-Primary key fingerprint: 20EB E4CF 3D9F 4B9A E55D 5F59 679F 2975 93B2 C8A2
- Subkey fingerprint: 1F49 4948 BAA4 F5F4 A0AF 82FF 7322 B68F 7896 C455
-</pre>
-
-<p>Note that GnuPG warns that the key is not certified. In other words you
-cannot be sure that the key used to sign the archive really belongs to the
-owner. The best option is to physically meet the actual owner and ask for him
-about the key validity. More simply, but also less secure, you can review the
-list of signatures of the key with <code>gpg2 --list-sigs</code> and then make a
-decision whether you <a
-href="https://www.gnupg.org/gph/en/manual/x334.html">trust</a> that key or
-not.</p>
-
-<p>On Windows, you can use the <a href="https://www.gpg4win.org/">GPG4Win</a>
-tool to verify the archive signature. The process is roughly the same that on
-GNU/Linux: you first have to import the public key used to sign the archive
-before verifying its integrity and checking that the imported key really
-belongs to the owner.</p>
-
diff --git a/pgp_signatures.html.in b/pgp_signatures.html.in
@@ -0,0 +1,70 @@
+<h2 id=PGP>PGP signatures</h2>
+
+<p>The majority of archives that we distribue are cryptographically signed
+using <a
+href="https://en.wikipedia.org/wiki/Pretty_Good_Privacy#How_PGP_encryption_works">
+OpenPGP</a>-compliant signatures. Everyone is encouraged to check the integrity
+of the downloaded content by verifying its corresponding signature. The signing
+and verification process ensures that the downloaded files were not modified or
+tampered since their creation and thus prevents anyone to use corrupted
+files.</p>
+
+<p>On GNU/Linux, the most common way for verifying the PGP signature is to use
+<a href=https://www.gnupg.org/>GnuPG</a>. First ensure that GnuPG is installed
+on your system. Then download the archive and its PGP signature and use the
+<code>gpg2</code> command to check the integrity of the archive against its
+signature. For instance, for the <a href="solstice.html">Solstice</a> archive:
+
+<pre class="code">
+$ wget www.meso-star.com/solstice/downloads/Solstice-${VERSION}-GNU-Linux.tar.gz
+$ wget www.meso-star.com/solstice/downloads/Solstice-${VERSION}-GNU-Linux.tar.gz.sig
+$ gpg2 --verify Solstice-${VERSION}-GNU-Linux.tar.gz.sig
+</pre>
+
+<p>The first time you may obtain the likely output:</p>
+
+<pre class="code">
+gpg: Signature made Wed 20 Sep 2017 08:28:35 AM CEST using RSA key 7322B68F7896C455
+gpg: Can't check signature: No public key
+</pre>
+
+<p>This means that you do not have the public part of the PGP key used to sign
+this archive. In the previous example the key identifier is
+<code>7322B68F7896C455</code>. Use <code>gpg2</code> to download this key from
+the PGP keyserver.</p>
+
+<pre class="code">
+$ gpg2 --keyserver hkps://hkps.pool.sks-keyservers.net --recv-keys 7322B68F7896C455
+</pre>
+
+<p>Now you can check the integrity of the archive with respect to the
+previously downloaded public-key.</p>
+
+<pre class="code">
+$ gpg2 --verify Solstice-${VERSION}-GNU-Linux.tar.gz.sig
+gpg: assuming signed data in 'Solstice-0.4.1-GNU-Linux64.tar.gz'
+gpg: Signature made Tue 26 Sep 2017 09:28:40 AM CEST
+gpg: using RSA key 1F494948BAA4F5F4A0AF82FF7322B68F7896C455
+gpg: Good signature from "Vincent Forest (http://www.meso-star.com)
+gpg: <vincent.forest@meso-star.com>" [ultimate]
+gpg: WARNING: This key is not certified with a trusted signature!
+gpg: There is no indication that the signature belongs to the owner.
+Primary key fingerprint: 20EB E4CF 3D9F 4B9A E55D 5F59 679F 2975 93B2 C8A2
+ Subkey fingerprint: 1F49 4948 BAA4 F5F4 A0AF 82FF 7322 B68F 7896 C455
+</pre>
+
+<p>Note that GnuPG warns that the key is not certified. In other words you
+cannot be sure that the key used to sign the archive really belongs to the
+owner. The best option is to physically meet the actual owner and ask for him
+about the key validity. More simply, but also less secure, you can review the
+list of signatures of the key with <code>gpg2 --list-sigs</code> and then make a
+decision whether you <a
+href="https://www.gnupg.org/gph/en/manual/x334.html">trust</a> that key or
+not.</p>
+
+<p>On Windows, you can use the <a href="https://www.gpg4win.org/">GPG4Win</a>
+tool to verify the archive signature. The process is roughly the same that on
+GNU/Linux: you first have to import the public key used to sign the archive
+before verifying its integrity and checking that the imported key really
+belongs to the owner.</p>
+
diff --git a/schiff.html b/schiff.html
@@ -10,6 +10,7 @@
<body>
<div id="menu">
+ <h2><a href=about.html>About</a></h2>
<h2 id=cur>Schiff</h2>
<div id=sub-menu>
<ul>
@@ -21,6 +22,9 @@
<li><a href="man/man5/schiff-geometry.5.html">schiff-geometry</a></li>
<li><a href="man/man5/schiff-output.5.html">schiff-output</a></li>
</ul>
+ <ul>
+ <li><a href=https://gitlab.com/meso-star/schiff>Source code repository</a></li>
+ </ul>
<div id="info">
<p>Schiff is developped by <a
href="https://www.meso-star.com">|Méso|Star></a> for the
@@ -92,12 +96,11 @@ with respect to the targeted toolchain.</p>
<h2>Quick start</h2>
<p>Download the desired archive of Schiff and verify its integrity against its
-<a href=pgp.html>PGP signature</a>. Then extract it. Finally source the
+<a href=about.html>PGP signature</a>. Then extract it. Finally source the
provided <code>schiff.profile</code> file to register the Schiff installation
for the current shell priorly to the invocation of the <code>schiff</code>
program.</p>
-
<pre class="code">
$ source ~/Schiff-0.3.0-GNU-Linux64/etc/schiff.profile
$ solstice -h
diff --git a/schiff.html.in b/schiff.html.in
@@ -59,12 +59,11 @@ with respect to the targeted toolchain.</p>
<h2>Quick start</h2>
<p>Download the desired archive of Schiff and verify its integrity against its
-<a href=pgp.html>PGP signature</a>. Then extract it. Finally source the
+<a href=about.html>PGP signature</a>. Then extract it. Finally source the
provided <code>schiff.profile</code> file to register the Schiff installation
for the current shell priorly to the invocation of the <code>schiff</code>
program.</p>
-
<pre class="code">
$ source ~/Schiff-${VERSION}-GNU-Linux64/etc/schiff.profile
$ solstice -h
diff --git a/solstice-menu.sh b/solstice-menu.sh
@@ -53,6 +53,9 @@ print_schiff_sub_menu() {
fi
done
echo ' </ul>'
+ echo ' <ul>'
+ echo " <li><a href=https://gitlab.com/meso-star/schiff>Source code repository</a></li>"
+ echo ' </ul>'
echo ' <div id="info">'
echo ' <p>Schiff is developped by <a'
echo ' href="https://www.meso-star.com">|Méso|Star></a> for the'
@@ -129,6 +132,11 @@ print_header() {
echo ''
echo '<body>'
echo '<div id="menu">'
+ if [ "$section" == "About" ]; then
+ echo ' <h2 id=cur>About</h2>'
+ else
+ echo " <h2><a href=${root}about.html>About</a></h2>"
+ fi
if [ "$section" == "Schiff" ]; then
echo ' <h2 id=cur>Schiff</h2>'
print_schiff_sub_menu "$root" "$name"
@@ -141,7 +149,6 @@ print_header() {
else
echo " <h2><a href=${root}solstice.html>Solstice</a></h2>"
fi
-
echo '</div>'
echo '<div id=content>'
}
diff --git a/solstice-resources.html.in b/solstice-resources.html.in
@@ -45,7 +45,7 @@ href="https://www.gnu.org/licenses/gpl.html">license</a> for details.</p>
</table>
<p>To use these tools, download the provided archive and verify its integrity
-against its <a href=solstice-downloads.html#pgp>PGP signature</a>. This archive
+against its <a href=about.html#pgp>PGP signature</a>. This archive
contains the sources of the program and a GNU/Makefile to simplify the build
process on GNU/Linux and on Windows through <a
href="http://www.mingw.org/">MinGW</a>. Extract it and run <code>make</code> to
diff --git a/solstice.html.in b/solstice.html.in
@@ -96,7 +96,7 @@ materials of the simulated solar plant.</p>
<h2>Quick start</h2>
<p>Get the desired archive of Solstice and verify its integrity against its <a
-href=solstice-downloads.html#pgp>PGP signature</a>. Then extract it. On
+href=about.html#pgp>PGP signature</a>. Then extract it. On
Windows, open a command prompt into the Solstice bin directory and invoke the
<code>solstice.exe</code> executable. You can alternatively register its
directory into the <code>path</code> environment variable to expose the
diff --git a/solstice.sh b/solstice.sh
@@ -188,7 +188,6 @@ echo "Write solstice-downloads.html"
print_header Solstice Downloads;
echo '<header><h1>Downloads</h1></header>';
print_downloads;
- VERSION=$1 envsubst < pgp_signature.html.in;
cat release_notes.html.in;
print_footer;
} > solstice-downloads.html;
