Added comments for config file settings/values (long overdue)

2025-01-23 19:23:03 +01:00 · 2003-03-15 20:48:15 +00:00 · 2003-03-15 20:48:15 +00:00 · 7208e09351
commit 7208e09351
parent d42f7a366d
1 changed files with 373 additions and 88 deletions
--- a/src/install/misc/firebird.conf
+++ b/src/install/misc/firebird.conf
@ -1,115 +1,400 @@
-##############################
+#######################################
 #
 # Firebird configuration file
 #
-##############################
+# Comments
+# --------
+# The # character is used for comments and can be placed anywhere on a
+# line.  Anything following the # character on a line is considered a
+# comment.
+#
+# Examples:
+#
+#    # This is a comment
+#    DefaultDbCachePages = 2048   # This is an end-of-line comment
+#
+#
+# Entries
+# -------
+# The default value for each entry is listed to the right of the "=".
+# To activate an entry, remove the leading "#"s and supply the desired
+# value.
+#
+# Please note, a number of the values are specified in **Bytes** (Not KB).
+# Accordingly, we have provided some simple conversion tables at the bottom
+# of this file.
+#
+#
+# Portions of this file have been reproduced/made available with the
+# permission of Ann Harrison @ IBPhoenix.
+#
+#######################################

+# ==================================
+# Settings for all platforms/engines
+# ==================================
+#
 # ----------------------------
-# Specify the root directory under which Firebird is installed
-
+# Specify the root directory under which Firebird is installed ?????
+#
 #RootDirectory =

-# ----------------------------
-# Parameters of the in-memory sorting module
-
-#SortMemBlockSize = 1048576
-#SortMemUpperLimit = 67108864

 # ----------------------------
-# Turn on/off special handling for opening nfs data files
+# External Table Paths/Directories
 #
-# The following option works if a database file exists on a NFS mounted
-# partition.  
-# The original behavour in InterBase(r) was to try and connect to a firebird 
-# db server on the remote machine via port 3050, this ensures that all opens 
-# of a file occur on the same machine and locking etc can be handled 
-# appropriately.
-# However this often causes frustration since often you end up in a position 
-# where you really do want db files to be opened by the local process even 
-# though it resides on a nfs share.  So the next option allows us to turn
-# this 'feature' off.
+# DirectoryList (';' separated), where files for external tables are
+# stored. Relative paths are treated relative to RootDirectory entry
+# (see above).
+#
+# NOTE: THE EXTERNAL TABLE ENGINE FEATURE COULD BE USED TO COMPROMISE
+# THE SERVER/HOST AS WELL AS DATABASE SECURITY!!
+#
+# IT IS STRONGLY RECOMMENDED THAT THIS SETTING BE USED TO LIMIT
+# EXTERNAL TABLE LOCATIONS!
+#
+#ExternalTablesDirs = 

-#RemoteFileOpenAbility = 0

 # ----------------------------
-# Does the guardian restart the server every time it crashes?
-
-#GuardianOption = 1
-
-# ----------------------------
-# Which CPUs should be used
-
-#CpuAffinityMask = 1
-
-# ----------------------------
-# Backward-compatible parameter ordering as it was in IB/FB1
-
-#OldParameterOrdering = 0
-
-# ----------------------------
-# Various remote stuff parameters
-
-#TcpRemoteBufferSize = 8192
-#TcpNoNagle = 0
-#IpcMapSize= 4096
-#ConnectionTimeout = 180
-#DummyPacketInterval = 60
-
-# ----------------------------
-# Default number of cached database pages
-
+# Number of cached database pages
+#
+# This sets the number of pages from any one database that can be held
+# in cache at once. If you increase this value, the engine will
+# allocate more pages to the cache for every database. By default, the
+# SuperServer allocates 2048 pages for each database and the classic
+# allocates 75 pages per client connection per database.
+#
 #DefaultDbCachePages = 2048

-# ----------------------------
-# Locking and shared memory parameters
-
-#LockMemSize = 262144
-#LockSemCount = 32
-#LockSignal = 16
-#LockGrantOrder = 1
-#LockHashSlots = 101
-#LockRequireSpins = 0
-#EventMemSize = 65536
-#DeadlockTimeout = 10

 # ----------------------------
-# Parameters of the thread scheduler (SS only)
+# In-memory sorting module
+#
+# For Classic servers, these settings are defaulted to 0 (disabled)
+# although they can be set, the values would apply to each client
+# connection/server instance and thus consume a lot of memory.
+#
+# The amount of memory allocated for each sort block.
+#
+#SortMemBlockSize = 1048576
+
+#
+# The maximum amount of memory to be allocated by the in-memory
+# sorting module.
+#
+#SortMemUpperLimit = 67108864

-#PrioritySwitchDelay = 100
-#DeadThreadsCollection = 50
-#PriorityBoost = 5

 # ----------------------------
-# Transport protocols object names
+# Backward-compatible parameter ordering as it was in FB v1/IB
+#
+#OldParameterOrdering = 0

-#RemoteBindAddress =
-#RemoteServiceName = gds_db
-#RemoteServicePort = 3050
-#RemoteAuxPort = 0
-#RemotePipeName = interbas
-#IpcName = FirebirdIPI
-
-# ----------------------------
-# How often the pages are flushed on disk (FW=off only)
-
-#MaxUnflushedWrites = 100
-#MaxUnflushedWriteTime = 5
-
-# ----------------------------
-# Various win32 options
-
-#ProcessPriorityLevel = 0
-#CreateInternalWindow = 1

 # ----------------------------
 # Boolean evaluation method (complete or shortcut)
-
+#
+# If your SQL code depends on side-effects of full evaluation of OR
+# and AND statements (right-hand-side terms), even if the expressions
+# final result could be determined by just examining the value of the
+# first term, you might need to turn this on.
+#
 #CompleteBooleanEvaluation = 0

-# ----------------------------
-# DirectoryList (';' - separated), where files for 
-# external tables may be stored. Relative paths 
-# are treated relative to $RootDirectory.
-# Use '/' to open all your files - but THIS IS UNSAFE!

-#ExternalTablesDirs = External
+# ----------------------------
+#
+# Determines the number of seconds that the lock manager will wait after a
+# conflict has been encountered before deciding that there is a potential
+# deadlock.
+#
+#DeadlockTimeout = 10
+
+
+# ----------------------------
+#
+# Bytes of shared memory allocated for event manager.
+# In classic, this space is created for each connection. In SuperServer,
+# there is one space shared by all clients
+#
+#EventMemSize = 65536
+
+
+# ----------------------------
+#
+# How often the pages are flushed on disk
+# (for databases with ForcedWrites=Off only)
+#
+# Number of unflushed writes which will accumulate before they are
+# flushed, at the next transaction commit.  For non-Win32 ports,
+# the default value is -1 (Disabled)
+#
+#MaxUnflushedWrites = 100
+
+#
+# Number of seconds during which unflushed writes will accumulate
+# before they are flushed, at the next transaction commit. For non-Win32
+# ports, the default value is -1 (Disabled)
+#
+#MaxUnflushedWriteTime = 5
+
+
+# ----------------------------
+# Client Connection Settings (Basic)
+#
+# Seconds to wait before concluding an attempt to connect has failed.
+#
+#ConnectionTimeout = 180
+
+#
+# Seconds to wait on a silent client connection before the server sends
+# dummy packets to request acknowledgment.
+#
+#DummyPacketInterval = 60
+
+
+# ----------------------------
+# TCP Protocol Settings
+#
+# The TCP Service name/Port number to be used for client database
+# connections.
+#
+#RemoteServiceName = gds_db
+#RemoteServicePort = 3050
+
+#
+# The TCP Port Number to be used for server Event Notification
+# messages.  The value of 0 (Zero) means that the server will choose
+# a port number randomly.
+#
+#RemoteAuxPort = 0
+
+
+#
+# TCP/IP buffer size for send and receive buffers of both the client
+# and server. The engine reads ahead of the client and can send 
+# several rows of data in a single packet. The larger the packet size,
+# the more data is sent per transfer. Range is 1448 to 32768.
+#
+#TcpRemoteBufferSize = 8192
+
+#
+# ?????
+#
+#TcpNoNagle = 0
+
+#
+# ??????
+#
+#RemoteBindAddress = 
+
+# ----------------------------
+# Locking and shared memory parameters
+#
+# Bytes of shared memory allocated for lock manager. 
+# In Classic mode, the size given is used for the initial allocation. The
+# table expands dynamically up to the limit of memory. In SuperServer, the
+# initial size is also the final size.
+# Default is 96K on Linux and Solaris, 256K on Windows.
+#
+#LockMemSize = 262144
+
+#
+# Number of semaphores for interprocess communication.
+# In non-threading environments, this sets the number of semaphores
+# available
+#
+#LockSemCount = 32
+
+#
+# When a connection wants to lock an object, it gets a lock request 
+# block which specifies the object and the lock level requested. Eack
+# locked object has a lock block. Request blocks are connected to those
+# lock blocks either as requests that have been granted, or as pending
+# requests. 
+#
+# The settings:
+# 	1 means locks are granted first come, first served.
+#	0 means emulate InterBase v3.3 behavior, where locks are granted 
+#	  as soon as they are available; can result in lock request
+#       starvation.
+#
+#LockGrantOrder = 1
+
+#
+# In Classic, only one client process may access the lock table at any
+# time. Access to the lock table is governed by a mutex. The mutex can
+# be requested conditionally -a wait is a failure and the request must
+# be retried - or unconditionally - the request will wait until it is
+# satisfied. This parameter establishes the number of attempts that
+# will be made conditionally. Relevant only on SMP machines.
+#
+#LockRequireSpins = 0
+
+#
+# Tune lock hash list; more hash slots mean shorter hash chains. Only
+# necessary under very high load. Prime number values are recommended.
+#
+#LockHashSlots = 101
+
+
+# ===========================
+# SuperServer Engine Settings
+# ===========================
+#
+# ----------------------------
+# Which CPUs should be used (Windows Only)
+#
+# In an SMP system, sets which processors can be used by the server.  
+# The value is taken from a bit map in which each bit represents a CPU.
+# Thus, to use only the first processor, the value is 1. To use both
+# CPU 1 and CPU 2, the value is 3. To use CPU 2 and CPU 3, the value
+# is 6. The default value is 1.
+#
+#CpuAffinityMask = 1
+
+
+# ----------------------------
+# Parameters of the thread scheduler (Windows Only)
+#
+# The wait time, in milli-seconds (ms), before the priority of:
+#	- an inactive thread is reduced to 'Low', or 
+#	- an active thread is increased to 'High'
+#
+# Note: The default value was chosen based on experiments on Intel 
+# PIII/P4 processors.  It should be increased for using in the computer
+# with lower speed processors.
+#
+#PrioritySwitchDelay = 100
+
+#
+# Number of cycles of the scheduler (PrioritySwitchDelay ms) before
+# thread are destroyed/closed.  Rather than immediately destroy/closed
+# worker threads (which would require a semaphore and blocking call --
+# significant overhead), the thread scheduler maintains a pool of the
+# threads.  When a thread has completed it's task/work, it is marked as
+# idle.  The idle thread is destroyed/closed after X iterations of the
+# scheduler loop.
+#
+# For a server with a very large number of connections (presumably more
+# than several hundred) the setting value should be increased. 
+#
+# The setting represents the number of loop iterations to be made before
+# the thread is destroyed/closed.
+#
+#DeadThreadsCollection = 50
+
+#
+# Number of additional 'intervals' given to a 'High' priority thread.
+#
+#PriorityBoost = 5
+
+
+# ==============================
+# Classic Server Engine Settings
+# ==============================
+#
+
+# ==============================
+# Settings for Windows platforms
+# ==============================
+#
+# ----------------------------
+# Does the guardian restart the server every time it crashes?
+#    0 - only start the engine/service once
+#    1 - always restart the engine/service if it terminates
+#
+#GuardianOption = 1
+
+
+#
+# ?????
+#
+#ProcessPriorityLevel = 0
+
+
+# ----------------------------
+# Local Connection Settings
+#
+# Size in bytes of one client's portion of the memory mapped file used
+# for local connections.
+#
+#IpcMapSize= 4096
+
+#
+# The Interface to be used for local connections
+#   IPC = FirebirdIPI (Standard interface)
+#   XNet = FirebirdXPI (New/faster interface)
+#
+#IpcName = FirebirdIPI
+
+#
+# ?????
+#
+#RemotePipeName = interbas
+
+# 
+# Does the server need to create a (hidden) window (used for ????)
+#
+#CreateInternalWindow = 1
+
+
+# ============================
+# Settings for Unix/Linux platforms
+# ============================
+#
+#
+# UNIX signal to use for interprocess communication 
+#
+#LockSignal = 16
+
+
+# ----------------------------
+# Allow opening of data files on NFS volumes
+#
+# Allows for database files which exists on a NFS mounted partition to
+# be opened by the engine.
+#
+# The original behavour was to try and connect to server on the remote
+# machine via port 3050, this ensures that all opens of a file occur on
+# the same machine and locking etc can be handled appropriately. However,
+# this often causes frustration since often you end up in a position 
+# where you really do want db files to be opened by the local process
+# even though it resides on a NFS share.  So this option allows for this
+# 'feature' to be turned off.
+#
+#RemoteFileOpenAbility = 0
+
+
+
+<<<<<<< firebird.conf
+#######################################
+#
+# KB to Bytes Conversion table
+#
+#######################################
+#
+#    KB     Bytes         KB     Bytes
+#   ----    ---------    ----    ---------
+#      1    1024           32    32768
+#      2    2048           64    65536 
+#      4    4096          128    131072
+#      8    8192          256    262144  
+#     16    16384         512    524288
+#
+#######################################
+#
+# MB to Bytes Conversion table
+#
+#######################################
+#
+#    MB    Bytes           MB    Bytes            MB    Bytes
+#   ---    ---------      ---    -----------     ---    -----------
+#     1    1048576         64    67108864        448    469762048
+#     2    2097152        128    134217728       512    536870912
+#     4    4194304        192    201326592       640    671088640
+#     8    8388608        256    268435456       768    805306368
+#    16    16777216       320    335544320       896    939524096
+#    32    33554432       384    402653184      1024    1073741824
+#