From 36bc60c5a92cf0bd9da6075dfd9d6fa4c9aaee26 Mon Sep 17 00:00:00 2001 From: Paul Brossier Date: Wed, 1 Dec 2004 03:37:05 +0000 Subject: [PATCH] updated manpages --- TODO | 6 ------ doc/Makefile.am | 3 ++- doc/Makefile.in | 4 +++- doc/aubionotes.sgml | 39 +++++++++++++++++++++++++++------------ doc/aubioonset.sgml | 13 +++++++++++++ 5 files changed, 45 insertions(+), 20 deletions(-) diff --git a/TODO b/TODO index 3328c01c..fe3d33b4 100644 --- a/TODO +++ b/TODO @@ -1,12 +1,6 @@ TODO ==== -Doc ---- - -- update doc -- complete manpages - Library ------- diff --git a/doc/Makefile.am b/doc/Makefile.am index 2efde6ea..eaac4ccf 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,7 +1,8 @@ # install the man pages and include in distribution #man_MANS = fluidsynth.1 #EXTRA_DIST = $(man_MANS) devel.cfg fluidsynth.1 -EXTRA_DIST = devel.cfg examples.cfg user.cfg aubio.css +EXTRA_DIST = devel.cfg examples.cfg user.cfg aubio.css \ + aubionotes.sgml aubioonset.sgml #docbook_docs = aubio-devdoc.xml #DOCBOOK_STYLESHEET ?= http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl diff --git a/doc/Makefile.in b/doc/Makefile.in index 4ddb4922..a0974aa6 100644 --- a/doc/Makefile.in +++ b/doc/Makefile.in @@ -155,7 +155,9 @@ target_alias = @target_alias@ # install the man pages and include in distribution #man_MANS = fluidsynth.1 #EXTRA_DIST = $(man_MANS) devel.cfg fluidsynth.1 -EXTRA_DIST = devel.cfg examples.cfg user.cfg aubio.css +EXTRA_DIST = devel.cfg examples.cfg user.cfg aubio.css \ + aubionotes.sgml aubioonset.sgml + subdir = doc ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs diff --git a/doc/aubionotes.sgml b/doc/aubionotes.sgml index 638960d4..5d3a90e9 100644 --- a/doc/aubionotes.sgml +++ b/doc/aubionotes.sgml @@ -69,22 +69,24 @@ manpage.1: manpage.sgml This manual page documents briefly the &dhpackage; command. -The library aubio provides a small set of functions to extract events and -objects from audio, from live streams or still files. Onsets are used to label -the beginning of notes, pitches to label their height. +The library aubio provides a small set of functions +to extract events and objects from audio, from live streams or still files. +Onsets are used to label the beginning of notes, pitches to label their +height. -aubionotes is still in an experimental state. Its aim is to segment notes -with onsets, and label them with their detected pitch. When started without an -input file argument (), aubionotes creates a jack input and a midi -output. When an input file is given, it outputs the results on the console. +aubionotes is still in an experimental state. Its aim +is to segment notes with onsets, and label them with their detected pitch. When +started without an input file argument (), aubionotes +creates a jack input and a midi output. When an input file is given, it outputs +the results on the console. OPTIONS -This program follows the usual GNU command line syntax, with long -options starting with two dashes (`-'). -A summary of options is included below. +This program follows the usual GNU command line syntax, with long options +starting with two dashes (`-'). A summary of options is included below. + @@ -98,8 +100,8 @@ supported. -Save results in this file. The file will be created on the model of the input -file. Results are marked by a very short wood-block sample. +Save results in this file. The file will be created on the model of the +input file. Results are marked by a very short wood-block sample. @@ -109,6 +111,19 @@ file. Results are marked by a very short wood-block sample. Set the threshold value for the onset peak picking. Typical values are within 0.001 and 0.900. Default is 0.1. The lower the more sensible. Try 0.3 in case of over-detections. + + + + + + + + The onset detection function to run. Can be one of + complexdomain, hfc, + phase, specdiff, + energy. By default (fixme), both + complex domain and HFC are used in parallel. + diff --git a/doc/aubioonset.sgml b/doc/aubioonset.sgml index d818de57..ba05e3c5 100644 --- a/doc/aubioonset.sgml +++ b/doc/aubioonset.sgml @@ -109,6 +109,19 @@ file. Results are marked by a very short wood-block sample. Set the threshold value for the onset peak picking. Typical values are within 0.001 and 0.900. Default is 0.1. The lower the more sensible. Try 0.3 in case of over-detections. + + + + + + + + The onset detection function to run. Can be one of + complexdomain, hfc, + phase, specdiff, + energy. By default (fixme), both + complex domain and HFC are used in parallel. + -- 2.26.2