summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGDR! <gdr@gdr.name>2020-08-15 06:53:46 +0000
committerGDR! <gdr@gdr.name>2020-08-15 06:53:46 +0000
commitf213190978c96592e52bc0f734116634404ae39c (patch)
treef47e1ccb1f0f50210481a7ef447ae9479eccf1be
parent3cd3c88bde3029230f1d436486c57a587f177c13 (diff)
parentd8e575311daf1f64425d19773378e7bb1a9c2f17 (diff)
Merge branch 'master' of ssh://ssh.rocketgit.com/user/gdr/tuntox into master
-rw-r--r--Makefile3
-rw-r--r--VPN.md2
-rw-r--r--debian/README.Debian6
-rw-r--r--debian/README.source10
-rw-r--r--debian/changelog5
-rw-r--r--debian/control17
-rw-r--r--debian/copyright53
-rw-r--r--debian/manpage.1.ex56
-rw-r--r--debian/manpage.sgml.ex154
-rw-r--r--debian/manpage.xml.ex291
-rw-r--r--debian/postinst.ex39
-rw-r--r--debian/postrm.ex37
-rw-r--r--debian/preinst.ex35
-rw-r--r--debian/prerm.ex38
-rwxr-xr-xdebian/rules25
-rw-r--r--debian/salsa-ci.yml.ex11
-rw-r--r--debian/source/format1
-rw-r--r--debian/tuntox-docs.docs2
-rw-r--r--debian/tuntox.cron.d.ex4
-rw-r--r--debian/tuntox.doc-base.EX20
-rw-r--r--debian/watch.ex38
21 files changed, 846 insertions, 1 deletions
diff --git a/Makefile b/Makefile
index aa9c71b..5c0f6a7 100644
--- a/Makefile
+++ b/Makefile
@@ -40,4 +40,7 @@ cscope.out:
40clean: 40clean:
41 rm -f *.o tuntox cscope.out gitversion.h tox_bootstrap.h 41 rm -f *.o tuntox cscope.out gitversion.h tox_bootstrap.h
42 42
43install: tuntox_nostatic
44 cp tuntox_nostatic $(DESTDIR)/bin/tuntox
45
43.PHONY: all clean tuntox 46.PHONY: all clean tuntox
diff --git a/VPN.md b/VPN.md
index 7fe339a..f1c8658 100644
--- a/VPN.md
+++ b/VPN.md
@@ -38,6 +38,6 @@ On the client:
38 64 bytes from 10.20.30.41: icmp_seq=4 ttl=64 time=151 ms 38 64 bytes from 10.20.30.41: icmp_seq=4 ttl=64 time=151 ms
39 64 bytes from 10.20.30.41: icmp_seq=5 ttl=64 time=50.3 ms 39 64 bytes from 10.20.30.41: icmp_seq=5 ttl=64 time=50.3 ms
40 40
41Based on [Ben Martin's article](https://www.linux.com/news/software/developer/17942-socat-the-general-bidirectional-pipe-handler) 41Based on [Ben Martin's article](https://web.archive.org/web/20160102211752/http://www.linux.com/news/software/developer/17942-socat-the-general-bidirectional-pipe-handler)
42 42
43I've also heard about a new program called [ToxVPN](https://github.com/cleverca22/toxvpn), who knows - maybe it does a better job? And more recently someone created [toxtun](http://toxtun.jschwab.org/), slowclap.gif for the creative choice of name. 43I've also heard about a new program called [ToxVPN](https://github.com/cleverca22/toxvpn), who knows - maybe it does a better job? And more recently someone created [toxtun](http://toxtun.jschwab.org/), slowclap.gif for the creative choice of name.
diff --git a/debian/README.Debian b/debian/README.Debian
new file mode 100644
index 0000000..5d1aa00
--- /dev/null
+++ b/debian/README.Debian
@@ -0,0 +1,6 @@
1tuntox for Debian
2----------------
3
4<possible notes regarding this package - if none, delete this file>
5
6 -- GDR! <gdr@gdr.name> Fri, 14 Aug 2020 10:06:39 +0000
diff --git a/debian/README.source b/debian/README.source
new file mode 100644
index 0000000..29d0d5d
--- /dev/null
+++ b/debian/README.source
@@ -0,0 +1,10 @@
1tuntox for Debian
2----------------
3
4<this file describes information about the source package, see Debian policy
5manual section 4.14. You WILL either need to modify or delete this file>
6
7
8
9 -- GDR! <gdr@gdr.name> Fri, 14 Aug 2020 10:06:39 +0000
10
diff --git a/debian/changelog b/debian/changelog
new file mode 100644
index 0000000..7cb8a35
--- /dev/null
+++ b/debian/changelog
@@ -0,0 +1,5 @@
1tuntox (0.0.9-1) unstable; urgency=medium
2
3 * Initial release (Closes: #nnnn) <nnnn is the bug number of your ITP>
4
5 -- GDR! <gdr@gdr.name> Fri, 14 Aug 2020 10:06:39 +0000
diff --git a/debian/control b/debian/control
new file mode 100644
index 0000000..beba103
--- /dev/null
+++ b/debian/control
@@ -0,0 +1,17 @@
1Source: tuntox
2Section: net
3Priority: optional
4Maintainer: GDR! <gdr@gdr.name>
5Build-Depends: debhelper-compat (= 12), libtoxcore-dev,
6 pkg-config, build-essential, make, libtoxcore-dev,
7 python-jinja2, python-requests
8Standards-Version: 4.5.0
9Homepage: https://gdr.name/tuntox/
10#Vcs-Browser: https://salsa.debian.org/debian/tuntox
11Vcs-Git: https://github.com/gjedeer/tuntox.git
12
13Package: tuntox
14Architecture: any
15Depends: ${shlibs:Depends}, ${misc:Depends}
16Description: <insert up to 60 chars description>
17 <insert long description, indented with spaces>
diff --git a/debian/copyright b/debian/copyright
new file mode 100644
index 0000000..97b81f6
--- /dev/null
+++ b/debian/copyright
@@ -0,0 +1,53 @@
1Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
2Upstream-Name: tuntox
3Upstream-Contact: gdr@gdr.name
4Source: https://github.com/gjedeer/tuntox
5
6Files: *
7Copyright: 2014-2020 GDR!
8License: GPL-3
9 This program is free software: you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation, either version 3 of the License, or
12 (at your option) any later version.
13 .
14 This package is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
18 .
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>.
21 .
22 On Debian systems, the complete text of the GNU General
23 Public License version 3 can be found in "/usr/share/common-licenses/GPL-3".
24
25# If you want to use GPL v2 or later for the /debian/* files use
26# the following clauses, or change it to suit. Delete these two lines
27Files: debian/*
28Copyright: 2020 GDR! <gdr@gdr.name>
29License: GPL-3+
30 This program is free software: you can redistribute it and/or modify
31 it under the terms of the GNU General Public License as published by
32 the Free Software Foundation, either version 3 of the License, or
33 (at your option) any later version.
34 .
35 This package is distributed in the hope that it will be useful,
36 but WITHOUT ANY WARRANTY; without even the implied warranty of
37 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
38 GNU General Public License for more details.
39 .
40 You should have received a copy of the GNU General Public License
41 along with this program. If not, see <http://www.gnu.org/licenses/>.
42 .
43 On Debian systems, the complete text of the GNU General
44 Public License version 3 can be found in "/usr/share/common-licenses/GPL-3".
45
46# Please also look if there are files or directories which have a
47# different copyright/license attached and list them here.
48# Please avoid picking licenses with terms that are more restrictive than the
49# packaged work, as it may make Debian's contributions unacceptable upstream.
50#
51# If you need, there are some extra license texts available in two places:
52# /usr/share/debhelper/dh_make/licenses/
53# /usr/share/common-licenses/
diff --git a/debian/manpage.1.ex b/debian/manpage.1.ex
new file mode 100644
index 0000000..9e6400d
--- /dev/null
+++ b/debian/manpage.1.ex
@@ -0,0 +1,56 @@
1.\" Hey, EMACS: -*- nroff -*-
2.\" (C) Copyright 2020 GDR! <gdr@gdr.name>,
3.\"
4.\" First parameter, NAME, should be all caps
5.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
6.\" other parameters are allowed: see man(7), man(1)
7.TH Tuntox SECTION "August 14 2020"
8.\" Please adjust this date whenever revising the manpage.
9.\"
10.\" Some roff macros, for reference:
11.\" .nh disable hyphenation
12.\" .hy enable hyphenation
13.\" .ad l left justify
14.\" .ad b justify to both left and right margins
15.\" .nf disable filling
16.\" .fi enable filling
17.\" .br insert line break
18.\" .sp <n> insert n+1 empty lines
19.\" for manpage-specific macros, see man(7)
20.SH NAME
21tuntox \- program to do something
22.SH SYNOPSIS
23.B tuntox
24.RI [ options ] " files" ...
25.br
26.B bar
27.RI [ options ] " files" ...
28.SH DESCRIPTION
29This manual page documents briefly the
30.B tuntox
31and
32.B bar
33commands.
34.PP
35.\" TeX users may be more comfortable with the \fB<whatever>\fP and
36.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
37.\" respectively.
38\fBtuntox\fP is a program that...
39.SH OPTIONS
40These programs follow the usual GNU command line syntax, with long
41options starting with two dashes (`-').
42A summary of options is included below.
43For a complete description, see the Info files.
44.TP
45.B \-h, \-\-help
46Show summary of options.
47.TP
48.B \-v, \-\-version
49Show version of program.
50.SH SEE ALSO
51.BR bar (1),
52.BR baz (1).
53.br
54The programs are documented fully by
55.IR "The Rise and Fall of a Fooish Bar" ,
56available via the Info system.
diff --git a/debian/manpage.sgml.ex b/debian/manpage.sgml.ex
new file mode 100644
index 0000000..975ca16
--- /dev/null
+++ b/debian/manpage.sgml.ex
@@ -0,0 +1,154 @@
1<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
2
3<!-- Process this file with docbook-to-man to generate an nroff manual
4 page: `docbook-to-man manpage.sgml > manpage.1'. You may view
5 the manual page with: `docbook-to-man manpage.sgml | nroff -man |
6 less'. A typical entry in a Makefile or Makefile.am is:
7
8manpage.1: manpage.sgml
9 docbook-to-man $< > $@
10
11
12 The docbook-to-man binary is found in the docbook-to-man package.
13 Please remember that if you create the nroff version in one of the
14 debian/rules file targets (such as build), you will need to include
15 docbook-to-man in your Build-Depends control field.
16
17 -->
18
19 <!-- Fill in your name for FIRSTNAME and SURNAME. -->
20 <!ENTITY dhfirstname "<firstname>FIRSTNAME</firstname>">
21 <!ENTITY dhsurname "<surname>SURNAME</surname>">
22 <!-- Please adjust the date whenever revising the manpage. -->
23 <!ENTITY dhdate "<date>August 14 2020</date>">
24 <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
25 allowed: see man(7), man(1). -->
26 <!ENTITY dhsection "<manvolnum>SECTION</manvolnum>">
27 <!ENTITY dhemail "<email>gdr@gdr.name</email>">
28 <!ENTITY dhusername "GDR!">
29 <!ENTITY dhucpackage "<refentrytitle>Tuntox</refentrytitle>">
30 <!ENTITY dhpackage "tuntox">
31
32 <!ENTITY debian "<productname>Debian</productname>">
33 <!ENTITY gnu "<acronym>GNU</acronym>">
34 <!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
35]>
36
37<refentry>
38 <refentryinfo>
39 <address>
40 &dhemail;
41 </address>
42 <author>
43 &dhfirstname;
44 &dhsurname;
45 </author>
46 <copyright>
47 <year>2003</year>
48 <holder>&dhusername;</holder>
49 </copyright>
50 &dhdate;
51 </refentryinfo>
52 <refmeta>
53 &dhucpackage;
54
55 &dhsection;
56 </refmeta>
57 <refnamediv>
58 <refname>&dhpackage;</refname>
59
60 <refpurpose>program to do something</refpurpose>
61 </refnamediv>
62 <refsynopsisdiv>
63 <cmdsynopsis>
64 <command>&dhpackage;</command>
65
66 <arg><option>-e <replaceable>this</replaceable></option></arg>
67
68 <arg><option>--example <replaceable>that</replaceable></option></arg>
69 </cmdsynopsis>
70 </refsynopsisdiv>
71 <refsect1>
72 <title>DESCRIPTION</title>
73
74 <para>This manual page documents briefly the
75 <command>&dhpackage;</command> and <command>bar</command>
76 commands.</para>
77
78 <para>This manual page was written for the &debian; distribution
79 because the original program does not have a manual page.
80 Instead, it has documentation in the &gnu;
81 <application>Info</application> format; see below.</para>
82
83 <para><command>&dhpackage;</command> is a program that...</para>
84
85 </refsect1>
86 <refsect1>
87 <title>OPTIONS</title>
88
89 <para>These programs follow the usual &gnu; command line syntax,
90 with long options starting with two dashes (`-'). A summary of
91 options is included below. For a complete description, see the
92 <application>Info</application> files.</para>
93
94 <variablelist>
95 <varlistentry>
96 <term><option>-h</option>
97 <option>--help</option>
98 </term>
99 <listitem>
100 <para>Show summary of options.</para>
101 </listitem>
102 </varlistentry>
103 <varlistentry>
104 <term><option>-v</option>
105 <option>--version</option>
106 </term>
107 <listitem>
108 <para>Show version of program.</para>
109 </listitem>
110 </varlistentry>
111 </variablelist>
112 </refsect1>
113 <refsect1>
114 <title>SEE ALSO</title>
115
116 <para>bar (1), baz (1).</para>
117
118 <para>The programs are documented fully by <citetitle>The Rise and
119 Fall of a Fooish Bar</citetitle> available via the
120 <application>Info</application> system.</para>
121 </refsect1>
122 <refsect1>
123 <title>AUTHOR</title>
124
125 <para>This manual page was written by &dhusername; &dhemail; for
126 the &debian; system (and may be used by others). Permission is
127 granted to copy, distribute and/or modify this document under
128 the terms of the &gnu; General Public License, Version 2 any
129 later version published by the Free Software Foundation.
130 </para>
131 <para>
132 On Debian systems, the complete text of the GNU General Public
133 License can be found in /usr/share/common-licenses/GPL.
134 </para>
135
136 </refsect1>
137</refentry>
138
139<!-- Keep this comment at the end of the file
140Local variables:
141mode: sgml
142sgml-omittag:t
143sgml-shorttag:t
144sgml-minimize-attributes:nil
145sgml-always-quote-attributes:t
146sgml-indent-step:2
147sgml-indent-data:t
148sgml-parent-document:nil
149sgml-default-dtd-file:nil
150sgml-exposed-tags:nil
151sgml-local-catalogs:nil
152sgml-local-ecat-files:nil
153End:
154-->
diff --git a/debian/manpage.xml.ex b/debian/manpage.xml.ex
new file mode 100644
index 0000000..e98e69b
--- /dev/null
+++ b/debian/manpage.xml.ex
@@ -0,0 +1,291 @@
1<?xml version='1.0' encoding='UTF-8'?>
2<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
5<!--
6
7`xsltproc -''-nonet \
8 -''-param man.charmap.use.subset "0" \
9 -''-param make.year.ranges "1" \
10 -''-param make.single.year.ranges "1" \
11 /usr/share/xml/docbook/stylesheet/docbook-xsl/manpages/docbook.xsl \
12 manpage.xml'
13
14A manual page <package>.<section> will be generated. You may view the
15manual page with: nroff -man <package>.<section> | less'. A typical entry
16in a Makefile or Makefile.am is:
17
18DB2MAN = /usr/share/sgml/docbook/stylesheet/xsl/docbook-xsl/manpages/docbook.xsl
19XP = xsltproc -''-nonet -''-param man.charmap.use.subset "0"
20
21manpage.1: manpage.xml
22 $(XP) $(DB2MAN) $<
23
24The xsltproc binary is found in the xsltproc package. The XSL files are in
25docbook-xsl. A description of the parameters you can use can be found in the
26docbook-xsl-doc-* packages. Please remember that if you create the nroff
27version in one of the debian/rules file targets (such as build), you will need
28to include xsltproc and docbook-xsl in your Build-Depends control field.
29Alternatively use the xmlto command/package. That will also automatically
30pull in xsltproc and docbook-xsl.
31
32Notes for using docbook2x: docbook2x-man does not automatically create the
33AUTHOR(S) and COPYRIGHT sections. In this case, please add them manually as
34<refsect1> ... </refsect1>.
35
36To disable the automatic creation of the AUTHOR(S) and COPYRIGHT sections
37read /usr/share/doc/docbook-xsl/doc/manpages/authors.html. This file can be
38found in the docbook-xsl-doc-html package.
39
40Validation can be done using: `xmllint -''-noout -''-valid manpage.xml`
41
42General documentation about man-pages and man-page-formatting:
43man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
44
45-->
46
47 <!-- Fill in your name for FIRSTNAME and SURNAME. -->
48 <!ENTITY dhfirstname "FIRSTNAME">
49 <!ENTITY dhsurname "SURNAME">
50 <!-- dhusername could also be set to "&dhfirstname; &dhsurname;". -->
51 <!ENTITY dhusername "GDR!">
52 <!ENTITY dhemail "gdr@gdr.name">
53 <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
54 allowed: see man(7), man(1) and
55 http://www.tldp.org/HOWTO/Man-Page/q2.html. -->
56 <!ENTITY dhsection "SECTION">
57 <!-- TITLE should be something like "User commands" or similar (see
58 http://www.tldp.org/HOWTO/Man-Page/q2.html). -->
59 <!ENTITY dhtitle "tuntox User Manual">
60 <!ENTITY dhucpackage "Tuntox">
61 <!ENTITY dhpackage "tuntox">
62]>
63
64<refentry>
65 <refentryinfo>
66 <title>&dhtitle;</title>
67 <productname>&dhpackage;</productname>
68 <authorgroup>
69 <author>
70 <firstname>&dhfirstname;</firstname>
71 <surname>&dhsurname;</surname>
72 <contrib>Wrote this manpage for the Debian system.</contrib>
73 <address>
74 <email>&dhemail;</email>
75 </address>
76 </author>
77 </authorgroup>
78 <copyright>
79 <year>2007</year>
80 <holder>&dhusername;</holder>
81 </copyright>
82 <legalnotice>
83 <para>This manual page was written for the Debian system
84 (and may be used by others).</para>
85 <para>Permission is granted to copy, distribute and/or modify this
86 document under the terms of the GNU General Public License,
87 Version 2 or (at your option) any later version published by
88 the Free Software Foundation.</para>
89 <para>On Debian systems, the complete text of the GNU General Public
90 License can be found in
91 <filename>/usr/share/common-licenses/GPL</filename>.</para>
92 </legalnotice>
93 </refentryinfo>
94 <refmeta>
95 <refentrytitle>&dhucpackage;</refentrytitle>
96 <manvolnum>&dhsection;</manvolnum>
97 </refmeta>
98 <refnamediv>
99 <refname>&dhpackage;</refname>
100 <refpurpose>program to do something</refpurpose>
101 </refnamediv>
102 <refsynopsisdiv>
103 <cmdsynopsis>
104 <command>&dhpackage;</command>
105 <!-- These are several examples, how syntaxes could look -->
106 <arg choice="plain"><option>-e <replaceable>this</replaceable></option></arg>
107 <arg choice="opt"><option>--example=<parameter>that</parameter></option></arg>
108 <arg choice="opt">
109 <group choice="req">
110 <arg choice="plain"><option>-e</option></arg>
111 <arg choice="plain"><option>--example</option></arg>
112 </group>
113 <replaceable class="option">this</replaceable>
114 </arg>
115 <arg choice="opt">
116 <group choice="req">
117 <arg choice="plain"><option>-e</option></arg>
118 <arg choice="plain"><option>--example</option></arg>
119 </group>
120 <group choice="req">
121 <arg choice="plain"><replaceable>this</replaceable></arg>
122 <arg choice="plain"><replaceable>that</replaceable></arg>
123 </group>
124 </arg>
125 </cmdsynopsis>
126 <cmdsynopsis>
127 <command>&dhpackage;</command>
128 <!-- Normally the help and version options make the programs stop
129 right after outputting the requested information. -->
130 <group choice="opt">
131 <arg choice="plain">
132 <group choice="req">
133 <arg choice="plain"><option>-h</option></arg>
134 <arg choice="plain"><option>--help</option></arg>
135 </group>
136 </arg>
137 <arg choice="plain">
138 <group choice="req">
139 <arg choice="plain"><option>-v</option></arg>
140 <arg choice="plain"><option>--version</option></arg>
141 </group>
142 </arg>
143 </group>
144 </cmdsynopsis>
145 </refsynopsisdiv>
146 <refsect1 id="description">
147 <title>DESCRIPTION</title>
148 <para>This manual page documents briefly the
149 <command>&dhpackage;</command> and <command>bar</command>
150 commands.</para>
151 <para>This manual page was written for the Debian distribution
152 because the original program does not have a manual page.
153 Instead, it has documentation in the GNU <citerefentry>
154 <refentrytitle>info</refentrytitle>
155 <manvolnum>1</manvolnum>
156 </citerefentry> format; see below.</para>
157 <para><command>&dhpackage;</command> is a program that...</para>
158 </refsect1>
159 <refsect1 id="options">
160 <title>OPTIONS</title>
161 <para>The program follows the usual GNU command line syntax,
162 with long options starting with two dashes (`-'). A summary of
163 options is included below. For a complete description, see the
164 <citerefentry>
165 <refentrytitle>info</refentrytitle>
166 <manvolnum>1</manvolnum>
167 </citerefentry> files.</para>
168 <variablelist>
169 <!-- Use the variablelist.term.separator and the
170 variablelist.term.break.after parameters to
171 control the term elements. -->
172 <varlistentry>
173 <term><option>-e <replaceable>this</replaceable></option></term>
174 <term><option>--example=<replaceable>that</replaceable></option></term>
175 <listitem>
176 <para>Does this and that.</para>
177 </listitem>
178 </varlistentry>
179 <varlistentry>
180 <term><option>-h</option></term>
181 <term><option>--help</option></term>
182 <listitem>
183 <para>Show summary of options.</para>
184 </listitem>
185 </varlistentry>
186 <varlistentry>
187 <term><option>-v</option></term>
188 <term><option>--version</option></term>
189 <listitem>
190 <para>Show version of program.</para>
191 </listitem>
192 </varlistentry>
193 </variablelist>
194 </refsect1>
195 <refsect1 id="files">
196 <title>FILES</title>
197 <variablelist>
198 <varlistentry>
199 <term><filename>/etc/foo.conf</filename></term>
200 <listitem>
201 <para>The system-wide configuration file to control the
202 behaviour of <application>&dhpackage;</application>. See
203 <citerefentry>
204 <refentrytitle>foo.conf</refentrytitle>
205 <manvolnum>5</manvolnum>
206 </citerefentry> for further details.</para>
207 </listitem>
208 </varlistentry>
209 <varlistentry>
210 <term><filename>${HOME}/.foo.conf</filename></term>
211 <listitem>
212 <para>The per-user configuration file to control the
213 behaviour of <application>&dhpackage;</application>. See
214 <citerefentry>
215 <refentrytitle>foo.conf</refentrytitle>
216 <manvolnum>5</manvolnum>
217 </citerefentry> for further details.</para>
218 </listitem>
219 </varlistentry>
220 </variablelist>
221 </refsect1>
222 <refsect1 id="environment">
223 <title>ENVIRONMENT</title>
224 <variablelist>
225 <varlistentry>
226 <term><envar>FOO_CONF</envar></term>
227 <listitem>
228 <para>If used, the defined file is used as configuration
229 file (see also <xref linkend="files"/>).</para>
230 </listitem>
231 </varlistentry>
232 </variablelist>
233 </refsect1>
234 <refsect1 id="diagnostics">
235 <title>DIAGNOSTICS</title>
236 <para>The following diagnostics may be issued
237 on <filename class="devicefile">stderr</filename>:</para>
238 <variablelist>
239 <varlistentry>
240 <term><errortext>Bad configuration file. Exiting.</errortext></term>
241 <listitem>
242 <para>The configuration file seems to contain a broken configuration
243 line. Use the <option>--verbose</option> option, to get more info.
244 </para>
245 </listitem>
246 </varlistentry>
247 </variablelist>
248 <para><command>&dhpackage;</command> provides some return codes, that can
249 be used in scripts:</para>
250 <segmentedlist>
251 <segtitle>Code</segtitle>
252 <segtitle>Diagnostic</segtitle>
253 <seglistitem>
254 <seg><errorcode>0</errorcode></seg>
255 <seg>Program exited successfully.</seg>
256 </seglistitem>
257 <seglistitem>
258 <seg><errorcode>1</errorcode></seg>
259 <seg>The configuration file seems to be broken.</seg>
260 </seglistitem>
261 </segmentedlist>
262 </refsect1>
263 <refsect1 id="bugs">
264 <!-- Or use this section to tell about upstream BTS. -->
265 <title>BUGS</title>
266 <para>The program is currently limited to only work
267 with the <package>foobar</package> library.</para>
268 <para>The upstreams <acronym>BTS</acronym> can be found
269 at <ulink url="http://bugzilla.foo.tld"/>.</para>
270 </refsect1>
271 <refsect1 id="see_also">
272 <title>SEE ALSO</title>
273 <!-- In alpabetical order. -->
274 <para><citerefentry>
275 <refentrytitle>bar</refentrytitle>
276 <manvolnum>1</manvolnum>
277 </citerefentry>, <citerefentry>
278 <refentrytitle>baz</refentrytitle>
279 <manvolnum>1</manvolnum>
280 </citerefentry>, <citerefentry>
281 <refentrytitle>foo.conf</refentrytitle>
282 <manvolnum>5</manvolnum>
283 </citerefentry></para>
284 <para>The programs are documented fully by <citetitle>The Rise and
285 Fall of a Fooish Bar</citetitle> available via the <citerefentry>
286 <refentrytitle>info</refentrytitle>
287 <manvolnum>1</manvolnum>
288 </citerefentry> system.</para>
289 </refsect1>
290</refentry>
291
diff --git a/debian/postinst.ex b/debian/postinst.ex
new file mode 100644
index 0000000..7e0cb64
--- /dev/null
+++ b/debian/postinst.ex
@@ -0,0 +1,39 @@
1#!/bin/sh
2# postinst script for tuntox
3#
4# see: dh_installdeb(1)
5
6set -e
7
8# summary of how this script can be called:
9# * <postinst> `configure' <most-recently-configured-version>
10# * <old-postinst> `abort-upgrade' <new version>
11# * <conflictor's-postinst> `abort-remove' `in-favour' <package>
12# <new-version>
13# * <postinst> `abort-remove'
14# * <deconfigured's-postinst> `abort-deconfigure' `in-favour'
15# <failed-install-package> <version> `removing'
16# <conflicting-package> <version>
17# for details, see https://www.debian.org/doc/debian-policy/ or
18# the debian-policy package
19
20
21case "$1" in
22 configure)
23 ;;
24
25 abort-upgrade|abort-remove|abort-deconfigure)
26 ;;
27
28 *)
29 echo "postinst called with unknown argument \`$1'" >&2
30 exit 1
31 ;;
32esac
33
34# dh_installdeb will replace this with shell code automatically
35# generated by other debhelper scripts.
36
37#DEBHELPER#
38
39exit 0
diff --git a/debian/postrm.ex b/debian/postrm.ex
new file mode 100644
index 0000000..055f2eb
--- /dev/null
+++ b/debian/postrm.ex
@@ -0,0 +1,37 @@
1#!/bin/sh
2# postrm script for tuntox
3#
4# see: dh_installdeb(1)
5
6set -e
7
8# summary of how this script can be called:
9# * <postrm> `remove'
10# * <postrm> `purge'
11# * <old-postrm> `upgrade' <new-version>
12# * <new-postrm> `failed-upgrade' <old-version>
13# * <new-postrm> `abort-install'
14# * <new-postrm> `abort-install' <old-version>
15# * <new-postrm> `abort-upgrade' <old-version>
16# * <disappearer's-postrm> `disappear' <overwriter>
17# <overwriter-version>
18# for details, see https://www.debian.org/doc/debian-policy/ or
19# the debian-policy package
20
21
22case "$1" in
23 purge|remove|upgrade|failed-upgrade|abort-install|abort-upgrade|disappear)
24 ;;
25
26 *)
27 echo "postrm called with unknown argument \`$1'" >&2
28 exit 1
29 ;;
30esac
31
32# dh_installdeb will replace this with shell code automatically
33# generated by other debhelper scripts.
34
35#DEBHELPER#
36
37exit 0
diff --git a/debian/preinst.ex b/debian/preinst.ex
new file mode 100644
index 0000000..8b23e6f
--- /dev/null
+++ b/debian/preinst.ex
@@ -0,0 +1,35 @@
1#!/bin/sh
2# preinst script for tuntox
3#
4# see: dh_installdeb(1)
5
6set -e
7
8# summary of how this script can be called:
9# * <new-preinst> `install'
10# * <new-preinst> `install' <old-version>
11# * <new-preinst> `upgrade' <old-version>
12# * <old-preinst> `abort-upgrade' <new-version>
13# for details, see https://www.debian.org/doc/debian-policy/ or
14# the debian-policy package
15
16
17case "$1" in
18 install|upgrade)
19 ;;
20
21 abort-upgrade)
22 ;;
23
24 *)
25 echo "preinst called with unknown argument \`$1'" >&2
26 exit 1
27 ;;
28esac
29
30# dh_installdeb will replace this with shell code automatically
31# generated by other debhelper scripts.
32
33#DEBHELPER#
34
35exit 0
diff --git a/debian/prerm.ex b/debian/prerm.ex
new file mode 100644
index 0000000..9e188db
--- /dev/null
+++ b/debian/prerm.ex
@@ -0,0 +1,38 @@
1#!/bin/sh
2# prerm script for tuntox
3#
4# see: dh_installdeb(1)
5
6set -e
7
8# summary of how this script can be called:
9# * <prerm> `remove'
10# * <old-prerm> `upgrade' <new-version>
11# * <new-prerm> `failed-upgrade' <old-version>
12# * <conflictor's-prerm> `remove' `in-favour' <package> <new-version>
13# * <deconfigured's-prerm> `deconfigure' `in-favour'
14# <package-being-installed> <version> `removing'
15# <conflicting-package> <version>
16# for details, see https://www.debian.org/doc/debian-policy/ or
17# the debian-policy package
18
19
20case "$1" in
21 remove|upgrade|deconfigure)
22 ;;
23
24 failed-upgrade)
25 ;;
26
27 *)
28 echo "prerm called with unknown argument \`$1'" >&2
29 exit 1
30 ;;
31esac
32
33# dh_installdeb will replace this with shell code automatically
34# generated by other debhelper scripts.
35
36#DEBHELPER#
37
38exit 0
diff --git a/debian/rules b/debian/rules
new file mode 100755
index 0000000..e1c367c
--- /dev/null
+++ b/debian/rules
@@ -0,0 +1,25 @@
1#!/usr/bin/make -f
2# See debhelper(7) (uncomment to enable)
3# output every command that modifies files on the build system.
4#export DH_VERBOSE = 1
5
6
7# see FEATURE AREAS in dpkg-buildflags(1)
8#export DEB_BUILD_MAINT_OPTIONS = hardening=+all
9
10# see ENVIRONMENT in dpkg-buildflags(1)
11# package maintainers to append CFLAGS
12#export DEB_CFLAGS_MAINT_APPEND = -Wall -pedantic
13# package maintainers to append LDFLAGS
14#export DEB_LDFLAGS_MAINT_APPEND = -Wl,--as-needed
15
16
17%:
18 dh $@
19
20
21# dh_make generated override targets
22# This is example for Cmake (See https://bugs.debian.org/641051 )
23#override_dh_auto_configure:
24# dh_auto_configure -- # -DCMAKE_LIBRARY_PATH=$(DEB_HOST_MULTIARCH)
25
diff --git a/debian/salsa-ci.yml.ex b/debian/salsa-ci.yml.ex
new file mode 100644
index 0000000..260ebbe
--- /dev/null
+++ b/debian/salsa-ci.yml.ex
@@ -0,0 +1,11 @@
1# For more information on what jobs are run see:
2# https://salsa.debian.org/salsa-ci-team/pipeline
3#
4# To enable the jobs, go to your repository (at salsa.debian.org)
5# and click over Settings > CI/CD > Expand (in General pipelines).
6# In "Custom CI config path" write debian/salsa-ci.yml and click
7# in "Save Changes". The CI tests will run after the next commit.
8---
9include:
10 - https://salsa.debian.org/salsa-ci-team/pipeline/raw/master/salsa-ci.yml
11 - https://salsa.debian.org/salsa-ci-team/pipeline/raw/master/pipeline-jobs.yml
diff --git a/debian/source/format b/debian/source/format
new file mode 100644
index 0000000..163aaf8
--- /dev/null
+++ b/debian/source/format
@@ -0,0 +1 @@
3.0 (quilt)
diff --git a/debian/tuntox-docs.docs b/debian/tuntox-docs.docs
new file mode 100644
index 0000000..efea0a6
--- /dev/null
+++ b/debian/tuntox-docs.docs
@@ -0,0 +1,2 @@
1README.Debian
2README.source
diff --git a/debian/tuntox.cron.d.ex b/debian/tuntox.cron.d.ex
new file mode 100644
index 0000000..d3a6012
--- /dev/null
+++ b/debian/tuntox.cron.d.ex
@@ -0,0 +1,4 @@
1#
2# Regular cron jobs for the tuntox package
3#
40 4 * * * root [ -x /usr/bin/tuntox_maintenance ] && /usr/bin/tuntox_maintenance
diff --git a/debian/tuntox.doc-base.EX b/debian/tuntox.doc-base.EX
new file mode 100644
index 0000000..e711dff
--- /dev/null
+++ b/debian/tuntox.doc-base.EX
@@ -0,0 +1,20 @@
1Document: tuntox
2Title: Debian tuntox Manual
3Author: <insert document author here>
4Abstract: This manual describes what tuntox is
5 and how it can be used to
6 manage online manuals on Debian systems.
7Section: unknown
8
9Format: debiandoc-sgml
10Files: /usr/share/doc/tuntox/tuntox.sgml.gz
11
12Format: postscript
13Files: /usr/share/doc/tuntox/tuntox.ps.gz
14
15Format: text
16Files: /usr/share/doc/tuntox/tuntox.text.gz
17
18Format: HTML
19Index: /usr/share/doc/tuntox/html/index.html
20Files: /usr/share/doc/tuntox/html/*.html
diff --git a/debian/watch.ex b/debian/watch.ex
new file mode 100644
index 0000000..ecc7a81
--- /dev/null
+++ b/debian/watch.ex
@@ -0,0 +1,38 @@
1# Example watch control file for uscan
2# Rename this file to "watch" and then you can run the "uscan" command
3# to check for upstream updates and more.
4# See uscan(1) for format
5
6# Compulsory line, this is a version 4 file
7version=4
8
9# PGP signature mangle, so foo.tar.gz has foo.tar.gz.sig
10#opts="pgpsigurlmangle=s%$%.sig%"
11
12# HTTP site (basic)
13#http://example.com/downloads.html \
14# files/tuntox-([\d\.]+)\.tar\.gz debian uupdate
15
16# Uncomment to examine an FTP server
17#ftp://ftp.example.com/pub/tuntox-(.*)\.tar\.gz debian uupdate
18
19# SourceForge hosted projects
20# http://sf.net/tuntox/ tuntox-(.*)\.tar\.gz debian uupdate
21
22# GitHub hosted projects
23#opts="filenamemangle=s%(?:.*?)?v?(\d[\d.]*)\.tar\.gz%<project>-$1.tar.gz%" \
24# https://github.com/<user>/tuntox/tags \
25# (?:.*?/)?v?(\d[\d.]*)\.tar\.gz debian uupdate
26
27# PyPI
28# https://pypi.debian.net/tuntox/tuntox-(.+)\.(?:zip|tgz|tbz|txz|(?:tar\.(?:gz|bz2|xz)))
29
30# Direct Git
31# opts="mode=git" http://git.example.com/tuntox.git \
32# refs/tags/v([\d\.]+) debian uupdate
33
34
35
36
37# Uncomment to find new files on GooglePages
38# http://example.googlepages.com/foo.html tuntox-(.*)\.tar\.gz