[PATCH gnupg-doc] web: Import Scute documentation.

Damien Goutte-Gattat dgouttegattat at incenp.org
Sun Sep 15 14:18:39 CEST 2019

Hi GnuPG folks,

The patch below is the first step to move Scute's documentation from
scute.org to gnupg.org.

The next step  will be to make sure the manual (stored in Scute's git
repo under doc/manual and hosted at http://scute.org/scute.html/) is
available at http://gnupg.org/documentation/manuals/. The patch below
takes care of adding a link to the correct destination, but the manual
files will also need to be placed under the /var/www/shared/manuals
directory on the web server.


- Damien

-- >8 --
Subject: [PATCH gnupg-doc] web: Import scute documentation.

Fill the Scute page with a condensed version of what is currently
on Scute's own website. Also list the Scute manual along with the
other manuals in web/documentation/manuals.
 web/documentation/manuals.org |  1 +
 web/software/scute/index.org  | 56 +++++++++++++++++++++++++++++++++++++++----
 2 files changed, 53 insertions(+), 4 deletions(-)

diff --git a/web/documentation/manuals.org b/web/documentation/manuals.org
index d72ff1a..ff314e4 100644
--- a/web/documentation/manuals.org
+++ b/web/documentation/manuals.org
@@ -12,3 +12,4 @@
   - Libksba manual :: [[file:manuals/ksba/][HTML]], [[file:manuals/ksba.pdf][PDF]].
   - Libassuan manual :: [[file:manuals/assuan/][HTML]], [[file:manuals/assuan.pdf][PDF]].
   - GPGME manual :: [[file:manuals/gpgme/][HTML]], [[file:manuals/gpgme.pdf][PDF]].
+  - Scute manual :: [[file:manuals/scute/][HTML]], [[file:manuals/scute.pdf][PDF]].
diff --git a/web/software/scute/index.org b/web/software/scute/index.org
index 613814f..9ca0ab3 100644
--- a/web/software/scute/index.org
+++ b/web/software/scute/index.org
@@ -4,10 +4,58 @@
 * Scute
-  /Scute/ is a PKCS#11 provider on top of GnuPG.
+  /Scute/ is a [[https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=pkcs11][PKCS#11]
+  provider on top of GnuPG.  It adds support for the [[https://www.g10code.com/p-card.html][OpenPGP
+  smartcard]] and PIV cards to the [[https://developer.mozilla.org/en-US/docs/Mozilla/Projects/NSS]
+  [Mozilla Network Security Services]] (NSS).
-  Please [[https://www.scute.org][www.scute.org]] for details until we have moved the
-  docs to this page.
+  This allows you to use your OpenPGP or PIV card as a security device in [[https://www.mozilla.org/]
+  [Firefox]] and other software that makes use of the NSS library.
-  See [[../../download/index.org::#scute][download]] section to download the latest tarball.  The current
+  Currently, supported usages are HTTPS client authentication, S/MIME email signing, and document
+  signing with [[https://www.libreoffice.org/][LibreOffice]].
+  See the [[../../download/index.org::#scute][download]] section to download the latest tarball.
+  The user manual is available [[file:../../documentation/manuals/scute/][here]].  The current
   version is {{{scute_ver}}}.
+** Installation
+  Scute requires the following packages to compile:
+  - [[file:../libgpg-error/][libgpg-error]] >= 1.24
+  - [[file:../libassuan/][libassuan]] >= 2.5.0
+  Scute also requires the following packages to run:
+  - Firefox, Thunderbird or any other supported application using PKCS#11
+  - [[file:../][GnuPG]] >= 2.2.0
+  - [[file:../pinentry/][Pinentry]]
+  Canonical installation instructions can be found in the file INSTALL in the top-level directory
+  of the source packages.
+** Development
+  The source of Scute is managed using the GIT distributed revision control system. The repository
+  can be retrieved with the following command:
+  : git clone git://git.gnupg.org/scute.git
+  Please send an e-mail to the [[http://lists.gnupg.org/mailman/listinfo/gnupg-devel][GnuPG
+  development mailing list]] if you are interested in participating in Scute development.  Bugs
+  reports should be submitted to our [[https://bugs.gnupg.org/][bug tracking system]] or sent via
+  e-mail to the GnuPG development mailing list.
+  A web interface to the [[http://git.gnupg.org/cgi-bin/gitweb.cgi?p=scute.git][Scute source
+  repository]] is available on-line, and contains up-to-date as well as archived versions of
+  all files included in the Scute source package, including the most recent development changes.
+** Contact
+  Scute is developed and maintained by [[https://www.g10code.com/][g10 Code GmbH]]. You can support
+  its development by [[https://www.g10code.com/support.html][getting support contracts]] for custom
+  development, security consulting and training.
+  The members of our community can be reached via e-mail on the
+  [[http://www.gnupg.org/documentation/mailing-lists.html][GnuPG mailing lists]].

More information about the Gnupg-devel mailing list