Museum

Home

Lab Overview

Retrotechnology Articles

⇒ Online Manual

Media Vault

Software Library

Restoration Projects

Artifacts Sought

Related Articles

XrmGetResource(3X11)

XrmMergeDatabases(3X11)

XrmPutResource(3X11)

XrmUniqueQuark(3X11)

XrmInitialize(3X11)  —  Subroutines

Version  —  11

NAME

XrmInitialize, XrmParseCommand, XrmValue, XrmOptionKind, XrmOptionDescRec − initialize the Resource Manager, Resource Manager structures, and parse the command line

SYNOPSIS

void XrmInitialize();

void XrmParseCommand(database, table, table_count, name, argc_in_out, argv_in_out,)
   XrmDatabase ∗database;
   XrmOptionDescList table;
   int table_count;
   char ∗name;
   int ∗argc_in_out;
   char ∗∗argv_in_out;

PARAMETERS

argc_in_outSpecifies the number of arguments and returns the number of remaining arguments. 

argv_in_outSpecifies a pointer to the command line arguments and returns the remaining arguments. 

databaseSpecifies the resource database. 

nameSpecifies the application name. 

tableSpecifies the table of command line arguments to be parsed. 

table_countSpecifies the number of entries in the table. 

DESCRIPTION

The XrmInitialize function initialize the resource manager.

The XrmParseCommand function parses an (argc, argv) pair according to the specified option table, loads recognized options into the specified database with type “String,” and modifies the (argc, argv) pair to remove all recognized options.

The specified table is used to parse the command line.  Recognized entries in the table are removed from argv, and entries are made in the specified resource database.  The table entries contain information on the option string, the option name, the style of option, and a value to provide if the option kind is XrmoptionNoArg. The argc argument specifies the number of arguments in argv and is set to the remaining number of arguments that were not parsed. The name argument should be the name of your application for use in building the database entry. The name argument is prefixed to the resourceName in the option table before storing the specification. No separating (binding) character is inserted. The table must contain either a period (.) or an asterisk (∗) as the first character in each resourceName entry. To specify a more completely qualified resource name, the resourceName entry can contain multiple components.

STRUCTURES

The XrmValue, XrmOptionKind, and XrmOptionDescRec structures contain:

typedef struct {
unsigned int size;
caddr_t addr;
} XrmValue, ∗XrmValuePtr;

typedef enum {
XrmoptionNoArg,/∗ Value is specified in XrmOptionDescRec.value ∗/
XrmoptionIsArg,/∗ Value is the option string itself ∗/
XrmoptionStickyArg,/∗ Value is characters immediately following option ∗/
XrmoptionSepArg,/∗ Value is next argument in argv ∗/
XrmoptionResArg,/∗ Resource and value in next argument in argv ∗/
XrmoptionSkipArg,/∗ Ignore this option and the next argument in argv ∗/
XrmoptionSkipLine,/∗ Ignore this option and the rest of argv ∗/
XrmoptionSkipNArgs/∗ Ignore this option and the next
   XrmOptionDescRec.value arguments in argv ∗/
} XrmOptionKind;

typedef struct {
char ∗option;/∗ Option specification string in argv   ∗/
char ∗specifier;/∗ Binding and resource name (sans application name)  ∗/
XrmOptionKind argKind;/∗ Which style of option it is   ∗/
caddr_t value;/∗ Value to provide if XrmoptionNoArg or
   XrmoptionSkipNArgs  ∗/
} XrmOptionDescRec, ∗XrmOptionDescList;

RELATED INFORMATION

XrmGetResource(3X11), XrmMergeDatabases(3X11), XrmPutResource(3X11), XrmUniqueQuark(3X11)
Xlib − C Language X Interface

Typewritten Software • bear@typewritten.org • Edmonds, WA 98026