Browse Source

added rudimentary manpage

master
Sven Oliver Moll 1 month ago
parent
commit
95e55c9ad7
4 changed files with 163 additions and 1 deletions
  1. 1
    1
      debian/control
  2. 157
    0
      debian/makewav.sgml
  3. 1
    0
      debian/manpages
  4. 4
    0
      debian/rules

+ 1
- 1
debian/control View File

@@ -2,7 +2,7 @@ Source: makewav
2 2
 Section: otherosfs
3 3
 Priority: optional
4 4
 Maintainer: Sven Oliver Moll <svolli@svol.li>
5
-Build-Depends: debhelper (>= 9), portaudio19-dev
5
+Build-Depends: debhelper (>= 9), portaudio19-dev, docbook-to-man
6 6
 Standards-Version: 3.9.8
7 7
 Homepage: https://xayax.net/tools/makewav/
8 8
 

+ 157
- 0
debian/makewav.sgml View File

@@ -0,0 +1,157 @@
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
+
8
+manpage.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>Sven Oliver</firstname>">
21
+  <!ENTITY dhsurname   "<surname>Moll</surname>">
22
+  <!-- Please adjust the date whenever revising the manpage. -->
23
+  <!ENTITY dhdate      "<date>May 13, 2019</date>">
24
+  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
25
+       allowed: see man(7), man(1). -->
26
+  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
27
+  <!ENTITY dhemail     "<email>svolli@svolli.de</email>">
28
+  <!ENTITY dhusername  "Sven Oliver Moll">
29
+  <!ENTITY dhucpackage "<refentrytitle>MAKEWAV</refentrytitle>">
30
+  <!ENTITY dhpackage   "makewav">
31
+
32
+  <!ENTITY docdir      "/usr/share/doc/makewav">
33
+]>
34
+
35
+<refentry>
36
+  <refentryinfo>
37
+    <address>
38
+      &dhemail;
39
+    </address>
40
+    <author>
41
+      &dhfirstname;
42
+      &dhsurname;
43
+    </author>
44
+    <copyright>
45
+      <year>2003</year>
46
+      <holder>&dhusername;</holder>
47
+    </copyright>
48
+    &dhdate;
49
+  </refentryinfo>
50
+  <refmeta>
51
+    &dhucpackage;
52
+
53
+    &dhsection;
54
+  </refmeta>
55
+  <refnamediv>
56
+    <refname>&dhpackage;</refname>
57
+
58
+    <refpurpose>Create a wav-file from an Atari 2600 ROM binary.</refpurpose>
59
+  </refnamediv>
60
+  <refsynopsisdiv>
61
+    <cmdsynopsis>
62
+      <command>&dhpackage; -l</command>
63
+    </cmdsynopsis>
64
+
65
+    <cmdsynopsis>
66
+      <command>&dhpackage;</command>
67
+
68
+      <arg><option>-a<replaceable>audiodevice</replaceable></option></arg>
69
+      <arg><option>-tc</option></arg>
70
+      <arg><option>-ts</option></arg>
71
+      <arg>romimage.bin</arg>
72
+
73
+    </cmdsynopsis>
74
+  </refsynopsisdiv>
75
+  <refsect1>
76
+    <title>DESCRIPTION</title>
77
+
78
+    <para>This manual page documents briefly a subset of the
79
+      <command>&dhpackage;</command> command.
80
+    </para>
81
+
82
+    <para><command>&dhpackage;</command> is a program that converts binary
83
+      data created for the Atari 2600 games console to a wav-file that can be
84
+      uploaded to a Cuttle Cart or an Arcadia SuperCharger.  It is also possible
85
+      to write the audio data directly to a sound card.
86
+    </para>
87
+
88
+  </refsect1>
89
+  <refsect1>
90
+    <title>OPTIONS</title>
91
+
92
+    <para>This program takes the following options.</para>
93
+    <para>There are more options, the full documentation is available
94
+    at &docdir;.
95
+    </para>
96
+
97
+    <variablelist>
98
+      <varlistentry>
99
+        <term><option>-a</option>
100
+        </term>
101
+        <listitem>
102
+          <para>Select audio device to send data to</para>
103
+        </listitem>
104
+      </varlistentry>
105
+      <varlistentry>
106
+        <term><option>-l</option>
107
+        </term>
108
+        <listitem>
109
+          <para>List all available audio devices for use with <option>-a</option>.</para>
110
+        </listitem>
111
+      </varlistentry>
112
+      <varlistentry>
113
+        <term><option>-tc</option>
114
+        </term>
115
+        <listitem>
116
+          <para>Select defaults for Cuttle Cart</para>
117
+        </listitem>
118
+      </varlistentry>
119
+      <varlistentry>
120
+        <term><option>-ts</option>
121
+        </term>
122
+        <listitem>
123
+          <para>Select defaults for Arcadia SuperCharger</para>
124
+        </listitem>
125
+      </varlistentry>
126
+    </variablelist>
127
+  </refsect1>
128
+  
129
+  <refsect1>
130
+    <title>AUTHOR</title>
131
+
132
+    <para>This manual page was written by &dhusername; (&dhemail;) as 
133
+      part of creating a debian package for this tool. Is it as the program
134
+      placed into the public domain.
135
+    </para>
136
+
137
+  </refsect1>
138
+</refentry>
139
+
140
+<!-- Keep this comment at the end of the file
141
+Local variables:
142
+mode: sgml
143
+sgml-omittag:t
144
+sgml-shorttag:t
145
+sgml-minimize-attributes:nil
146
+sgml-always-quote-attributes:t
147
+sgml-indent-step:2
148
+sgml-indent-data:t
149
+sgml-parent-document:nil
150
+sgml-default-dtd-file:nil
151
+sgml-exposed-tags:nil
152
+sgml-local-catalogs:nil
153
+sgml-local-ecat-files:nil
154
+End:
155
+-->
156
+
157
+

+ 1
- 0
debian/manpages View File

@@ -0,0 +1 @@
1
+debian/makewav.1

+ 4
- 0
debian/rules View File

@@ -17,3 +17,7 @@ export DEB_BUILD_MAINT_OPTIONS = hardening=+all
17 17
 %:
18 18
 	dh $@
19 19
 
20
+override_dh_installdocs:
21
+	dh_installdocs
22
+	docbook-to-man debian/makewav.sgml > debian/makewav.1
23
+

Loading…
Cancel
Save