Added documentation.
authorStefan Westerfeld <stefan@space.twc.de>
Sun, 16 May 2010 18:01:55 +0000 (20:01 +0200)
committerStefan Westerfeld <stefan@space.twc.de>
Sun, 16 May 2010 18:01:55 +0000 (20:01 +0200)
configure.ac
docs/Makefile.am [new file with mode: 0644]
docs/jacksampler.1 [new file with mode: 0644]
docs/jacksampler.1.doxi [new file with mode: 0644]
docs/jacksamplerdefs.doxi [new file with mode: 0644]

index 9f2226b..eba1d08 100644 (file)
@@ -33,5 +33,5 @@ fi
 AC_BSE_REQUIREMENTS
 AC_JACK_REQUIREMENTS
 
-AC_CONFIG_FILES([Makefile src/Makefile])
+AC_CONFIG_FILES([Makefile src/Makefile docs/Makefile])
 AC_OUTPUT
diff --git a/docs/Makefile.am b/docs/Makefile.am
new file mode 100644 (file)
index 0000000..3a0207a
--- /dev/null
@@ -0,0 +1,15 @@
+dist_man_MANS = jacksampler.1
+
+DOCS_DIR = ~/public_html/jacksampler/docs-$(VERSION)
+DOXER = ~/src/beast/doxer/doxer.py  
+
+rebuild-manpage:
+       $(DOXER) doxi2man jacksampler.1.doxi
+
+publish-docs:
+       mkdir -p $(DOCS_DIR)
+       for i in $(dist_man_MANS); do \
+         $(DOXER) doxi2html $$i.doxi; \
+         cp $$i.html $(DOCS_DIR); \
+        done
+       cd $(DOCS_DIR) && find . -type f -print0 | xargs -0 git add
diff --git a/docs/jacksampler.1 b/docs/jacksampler.1
new file mode 100644 (file)
index 0000000..8f546aa
--- /dev/null
@@ -0,0 +1,95 @@
+.\" generator: doxer.py 0.6
+.\" generation: 2010-05-16T19:52:30
+.TH "JackSampler" "1" "Wed Apr 19 00:50:37 2006" "jacksampler-" "JackSampler Manual Page"
+
+.SH
+NAME
+
+
+.PP
+jacksampler - A JACK based sampler
+.SH
+SYNOPSIS
+
+
+.PP
+\fBjacksampler\fP [\fIConfigFiles...\fP]
+.SH
+DESCRIPTION
+
+
+.PP
+\fBjacksampler\fP is a JACK based sampler, which plays sample files depending
+on JACK midi input.
+.SH
+CONFIGURATION
+
+
+.PP
+JackSampler supports playing multiple instruments; the user can switch
+the active instrument using the keyboard while JackSampler runs. For
+each instrument, an ascii based configuration file determines which
+sample is played for which note. JackSampler chooses the nearest sample
+if no exact match can be found, and plays that sample slower or faster
+so that the sample will have the right frequency which corrsponds to the
+midi note.
+.br
+
+.br
+For each instrument, a configuration file can contain multiple entries
+for samples, looking like this:
+.br
+
+.br
+sample 24 grand-piano/c1a.wav 
+.br
+
+sample 31 grand-piano/g1b.wav 
+.br
+
+sample 36 grand-piano/c2.wav 
+.br
+
+...
+.br
+
+.br
+There are two additional configuration parameters; one is the time
+jacksampler uses to fade out the sample on note release in milliseconds.
+A configuration entry could look like this:
+.br
+
+.br
+release 100
+.br
+
+.br
+Also there is the possibility to delay the release, so that after the
+note off event is received, a delay occurs until the note is really
+faded out, a sample entry looks like this:
+.br
+
+.br
+release_delay 100
+.br
+
+.br
+Lines starting with a # are ignored. JackSampler also interprets the
+sustain pedal by not releasing notes if the sustain pedal is on,
+postponing their release until its off again.
+.SH
+KEYBOARD
+
+
+.PP
+Typing s, status or q, quit displays status information, or quits
+jacksampler. Typing a number switches to the corresponding
+instrument. The first command line argument is used as configuration
+for instrument 1, the second command line argument is used as
+configuration for instrument 2, and so on.
+.SH
+SEE ALSO
+
+
+.PP
+jacksampler Website (http://space.twc.de/~stefan/jacksampler.php)
diff --git a/docs/jacksampler.1.doxi b/docs/jacksampler.1.doxi
new file mode 100644 (file)
index 0000000..d4da6f7
--- /dev/null
@@ -0,0 +1,61 @@
+@doxer_dnl      # emacs: -*- mode: texinfo; texinfo-open-quote: "\""; texinfo-close-quote: "\""; -*-
+@doxer_set{rvstamp,parse_date} $Date: 2006/04/19 00:50:37 $
+@include "jacksamplerdefs.doxi"
+@doxer_set{title}      jacksampler - A JACK based sampler
+@doxer_set{man-title}  JackSampler
+@doxer_set{man-date}   @doxer_get{rvstamp}
+@doxer_set{man-source} jacksampler-@doxer_get{BST_VERSION}
+@doxer_set{man-manual} JackSampler Manual Page
+
+@heading NAME
+jacksampler - A JACK based sampler
+
+@heading SYNOPSIS
+       @manb{jacksampler} [@mani{ConfigFiles...}]
+
+@heading DESCRIPTION
+       @manb{jacksampler} is a JACK based sampler, which plays sample files depending
+        on JACK midi input.
+
+@heading CONFIGURATION
+        JackSampler supports playing multiple instruments; the user can switch
+        the active instrument using the keyboard while JackSampler runs. For
+        each instrument, an ascii based configuration file determines which
+        sample is played for which note. JackSampler chooses the nearest sample
+        if no exact match can be found, and plays that sample slower or faster
+        so that the sample will have the right frequency which corrsponds to the
+        midi note.
+
+        For each instrument, a configuration file can contain multiple entries
+        for samples, looking like this:
+
+        sample 24 grand-piano/c1a.wav @*
+        sample 31 grand-piano/g1b.wav @*
+        sample 36 grand-piano/c2.wav @*
+        ...
+
+        There are two additional configuration parameters; one is the time
+        jacksampler uses to fade out the sample on note release in milliseconds.
+        A configuration entry could look like this:
+
+        release 100
+
+        Also there is the possibility to delay the release, so that after the
+        note off event is received, a delay occurs until the note is really
+        faded out, a sample entry looks like this:
+
+        release_delay 100
+
+        Lines starting with a # are ignored. JackSampler also interprets the
+        sustain pedal by not releasing notes if the sustain pedal is on,
+        postponing their release until its off again.
+
+@heading KEYBOARD
+        Typing s, status or q, quit displays status information, or quits
+        jacksampler. Typing a number switches to the corresponding
+        instrument. The first command line argument is used as configuration
+        for instrument 1, the second command line argument is used as
+        configuration for instrument 2, and so on.
+
+@heading SEE ALSO
+@longuri{http://space.twc.de/~stefan/jacksampler.php, jacksampler Website}
diff --git a/docs/jacksamplerdefs.doxi b/docs/jacksamplerdefs.doxi
new file mode 100644 (file)
index 0000000..93cb4ef
--- /dev/null
@@ -0,0 +1,111 @@
+@doxer_hidden  # emacs: -*- mode: texinfo; texinfo-open-quote: "\""; texinfo-close-quote: "\""; -*-
+#
+# Copyright (C) 2005 Tim Janik <timj@@gtk.org>
+#
+# This software is provided "as is"; redistribution and modification
+# is permitted, provided that the following disclaimer is retained.
+# 
+# This software 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.
+# In no event shall the authors or contributors be liable for any
+# direct, indirect, incidental, special, exemplary, or consequential
+# damages (including, but not limited to, procurement of substitute
+# goods or services; loss of use, data, or profits; or business
+# interruption) however caused and on any theory of liability, whether
+# in contract, strict liability, or tort (including negligence or
+# otherwise) arising in any way out of the use of this software, even
+# if advised of the possibility of such damage.
+@include <doxer-standard.doxi>
+
+#
+#      BEAST/BSE macros
+#
+
+# path definitions
+@defalias{top_webdir}  @doxer_get{TOP_WEBDIR}
+@defalias{top_styledir}        @top_webdir{}/style
+
+#      Component names
+@defalias{beastbse}    @emph{BEAST/BSE}
+@defalias{beast}       @emph{BEAST}
+@defalias{sfidl}       @emph{sfidl}
+@defalias{gxk}         @emph{GXK}
+@defalias{gtk}         @emph{GTK+}
+@defalias{bse}         @emph{BSE}
+@defalias{sfi}         @emph{SFI}
+@defalias{bsesh}       @emph{BSESH}
+@defalias{arts}        @emph{aRts}
+
+##     semantic tags
+@doxer_command         firstterm
+@doxer_italic{@doxer_args{*}}
+@done
+@doxer_command         path                    @dnl file name paths
+@doxer_italic{@doxer_monospace{@doxer_args{*}}}
+@done
+@defalias{file}                @path{@doxer_args{*}}
+@doxer_command         key                     @dnl source code identifier
+@doxer_bold{@doxer_span{key,@doxer_args{*}}}
+@done
+@doxer_command         ident                   @dnl source code identifier
+@doxer_monospace{@doxer_args{*}}
+@done
+@doxer_command         var                     @dnl shorthand for variable identifiers
+@doxer_monospace{@doxer_args{*}}
+@done
+@doxer_command         const                   @dnl source code constant
+@doxer_monospace{@doxer_args{*}}
+@done
+@doxer_command         macro                   @dnl source code macro
+@doxer_monospace{@doxer_args{*}}
+@done
+@doxer_command         option                  @dnl source code identifier as string
+@doxer_monospace{:@doxer_args{*}:}
+@done
+@doxer_command         func                    @dnl source code function
+@doxer_monospace{@doxer_args{*}}
+@done
+@doxer_command         type                    @dnl source code type name
+@doxer_bold{@doxer_monospace{@doxer_args{*}}}
+@done
+@doxer_command         object                  @dnl source code object name
+@doxer_bold{@doxer_monospace{@doxer_args{*}}}
+@done
+@doxer_command         label                   @dnl GUI labels
+@doxer_italic{"@doxer_args{*}"}
+@done
+@doxer_command         channel                 @dnl GUI channel label
+@doxer_bold{@doxer_italic{"@doxer_args{*}"}}
+@done
+@doxer_command         prop                    @dnl GUI property label
+@doxer_bold{@doxer_italic{"@doxer_args{*}"}}
+@done
+@doxer_command         module                  @dnl GUI object name
+@doxer_bold{@doxer_monospace{@doxer_args{*}}}
+@done
+@doxer_command         tab                     @dnl notebook tabulators
+@doxer_bold{@doxer_span{tabulator,@doxer_args{*}}}
+@done
+@doxer_command         menu                    @dnl GUI menu paths, '/'-seperated
+@doxer_bold{@doxer_sub{"\\/","/",@doxer_sub{"(?<!\\)/", " -> ",@doxer_args{*}}}}
+@done
+@doxer_command         important
+@doxer_fontsize{+1,@doxer_bold{@doxer_args{*}}}
+@done
+
+## manual page markup
+@doxer_command         mani    @dnl### manual page italic
+@doxer_italic{@doxer_args{*}}
+@done
+@doxer_command         manb    @dnl### manual page bold
+@doxer_bold{@doxer_args{*}}
+@done
+@doxer_command         manr    @dnl### manual page roman (normal)
+@doxer_args{*}
+@done
+@doxer_command         mans    @dnl### manual page small
+@doxer_args{*}
+@done
+
+@done  # finishes doxer_hidden section