.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "NBACKUP 1"
.TH NBACKUP 1 2024-03-05 "Firebird 3.0" "Firebird documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
nbackup \- Physical backup manager for Firebird
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.IP "\fBnbackup\fR [\fIoption\fR...] \-l|\-u|\-f \fIdatabase\fR" 4
.IX Item "nbackup [option...] -l|-u|-f database"
.PD 0
.IP "\fBnbackup\fR [\fIoption\fR...] \-b \fIlevel\fR \fIdatabase\fR \fIfile\fR" 4
.IX Item "nbackup [option...] -b level database file"
.IP "\fBnbackup\fR [\fIoption\fR...] \-r \fIdatabase\fR \fIfile0\fR [\fIfile1\fR...]" 4
.IX Item "nbackup [option...] -r database file0 [file1...]"
.PD
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBnbackup\fR allows making incremental backups of firebird databases. It also
allows database files to be locked for copying with OS tools like
\&\fBcp\fR\|(1).
.SH COMMANDS
.IX Header "COMMANDS"
.IP "\fB\-l\fR \fIdatabase\fR" 4
.IX Item "-l database"
.PD 0
.IP "\fB\-lock\fR \fIdatabase\fR" 4
.IX Item "-lock database"
.PD
Locks \fIdatabase\fR for filesystem copy.
.Sp
Options of the \fB\-lock\fR command:
.RS 4
.IP \fB\-s\fR 4
.IX Item "-s"
.PD 0
.IP \fB\-size\fR 4
.IX Item "-size"
.PD
Print database size (in database pages) after locking.
.RE
.RS 4
.RE
.IP "\fB\-un\fR \fIdatabase\fR" 4
.IX Item "-un database"
.PD 0
.IP "\fB\-unlock\fR \fIdatabase\fR" 4
.IX Item "-unlock database"
.PD
Unlocks previously locked database.
.IP "\fB\-f\fR \fIdatabase\fR" 4
.IX Item "-f database"
.PD 0
.IP "\fB\-fixup\fR \fIdatabase\fR" 4
.IX Item "-fixup database"
.PD
Fixup \fIdatabase\fR after filesystem copy. This needs to be done on the target
database before usage.
.IP "\fB\-b\fR \fIlevel\fR \fIdatabase\fR \fIfile\fR" 4
.IX Item "-b level database file"
.PD 0
.IP "\fB\-backup\fR \fIlevel\fR \fIdatabase\fR \fIfile\fR" 4
.IX Item "-backup level database file"
.PD
Create incremental backup of level \fIlevel\fR. Level 0 means full backup. Level
\&\fIN\fR includes all the changes since the last backup of level \fIN\fR. \fIfile\fR may
be \f(CW\*(C`stdout\*(C'\fR meaning to write the backup data to the standard output.
.Sp
Additional options to the \fB\-backup\fR command:
.RS 4
.IP "\fB\-d\fR \fIon|off\fR" 4
.IX Item "-d on|off"
.PD 0
.IP "\fB\-direct\fR \fIon|off\fR" 4
.IX Item "-direct on|off"
.PD
Turns on or off direct I/O during database backup.
.Sp
Direct I/O may be useful when database is much larger that RAM, because in that
case using buffered I/O may cause replacing useful cache contents with database
file contents, which are generally read only once.
.RE
.RS 4
.RE
.IP "\fB\-r\fR \fIdatabase\fR \fIfile0\fR [\fIfile1\fR...]" 4
.IX Item "-r database file0 [file1...]"
.PD 0
.IP "\fB\-restore\fR \fIdatabase\fR \fIfile0\fR [\fIfile1\fR...]" 4
.IX Item "-restore database file0 [file1...]"
.PD
Restore incremental backup. \fIfile0\fR is the level 0 backup, \fIfile1\fR is the
level 1 backup and so on.
.Sp
Additional \fB\-restore\fR options:
.RS 4
.IP "\fB\-de\fR \fIcommand\fR" 4
.IX Item "-de command"
.PD 0
.IP "\fB\-decompress\fR \fIcommand\fR" 4
.IX Item "-decompress command"
.PD
Decompress backup file contents using the given \fIcommand\fR.
.RE
.RS 4
.Sp
\&\fBNote:\fR \fB\-restore\fR should be the last argument to \fBnbackup\fR followed only by
database and file names. All other options must precede \fB\-restore\fR or will be
interpreted as backup file names.
.RE
.SH "COMMON OPTIONS"
.IX Header "COMMON OPTIONS"
.IP "\fB\-u\fR \fIuser\fR" 4
.IX Item "-u user"
.PD 0
.IP "\fB\-user\fR \fIuser\fR" 4
.IX Item "-user user"
.PD
User name for connecting to the firebird server.
.IP "\fB\-p\fR \fIpassword\fR" 4
.IX Item "-p password"
.PD 0
.IP "\fB\-password\fR \fIpassword\fR" 4
.IX Item "-password password"
.PD
Password for connecting to the firebird server.
.IP "\fB\-fetch_password\fR \fIfile\fR" 4
.IX Item "-fetch_password file"
Read password from specified \fIfile\fR.
.IP \fB\-nod\fR 4
.IX Item "-nod"
.PD 0
.IP \fB\-nodbtriggers\fR 4
.IX Item "-nodbtriggers"
.PD
Do not run database-level triggers.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBgbak\fR\|(1)
.PP
Additional documentation about \fBnbackup\fR and other Firebird utilities can be
found on the Firebird Project website, <http://www.firebirdsql.org>.
.SH AUTHOR
.IX Header "AUTHOR"
Original idea is of Sean Leyne sean@broadviewsoftware.com.  Designed and
implemented by Nickolay Samofatov skidder@bssys.com.  This work was funded
through a grant from BroadView Software, Inc.
.PP
This manual page was written by Damyan Ivanov dmn@debian.org for the Debian
project. 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.