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;


database Specifies the resource database.
table Specifies the table of command line arguments to be parsed.
table_count Specifies the number of entries in the table.
name Specifies the application name.
argc_in_out Specifies the number of arguments and returns the number of remaining arguments.
argv_in_out Specifies the command line arguments and returns the remaining arguments.


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. If database contains NULL, XrmParseCommand() creates a new database and returns a pointer to it. Otherwise, entries are added to the database specified. If a database is created, it is created in the current locale.

The specified table is used to parse the command line. Recognized options in the table are removed from argv, and entries are added to the specified resource database in the order they occur in argv. 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 option names are compared byte-for-byte to arguments in argv, independent of any locale. The resource values given in the table are stored in the resource database without modification. All resource database entries are created using a ``String'' representation type. The argc argument specifies the number of arguments in argv and is set on return 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 a database entry. The name argument is treated as a single component, even if it has embedded periods. No separating (binding) character is inserted, so 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. If the name argument and the resourceNames are not in the Host Portable Character Encoding, the result is implementation dependent.

The following provides a sample option table:

static XrmOptionDescRec opTable[] = {
	{"-background",	"*background",			XrmoptionSepArg, (XPointer) NULL},
	{"-bd",		"*borderColor",			XrmoptionSepArg, (XPointer) NULL},
	{"-bg",		"*background",			XrmoptionSepArg, (XPointer) NULL},
	{"-borderwidth","*TopLevelShell.borderWidth",	XrmoptionSepArg, (XPointer) NULL},
	{"-bordercolor","*borderColor",			XrmoptionSepArg, (XPointer) NULL},
	{"-bw",		"*TopLevelShell.borderWidth",	XrmoptionSepArg, (XPointer) NULL},
	{"-display",	".display",			XrmoptionSepArg, (XPointer) NULL},
	{"-fg",		"*foreground",			XrmoptionSepArg, (XPointer) NULL},
	{"-fn",		"*font",			XrmoptionSepArg, (XPointer) NULL},
	{"-font",	"*font",			XrmoptionSepArg, (XPointer) NULL},
	{"-foreground",	"*foreground",			XrmoptionSepArg, (XPointer) NULL},
	{"-geometry",	".TopLevelShell.geometry",	XrmoptionSepArg, (XPointer) NULL},
	{"-iconic",	".TopLevelShell.iconic",	XrmoptionNoArg,	 (XPointer) "on"},
	{"-name",	".name",			XrmoptionSepArg, (XPointer) NULL},
	{"-reverse",	"*reverseVideo",		XrmoptionNoArg,	 (XPointer) "on"},
	{"-rv",		"*reverseVideo",		XrmoptionNoArg,	 (XPointer) "on"},
	{"-synchronous","*synchronous",			XrmoptionNoArg,	 (XPointer) "on"},
	{"-title",	".TopLevelShell.title",		XrmoptionSepArg, (XPointer) NULL},
	{"-xrm",	NULL,				XrmoptionResArg, (XPointer) NULL},

In this table, if the -background (or -bg) option is used to set background colors, the stored resource specifier matches all resources of attribute background. If the -borderwidth option is used, the stored resource specifier applies only to border width attributes of class TopLevelShell (that is, outer-most windows, including pop-up windows). If the -title option is used to set a window name, only the topmost application windows receive the resource.

When parsing the command line, any unique unambiguous abbreviation for an option name in the table is considered a match for the option. Note that uppercase and lowercase matter.

See also

XrmGetResource(), XrmInitialize(), XrmMergeDatabases(), XrmPutResource(), XrmUniqueQuark(), "Parsing Command Line Options"
Christophe Tronche, ch@tronche.com