[SCM] mma/master: generate extra man pages from *.pod files using makeman script

bolangi-guest at users.alioth.debian.org bolangi-guest at users.alioth.debian.org
Thu Jan 5 06:48:28 UTC 2012


The following commit has been merged in the master branch:
commit 94c137552d426401b9f2733ff01bf46016147764
Author: Joel Roth <joelz at pobox.com>
Date:   Wed Jan 4 20:22:46 2012 -1000

    generate extra man pages from *.pod files using makeman script

diff --git a/debian/makeman b/debian/makeman
new file mode 100755
index 0000000..5112698
--- /dev/null
+++ b/debian/makeman
@@ -0,0 +1,15 @@
+#!/usr/bin/env perl
+use Modern::Perl;
+my %files = qw(
+	mma-splitrec.pod mma-splitrec.py
+	mup2mma.pod      mup2mma.py
+	pg2mma.pod       pg2mma.py
+);
+while ( my ($pod,$exec) = each %files ){
+	
+	my $file = "$exec.1";
+	my $cmd = qq(pod2man -c " " -r " " --section=1 $pod $exec.1 --name=$exec);
+	say $cmd;
+	system $cmd;
+}
+
diff --git a/debian/mma-splitrec.pod b/debian/mma-splitrec.pod
new file mode 100644
index 0000000..17cfff8
--- /dev/null
+++ b/debian/mma-splitrec.pod
@@ -0,0 +1,113 @@
+=head1 NAME
+
+B<mma-splitrec.py> - Create wav tracks from MMA input file
+
+=head1 SYNOPSIS
+
+B<mma-splitrec.py> <somefile.mma>
+
+=head1 DESCRIPTION
+
+This program is used to create a set of wav tracks from a MMA
+input file. You need MMA, the input file, a midiplayer, audio
+recorder and an external synth or timidity.
+
+The command:
+
+=over 12
+
+mma-splitrec.py somefile.mma
+
+=back
+
+will determine the tracks in the MMA file, create temporary MIDIs
+for each track, play each file though an external synth and record
+the results into a series of wav files.
+
+Also created is a mix file with all the tracks. This is called "bg.wav".
+
+When using an external synth the conversion takes a long time ...
+about the number of tracks times the duration of the song. Be patient.
+
+If you have timidity installed you can let it create the wav files. It works
+pretty well, depending on your installed soundfonts.
+
+Using timidity i've had good success with the following:
+
+=over 12
+
+1. use mma-splitrec.py with a decent soundfont to create tracks,
+
+2. use timidity to create a mix track of the mma file,
+
+3. copy the mix to my Zoom H4 recorder into a project file,
+
+4. play/create lots of sax tracks while listening to the mix (4 track mode on the H4),
+
+5. copy the sax tracks the split tracks from (1) into audacity,
+
+6. edit the tracks,
+
+7. publish the song and become rich and famous!
+
+=back
+
+=head1 OPTIONS
+
+=over 12
+
+=item B<-m> 
+
+Set the midi file player (aplaymidi) options. This is usually
+the port. You should quote the arg:  -m "-p 20"
+
+=item B<-r>
+
+Recorder options (arecord). You can change the number of channels,
+quality, port, etc. Again, quote the arg: -r "-D hw:0,0 -c2"
+
+=item B<-o>
+
+Timidity options. Quote args: -o "-Ow"
+
+See the manual pages for aplaymidi, arecord and timidiy for option details.
+
+=item B<-i>
+
+By default an external synth is assumed. Use this option to force use
+of timidity.
+
+=item B<-b>
+
+By default the track "bg.wav" is created with all tracks playing. This
+option will skip creating that track.
+
+=item B<-t>
+
+Create only track XX. The track name is passed to mma and its -T option.
+To create a set of tracks you need multiple -t settings: -t Solo -t Chord-piano
+
+The track names are NOT case sensitive.
+
+=item B<-x>
+
+Exclude tracks. Again, a separate -x is required for each track to skip.
+
+=back
+
+=head1 SEE ALSO
+
+mma(1)
+
+=head1 RESOURCES
+
+The latest version of this program is always distributed with
+B<MMA> and is available at http://www.mellowood.ca/mma
+
+=head1 AUTHOR
+
+Bob van der Poel <bob at mellowood.ca>
+
+=head1 LICENSE
+
+mma-splitrec.py is Copyright 2002-2008 Bob van der Poel. Free use of this software is granted under the terms of the GNU General Public License.
diff --git a/debian/mup2mma.pod b/debian/mup2mma.pod
new file mode 100644
index 0000000..4d64405
--- /dev/null
+++ b/debian/mup2mma.pod
@@ -0,0 +1,69 @@
+=head1 NAME
+
+mup2mma.py
+
+=head1 SYNOPSIS
+
+B<mup2mma> [options] <mupfile>
+
+=head1 DESCRIPTION
+
+mup2mma extracts chords from a MUP music notation file and                     
+creates a MMA file. For this to work the MUP file must use                     
+the macro "C" for chord. In my MUP files I have the following:                 
+
+=over 6
+
+define C bold (11) chord above all: @                                      
+
+=back
+                                                                                   
+This script just checks all input lines and assumes that anything              
+starting with "C" is a chord line.                                             
+                                                                                   
+Additional "features":                                                         
+                                                                                   
+=over 6
+
+Lines in the form "// TEMPO: xx" generate a Tempo entry                    
+
+"time =" lines are parsed for common time signatures                       
+
+repeats are inserted as comment lines                                      
+
+=back
+                                                                                   
+=head1 OPTIONS
+
+=over 6 
+
+=item -m
+
+add melody lines
+
+=item -l
+
+add lyrics                                                 
+
+=item -o
+
+overwrite                                                   
+                                    
+=back
+
+=head1 SEE ALSO
+
+mma(1)
+
+=head1 RESOURCES
+
+The latest version of this program is always distributed with
+B<MMA> and is available at http://www.mellowood.ca/mma
+
+=head1 AUTHOR
+
+Bob van der Poel <bob at mellowood.ca>
+
+=head1 LICENSE
+
+mup2mma.py is Copyright 2002-2008 Bob van der Poel. Free use of this software is granted under the terms of the GNU General Public License.
diff --git a/util/README.pg2mma b/debian/pg2mma.pod
similarity index 50%
copy from util/README.pg2mma
copy to debian/pg2mma.pod
index 1833dfc..c60a20a 100644
--- a/util/README.pg2mma
+++ b/debian/pg2mma.pod
@@ -1,10 +1,22 @@
+=head1 NAME
 
-Short usage file for pg2mma.py.
+pg2mma.py
+
+=head1 SYNOPSIS
+
+B<pg2mma.py> <infile> <outfile>
+
+No options. Both infile and outfile must be specified. No files will
+be overwritten.
+
+=head1 DESCRIPTION
 
 This program is used to convert a PGMusic .pat file containing
 extended patch definitions to a MMA format. The .pat files will
 contain lines like:
 
+=over 6
+
         [                                                      
         [Yamaha PSR 9000 - E.Piano                                 
         [     (P1)                                                             
@@ -17,20 +29,28 @@ contain lines like:
         4.0.120=Phase EP
         5.0.116=New Tines
 
+=back
+
 This program will convert the above to:
 
-     Begin Patch Set
-        // Yamaha PSR 9000 - E.Piano                                 
-        //   (P1)                                                             
-        4.0.114=GalaxyEp
-        4.0.117=StageEp
-        4.0.115=PolarisEp
-        5.0.118=JazzChorus
-        5.0.113=HyperTines
-        4.0.119=Cool!Ep
-        4.0.120=PhaseEp
-        5.0.116=NewTines
-     End
+=over 6
+
+Begin Patch Set
+
+  // Yamaha PSR 9000 - E.Piano                                 
+  //   (P1)                                                             
+  4.0.114=GalaxyEp
+  4.0.117=StageEp
+  4.0.115=PolarisEp
+  5.0.118=JazzChorus
+  5.0.113=HyperTines
+  4.0.119=Cool!Ep
+  4.0.120=PhaseEp
+  5.0.116=NewTines
+
+End
+
+=back
 
 The names in the orginal file are converted to CamelCase; both ';' and []
 comments are converted to MMA // style.
@@ -41,14 +61,29 @@ patch values will be decremented by 1.
 The produced files should be useable directly by mma. However, there are a
 few cautions:
 
- - the .pat files we've looked at do contain errors. 
- - many of the .pat files redefine existing GM voice names. You will need to
-   change these names or put up with warning messages from MMA.
+=over 6
 
-Usage: pg2mma.py <infile> <outfile>
+=item * the .pat files we've looked at do contain errors. 
 
-No options. Both infile and outfile must be specified. No files will
-be overwritten.
+=item * many of the .pat files redefine existing GM voice names. You
+will need to change these names or put up with warning
+messages from MMA.
+
+=back
+
+=head1 SEE ALSO
+
+mma(1)
+
+=head1 RESOURCES
+
+The latest version of this program is always distributed with
+B<MMA> and is available at http://www.mellowood.ca/mma
+
+=head1 AUTHOR
+
+Bob van der Poel <bob at mellowood.ca>
 
-bvdp, September 2007.
+=head1 LICENSE
 
+pg2mma.py is Copyright 2002-2008 Bob van der Poel. Free use of this software is granted under the terms of the GNU General Public License.

-- 
mma packaging



More information about the pkg-multimedia-commits mailing list