<!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>Damyan</firstname>">
  <!ENTITY dhsurname   "<surname>Ivanov</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>April 29, 2002</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>dam@modsoftsys.com</email>">
  <!ENTITY dhusername  "Damyan Ivanov">
  <!ENTITY dhucpackage "<refentrytitle>ISQL</refentrytitle>">
  <!ENTITY dhpackage   "isql">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2002</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

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

    <refpurpose>Firebird Interactive SQL shell</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>
	  <arg> -a </arg>
      <arg> -cache <replaceable>bufnum</replaceable> </arg>
	  <arg> -database <replaceable>database</replaceable> </arg>
      <arg> -echo </arg>
      <arg> -input <replaceable>infile</replaceable> </arg>
      <arg> -noautocommit </arg>
      <arg> -nowarnings </arg>
      <arg> -output <replaceable>outfile</replaceable> </arg>
      <arg> -password <replaceable>password</replaceable> </arg>
      <arg> -page <replaceable>pagelen</replaceable> </arg>
      <arg> -role <replaceable>role</replaceable> </arg>
      <arg> -s <replaceable>sqldialect</replaceable> </arg>
      <arg> -terminator <replaceable>lineterm</replaceable> </arg>
      <arg> -user <replaceable>user</replaceable> </arg>
	  <arg> -x </arg>
      <arg> -z </arg>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

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

    <para>This manual page was written for the &debian; distribution
      because the original program does not have a (free) manual page.
      Instead, it has non-free documentation you can get from
			InterBase (Borland) or FireBird project sites; see at the end
			of the document.</para>

    <para><command>&dhpackage;</command> is a program that
		allows the user to issue arbitrary SQL commands to a Firebird database
		as well as exctacting the metadata.</para>

		<para><command>&dhpackage;</command> in &debian; is available under
		<command>isql-fb</command> name due to filename conflict with binary
		from other package.
		If for some reason it is needed to have it under original name it is
		possible to add /usr/lib/firebird/bin at the beginning of PATH variable
		which should solve eventual problem.</para>

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

    <para><command>&dhpackage;</command> can handle various command line
	options.
	Most options can be abbreviated. Below are given the
	shortest abbreviations as well as the full versions.
	A summary of options follows.</para>

    <variablelist>
		
		<varlistentry>
		<term><option>-a</option>
		</term>
		<listitem>
		<para>Extract DDL statements necessary to re-create database's metadata.
		The CREATE DATABASE statement is surrounded by C-style comment.
		Statements are printed to standard output unless redirection is used. See <option>-output</option>. See <option>-x</option>.</para>
		</listitem>
		</varlistentry>

		<varlistentry>
		<term><option>-c[ache] <replaceable>buffers</replaceable></option>
		</term>
		<listitem>
			<para>Specify default number of cache buffers to be used in connections.</para>
		</listitem>
		</varlistentry>
		
		<varlistentry>
		<term><option>-d[atabase] <replaceable>database</replaceable></option>
		</term>
		<listitem>
			<para>Used together with <option>-x</option>. Specifies target database name when extracting. See <option>-x</option>.</para>
		</listitem>
		</varlistentry>

      <varlistentry>
        <term><option>-e[cho]</option>
        </term>
        <listitem>
          <para>Display each statement before executing it.</para>
        </listitem>
      </varlistentry>

	  <varlistentry>
	  	<term><option>-x|-ex[tract]</option>
		</term>
		<listitem>
			<para>Extracts DDL statements to recreate database metadata.
			The only difference with <option>-a</option> is that -extract
			behaves differently if <option>-d</option> is also specified.</para>
			<para>If no <option>-d</option> is specified, -x behaves exactly
			as <option>-a</option>. If <option>-d</option> is specified,
			the CREATE DATABASE statement is uncommented, replacing database
			name with <replaceable>database</replaceable>.</para>
		</listitem>
	</varlistentry>

	<varlistentry>
        <term><option>-i[nput] <replaceable>infile</replaceable></option>
        </term>
        <listitem>
          <para>Reads commands from <replaceable>infile</replaceable> instead of standard input. Exits with commit after the last command.</para>
        </listitem>
   </varlistentry>

	<varlistentry>
		<term><option>-m[erge_stderr]</option>
		</term>
		<listitem>
			<para>Merges standard error to standard output. Useful for redirecting both streams.</para>
		</listitem>
	</varlistentry>
	
	<varlistentry>
		<term><option>-n[oautocommit]</option></term>
		<listitem>
			<para>Normally, all DDL statements like CREATE TABLE are
			automatically committed in a separate transaction. This option
			disables the automatic commit of DDL statements.</para>
		</listitem>
	</varlistentry>
	
	<varlistentry>
		<term><option>-nowarnings</option></term>
		<listitem>
			<para>Disables displaying of SQL warnings.</para>
		</listitem>
	</varlistentry>
	
	<varlistentry>
		<term><option>-o[utput] <replaceable>outfile</replaceable></option>
		</term>
		<listitem>
			<para>All output is redirected to the given <replaceable>outfile</replaceable>.</para>
		</listitem>
	</varlistentry>
	
	<varlistentry>
		<term><option>-page[length] <replaceable>n</replaceable></option>
		</term>
		<listitem>
			<para>Prints column headers every
			<replaceable>n</replaceable> output lines. Default is 20.</para>
		</listitem>
	</varlistentry>
	
	<varlistentry>
		<term><option>-pas[sword] <replaceable>password</replaceable></option>
		</term>
		<listitem>
			<para>Uses given <replaceable>password</replaceable> as a default
			for connecting to the database.</para>
		</listitem>
	</varlistentry>
	
	<varlistentry>
		<term><option>-r[ole] <replaceable>sqlrole</replaceable></option>
		</term>
		<listitem>
			<para>Uses given <replaceable>sqlrole</replaceable> as a default
			for connecting to the database.</para>
		</listitem>
	</varlistentry>
	
	<varlistentry>
		<term><option>-s[qldialect] <replaceable>sqldialect</replaceable></option>
		</term>
		<listitem>
			<para>Uses given <replaceable>sqldialect</replaceable> as a default
			for connecting to the database.</para>
		</listitem>
	</varlistentry>
	
	<varlistentry>
    	<term><option>-t[erminator] <replaceable>lineterm</replaceable></option>
        </term>
        <listitem>
          <para>Set command line terminator. Default is semicolon (`;').</para>
        </listitem>
      </varlistentry>

	<varlistentry>
		<term><option> -u[ser] <replaceable>username</replaceable></option>
		</term>
		<listitem>
			<para>Uses given <replaceable>username</replaceable> as a default
			for connecting to the database.</para>
		</listitem>
	</varlistentry>
	
	<varlistentry>
        <term><option>-z</option>
        </term>
        <listitem>
          <para>Show version string before doing anything else.</para>
        </listitem>
    </varlistentry>

    </variablelist>
  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>

    <para>gbak(1), gdef(1), gfix(1),  gpre(1), gsec(1),  gstat(1), qli(1).</para>

    <para>Additional documentation about <command>&dhpackage;</command> and
	other <application>Firebird</application> parts can be found on the Firebird Project website.</para>

		<para>For more information about Firebird project, visit
		http://www.firebirdsql.org/.</para>
  </refsect1>
  <refsect1>
    <title>AUTHOR</title>

    <para>This manual page was written by &dhusername; (&dhemail;) for the
        &debian; system (but may be used by others). Permission is granted to
        use this document, with or without modifications, provided that this
        notice is retained. If we meet some day, and you think this stuff is
        worth it, you can buy me a beer in return.  </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:
-->


