<!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>Paul</firstname>">
  <!ENTITY dhsurname   "<surname>Brossier</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>20051214</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>&lt;piem@altern.org&gt;</email>">
  <!ENTITY dhusername  "Paul Brossier">
  <!ENTITY dhucpackage "<refentrytitle>CHUCK</refentrytitle>">
  <!ENTITY dhpackage   "chuck">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
]>

<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>audio programming language for real-time synthesis, composition, and performance</refpurpose>
  </refnamediv>

<!--[options|commands] [+-=^] file1 file2 file3 ...
   [options] = halt|loop|audio|silent|dump|nodump|about|
               srate<N>|bufsize<N>|bufnum<N>|dac<N>|adc<N>|
               remote<hostname>|port<N>|verbose<N>|probe|
               blocking|callback
   [commands] = add|remove|replace|status|time|kill
   [+-=^] = shortcuts for add, remove, replace, status

chuck version: 1.2.0.4 (dracula)
   http://chuck.cs.princeton.edu/
-->
  
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>
      <arg><option>--halt</option></arg>
      <arg><option>--loop</option></arg>
      <arg><option>--audio</option></arg>
      <arg><option>--silent</option></arg>
      <arg><option>--dump</option></arg>
      <arg><option>--nodump</option></arg>
      <arg><option>--about</option></arg>

      <arg><option>--srate<replaceable>N</replaceable></option></arg>
      <arg><option>--bufsize<replaceable>N</replaceable></option></arg>
      <arg><option>--bufnum<replaceable>N</replaceable></option></arg>
      <arg><option>--dac<replaceable>N</replaceable></option></arg>
      <arg><option>--adc<replaceable>N</replaceable></option></arg>
      <arg><option>--remote<replaceable>hostname</replaceable></option></arg>
      <arg><option>--port<replaceable>N</replaceable></option></arg>
      <arg><option>--verbose<replaceable>N</replaceable></option></arg>
      <arg><option>--probe</option></arg>
      <arg><option>--blocking</option></arg>
      <arg><option>--callback</option></arg>
      
      <arg><option>--add</option></arg>
      <arg><option>--remove</option></arg>
      <arg><option>--replace</option></arg>
      <arg><option>--status</option></arg>
      <arg><option>--time</option></arg>
      <arg><option>--kill</option></arg>

      <arg><option>--version</option></arg>

      <arg><option>+</option></arg>
      <arg><option>-</option></arg>
      <arg><option>=</option></arg>
      <arg><option>&circ;</option></arg>

      <arg>file1</arg>
      <arg>file2</arg>
      <arg>file2</arg>

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

    <para>This manual page documents briefly the <command>&dhpackage;</command>
commands.</para>

    <para><command>&dhpackage;</command> is a new audio programming language
for real-time synthesis, composition, and performance, which runs on commodity
operating systems.</para>

    <para><command>&dhpackage;</command> presents a new time-based concurrent
programming model, which supports multiple, simultaneous, dynamic control
rates, and the ability to add, remove, and modify code, on-the-fly, while the
program is running, without stopping or restarting.</para>

    <para>Use <command>&dhpackage;</command> for jack audio interfaces,
    <command>&dhpackage;.alsa</command> to access alsa devices,
    and <command>&dhpackage;.pulse</command> to access pulse devices.</para>

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

    <para>A summary of options is included below.</para>

    <variablelist>
      
      <varlistentry><term><option>--add <replaceable>file.ck</replaceable></option></term>
        <listitem><para>Add a file to a running chuck server.</para></listitem>
      </varlistentry>
      <varlistentry><term><option>--remove <replaceable>shrednumber</replaceable></option></term>
        <listitem><para>Remove a shred to a running chuck server.</para></listitem>
      </varlistentry>
      <varlistentry><term><option>--replace <replaceable>shrednumber</replaceable> <replaceable>file.ck</replaceable></option></term>
        <listitem><para>Replace an existing shred with another file.</para></listitem>
      </varlistentry>
      <varlistentry><term><option>--status</option></term>
        <listitem><para>Print chuck server status information.</para></listitem>
      </varlistentry>

      <varlistentry><term><option>+</option> <option>-</option> <option>=</option> <option>&circ;</option></term>
        <listitem><para>Shortcuts for add, remove, replace and status.</para></listitem>
      </varlistentry>

      <varlistentry><term><option>--time</option></term>
        <listitem><para>Get the current time.</para></listitem>
      </varlistentry>
      <varlistentry><term><option>--kill</option></term>
        <listitem><para>Kill the chuck server.</para></listitem>
      </varlistentry>

      <varlistentry><term><option>--halt</option></term>
        <listitem><para>Start in halt mode (default).</para></listitem>
      </varlistentry>
      <varlistentry><term><option>--loop</option></term>
        <listitem><para>Start chuck in loop mode (daemon mode).</para></listitem>
      </varlistentry>
      <varlistentry><term><option>--audio</option></term>
        <listitem><para>Start server with audio (default).</para></listitem>
      </varlistentry>
      <varlistentry><term><option>--silent</option></term>
        <listitem><para>Start server in silent mode.</para></listitem>
      </varlistentry>
      <varlistentry><term><option>--dump</option></term>
        <listitem><para>Dump compilation result (verbose mode).</para></listitem>
      </varlistentry>
      <varlistentry><term><option>--nodump</option></term>
        <listitem><para>Do not dump compilation result.</para></listitem>
      </varlistentry>

      <varlistentry><term><option>--srate<replaceable>N</replaceable></option></term>
	<listitem><para>Set sampling rate (default to 48000 for jack, auto
detected otherwise).</para></listitem>
      </varlistentry>
      <varlistentry><term><option>--bufsize<replaceable>N</replaceable></option></term>
        <listitem><para>Set buffer size.</para></listitem>
      </varlistentry>
      <varlistentry><term><option>--bufnum<replaceable>N</replaceable></option></term>
        <listitem><para>Set number of buffer.</para></listitem>
      </varlistentry>
      <varlistentry><term><option>--dac<replaceable>N</replaceable></option></term>
        <listitem><para>Set output audio device.</para></listitem>
      </varlistentry>
      <varlistentry><term><option>--adc<replaceable>N</replaceable></option></term>
        <listitem><para>Set input audio device.</para></listitem>
      </varlistentry>
      <varlistentry><term><option>--remote<replaceable>hostname</replaceable></option></term>
        <listitem><para>Connect to remote hostname.</para></listitem>
      </varlistentry>
      <varlistentry><term><option>--port<replaceable>N</replaceable></option></term>
        <listitem><para>Connect/Listen on port number N.</para></listitem>
      </varlistentry>
      <varlistentry><term><option>--verbose<replaceable>N</replaceable></option></term>
        <listitem><para>Set verbosity level to N.</para></listitem>
      </varlistentry>
      <varlistentry><term><option>--probe</option></term>
        <listitem><para>List available audio devices.</para></listitem>
      </varlistentry>
      <varlistentry><term><option>--blocking</option></term>
        <listitem><para>Use blocking mode audio access.</para></listitem>
      </varlistentry>
      <varlistentry><term><option>--callback</option></term>
        <listitem><para>Use callback mode audio access.</para></listitem>
      </varlistentry>

      <varlistentry><term><option>--about</option> <option>--help</option></term>
        <listitem><para>Show summary of options.</para></listitem>
      </varlistentry>
      <varlistentry><term><option>--version</option></term>
        <listitem><para>Show version of program.</para></listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>

    <para>/usr/share/doc/chuck/ChucK_manual.pdf</para>

  </refsect1>
  <refsect1>
    <title>EXAMPLES</title>

    <para>$ cd /usr/share/doc/chuck/examples</para>
    <para>$ chuck otf_01.ck &</para>
    <para>$ chuck --add otf_02.ck &</para>
    <para>$ chuck + otf_0[4567].ck</para>
    <para>$ chuck - 0</para>
    <para>$ chuck --kill</para>
  </refsect1>
  <refsect1>
    <title>AUTHOR</title>

    <para>This manual page was written by &dhusername;
<command>&dhemail;</command>.  Permission is granted to copy, distribute and/or
modify this document under the terms of the &gnu; General Public License,
Version 2 any later version published by the Free Software Foundation.  </para>

	<para>
	  On Debian systems, the complete text of the GNU General Public
	  License can be found in /usr/share/common-licenses/GPL.
	</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:
-->


