<?xml version="1.0" encoding="UTF-8"?>
<!-- $Id: solfege.manpage.xml.in,v 1.3 2003/12/02 22:25:55 tca Exp $ -->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
  "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
]>
<refentry id="solfegeman">

<refmeta>
 <refentrytitle>GNU Solfege</refentrytitle>
 <manvolnum>1</manvolnum>
</refmeta>

<refnamediv>
 <refname>solfege</refname>
 <refpurpose>GPL'ed ear training software</refpurpose>
</refnamediv>

<refsynopsisdiv>
  <cmdsynopsis>
    <command>/usr/bin/solfege</command>
    <arg><option>-h</option></arg>
    <arg><option>-?</option></arg>
    <arg><option>--usage</option></arg>
    <arg><option>-v</option></arg>
    <arg><option>-w</option></arg>
    <arg><option>--no-splash</option></arg>
    <arg><option>--no-sound</option></arg>
    <sbr/>
    <arg><option>--verbose-sound-init</option></arg>
  </cmdsynopsis>
</refsynopsisdiv>

<refsect1>
<title>Description</title>
<para>
GNU Solfege is a program that let you use your computer 
to do ear training. You will get the most complete version of
the program if you run it on a machine that has GNOME installed.
But it will also run on more limited setups like linux or win32
with only python, gtk+ and PyGTK installed. 
</para>

<para>
This man page contains info to get Solfege
up and running. For help on using the program, please use the
online documentation.
</para>

</refsect1>

<refsect1>
<title>Options</title>
<para>
This program follow the usual GNU command line syntax, with long
options starting with two dashes (`-').
</para>
<variablelist>
  <varlistentry>
    <term><option>-h</option>
          <option>--help</option>
    </term>
    <listitem>
      <para>Show summary of options.</para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><option>-?</option>
          <option>--gtk-help</option>
    </term>
    <listitem>
      <para>Show summary of Gtk/GNOME options.</para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><option>--usage</option>
    </term>
    <listitem>
      <para>Short version of <option>--gtk-help</option>.</para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><option>-v</option>
          <option>--version</option>
    </term>
    <listitem>
      <para>Show program version.</para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><option>-w</option>
          <option>--warranty</option>
    </term>
    <listitem>
      <para>There is no warranty.</para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><option>--no-splash</option>
    </term>
    <listitem>
      <para>Do not show the startup window.</para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><option>--no-sound</option>
    </term>
    <listitem>
      <para>Do not try to play any sounds. Instead some data is printed to
         standard output. Use this for debugging and porting.</para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><option>--verbose-sound-init</option>
    </term>
    <listitem>
      <para>Print some info about the sound setup while starting.</para>
    </listitem>
  </varlistentry>
</variablelist>
</refsect1>

<refsect1>
<title>Bugs</title>
<para>
Plenty! You can report them to bug-solfege@gnu.org, or
even better: post a patch to fix it to the same address.
Remember to tell what version of Solfege you are running
and the name and version of you operation system.
</para>
</refsect1>

<refsect1>
<title>Files</title>
<para>
<variablelist>
  <varlistentry>
    <term><filename>~/.solfegerc</filename>
    </term>
    <listitem>
     <para>
This file is used to store most configuration values. While it is
possible to edit the file by hand, everything you need can and
should be done from the gui.
     </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><filename>~/.solfege</filename>
    </term>
    <listitem>
      <para>Statistics is stored in subdirectories below this dir.</para>
    </listitem>
  </varlistentry>
</variablelist>
</para>
</refsect1>

<refsect1>
<title>NOTES</title>
<para>
If you don't have <filename>/dev/music</filename>
it is possible that your kernel supports it. Try to create the device
file yourself (as root):

<programlisting>
cd /dev
mknod music u 14 8
</programlisting>
</para>
<para>
To get more help on <command>solfege</command>,
use the online documentation, look at the files in 
<filename>/usr/share/doc/solfege</filename>
(debian users) and the <filename>README</filename>
and <filename>INSTALL</filename>
file from the downloaded .tar.gz file.
If you have problems running
<command>solfege</command>
please post your questions to
<email>solfege-devel@lists.sourceforge.net</email>.

Remember to mention what version of Solfege you have, and the name and
version of your operating system. If possible, please check that the bug
exists in the latest version of Solfege.
</para>
</refsect1>


<refsect1>
<title>Copyright</title>
<para>
GNU Solfege is Copyright <trademark class="copyright"/> 1999, 2000, 2001, 2002, 2003, 2004 by
Tom Cato Amundsen <email>tca@gnu.org</email>.</para>

<para>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.</para>
</refsect1>

<refsect1>
<title>Author</title>
<para>
Main author of GNU Solfege and this manual page is
Tom Cato Amundsen <email>tca@gnu.org</email>. For more details,
read the <filename>AUTHORS</filename> file from the source tarball.
</para>
</refsect1>
</refentry>
