<?xml version='1.0' encoding='ISO-8859-1'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [

<!--

Process this file with an XSLT processor: `xsltproc \
-''-nonet /usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\
manpages/docbook.xsl manpage.dbk'.  A manual page
<package>.<section> will be generated.  You may view the
manual page with: nroff -man <package>.<section> | less'.  A
typical entry in a Makefile or Makefile.am is:

DB2MAN=/usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\
manpages/docbook.xsl
XP=xsltproc -''-nonet

manpage.1: manpage.dbk
        $(XP) $(DB2MAN) $<
    
The xsltproc binary is found in the xsltproc package.  The
XSL files are in docbook-xsl.  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 xsltproc
and docbook-xsl in your Build-Depends control field.

-->

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>Cyril</firstname>">
  <!ENTITY dhsurname   "<surname>Martin</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>february 24, 2004</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>8</manvolnum>">
  <!ENTITY dhemail     "<email>mcoolive@free.fr</email>">
  <!ENTITY dhusername  "Cyril Martin">
  <!ENTITY dhucpackage "<refentrytitle>EAGLE-USB</refentrytitle>">
  <!ENTITY dhpackage   "eaglectrl">

  <!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>2004</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>

    <refpurpose>advanced controls for eagle-usb driver.</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>

      <arg><option>-h</option>|<option>--help</option></arg>
      <arg><option>-v</option>|<option>--version</option></arg>
      <arg><option>-o</option>|<option>--options <replaceable>options-file</replaceable></option></arg>
      <arg><option>-c</option>|<option>--cmvs <replaceable>file</replaceable></option></arg>
      <arg><option>-d</option>|<option>--dsp <replaceable>dsp-file</replaceable></option></arg>
      <arg><option>-i</option>|<option>--if</option></arg>
      <arg><option>-s</option>|<option>--sync <replaceable>sec</replaceable></option></arg>
      <arg><option>-p</option>|<option>--print</option></arg>
      <arg><option>-w</option>|<option>--wizard</option></arg>
      <arg><option>-g</option>|<option>--get-debug</option></arg>
      <arg><option>-x</option>|<option>--set-debug <replaceable>debug-mask</replaceable></option></arg>
      <arg><option>-l</option>|<option>--list-debug</option></arg>

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

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

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

    <variablelist>
      <varlistentry>
        <term><option>-h</option>,
          <option>--help</option>
        </term>
        <listitem>
          <para>Show summary of options.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-v</option>,
          <option>--version</option>
        </term>
        <listitem>
          <para>Show the version number of program.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-o</option>,
          <option>--options <replaceable>file</replaceable></option>
        </term>
        <listitem>
          <para>Set options file (file defaults to 
		/etc/eagle-usb/eagle-usb.conf).</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-c</option>,
          <option>--cmvs <replaceable>file</replaceable></option>
        </term>
        <listitem>
          <para>Set cmvs file (file defaults to 
		/etc/eagle-usb/CMVep.txt).</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-d</option>,
          <option>--dsp <replaceable>dsp-file</replaceable></option>
        </term>
        <listitem>
          <para>Send Options, CMVS, and DSP file path is either a path to the
	  DSP file or to a directory containing DSP files for ISDN and POTS.
	  In this case eaglectrl will choose which file to send 
	  to modem depending on the modem type.
	  Defaults to /usr/lib/eagle-usb.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-i</option>,
          <option>--if</option>
        </term>
        <listitem>
          <para>Print modem interface name.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-s</option>,
          <option>--sync <replaceable>sec</replaceable></option>
        </term>
        <listitem>
          <para>Wait <replaceable>sec</replaceable> seconds for modem 
	  to be operationnal.
	  If sec is 0 wait until synchro happens (infinite).
	  Defaults to 60.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-p</option>,
          <option>--print</option>
        </term>
        <listitem>
          <para>Display detected devices.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-w</option>,
          <option>--wizard</option>
        </term>
        <listitem>
          <para>Wizard mode. Works if you have ONLY 1 eagle modem plugged in.
	  Choose itself sequence to send to modem (firmware/DSP ..)
	  NOTE: You can use it in conjunction with -o, -d and -s to specify 
	  the options file, DSP file and synchro timeout values to use.
	  </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-g</option>,
          <option>--get-debug</option>
        </term>
        <listitem>
          <para>Get debug mask.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-x</option>,
          <option>--set-debug <replaceable>debug-mask</replaceable></option>
        </term>
        <listitem>
          <para>Set driver debug-mask to the given value,
	  which can either be an haxadecimal number (0x0, 0xFF)
	  or a list of debug flags separated by a comma.
	  A list of available flags can be given by the 
	  <option>--list-debug</option> option.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-l</option>,
          <option>--list-debug</option>
        </term>
        <listitem>
          <para>Display a list of available flags for the debug-mask.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>

    <para>eaglestat(8), eagleconfig(8), eaglediag(8), 
    startadsl(8), stopadsl(8).</para>

  </refsect1>
</refentry>

