| 1 | .\" Copyright (c) 2005-2008 David Carter <dcarter@arm4.org> and others. |
|---|
| 2 | .\" All rights reserved. This program and the accompanying materials |
|---|
| 3 | .\" are made available under the terms of the Eclipse Public License v1.0 |
|---|
| 4 | .\" which accompanies this distribution, and is available at |
|---|
| 5 | .\" http://www.eclipse.org/legal/epl-v10.html |
|---|
| 6 | .TH "arm4.conf" 5 "July 2008" "arm4.org" "ARM 4 File Formats" |
|---|
| 7 | .SH NAME |
|---|
| 8 | arm4.conf \- ARM 4 agent configuration file |
|---|
| 9 | .SH SYNOPSIS |
|---|
| 10 | \fI/etc/arm4.conf\fR |
|---|
| 11 | .SH DESCRIPTION |
|---|
| 12 | The agent has a number of configurable options that are controlled through |
|---|
| 13 | the configuration file. The agent and it's utilities can use either the |
|---|
| 14 | default file at \fI/etc/arm4.conf\fR, or a file passed in as a command |
|---|
| 15 | line argument. |
|---|
| 16 | .P |
|---|
| 17 | While the options are passed to the programs as they start, they generally |
|---|
| 18 | affect persistent global objects shuch as the shared memory regions |
|---|
| 19 | that remain after the program exits. Because of this, many options will |
|---|
| 20 | only be changed when the shared memory objects are recreated. |
|---|
| 21 | .TP |
|---|
| 22 | Options may be set in one of two ways: |
|---|
| 23 | <\fIoption\fR> <\fIvalue\fR> |
|---|
| 24 | .br |
|---|
| 25 | <\fIoption\fR> = <\fIvalue\fR> |
|---|
| 26 | .P |
|---|
| 27 | Blank lines and lines starting with \fI#\fR are considered to be comment lines. |
|---|
| 28 | .P |
|---|
| 29 | The different configuration options are: |
|---|
| 30 | .TP |
|---|
| 31 | .B hostname |
|---|
| 32 | overrides the default hostname. The default value is the same as returned by running the command |
|---|
| 33 | \fBuname -n\fR. |
|---|
| 34 | .TP |
|---|
| 35 | .B user |
|---|
| 36 | the user name or UID for the daemon. The defaults is to run as the current user. |
|---|
| 37 | .TP |
|---|
| 38 | .B group |
|---|
| 39 | the group name or GID for the daemon. The defaults is to run as the current group. |
|---|
| 40 | .TP |
|---|
| 41 | .B umask |
|---|
| 42 | the umask used for the creation of shared objects. |
|---|
| 43 | .TP |
|---|
| 44 | .B instance |
|---|
| 45 | specify the \fIARM 4\fR instance number. Refer to user guide for more information on |
|---|
| 46 | running multiple instances. The default instance is 0. |
|---|
| 47 | .TP |
|---|
| 48 | .B log_filename |
|---|
| 49 | specify a file that will log all error messags from the the \fBarm4_daemon\fR process. |
|---|
| 50 | .TP |
|---|
| 51 | .B schema_location |
|---|
| 52 | specify a location for the schema files. This may be a local directory or a URL. This |
|---|
| 53 | does not include the name of the schema file itself. |
|---|
| 54 | .TP |
|---|
| 55 | .B db |
|---|
| 56 | specify the database to use as the back end. The supported back ends are \fBbdb\fR |
|---|
| 57 | for Berkeley databases, and \fBsqlite\fR for Sqlite3 databases. |
|---|
| 58 | .TP |
|---|
| 59 | .B db_home_dir |
|---|
| 60 | the home directory for the \fIARM 4\fR instance databases. The default is |
|---|
| 61 | \fI/var/lib/arm4/data\fR. |
|---|
| 62 | .TP |
|---|
| 63 | .B db_backup_dir |
|---|
| 64 | the parent directory for the database archives. When a new archive is created, |
|---|
| 65 | a time stamped directory is created as a child of this directory. The default |
|---|
| 66 | is \fI/var/lib/arm4/data/backup\fR. |
|---|
| 67 | .TP |
|---|
| 68 | .SH Berkeley DB Specific Configuration Options |
|---|
| 69 | .TP |
|---|
| 70 | .B db_log_file_size |
|---|
| 71 | sets the transaction file size for the Berkeley DB. This should be large enough that |
|---|
| 72 | no single transaction can span multiple files or memory allocation errors will occur. |
|---|
| 73 | The \fBdb_file_size\fR parameter must always be smaller than the \fBdb_buffer_size\fR. |
|---|
| 74 | Refer to the Berkeley DB documentation for more information. |
|---|
| 75 | .TP |
|---|
| 76 | .B db_buffer_size |
|---|
| 77 | sets the size of memory allocated for transactions. It should be large enough to |
|---|
| 78 | hold all active transactions or memory allocation errors will occur. the \fBdb_buffer_size\fR |
|---|
| 79 | parameter should always be larger than \fBdb_file_size\fR. Refer to the |
|---|
| 80 | Berkeley DB documentation for more information. |
|---|
| 81 | .TP |
|---|
| 82 | .B db_key |
|---|
| 83 | multiple instances of the Berkeley database share common memory regions. In cases |
|---|
| 84 | where this is undesireable, the \fBdb_key\fR can be set explicitly. Refer to the |
|---|
| 85 | Berkeley DB documentation for more information. |
|---|
| 86 | .TP |
|---|
| 87 | .B checkpoint |
|---|
| 88 | specifies the database checkpoint interval in seconds. A value less than or equal to zero disables checkpointing, except on database close. |
|---|
| 89 | It is also possible to initiate a checkpoint operation using \fIarm4_control(1)\fR. |
|---|
| 90 | .SH FILES |
|---|
| 91 | \fI/etc/arm4.conf\fR |
|---|
| 92 | .SH "REPORTING BUGS" |
|---|
| 93 | Report bugs at <http://www.arm4.org> |
|---|
| 94 | .SH COPYRIGHT |
|---|
| 95 | Copyright \(co 2005\-2008 David Carter <dcarter@arm4.org> and others. |
|---|
| 96 | .P |
|---|
| 97 | All rights reserved. This program and the accompanying materials |
|---|
| 98 | are made available under the terms of the Eclipse Public License v1.0 |
|---|
| 99 | which accompanies this distribution, and is available at |
|---|
| 100 | http://www.eclipse.org/legal/epl-v10.html |
|---|
| 101 | .SH "SEE ALSO" |
|---|
| 102 | .LP |
|---|
| 103 | .BR arm4_daemon (1), |
|---|
| 104 | .BR arm4_control (1), |
|---|
| 105 | .BR arm4_dump (1), |
|---|
| 106 | .BR arm4_export (1) |
|---|
| 107 | .BR arm4_report (1) |
|---|
