Functions and parameters

The following table gives an overview of nbackup's parameters. If the field “Added” is empty, the parameter has existed since nbackup's introduction in Firebird 2.0.

Table 1. Nbackup parameters

Parameter	Function	Added
-B `n` `<database>` [`<filename>`]	Make level-`n` backup of database to file
-R `<database>` [`<filename>` ...]	Restore database from backup file(s)
-L `<database>`	Lock database
-N `<database>`	Unlock locked database
-F `<database>`	Unlock user-restored database
-S	Give size in database pages (with -L)	2.1
-T	Suppress database triggers (with -B, -L, -N)	2.1
-D on\|off	Direct I/O on/off (with -B)	2.1.4
-U `<username>`	Supply user name (with -B, -L, -N)
-P `<password>`	Supply password (with -B, -L, -N)
-FE `<filename>`	Fetch password from file (with -B, -L, -N)	2.5
-Z	Version info (by itself or with -B, -R, -L, -N, -F)	2.5
-?	Help (switches off all other parameters)	2.5

Depending on the chosen main function (-B, -R, -L, -N or -F), nbackup may require different types of access to the database: a Firebird server connection, direct file access, or both. The following table gives the details:

Table 2. Access required

Parameter	Function	Access
-B	Backup	server + file
-R	Restore	file
-L	Lock	server
-N	Unlock (undo -L)	server
-F	Unlock after user restore	file

Where server access is required (with -B, -L and -N), the user must either provide a Firebird username and password (with -U and -P/-FE or through the environment variables ISC_USER and ISC_PASSWORD), or be admitted by the server on other grounds (e.g. as root under Posix or by trusted authentication under Windows).

Where filesystem access is required (with -B, -R and -F), the user must have sufficient read and/or write privileges to the database file.

Where filesystem access is required exclusively (with -R and -F), the user need not have a Firebird login and a running Firebird server need not be present.

Please notice: The above table and text concern access to the database. Access to the backup file is – obviously – always on the filesystem level.