man/000075500000000000000000000000001177742570500116465ustar00rootroot00000000000000man/berkeley_db_svc.1000064400000000000000000000050551177742570500150570ustar00rootroot00000000000000.\" Manual Page for Berkely DB utils, created from upstream .\" documentation by Thijs Kinkhorst . .TH BERKELEY_DB_SVC 1 "28 January 2005" .SH NAME berkeley_db_svc \- Berkeley DB RPC server .SH SYNOPSIS .B berkeley_db_svc [-Vv] [-h home] [-I seconds] [-L file] [-t seconds] [-T seconds] .SH DESCRIPTION The berkeley_db_svc utility is the Berkeley DB RPC server. .SH OPTIONS .IP \fB\-h\fR Add the specified home directory to the list of allowed home directories that can be specified by the client. The home directory should be an absolute pathname. The last component of each home directory specified must be unique because that is how clients specify which database environment they want to join. .sp Recovery will be run on each specified environment before the server begins accepting requests from clients. For this reason, only one copy of the server program should ever be run at any time because recovery must always be single-threaded. .IP \fB\-I\fR Set the default idle timeout for client environments to the specified number of seconds. The default timeout is 24 hours. .IP \fB\-L\fR Log the execution of the berkeley_db_svc utility to the specified file in the following format, where \fI###\fR is the process ID, and the date is the time the utility was started. .sp berkeley_db_svc: ### Wed Jun 15 01:23:45 EDT 1995 .sp This file will be removed if the berkeley_db_svc utility exits gracefully. .IP \fB\-t\fR Set the default timeout for client resources (idle transactions and cursors) to the specified number of seconds. When the timeout expires, if the resource is a transaction, it is aborted; if the resource is a cursor, it is closed. The default timeout is 5 minutes. .IP \fB\-T\fR Set the maximum timeout allowed for client resources. The default timeout is 20 minutes. If a client application requests a server timeout greater than the maximum timeout set for this server, the client's timeout will be capped at the maximum timeout value. .IP \fB\-V\fR Write the library version number to the standard output, and exit. .IP \fB\-v\fR Run in verbose mode. .PP The berkeley_db_svc utility exits 0 on success, and >0 if an error occurs. .SH ENVIRONMENT .IP \fBDB_HOME\fR If the \fB-h\fR option is not specified and the environment variable DB_HOME is set, it is used as the path of the database home, as described in DB_ENV->open. .SH AUTHORS Sleepycat Software, Inc. This manual page was created based on the HTML documentation for berkeley_db_svc from Sleepycat, by Thijs Kinkhorst , for the Debian system (but may be used by others). man/db_archive.1000064400000000000000000000110561177742570500140210ustar00rootroot00000000000000.\" Manual Page for Berkely DB utils, created from upstream .\" documentation by Thijs Kinkhorst . .TH DB_ARCHIVE 1 "28 January 2005" .SH NAME db_archive \- Find unused log files for archiving purposes .SH SYNOPSIS .B db_archive [-adlsVv] [-h home] [-P password] .SH DESCRIPTION The db_archive utility writes the pathnames of log files that are no longer in use (for example, no longer involved in active transactions), to the standard output, one pathname per line. These log files should be written to backup media to provide for recovery in the case of catastrophic failure (which also requires a snapshot of the database files), but they may then be deleted from the system to reclaim disk space. .SH OPTIONS .PP .IP \fB\-a\fR Write all pathnames as absolute pathnames, instead of relative to the database home directories. .IP \fB\-d\fR Remove log files that are no longer needed; no filenames are written. Automatic log file removal is likely to make catastrophic recovery impossible. .IP \fB\-h\fR Specify a home directory for the database environment; by default, the current working directory is used. .IP \fB\-l\fR Write out the pathnames of all the database log files, whether or not they are involved in active transactions. .IP \fB\-P\fR Specify an environment password. Although Berkeley DB utilities overwrite password strings as soon as possible, be aware there may be a window of vulnerability on systems where unprivileged users can see command-line arguments or where utilities are not able to overwrite the memory containing the command-line arguments. .IP \fB\-s\fR Write the pathnames of all the database files that need to be archived in order to recover the database from catastrophic failure. If any of the database files have not been accessed during the lifetime of the current log files, db_archive will not include them in this output. .sp It is possible that some of the files to which the log refers have since been deleted from the system. In this case, db_archive will ignore them. When db_recover is run, any files to which the log refers that are not present during recovery are assumed to have been deleted and will not be recovered. .IP \fB\-V\fR Write the library version number to the standard output, and exit. .IP \fB\-v\fR Run in verbose mode, listing the checkpoints in the log files as they are reviewed. .PP Log cursor handles (returned by the DB_ENV->log_cursor method) may have open file descriptors for log files in the database environment. Also, the Berkeley DB interfaces to the database environment logging subsystem (for example, DB_ENV->log_put and DB_TXN->abort) may allocate log cursors and have open file descriptors for log files as well. On operating systems where filesystem related system calls (for example, rename and unlink on Windows/NT) can fail if a process has an open file descriptor for the affected file, attempting to move or remove the log files listed by db_archive may fail. All Berkeley DB internal use of log cursors operates on active log files only and furthermore, is short-lived in nature. So, an application seeing such a failure should be restructured to close any open log cursors it may have, and otherwise to retry the operation until it succeeds. (Although the latter is not likely to be necessary; it is hard to imagine a reason to move or rename a log file in which transactions are being logged or aborted.) .PP The db_archive utility uses a Berkeley DB environment (as described for the \fB-h\fR option, the environment variable \fBDB_HOME\fR, or because the utility was run in a directory containing a Berkeley DB environment). In order to avoid environment corruption when using a Berkeley DB environment, db_archive should always be given the chance to detach from the environment and exit gracefully. To cause db_archive to release all environment resources and exit cleanly, send it an interrupt signal (SIGINT). .PP The DB_ENV->log_archive method is the underlying method used by the db_archive utility. See the db_archive utility source code for an example of using DB_ENV->log_archive in a IEEE/ANSI Std 1003.1 (POSIX) environment. .PP The db_archive utility exits 0 on success, and >0 if an error occurs. .SH ENVIRONMENT .IP \fBDB_HOME\fR If the \fB-h\fR option is not specified and the environment variable DB_HOME is set, it is used as the path of the database home, as described in DB_ENV->open. .SH AUTHORS Sleepycat Software, Inc. This manual page was created based on the HTML documentation for db_archive from Sleepycat, by Thijs Kinkhorst , for the Debian system (but may be used by others). man/db_checkpoint.1000064400000000000000000000065121177742570500145300ustar00rootroot00000000000000.\" Manual Page for Berkely DB utils, created from upstream .\" documentation by Thijs Kinkhorst . .TH DB_CHECKPOINT 1 "28 January 2005" .SH NAME db_checkpoint \- Periodically checkpoint transactions .SH SYNOPSIS .B db_checkpoint [-1Vv] [-h home] [-k kbytes] [-L file] [-P password] [-p min] .SH DESCRIPTION The db_checkpoint utility is a daemon process that monitors the database log, and periodically calls DB_ENV->txn_checkpoint to checkpoint it. .SH OPTIONS .IP \fB\-1\fR Checkpoint the log once, regardless of whether or not there has been activity since the last checkpoint and then exit. .IP \fB\-h\fR Specify a home directory for the database environment; by default, the current working directory is used. .IP \fB\-k\fR Checkpoint the database at least as often as every \fBkbytes\fR of log file are written. .IP \fB\-L\fR Log the execution of the db_checkpoint utility to the specified file in the following format, where \fI###\fR is the process ID, and the date is the time the utility was started. .sp .TR 8 db_checkpoint: ### Wed Jun 15 01:23:45 EDT 1995 .sp This file will be removed if the db_checkpoint utility exits gracefully. .IP \fB\-P\fR Specify an environment password. Although Berkeley DB utilities overwrite password strings as soon as possible, be aware there may be a window of vulnerability on systems where unprivileged users can see command-line arguments or where utilities are not able to overwrite the memory containing the command-line arguments. .IP \fB\-p\fR Checkpoint the database at least every \fBmin\fR minutes if there has been any activity since the last checkpoint. .IP \fB\-V\fR Write the library version number to the standard output, and exit. .IP \fB\-v\fR Write the time of each checkpoint attempt to the standard output. .PP At least one of the \fB-1\fR, \fB-k\fR, and \fB-p\fR options must be specified. .PP The db_checkpoint utility uses a Berkeley DB environment (as described for the \fB-h\fR option, the environment variable \fBDB_HOME\fR, or because the utility was run in a directory containing a Berkeley DB environment). In order to avoid environment corruption when using a Berkeley DB environment, db_checkpoint should always be given the chance to detach from the environment and exit gracefully. To cause db_checkpoint to release all environment resources and exit cleanly, send it an interrupt signal (SIGINT). .PP The db_checkpoint utility does not attempt to create the Berkeley DB shared memory regions if they do not already exist. The application that creates the region should be started first, and once the region is created, the db_checkpoint utility should be started. .PP The DB_ENV->txn_checkpoint method is the underlying method used by the db_checkpoint utility. See the db_checkpoint utility source code for an example of using DB_ENV->txn_checkpoint in a IEEE/ANSI Std 1003.1 (POSIX) environment. .PP The db_checkpoint utility exits 0 on success, and >0 if an error occurs. .PP .SH ENVIRONMENT .IP \fBDB_HOME\fR If the \fB-h\fR option is not specified and the environment variable DB_HOME is set, it is used as the path of the database home, as described in DB_ENV->open. .SH AUTHORS Sleepycat Software, Inc. This manual page was created based on the HTML documentation for db_checkpoint from Sleepycat, by Thijs Kinkhorst , for the Debian system (but may be used by others). man/db_deadlock.1000064400000000000000000000070451177742570500141510ustar00rootroot00000000000000.\" Manual Page for Berkely DB utils, created from upstream .\" documentation by Thijs Kinkhorst . .TH DB_DEADLOCK 1 "28 January 2005" .SH NAME db_deadlock \- Detect and abort deadlocks .SH SYNOPSIS .B db_deadlock [-Vv] [-a e | m | n | o | W | w | y] [-h home] [-L file] [-t sec.usec] .SH DESCRIPTION The db_deadlock utility traverses the database environment lock region, and aborts a lock request each time it detects a deadlock or a lock request that has timed out. By default, in the case of a deadlock, a random lock request is chosen to be aborted. .PP This utility should be run as a background daemon, or the underlying Berkeley DB deadlock detection interfaces should be called in some other way, whenever there are multiple threads or processes accessing a database and at least one of them is modifying it. .SH OPTIONS .IP \fB\-a\fR When a deadlock is detected, abort the locker: .RS .IP m with the most locks .IP n with the fewest locks .IP o with the oldest lock .IP W with the most write locks .IP w with the fewest write locks .IP y with the youngest lock .RE .IP When lock or transaction timeouts have been specified: .RS .IP e abort any lock request that has timed out .RE .IP \fB\-h\fR Specify a home directory for the database environment; by default, the current working directory is used. .IP \fB\-L\fR Log the execution of the db_deadlock utility to the specified file in the following format, where \fI###\fR is the process ID, and the date is the time the utility was started. .sp .TR 8 db_deadlock: ### Wed Jun 15 01:23:45 EDT 1995 .sp This file will be removed if the db_deadlock utility exits gracefully. .IP \fB\-t\fR Check the database environment every \fBsec\fR seconds plus \fBusec\fR microseconds to see if a process has been forced to wait for a lock; if one has, review the database environment lock structures. .IP \fB\-V\fR Write the library version number to the standard output, and exit. .IP \fB\-v\fR Run in verbose mode, generating messages each time the detector runs. .PP If the \fB-t\fR option is not specified, db_deadlock will run once and exit. .PP The db_deadlock utility uses a Berkeley DB environment (as described for the \fB-h\fR option, the environment variable \fBDB_HOME\fR, or because the utility was run in a directory containing a Berkeley DB environment). In order to avoid environment corruption when using a Berkeley DB environment, db_deadlock should always be given the chance to detach from the environment and exit gracefully. To cause db_deadlock to release all environment resources and exit cleanly, send it an interrupt signal (SIGINT). .PP The db_deadlock utility does not attempt to create the Berkeley DB shared memory regions if they do not already exist. The application which creates the region should be started first, and then, once the region is created, the db_deadlock utility should be started. .PP The DB_ENV->lock_detect method is the underlying method used by the db_deadlock utility. See the db_deadlock utility source code for an example of using DB_ENV->lock_detect in a IEEE/ANSI Std 1003.1 (POSIX) environment. .PP The db_deadlock utility exits 0 on success, and >0 if an error occurs. .PP .SH ENVIRONMENT .IP \fBDB_HOME\fR If the \fB-h\fR option is not specified and the environment variable DB_HOME is set, it is used as the path of the database home, as described in DB_ENV->open. .SH AUTHORS Sleepycat Software, Inc. This manual page was created based on the HTML documentation for db_deadlock from Sleepycat, by Thijs Kinkhorst , for the Debian system (but may be used by others). man/db_dump.1000064400000000000000000000125131177742570500133440ustar00rootroot00000000000000.\" Manual Page for Berkely DB utils, created from upstream .\" documentation by Thijs Kinkhorst . .TH DB_DUMP 1 "28 January 2005" .SH NAME db_dump \- Write database to flat-text format .SH SYNOPSIS .B db_dump [-klNpRrV] [-d ahr] [-f output] [-h home] [-P password] [-s database] file .SH DESCRIPTION The db_dump utility reads the database file file and writes it to the standard output using a portable flat-text format understood by the db_load utility. The file argument must be a file produced using the Berkeley DB library functions. .SH OPTIONS .IP \fB\-d\fR Dump the specified database in a format helpful for debugging the Berkeley DB library routines. .RS .IP a Display all information. .IP h Display only page headers. .IP r Do not display the free-list or pages on the free list. This mode is used by the recovery tests. .RE .IP \fBThe output format of the -d option is not standard and may change, without notice, between releases of the Berkeley DB library.\fR .IP \fB\-f\fR Write to the specified \fBfile\fR instead of to the standard output. .IP \fB\-h\fR Specify a home directory for the database environment; by default, the current working directory is used. .IP \fB\-k\fR Dump record numbers from Queue and Recno databases as keys. .IP \fB\-l\fR List the databases stored in the file. .IP \fB\-N\fR Do not acquire shared region mutexes while running. Other problems, such as potentially fatal errors in Berkeley DB, will be ignored as well. This option is intended only for debugging errors, and should not be used under any other circumstances. .IP \fB\-P\fR Specify an environment password. Although Berkeley DB utilities overwrite password strings as soon as possible, be aware there may be a window of vulnerability on systems where unprivileged users can see command-line arguments or where utilities are not able to overwrite the memory containing the command-line arguments. .IP \fB\-p\fR If characters in either the key or data items are printing characters (as defined by \fBisprint\fR(3)), use printing characters in \fBfile\fR to represent them. This option permits users to use standard text editors and tools to modify the contents of databases. .sp Note: different systems may have different notions about what characters are considered \fIprinting characters\fR, and databases dumped in this manner may be less portable to external systems. .IP \fB\-R\fR Aggressively salvage data from a possibly corrupt file. The \fB-R\fR flag differs from the \fB-r\fR option in that it will return all possible data from the file at the risk of also returning already deleted or otherwise nonsensical items. Data dumped in this fashion will almost certainly have to be edited by hand or other means before the data is ready for reload into another database .IP \fB\-r\fR Salvage data from a possibly corrupt file. When used on a uncorrupted database, this option should return equivalent data to a normal dump, but most likely in a different order. .IP \fB\-s\fR Specify a single database to dump. If no database is specified, all databases in the database file are dumped. .IP \fB\-V\fR Write the library version number to the standard output, and exit. .PP Dumping and reloading Hash databases that use user-defined hash functions will result in new databases that use the default hash function. Although using the default hash function may not be optimal for the new database, it will continue to work correctly. .PP Dumping and reloading Btree databases that use user-defined prefix or comparison functions will result in new databases that use the default prefix and comparison functions. \fBIn this case, it is quite likely that the database will be damaged beyond repair permitting neither record storage or retrieval.\fR .PP The only available workaround for either case is to modify the sources for the db_load utility to load the database using the correct hash, prefix, and comparison functions. .PP The db_dump utility output format is documented in the Dump Output Formats section of the Berkeley DB Reference Guide. .PP The db_dump utility may be used with a Berkeley DB environment (as described for the \fB-h\fR option, the environment variable \fBDB_HOME\fR, or because the utility was run in a directory containing a Berkeley DB environment). In order to avoid environment corruption when using a Berkeley DB environment, db_dump should always be given the chance to detach from the environment and exit gracefully. To cause db_dump to release all environment resources and exit cleanly, send it an interrupt signal (SIGINT). .PP Even when using a Berkeley DB database environment, the db_dump utility does not use any kind of database locking if it is invoked with the \fB-d\fR, \fB-R\fR, or \fB-r\fR arguments. If used with one of these arguments, the db_dump utility may only be safely run on databases that are not being modified by any other process; otherwise, the output may be corrupt. .PP The db_dump utility exits 0 on success, and >0 if an error occurs. .SH ENVIRONMENT .IP \fBDB_HOME\fR If the \fB-h\fR option is not specified and the environment variable DB_HOME is set, it is used as the path of the database home, as described in DB_ENV->open. .SH AUTHORS Sleepycat Software, Inc. This manual page was created based on the HTML documentation for db_dump from Sleepycat, by Thijs Kinkhorst , for the Debian system (but may be used by others). man/db_hotbackup.1000064400000000000000000000106251177742570500143610ustar00rootroot00000000000000.\" Manual Page for Berkely DB utils, created from upstream .\" documentation by Thijs Kinkhorst . .TH DB_HOTBACKUP 1 "28 January 2005" .SH NAME db_hotbackup \- Create "hot backup" or "hot failover" snapshots .SH SYNOPSIS .B db_hotbackup [-cuVv] [-d data_dir ...] [-h home] [-l log_dir] [-P password] -b backup_dir .SH DESCRIPTION The db_hotbackup utility creates "hot backup" or "hot failover" snapshots of Berkeley DB database environments. .PP The db_hotbackup utility performs the following steps: .RS .IP 1. If the \-c option is specified, checkpoint the source home database environment, and remove any unnecessary log files. .IP 2. If the target directory for the backup does not exist, it is created with mode read-write-execute for the owner. .sp If the target directory for the backup does exist and the \-u option was specified, all log files in the target directory are removed; if the \-u option was not specified, all files in the target directory are removed. .IP 3. If the \-u option was not specified, copy application-specific files found in the database environment home directory, or any directory specified using the -d option, into the target directory for the backup. .IP 4. Copy all log files found in the directory specified by the \-l option (or in the database environment home directory, if no \-l option was specified), into the target directory for the backup. .IP 5. Perform catastrophic recovery on the hot backup. .IP 6. Remove any unnecessary log files from the hot backup. .RE .PP The db_hotbackup utility does not resolve pending transactions that are in the prepared state. Applications that use DB_TXN->prepare should specify DB_RECOVER_FATAL when opening the environment, and run DB_ENV->txn_recover to resolve any pending transactions, when failing over to the hot backup. .SH OPTIONS .IP \fB\-b\fR Specify the target directory for the backup. .IP \fB\-c\fR Before performing the snapshot, checkpoint the source database environment and remove any log files that are no longer required in that environment. \fBTo avoid making catastrophic failure impossible, log file removal must be integrated with log file archival.\fR .IP \fB\-d\fR Specify one or more source directories that contain databases; if none is specified, the database environment home directory will be searched for database files. As database files are copied into a single backup directory, files named the same, stored in different source directories, could overwrite each other when copied into the backup directory. .IP \fB\-h\fR Specify the source directory for the backup, that is, the database environment home directory. .IP \fB\-l\fR Specify a source directory that contains log files; if none is specified, the database environment home directory will be searched for log files. .IP \fB\-P\fR Specify an environment password. Although Berkeley DB utilities overwrite password strings as soon as possible, be aware there may be a window of vulnerability on systems where unprivileged users can see command-line arguments or where utilities are not able to overwrite the memory containing the command-line arguments. .IP \fB\-u\fR Update a pre-existing hot backup snapshot by copying in new log files. If the \fB\-u\fR option is specified, no databases will be copied into the target directory. .IP \fB\-V\fR Write the library version number to the standard output, and exit. .IP \fB\-v\fR Run in verbose mode, listing operations as they are done. .PP The db_hotbackup utility uses a Berkeley DB environment (as described for the \fB\-h\fR option, the environment variable \fBDB_HOME\fR, or because the utility was run in a directory containing a Berkeley DB environment). In order to avoid environment corruption when using a Berkeley DB environment, db_hotbackup should always be given the chance to detach from the environment and exit gracefully. To cause db_hotbackup to release all environment resources and exit cleanly, send it an interrupt signal (SIGINT). .PP The db_hotbackup utility exits 0 on success, and >0 if an error occurs. .SH ENVIRONMENT .IP \fBDB_HOME\fR If the \fB-h\fR option is not specified and the environment variable DB_HOME is set, it is used as the path of the database home, as described in DB_ENV->open. .SH AUTHORS Sleepycat Software, Inc. This manual page was created based on the HTML documentation for db_hotbackup from Sleepycat, by Thijs Kinkhorst , for the Debian system (but may be used by others). man/db_load.1000064400000000000000000000200761177742570500133210ustar00rootroot00000000000000.\" Manual Page for Berkely DB utils, created from upstream .\" documentation by Thijs Kinkhorst . .TH DB_LOAD 1 "28 January 2005" .SH NAME db_load \- Load data from standard in .SH SYNOPSIS .B db_load [-nTV] [-c name=value] [-f file] [-h home] [-P password] [-t btree | hash | queue | recno] file .B db_load [-r lsn | fileid] [-h home] [-P password] file .SH DESCRIPTION The db_load utility reads from the standard input and loads it into the database file. The database file is created if it does not already exist. .PP The input to db_load must be in the output format specified by the db_dump utility, utilities, or as specified for the -T below. .SH OPTIONS .IP \fB\-c\fR Specify configuration options ignoring any value they may have based on the input. The command-line format is \fBname=value\fR. See the Supported Keywords section below for a list of keywords supported by the \fB-c\fR option. .IP \fB\-f\fR Read from the specified \fBinput\fR file instead of from the standard input. .IP \fB\-h\fR Specify a home directory for the database environment. .sp If a home directory is specified, the database environment is opened using the DB_INIT_LOCK, DB_INIT_LOG, DB_INIT_MPOOL, DB_INIT_TXN, and DB_USE_ENVIRON flags to DB_ENV->open. (This means that db_load can be used to load data into databases while they are in use by other processes.) If the DB_ENV->open call fails, or if no home directory is specified, the database is still updated, but the environment is ignored; for example, no locking is done. .IP \fB\-n\fR Do not overwrite existing keys in the database when loading into an already existing database. If a key/data pair cannot be loaded into the database for this reason, a warning message is displayed on the standard error output, and the key/data pair are skipped. .IP \fB\-P\fR Specify an environment password. Although Berkeley DB utilities overwrite password strings as soon as possible, be aware there may be a window of vulnerability on systems where unprivileged users can see command-line arguments or where utilities are not able to overwrite the memory containing the command-line arguments. .IP \fB\-r\fR Reset the database's file ID or log sequence numbers (LSNs). .sp All database pages in transactional environments contain references to the environment's log records. In order to copy a database into a different database environment, database page references to the old environment's log records must be reset, otherwise data corruption can occur when the database is modified in the new environment. The \fB-r\fR \fBlsn\fR option resets a database's log sequence numbers. .sp All databases contain an ID string used to identify the database in the database environment cache. If a database is copied, and used in the same environment as another file with the same ID string, corruption can occur. The \fB-r\fR \fBfileid\fR option resets a database's file ID to a new value. .sp \fBIn both cases, the physical file specified by the file argument is modified in-place.\fR .IP \fB\-T\fR The \fB-T\fR option allows non-Berkeley DB applications to easily load text files into databases. .sp If the database to be created is of type Btree or Hash, or the keyword \fBkeys\fR is specified as set, the input must be paired lines of text, where the first line of the pair is the key item, and the second line of the pair is its corresponding data item. If the database to be created is of type Queue or Recno and the keywork \fBkeys\fR is not set, the input must be lines of text, where each line is a new data item for the database. .sp A simple escape mechanism, where newline and backslash (\) characters are special, is applied to the text input. Newline characters are interpreted as record separators. Backslash characters in the text will be interpreted in one of two ways: If the backslash character precedes another backslash character, the pair will be interpreted as a literal backslash. If the backslash character precedes any other character, the two characters following the backslash will be interpreted as a hexadecimal specification of a single character; for example, \0a is a newline character in the ASCII character set. .sp For this reason, any backslash or newline characters that naturally occur in the text input must be escaped to avoid misinterpretation by db_load. .sp If the \fB-T\fR option is specified, the underlying access method type must be specified using the \fB-t\fR option. .IP \fB\-t\fR Specify the underlying access method. If no \fB-t\fR option is specified, the database will be loaded into a database of the same type as was dumped; for example, a Hash database will be created if a Hash database was dumped. .sp Btree and Hash databases may be converted from one to the other. Queue and Recno databases may be converted from one to the other. If the \fB-k\fR option was specified on the call to db_dump then Queue and Recno databases may be converted to Btree or Hash, with the key being the integer record number. .IP \fB\-V\fR Write the library version number to the standard output, and exit. .PP The db_load utility may be used with a Berkeley DB environment (as described for the \fB-h\fR option, the environment variable \fBDB_HOME\fR, or because the utility was run in a directory containing a Berkeley DB environment). In order to avoid environment corruption when using a Berkeley DB environment, db_load should always be given the chance to detach from the environment and exit gracefully. To cause db_load to release all environment resources and exit cleanly, send it an interrupt signal (SIGINT). .PP The db_load utility exits 0 on success, 1 if one or more key/data pairs were not loaded into the database because the key already existed, and >1 if an error occurs. .SH EXAMPLES The db_load utility can be used to load text files into databases. For example, the following command loads the standard UNIX \fI/etc/passwd\fR file into a database, with the login name as the key item and the entire password entry as the data item: .PP .TR 8 awk \-F: '{print $1; print $0}' < /etc/passwd | sed 's/\\/\\\\/g' | db_load \-T \-t hash passwd.db .PP Note that backslash characters naturally occurring in the text are escaped to avoid interpretation as escape characters by db_load. .SH ENVIRONMENT .IP \fBDB_HOME\fR If the \fB-h\fR option is not specified and the environment variable DB_HOME is set, it is used as the path of the database home, as described in DB_ENV->open. .SH SUPPORTED KEYWORDS The following keywords are supported for the \fB-c\fR command-line ption to the db_load utility. See DB->open for further discussion of these keywords and what values should be specified. .PP The parenthetical listing specifies how the value part of the \fBname=value\fR pair is interpreted. Items listed as (boolean) expect value to be \fB1\fR (set) or \fB0\fR (unset). Items listed as (number) convert value to a number. Items listed as (string) use the string value without modification. .IP bt_minkey (number) The minimum number of keys per page. .IP chksum (boolean) Enable page checksums. .IP database (string) The database to load. .IP db_lorder (number) The byte order for integers in the stored database metadata. .IP db_pagesize (number) The size of database pages, in bytes. .IP duplicates (boolean) The value of the DB_DUP flag. .IP dupsort (boolean) The value of the DB_DUPSORT flag. .IP extentsize (number) The size of database extents, in pages, for Queue databases configured to use extents. .IP h_ffactor (number) The density within the Hash database. .IP h_nelem (number) The size of the Hash database. .IP keys (boolean) Specify whether keys are present for Queue or Recno databases. .IP re_len (number) Specify fixed-length records of the specified length. .IP re_pad (string) Specify the fixed-length record pad character. .IP recnum (boolean) The value of the DB_RECNUM flag. .IP renumber (boolean) The value of the DB_RENUMBER flag. .IP subdatabase (string) The subdatabase to load. .SH AUTHORS Sleepycat Software, Inc. This manual page was created based on the HTML documentation for db_load from Sleepycat, by Thijs Kinkhorst , for the Debian system (but may be used by others). man/db_printlog.1000064400000000000000000000053351177742570500142410ustar00rootroot00000000000000.\" Manual Page for Berkely DB utils, created from upstream .\" documentation by Thijs Kinkhorst . .TH DB_PRINTLOG 1 "28 January 2005" .SH NAME db_printlog \- Dumps Berkeley DB log files in a human-readable format .SH SYNOPSIS .B db_printlog [-NrV] [-b start-LSN] [-e stop-LSN] [-h home] [-P password] .SH DESCRIPTION The db_printlog utility is a debugging utility that dumps Berkeley DB log files in a human-readable format. .SH OPTIONS .IP \fB\-b\fR Display log records starting at log sequence number (LSN) \fBstart-LSN\fR; \fBstart-LSN\fR is specified as a file number, followed by a slash (/) character, followed by an offset number, with no intervening whitespace. .IP \fB\-e\fR Stop displaying log records at log sequence number (LSN) \fBstop-LSN\fR; \fBstop-LSN\fR is specified as a file number, followed by a slash (/) character, followed by an offset number, with no intervening whitespace. .IP \fB\-h\fR Specify a home directory for the database environment; by default, the current working directory is used. .IP \fB\-N\fR Do not acquire shared region mutexes while running. Other problems, such as potentially fatal errors in Berkeley DB, will be ignored as well. This option is intended only for debugging errors, and should not be used under any other circumstances. .IP \fB\-P\fR Specify an environment password. Although Berkeley DB utilities overwrite password strings as soon as possible, be aware there may be a window of vulnerability on systems where unprivileged users can see command-line arguments or where utilities are not able to overwrite the memory containing the command-line arguments. .IP \fB\-r\fR Read the log files in reverse order. .IP \fB\-V\fR Write the library version number to the standard output, and exit. .PP The db_printlog utility uses a Berkeley DB environment (as described for the \fB-h\fR option, the environment variable \fBDB_HOME\fR, or because the utility was run in a directory containing a Berkeley DB environment). In order to avoid environment corruption when using a Berkeley DB environment, db_printlog should always be given the chance to detach from the environment and exit gracefully. To cause db_printlog to release all environment resources and exit cleanly, send it an interrupt signal (SIGINT). .PP The db_printlog utility exits 0 on success, and >0 if an error occurs. .SH ENVIRONMENT .IP \fBDB_HOME\fR If the \fB-h\fR option is not specified and the environment variable DB_HOME is set, it is used as the path of the database home, as described in DB_ENV->open. .SH AUTHORS Sleepycat Software, Inc. This manual page was created based on the HTML documentation for db_printlog from Sleepycat, by Thijs Kinkhorst , for the Debian system (but may be used by others). man/db_recover.1000064400000000000000000000075661177742570500140600ustar00rootroot00000000000000.\" Manual Page for Berkely DB utils, created from upstream .\" documentation by Thijs Kinkhorst . .TH DB_RECOVER 1 "28 January 2005" .SH NAME db_recover \- Restore the database to a consistent state .SH SYNOPSIS .B db_recover [-ceVv] [-h home] [-P password] [-t [[CC]YY]MMDDhhmm[.SS]]] .SH DESCRIPTION The db_recover utility must be run after an unexpected application, Berkeley DB, or system failure to restore the database to a consistent state. All committed transactions are guaranteed to appear after db_recover has run, and all uncommitted transactions will be completely undone. .SH OPTIONS .IP \fB\-c\fR Perform catastrophic recovery instead of normal recovery. .IP \fB\-e\fR Retain the environment after running recovery. This option will rarely be used unless a DB_CONFIG file is present in the home directory. If a DB_CONFIG file is not present, then the regions will be created with default parameter values. .IP \fB\-h\fR Specify a home directory for the database environment; by default, the current working directory is used. .IP \fB\-P\fR Specify an environment password. Although Berkeley DB utilities overwrite password strings as soon as possible, be aware there may be a window of vulnerability on systems where unprivileged users can see command-line arguments or where utilities are not able to overwrite the memory containing the command-line arguments. .IP \fB\-t\fR Recover to the time specified rather than to the most current possible date. The timestamp argument should be in the form [[CC]YY]MMDDhhmm[.SS] where each pair of letters represents the following: .RS .IP CC The first two digits of the year (the century). .IP YY The second two digits of the year. If "YY" is specified, but "CC" is not, a value for "YY" between 69 and 99 results in a "CC" value of 19. Otherwise, a "YY" value of 20 is used. .IP MM The month of the year, from 1 to 12. .IP DD The day of the month, from 1 to 31. .IP hh The hour of the day, from 0 to 23. .IP mm The minute of the hour, from 0 to 59. .IP SS The second of the minute, from 0 to 61. .RE .IP If the "CC" and "YY" letter pairs are not specified, the values default to the current year. If the "SS" letter pair is not specified, the value defaults to 0. .IP \fB\-V\fR Write the library version number to the standard output, and exit. .IP \fB\-v\fR Run in verbose mode. .PP In the case of catastrophic recovery, an archival copy - or \fIsnapshot\fR - of all database files must be restored along with all of the log files written since the database file snapshot was made. (If disk space is a problem, log files may be referenced by symbolic links). .PP If the failure was not catastrophic, the files present on the system at the time of failure are sufficient to perform recovery. .PP If log files are missing, db_recover will identify the missing log file(s) and fail, in which case the missing log files need to be restored and recovery performed again. .PP The db_recover utility uses a Berkeley DB environment (as described for the \fB-h\fR option, the environment variable \fBDB_HOME\fR, or because the utility was run in a directory containing a Berkeley DB environment). In order to avoid environment corruption when using a Berkeley DB environment, db_recover should always be given the chance to detach from the environment and exit gracefully. To cause db_recover to release all environment resources and exit cleanly, send it an interrupt signal (SIGINT). .PP The db_recover utility exits 0 on success, and >0 if an error occurs. .SH ENVIRONMENT .IP \fBDB_HOME\fR If the \fB-h\fR option is not specified and the environment variable DB_HOME is set, it is used as the path of the database home, as described in DB_ENV->open. .SH AUTHORS Sleepycat Software, Inc. This manual page was created based on the HTML documentation for db_recover from Sleepycat, by Thijs Kinkhorst , for the Debian system (but may be used by others). man/db_stat.1000064400000000000000000000115711177742570500133550ustar00rootroot00000000000000.\" Manual Page for Berkely DB utils, created from upstream .\" documentation by Thijs Kinkhorst . .TH DB_STAT 1 "28 January 2005" .SH NAME db_stat \- Display statistics for Berkeley DB environments .SH SYNOPSIS .B db_stat -d file [-fN] [-h home] [-P password] [-s database] .B db_stat [-cEelmNrtVZ] [-C Aclop] [-h home] [-L A] [-M A] [-R A] [-P password] .SH DESCRIPTION The db_stat utility displays statistics for Berkeley DB environments. .SH OPTIONS .IP \fB\-C\fR Display internal information about the locking subsystem. (The output from this option is often both voluminous and meaningless, and is intended only for debugging.) .RS .IP A Display all information. .IP c Display lock conflict matrix. .IP l Display lockers within hash chains. .IP o Display lock objects within hash chains. .IP p Display locking subsystem parameters. .RE .IP \fB\-c\fR Display locking subsystem statistics, as described in DB_ENV->lock_stat. .IP \fB\-d\fR Display database statistics for the specified file, as described in DB->stat. .sp If the database contains multiple databases and the \fB-s\fR flag is not specified, the statistics are for the internal database that describes the other databases the file contains, and not for the file as a whole. .IP \fB\-E\fR Display internal information about the database environment, including all configured subsystems of the database environment. (The output from this option is often both voluminous and meaningless, and is intended only for debugging.) .IP \fB\-e\fR Display information about the database environment, including all configured subsystems of the database environment. .IP \fB\-f\fR Display only those database statistics that can be acquired without traversing the database. .IP \fB\-h\fR Specify a home directory for the database environment; by default, the current working directory is used. .IP \fB\-l\fR Display logging subsystem statistics, as described in DB_ENV->log_stat. .IP \fB\-M\fR Display internal information about the cache. (The output from this option is often both voluminous and meaningless, and is intended only for debugging.) .RS .IP A Display all information. .IP h Display buffers within hash chains. .RE .IP \fB\-m\fR Display cache statistics, as described in DB_ENV->memp_stat. .IP \fB\-N\fR Do not acquire shared region mutexes while running. Other problems, such as potentially fatal errors in Berkeley DB, will be ignored as well. This option is intended only for debugging errors, and should not be used under any other circumstances. .IP \fB\-P\fR Specify an environment password. Although Berkeley DB utilities overwrite password strings as soon as possible, be aware there may be a window of vulnerability on systems where unprivileged users can see command-line arguments or where utilities are not able to overwrite the memory containing the command-line arguments. .IP \fB\-R\fR Display internal information about the replication subsystem. (The output from this option is often both voluminous and meaningless, and is intended only for debugging.) .RS .IP A Display all information. .RE .IP \fB\-r\fR Display replication statistics, as described in DB_ENV->rep_stat. .IP \fB\-s\fR Display statistics for the specified database contained in the file specified with the \fB-d\fR flag. .IP \fB\-t\fR Display transaction subsystem statistics, as described in DB_ENV->txn_stat. .IP \fB\-V\fR Write the library version number to the standard output, and exit. .IP \fB\-Z\fR Reset the statistics after reporting them; valid only with the \fB-C\fR, \fB-c\fR, \fB-E\fR, \fB-e\fR, \fB-L\fR, \fB-l\fR, \fB-M\fR, \fB-m\fR, \fB-R\fR, \fB-r\fR, and \fB-t\fR options. .PP Values normally displayed in quantities of bytes are displayed as a combination of gigabytes (GB), megabytes (MB), kilobytes (KB), and bytes (B). Otherwise, values smaller than 10 million are displayed without any special notation, and values larger than 10 million are displayed as a number followed by "M". .PP The db_stat utility may be used with a Berkeley DB environment (as described for the \fB-h\fR option, the environment variable \fBDB_HOME\fR, or because the utility was run in a directory containing a Berkeley DB environment). In order to avoid environment corruption when using a Berkeley DB environment, db_stat should always be given the chance to detach from the environment and exit gracefully. To cause db_stat to release all environment resources and exit cleanly, send it an interrupt signal (SIGINT). .PP The db_stat utility exits 0 on success, and >0 if an error occurs. .SH ENVIRONMENT .IP \fBDB_HOME\fR If the \fB-h\fR option is not specified and the environment variable DB_HOME is set, it is used as the path of the database home, as described in DB_ENV->open. .SH AUTHORS Sleepycat Software, Inc. This manual page was created based on the HTML documentation for db_stat from Sleepycat, by Thijs Kinkhorst , for the Debian system (but may be used by others). man/db_upgrade.1000064400000000000000000000076611177742570500140360ustar00rootroot00000000000000.\" Manual Page for Berkely DB utils, created from upstream .\" documentation by Thijs Kinkhorst . .TH DB_UPGRADE 1 "28 January 2005" .SH NAME db_upgrade \- Upgrade the Berkeley DB version to the current release version. .SH SYNOPSIS .B db_upgrade [-NsVv] [-h home] [-P password] file ... .SH DESCRIPTION The db_upgrade utility upgrades the Berkeley DB version of one or more files and the databases they contain to the current release version. .SH OPTIONS .IP \fB\-h\fR Specify a home directory for the database environment; by default, the current working directory is used. .IP \fB\-N\fR Do not acquire shared region mutexes while running. Other problems, such as potentially fatal errors in Berkeley DB, will be ignored as well. This option is intended only for debugging errors, and should not be used under any other circumstances. .IP \fB\-P\fR Specify an environment password. Although Berkeley DB utilities overwrite password strings as soon as possible, be aware there may be a window of vulnerability on systems where unprivileged users can see command-line arguments or where utilities are not able to overwrite the memory containing the command-line arguments. .IP \fB\-s\fR This flag is only meaningful when upgrading databases from releases before the Berkeley DB 3.1 release. .sp As part of the upgrade from the Berkeley DB 3.0 release to the 3.1 release, the on-disk format of duplicate data items changed. To correctly upgrade the format requires that applications specify whether duplicate data items in the database are sorted or not. Specifying the \fB-s\fR flag means that the duplicates are sorted; otherwise, they are assumed to be unsorted. Incorrectly specifying the value of this flag may lead to database corruption. .sp Because the db_upgrade utility upgrades a physical file (including all the databases it contains), it is not possible to use db_upgrade to upgrade files where some of the databases it includes have sorted duplicate data items, and some of the databases it includes have unsorted duplicate data items. If the file does not have more than a single database, if the databases do not support duplicate data items, or if all the databases that support duplicate data items support the same style of duplicates (either sorted or unsorted), db_upgrade will work correctly as long as the \fB-s\fR flag is correctly specified. Otherwise, the file cannot be upgraded using db_upgrade, and must be upgraded manually using the db_dump and db_load utilities. .IP \fB\-V\fR Write the library version number to the standard output, and exit. .IP \fB\-v\fR Run in verbose mode, displaying a message for each successful upgrade. .PP \fBIt is important to realize that Berkeley DB database upgrades are done in place, and so are potentially destructive.\fR This means that if the system crashes during the upgrade procedure, or if the upgrade procedure runs out of disk space, the databases may be left in an inconsistent and unrecoverable state. .PP The db_upgrade utility may be used with a Berkeley DB environment (as described for the \fB-h\fR option, the environment variable \fBDB_HOME\fR, or because the utility was run in a directory containing a Berkeley DB environment). In order to avoid environment corruption when using a Berkeley DB environment, db_upgrade should always be given the chance to detach from the environment and exit gracefully. To cause db_upgrade to release all environment resources and exit cleanly, send it an interrupt signal (SIGINT). .PP The db_upgrade utility exits 0 on success, and >0 if an error occurs. .SH ENVIRONMENT .IP \fBDB_HOME\fR If the \fB-h\fR option is not specified and the environment variable DB_HOME is set, it is used as the path of the database home, as described in DB_ENV->open. .SH AUTHORS Sleepycat Software, Inc. This manual page was created based on the HTML documentation for db_upgrade from Sleepycat, by Thijs Kinkhorst , for the Debian system (but may be used by others). man/db_verify.1000064400000000000000000000060331177742570500137030ustar00rootroot00000000000000.\" Manual Page for Berkely DB utils, created from upstream .\" documentation by Thijs Kinkhorst . .TH DB_VERIFY 1 "28 January 2005" .SH NAME db_verify \- Verifies the structure databases .SH SYNOPSIS .B db_verify [-NoqV] [-h home] [-P password] file ... .SH DESCRIPTION The db_verify utility verifies the structure of one or more files and the databases they contain. .SH OPTIONS .IP \fB\-h\fR Specify a home directory for the database environment; by default, the current working directory is used. .IP \fB\-o\fR Skip the database checks for btree and duplicate sort order and for hashing. .sp If the file being verified contains databases with non-default comparison or hashing configurations, calling the db_verify utility without the \fB-o\fR flag will usually return failure. The \fB-o\fR flag causes db_verify to ignore database sort or hash ordering and allows db_verify to be used on these files. To fully verify these files, verify them explicitly using the DB->verify method, after configuring the correct comparison or hashing functions. .IP \fB\-N\fR Do not acquire shared region mutexes while running. Other problems, such as potentially fatal errors in Berkeley DB, will be ignored as well. This option is intended only for debugging errors, and should not be used under any other circumstances. .IP \fB\-P\fR Specify an environment password. Although Berkeley DB utilities overwrite password strings as soon as possible, be aware there may be a window of vulnerability on systems where unprivileged users can see command-line arguments or where utilities are not able to overwrite the memory containing the command-line arguments. .IP \fB\-q\fR Suppress the printing of any error descriptions, simply exit success or failure. .IP \fB\-V\fR Write the library version number to the standard output, and exit. .PP \fBThe db_verify utility does not perform any locking, even in Berkeley DB environments that are configured with a locking subsystem. As such, it should only be used on files that are not being modified by another thread of control.\fR .PP The db_verify utility may be used with a Berkeley DB environment (as described for the \fB-h\fR option, the environment variable \fBDB_HOME\fR, or because the utility was run in a directory containing a Berkeley DB environment). In order to avoid environment corruption when using a Berkeley DB environment, db_verify should always be given the chance to detach from the environment and exit gracefully. To cause db_verify to release all environment resources and exit cleanly, send it an interrupt signal (SIGINT). .PP The db_verify utility exits 0 on success, and >0 if an error occurs. .SH ENVIRONMENT .IP \fBDB_HOME\fR If the \fB-h\fR option is not specified and the environment variable DB_HOME is set, it is used as the path of the database home, as described in DB_ENV->open. .SH AUTHORS Sleepycat Software, Inc. This manual page was created based on the HTML documentation for db_verify from Sleepycat, by Thijs Kinkhorst , for the Debian system (but may be used by others).