.\" $Id$
.Dd Feb 27, 2007
.Dt sybdump \&1
.Sh NAME
.Nm sybdump ,
.Nm sybload
.Nd DUMP/LOAD Sybase databases using
.Nm libpipe
.Sh SYNOPSIS
.Nm
.Op Fl D
.Op Fl S Ar server
.Op Fl U Ar user
.Op Fl P Ar password
.Op Bro Fl j | z Brc Ar level
.Op Fl f Ar database.dmp
.Op Fl T Ar timeout
.Op Fl t
.Ar database
.Op > Ar database.dmp
.Pp
.Nm sybload
.Op Fl L
.Op Fl S Ar server
.Op Fl U Ar user
.Op Fl P Ar password
.Op Bro Fl j | z Brc Ar level
.Op Fl f Ar database.dmp
.Op Fl T Ar timeout
.Op Fl t
.Ar database
.Op < Ar database.dmp
.Pp
.Pf ( Nm sybload
is an alternative name for
.Nm
implying the
.Fl L
switch. Similarly,
.Fl D
explicitly specifies a DUMP request, regardless of the invoked name.)
.Pp
.Nm
.Op Fl S Ar sourceserver
.Op Fl U Ar sourceuser
.Op Fl P Ar sourcepassword
.Fl s Ar destinationserver
.Op Fl u Ar destuser
.Op Fl p Ar destpassword
.Op Fl t
.Ar database
.Sh DESCRIPTION
The
.Nm
utility relies on the
.Nm libpipe
plugin being installed on the target Sybase server and requests the server
to send (or, in the case of
.Fl L
-- receive) a dump of the specified
.Ar database
via a direct network connection.
.Pp
This is, usually, faster and more reliable than using NFS for dumping
onto storage located on another machine. The method also allows
on-the-fly processing of the data (such as (de)compressing,
(un)encrypting, etc.).
.Pp
Unlike when using a remote backup server, no server software needs
to be running on the client computer. Instead,
.Nm libpipe
must be present on the server.
.Pp
The first two usages are orthogonal -- they DUMP or LOAD directly
to stdout or from stdin. The third one is different. In this case,
the data is not, actually, sent to the client
.Pf ( Nm ) ,
but is forwarded by the
.Ar sourceserver
to the expecting
.Ar destinationserver .
When thus invoked,
.Nm
will simply report the progress messages arriving from both servers.
.Nm libpipe
must be installed on both servers, of course.
.Pp
When requesting a DUMP (first or third usage), the database will be prepared
according to Sybase's requirements for a clean dump loadable into a server,
that, potentially, runs on a machine of different architecture.
.Pp
A just LOADed database (second or third usage) will be automatically brought
online (thus triggering possible Sybase's analysis, conversion, etc.), and the
.Nm sp_post_xpload
procedure will be invoked if advised by the server (such as in cross-endian
database transfer).
.Sh OPTIONS
The default value for
.Fl U
and
.Fl u
is "sa" (user to login as). The default passwords are non-existant (NULL).
.Pp
If the dumpfile is not specified with the
.Fl f
option, the usual stdin (for LOAD) or stdout (for DUMP) is used.
.Pp
.Op Bro Fl j | z Brc Ar level
option specifies compression (and level) of the dump by either
.Lb libz
or
.Lb libbz2
Use if you wish
.Nm
to compress directly, or, when LOADing, to hint
.Nm sybload
to uncompress. When LOADing seekable files, the check for compression is
done automatically, but when stdin is the output of another command, an
explicit
.Fl z | j
(with any level number) is currently required for decompression to function.
.Pp
.Fl t
can be specified to tell
.Nm
to ignore SIGINT. This obscure feature is currently used by
dumpall, to allow the ongoing dumps to finish upon Ctrl-C.
.Pp
.Fl T Ar timeout
specifies the maximum time (in seconds) to wait for the server to respond. 
The default value is -1 (INFTIM), which means forever. You should allow
the server at least a few minutes...
.Sh EXAMPLES
.Bl -tag
.It Nm Ar test No | Ic gzip -9 > test.cmp
.It Nm Ar -z 9 test Ic > test.cmp
Both of these allow to run the (CPU-intensive) compression on the client-side,
where the CPU may be faster and/or the
.Nm gzip
(first example) or
.Lb libz
(second example) may be assembler-optimized.
.It Ic gzcat test.cmp | Nm Fl L Ar test
.It Nm sybload Ar test Ic < test.cmp
LOAD the database from the previous example back into the default server.
.It Nm sybdump Fl S Ar BIGBIRD125 Fl s Ar BERT125 \
Ar RD_BACKUP Ar RD_CURRENT
Transfer the backup of the RD-database from server
.Ar BIGBIRD125
(where it is named RD_BACKUP)
to
.Ar BERT125
\&.
.El
.Sh SEE ALSO
.Xr libpipe 1 ,
.Xr bzip2 1 ,
.Xr gzip 1 ,
.Xr libpipe 1 ,
.Xr zlib 3 ;
Sybase's DUMP/LOAD manual.
.Sh AUTHORS
.An Virtual Estates, Inc. Aq libpipe+sybdump@virtual-estates.com
wrote this open-source utility and the manual page to complement and
illustrate their
.Nm libpipe
plugin for Sybase backup-server (sybmultbuf).