1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307
|
<!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:
-->
|