Blame man/XrmMergeDatabases.man

Packit 5bd3a9
.\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium
Packit 5bd3a9
.\"
Packit 5bd3a9
.\" Permission is hereby granted, free of charge, to any person obtaining
Packit 5bd3a9
.\" a copy of this software and associated documentation files (the
Packit 5bd3a9
.\" "Software"), to deal in the Software without restriction, including
Packit 5bd3a9
.\" without limitation the rights to use, copy, modify, merge, publish,
Packit 5bd3a9
.\" distribute, sublicense, and/or sell copies of the Software, and to
Packit 5bd3a9
.\" permit persons to whom the Software is furnished to do so, subject to
Packit 5bd3a9
.\" the following conditions:
Packit 5bd3a9
.\"
Packit 5bd3a9
.\" The above copyright notice and this permission notice shall be included
Packit 5bd3a9
.\" in all copies or substantial portions of the Software.
Packit 5bd3a9
.\"
Packit 5bd3a9
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
Packit 5bd3a9
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
Packit 5bd3a9
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
Packit 5bd3a9
.\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
Packit 5bd3a9
.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
Packit 5bd3a9
.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
Packit 5bd3a9
.\" OTHER DEALINGS IN THE SOFTWARE.
Packit 5bd3a9
.\"
Packit 5bd3a9
.\" Except as contained in this notice, the name of the X Consortium shall
Packit 5bd3a9
.\" not be used in advertising or otherwise to promote the sale, use or
Packit 5bd3a9
.\" other dealings in this Software without prior written authorization
Packit 5bd3a9
.\" from the X Consortium.
Packit 5bd3a9
.\"
Packit 5bd3a9
.\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
Packit 5bd3a9
.\" Digital Equipment Corporation
Packit 5bd3a9
.\"
Packit 5bd3a9
.\" Portions Copyright \(co 1990, 1991 by
Packit 5bd3a9
.\" Tektronix, Inc.
Packit 5bd3a9
.\"
Packit 5bd3a9
.\" Permission to use, copy, modify and distribute this documentation for
Packit 5bd3a9
.\" any purpose and without fee is hereby granted, provided that the above
Packit 5bd3a9
.\" copyright notice appears in all copies and that both that copyright notice
Packit 5bd3a9
.\" and this permission notice appear in all copies, and that the names of
Packit 5bd3a9
.\" Digital and Tektronix not be used in in advertising or publicity pertaining
Packit 5bd3a9
.\" to this documentation without specific, written prior permission.
Packit 5bd3a9
.\" Digital and Tektronix makes no representations about the suitability
Packit 5bd3a9
.\" of this documentation for any purpose.
Packit 5bd3a9
.\" It is provided ``as is'' without express or implied warranty.
Packit 5bd3a9
.\" 
Packit 5bd3a9
.\"
Packit 5bd3a9
.ds xT X Toolkit Intrinsics \- C Language Interface
Packit 5bd3a9
.ds xW Athena X Widgets \- C Language X Toolkit Interface
Packit 5bd3a9
.ds xL Xlib \- C Language X Interface
Packit 5bd3a9
.ds xC Inter-Client Communication Conventions Manual
Packit 5bd3a9
.na
Packit 5bd3a9
.de Ds
Packit 5bd3a9
.nf
Packit 5bd3a9
.\\$1D \\$2 \\$1
Packit 5bd3a9
.ft CW
Packit 5bd3a9
.\".ps \\n(PS
Packit 5bd3a9
.\".if \\n(VS>=40 .vs \\n(VSu
Packit 5bd3a9
.\".if \\n(VS<=39 .vs \\n(VSp
Packit 5bd3a9
..
Packit 5bd3a9
.de De
Packit 5bd3a9
.ce 0
Packit 5bd3a9
.if \\n(BD .DF
Packit 5bd3a9
.nr BD 0
Packit 5bd3a9
.in \\n(OIu
Packit 5bd3a9
.if \\n(TM .ls 2
Packit 5bd3a9
.sp \\n(DDu
Packit 5bd3a9
.fi
Packit 5bd3a9
..
Packit 5bd3a9
.de IN		\" send an index entry to the stderr
Packit 5bd3a9
..
Packit 5bd3a9
.de Pn
Packit 5bd3a9
.ie t \\$1\fB\^\\$2\^\fR\\$3
Packit 5bd3a9
.el \\$1\fI\^\\$2\^\fP\\$3
Packit 5bd3a9
..
Packit 5bd3a9
.de ZN
Packit 5bd3a9
.ie t \fB\^\\$1\^\fR\\$2
Packit 5bd3a9
.el \fI\^\\$1\^\fP\\$2
Packit 5bd3a9
..
Packit 5bd3a9
.de hN
Packit 5bd3a9
.ie t <\fB\\$1\fR>\\$2
Packit 5bd3a9
.el <\fI\\$1\fP>\\$2
Packit 5bd3a9
..
Packit 5bd3a9
.ny0
Packit 5bd3a9
.TH XrmMergeDatabases __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
Packit 5bd3a9
.SH NAME
Packit 5bd3a9
XrmMergeDatabases, XrmCombineDatabase, XrmCombineFileDatabase \- merge resource databases
Packit 5bd3a9
.SH SYNTAX
Packit 5bd3a9
.HP
Packit 5bd3a9
#include <X11/Xresource.h>
Packit 5bd3a9
.HP
Packit 5bd3a9
void XrmMergeDatabases(\^XrmDatabase \fIsource_db\fP, XrmDatabase
Packit 5bd3a9
*\fItarget_db\fP\^); 
Packit 5bd3a9
.HP
Packit 5bd3a9
void XrmCombineDatabase(\^XrmDatabase \fIsource_db\fP, XrmDatabase
Packit 5bd3a9
*\fItarget_db\fP, Bool \fIoverride\fP\^); 
Packit 5bd3a9
.HP
Packit 5bd3a9
Status XrmCombineFileDatabase(\^char *\fIfilename\fP, XrmDatabase
Packit 5bd3a9
*\fItarget_db\fP\^, Bool \fIoverride\fP); 
Packit 5bd3a9
.SH ARGUMENTS
Packit 5bd3a9
.IP \fIsource_db\fP 1i
Packit 5bd3a9
Specifies the resource database that is to be merged into the target database.
Packit 5bd3a9
.IP \fItarget_db\fP 1i
Packit 5bd3a9
Specifies the resource database into which the source 
Packit 5bd3a9
database is to be merged.
Packit 5bd3a9
.IP \fIfilename\fP 1i
Packit 5bd3a9
Specifies the resource database file name.
Packit 5bd3a9
.IP \fIoverride\fP 1i
Packit 5bd3a9
Specifies whether source entries override target ones.
Packit 5bd3a9
.SH DESCRIPTION
Packit 5bd3a9
Calling the
Packit 5bd3a9
.ZN XrmMergeDatabases
Packit 5bd3a9
function is equivalent to calling the
Packit 5bd3a9
.ZN XrmCombineDatabase
Packit 5bd3a9
function with an override argument of
Packit 5bd3a9
.ZN True .
Packit 5bd3a9
.LP
Packit 5bd3a9
The
Packit 5bd3a9
.ZN XrmCombineDatabase
Packit 5bd3a9
function merges the contents of one database into another.
Packit 5bd3a9
If the same specifier is used for an entry in both databases,
Packit 5bd3a9
the entry in the source_db will replace the entry in the target_db
Packit 5bd3a9
if override is
Packit 5bd3a9
.ZN True ;
Packit 5bd3a9
otherwise, the entry in source_db is discarded.
Packit 5bd3a9
If target_db contains NULL,
Packit 5bd3a9
.ZN XrmCombineDatabase
Packit 5bd3a9
simply stores source_db in it.
Packit 5bd3a9
Otherwise, source_db is destroyed by the merge, but the database pointed
Packit 5bd3a9
to by target_db is not destroyed.
Packit 5bd3a9
The database entries are merged without changing values or types,
Packit 5bd3a9
regardless of the locales of the databases.
Packit 5bd3a9
The locale of the target database is not modified.
Packit 5bd3a9
.LP
Packit 5bd3a9
The
Packit 5bd3a9
.ZN XrmCombineFileDatabase
Packit 5bd3a9
function merges the contents of a resource file into a database.
Packit 5bd3a9
If the same specifier is used for an entry in both the file and
Packit 5bd3a9
the database,
Packit 5bd3a9
the entry in the file will replace the entry in the database
Packit 5bd3a9
if override is
Packit 5bd3a9
.ZN True ;
Packit 5bd3a9
otherwise, the entry in the file is discarded.
Packit 5bd3a9
The file is parsed in the current locale.
Packit 5bd3a9
If the file cannot be read,
Packit 5bd3a9
a zero status is returned;
Packit 5bd3a9
otherwise, a nonzero status is returned.
Packit 5bd3a9
If target_db contains NULL,
Packit 5bd3a9
.ZN XrmCombineFileDatabase
Packit 5bd3a9
creates and returns a new database to it.
Packit 5bd3a9
Otherwise, the database pointed to by target_db is not destroyed by the merge.
Packit 5bd3a9
The database entries are merged without changing values or types,
Packit 5bd3a9
regardless of the locale of the database.
Packit 5bd3a9
The locale of the target database is not modified.
Packit 5bd3a9
.SH "SEE ALSO"
Packit 5bd3a9
XrmGetResource(__libmansuffix__),
Packit 5bd3a9
XrmInitialize(__libmansuffix__),
Packit 5bd3a9
XrmPutResource(__libmansuffix__)
Packit 5bd3a9
.br
Packit 5bd3a9
\fI\*(xL\fP