add pn_handbook

build_all.sh

@@ -21,6 +21,10 @@ cd pn_default_xpp_config
 dpkg-buildpackage -us -uc
 cd ..
 
+cd pn_handbook
+dpkg-buildpackage -us -uc
+cd ..
+
 # ########################################################################## #
 # Move packages to release subdirectory
 

pn_handbook/Readme.md

@@ -0,0 +1 @@
+# The handbook for the PineNote Debian installation

pn_handbook/debian/README

@@ -0,0 +1,6 @@
+The Debian Package pn-handbook
+----------------------------
+
+<Comments regarding the Package.>
+
+ -- Maximilian Weigand <mweigand@koko>  Tue, 06 Jun 2023 13:25:01 +0200

pn_handbook/debian/README.Debian

@@ -0,0 +1,6 @@
+pn-handbook for Debian
+---------------------
+
+<Possible notes regarding this package - if none, delete this file.>
+
+ -- Maximilian Weigand <mweigand@koko>  Tue, 06 Jun 2023 13:25:01 +0200

pn_handbook/debian/README.source

@@ -0,0 +1,10 @@
+pn-handbook for Debian
+---------------------
+
+<This file describes information about the source package, see Debian policy
+manual section 4.14. You WILL either need to modify or delete this file.>
+
+
+
+ -- Maximilian Weigand <mweigand@koko>  Tue, 06 Jun 2023 13:25:01 +0200
+

pn_handbook/debian/changelog

@@ -0,0 +1,5 @@
+pn-handbook (1.0) UNRELEASED; urgency=medium
+
+  * Initial release.
+
+ -- Maximilian Weigand <mweigand@koko>  Tue, 06 Jun 2023 13:25:01 +0200

pn_handbook/debian/control

@@ -0,0 +1,19 @@
+Source: pn-handbook
+Section: unknown
+Priority: optional
+Maintainer: Maximilian Weigand <mweigand@koko>
+Rules-Requires-Root: no
+Build-Depends:
+ debhelper-compat (= 13),
+Standards-Version: 4.6.2
+Homepage: <insert the upstream URL, if relevant>
+#Vcs-Browser: https://salsa.debian.org/debian/pn-handbook
+#Vcs-Git: https://salsa.debian.org/debian/pn-handbook.git
+
+Package: pn-handbook
+Architecture: all
+Depends:
+ ${misc:Depends},
+ firefox-esr
+Description: <insert up to 60 chars description>
+ <Insert long description, indented with spaces.>

pn_handbook/debian/copyright

@@ -0,0 +1,43 @@
+Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+Source: <url://example.com>
+Upstream-Name: pn-handbook
+Upstream-Contact: <preferred name and address to reach the upstream project>
+
+Files:
+ *
+Copyright:
+ <years> <put author's name and email here>
+ <years> <likewise for another author>
+License: GPL-3.0+
+
+Files:
+ debian/*
+Copyright:
+ 2023 Maximilian Weigand <mweigand@koko>
+License: GPL-3.0+
+
+License: GPL-3.0+
+ 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 package 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 <https://www.gnu.org/licenses/>.
+Comment:
+ On Debian systems, the complete text of the GNU General
+ Public License version 3 can be found in "/usr/share/common-licenses/GPL-3".
+
+# Please also look if there are files or directories which have a
+# different copyright/license attached and list them here.
+# Please avoid picking licenses with terms that are more restrictive than the
+# packaged work, as it may make Debian's contributions unacceptable upstream.
+#
+# If you need, there are some extra license texts available in two places:
+#   /usr/share/debhelper/dh_make/licenses/
+#   /usr/share/common-licenses/

pn_handbook/debian/manpage.1.ex

@@ -0,0 +1,56 @@
+.\"                                      Hey, EMACS: -*- nroff -*-
+.\" (C) Copyright 2023 Maximilian Weigand <mweigand@koko>,
+.\"
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH Pn-handbook SECTION "June  6 2023"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh        disable hyphenation
+.\" .hy        enable hyphenation
+.\" .ad l      left justify
+.\" .ad b      justify to both left and right margins
+.\" .nf        disable filling
+.\" .fi        enable filling
+.\" .br        insert line break
+.\" .sp <n>    insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+pn-handbook \- program to do something
+.SH SYNOPSIS
+.B pn-handbook
+.RI [ options ] " files" ...
+.br
+.B bar
+.RI [ options ] " files" ...
+.SH DESCRIPTION
+This manual page documents briefly the
+.B pn-handbook
+and
+.B bar
+commands.
+.PP
+.\" TeX users may be more comfortable with the \fB<whatever>\fP and
+.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
+.\" respectively.
+\fBpn-handbook\fP is a program that...
+.SH OPTIONS
+These programs follow the usual GNU command line syntax, with long
+options starting with two dashes ('\-').
+A summary of options is included below.
+For a complete description, see the Info files.
+.TP
+.B \-h, \-\-help
+Show summary of options.
+.TP
+.B \-v, \-\-version
+Show version of program.
+.SH SEE ALSO
+.BR bar (1),
+.BR baz (1).
+.br
+The programs are documented fully by
+.IR "The Rise and Fall of a Fooish Bar" ,
+available via the Info system.

pn_handbook/debian/manpage.md.ex

@@ -0,0 +1,126 @@
+% pn-handbook(SECTION) | User Commands
+%
+% "June  6 2023"
+
+[comment]: # The lines above form a Pandoc metadata block. They must be
+[comment]: # the first ones in the file.
+[comment]: # See https://pandoc.org/MANUAL.html#metadata-blocks for details.
+
+[comment]: # pandoc -s -f markdown -t man package.md -o package.1
+[comment]: # 
+[comment]: # A manual page package.1 will be generated. You may view the
+[comment]: # manual page with: nroff -man package.1 | less. A typical entry
+[comment]: # in a Makefile or Makefile.am is:
+[comment]: # 
+[comment]: # package.1: package.md
+[comment]: #         pandoc --standalone --from=markdown --to=man $< --output=$@
+[comment]: # 
+[comment]: # The pandoc binary is found in the pandoc package. Please remember
+[comment]: # that if you create the nroff version in one of the debian/rules
+[comment]: # file targets, such as build, you will need to include pandoc in
+[comment]: # your Build-Depends control field.
+
+[comment]: # Remove the lines starting with '[comment]:' in this file in order
+[comment]: # to avoid warning messages from pandoc.
+
+# NAME
+
+pn-handbook - program to do something
+
+# SYNOPSIS
+
+**pn-handbook** **-e** _this_ [**\-\-example=that**] [{**-e** | **\-\-example**} _this_]
+                 [{**-e** | **\-\-example**} {_this_ | _that_}]
+
+**pn-handbook** [{**-h** | *\-\-help**} | {**-v** | **\-\-version**}]
+
+# DESCRIPTION
+
+This manual page documents briefly the **pn-handbook** and **bar** commands.
+
+This manual page was written for the Debian distribution because the
+original program does not have a manual page. Instead, it has documentation
+in the GNU info(1) format; see below.
+
+**pn-handbook** is a program that...
+
+# OPTIONS
+
+The program follows the usual GNU command line syntax, with long options
+starting with two dashes ('-'). A summary of options is included below. For
+a complete description, see the **info**(1) files.
+
+**-e** _this_, **\-\-example=**_that_
+:   Does this and that.
+
+**-h**, **\-\-help**
+:   Show summary of options.
+
+**-v**, **\-\-version**
+:   Show version of program.
+
+# FILES
+
+/etc/foo.conf
+:   The system-wide configuration file to control the behaviour of
+    pn-handbook. See **foo.conf**(5) for further details.
+
+${HOME}/.foo.conf
+:   The per-user configuration file to control the behaviour of
+    pn-handbook. See **foo.conf**(5) for further details.
+
+# ENVIRONMENT
+
+**FOO_CONF**
+:   If used, the defined file is used as configuration file (see also
+    the section called “FILES”).
+
+# DIAGNOSTICS
+
+The following diagnostics may be issued on stderr:
+
+Bad configuration file. Exiting.
+:   The configuration file seems to contain a broken configuration
+    line. Use the **\-\-verbose** option, to get more info.
+
+**pn-handbook** provides some return codes, that can be used in scripts:
+
+    Code Diagnostic
+    0 Program exited successfully.
+    1 The configuration file seems to be broken.
+
+# BUGS
+
+The program is currently limited to only work with the foobar library.
+
+The upstream BTS can be found at http://bugzilla.foo.tld.
+
+# SEE ALSO
+
+**bar**(1), **baz**(1), **foo.conf**(5)
+
+The programs are documented fully by The Rise and Fall of a Fooish Bar
+available via the **info**(1) system.
+
+# AUTHOR
+
+Maximilian Weigand <mweigand@koko>
+:   Wrote this manpage for the Debian system.
+
+# COPYRIGHT
+
+Copyright © 2007 Maximilian Weigand
+
+This manual page was written for the Debian system (and may be used by
+others).
+
+Permission is granted to copy, distribute and/or modify this document under
+the terms of the GNU General Public License, Version 2 or (at your option)
+any later version published by the Free Software Foundation.
+
+On Debian systems, the complete text of the GNU General Public License
+can be found in /usr/share/common-licenses/GPL.
+
+[comment]: #  Local Variables:
+[comment]: #  mode: markdown
+[comment]: #  End: