Browse Source

added rudimentary manpage

master
Sven Oliver Moll 6 months 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
Section: otherosfs
Priority: optional
Maintainer: Sven Oliver Moll <svolli@svol.li>
Build-Depends: debhelper (>= 9), portaudio19-dev
Build-Depends: debhelper (>= 9), portaudio19-dev, docbook-to-man
Standards-Version: 3.9.8
Homepage: https://xayax.net/tools/makewav/


+ 157
- 0
debian/makewav.sgml View File

@@ -0,0 +1,157 @@
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

<!-- Process this file with docbook-to-man to generate an nroff manual
page: `docbook-to-man manpage.sgml > manpage.1'. You may view
the manual page with: `docbook-to-man manpage.sgml | nroff -man |
less'. A typical entry in a Makefile or Makefile.am is:

manpage.1: manpage.sgml
docbook-to-man $< > $@

The docbook-to-man binary is found in the docbook-to-man package.
Please remember that if you create the nroff version in one of the
debian/rules file targets (such as build), you will need to include
docbook-to-man in your Build-Depends control field.

-->

<!-- Fill in your name for FIRSTNAME and SURNAME. -->
<!ENTITY dhfirstname "<firstname>Sven Oliver</firstname>">
<!ENTITY dhsurname "<surname>Moll</surname>">
<!-- Please adjust the date whenever revising the manpage. -->
<!ENTITY dhdate "<date>May 13, 2019</date>">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1). -->
<!ENTITY dhsection "<manvolnum>1</manvolnum>">
<!ENTITY dhemail "<email>svolli@svolli.de</email>">
<!ENTITY dhusername "Sven Oliver Moll">
<!ENTITY dhucpackage "<refentrytitle>MAKEWAV</refentrytitle>">
<!ENTITY dhpackage "makewav">

<!ENTITY docdir "/usr/share/doc/makewav">
]>

<refentry>
<refentryinfo>
<address>
&dhemail;
</address>
<author>
&dhfirstname;
&dhsurname;
</author>
<copyright>
<year>2003</year>
<holder>&dhusername;</holder>
</copyright>
&dhdate;
</refentryinfo>
<refmeta>
&dhucpackage;

&dhsection;
</refmeta>
<refnamediv>
<refname>&dhpackage;</refname>

<refpurpose>Create a wav-file from an Atari 2600 ROM binary.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhpackage; -l</command>
</cmdsynopsis>

<cmdsynopsis>
<command>&dhpackage;</command>

<arg><option>-a<replaceable>audiodevice</replaceable></option></arg>
<arg><option>-tc</option></arg>
<arg><option>-ts</option></arg>
<arg>romimage.bin</arg>

</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>

<para>This manual page documents briefly a subset of the
<command>&dhpackage;</command> command.
</para>

<para><command>&dhpackage;</command> is a program that converts binary
data created for the Atari 2600 games console to a wav-file that can be
uploaded to a Cuttle Cart or an Arcadia SuperCharger. It is also possible
to write the audio data directly to a sound card.
</para>

</refsect1>
<refsect1>
<title>OPTIONS</title>

<para>This program takes the following options.</para>
<para>There are more options, the full documentation is available
at &docdir;.
</para>

<variablelist>
<varlistentry>
<term><option>-a</option>
</term>
<listitem>
<para>Select audio device to send data to</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-l</option>
</term>
<listitem>
<para>List all available audio devices for use with <option>-a</option>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-tc</option>
</term>
<listitem>
<para>Select defaults for Cuttle Cart</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-ts</option>
</term>
<listitem>
<para>Select defaults for Arcadia SuperCharger</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>AUTHOR</title>

<para>This manual page was written by &dhusername; (&dhemail;) as
part of creating a debian package for this tool. Is it as the program
placed into the public domain.
</para>

</refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->



+ 1
- 0
debian/manpages View File

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

+ 4
- 0
debian/rules View File

@@ -17,3 +17,7 @@ export DEB_BUILD_MAINT_OPTIONS = hardening=+all
%:
dh $@

override_dh_installdocs:
dh_installdocs
docbook-to-man debian/makewav.sgml > debian/makewav.1


Loading…
Cancel
Save