XrmInitialize(3)

XrmInitialize(3) 💖 — the Resource Manager glow-up, straight from XLIB FUNCTIONS 🦋

✨ NAME ✨

Okay bestie, this whole page is the Resource Manager starter pack: it's about initializing the Resource Manager, the Resource Manager structures, and parsing the command line. The main characters are XrmInitialize, XrmParseCommand, XrmValue, XrmOptionKind, and XrmOptionDescRec — all iconic, no cap 👑.

---

💅 SYNTAX 💅

Here's the literal include and prototypes, bestie — copy these exactly or the compiler will give you the silent treatment 💀:

#include <X11/Xresource.h>

void XrmInitialize(void);

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

---

🫶 ARGUMENTS 🫶

Vibe check on the arguments, one by one:

• 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.
• database — Specifies the resource database.
• name — Specifies the application name.
• table — Specifies the table of command line arguments to be parsed.
• table_count — Specifies the number of entries in the table.

---

🌸 DESCRIPTION 🌸

XrmInitialize is the one that initializes the Resource Manager. It has main character energy in the sense that it must be called before any other Xrm functions are used. No skipping, bestie. ⭐

XrmParseCommand parses an (argc, argv) pair according to the specified option table. It loads recognized options into the specified database with type “String,” and then 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 literally what gets 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 — order matters, iykyk. 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. Yes, byte-for-byte. Not vibe-for-vibe. 💀 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. That name gets prefixed to the resourceName in the option table before storing a database entry. It's treated as a single component, even if it has embedded periods — periods do not break it apart, periodt. 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. If you want a more completely qualified resource name, the resourceName entry can contain multiple components. And if the name argument and the resourceNames are not in the Host Portable Character Encoding, the result is implementation-dependent. 🫠

---

🎀 STRUCTURES 🎀

The XrmValue, XrmOptionKind, and XrmOptionDescRec structures contain — here's the exact C, comments and all:

typedef struct {
        unsigned int size;
        XPointer 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            */
        XPointer value; /* Value to provide if XrmoptionNoArg or
                          XrmoptionSkipNArgs   */
} XrmOptionDescRec, *XrmOptionDescList;

---

📚 SEE ALSO 📚

Go read these next, bestie:

• XrmGetResource(3)
• XrmMergeDatabases(3)
• XrmPutResource(3)
• XrmUniqueQuark(3)
• Xlib - C Language X Interface

---

Okay that's the whole page. Signing off with the footer tea: X Version 11 ✨ libX11 1.8.14 ✨ XrmInitialize(3) — source, version, and page-date sign-off vibes, and we ate 💅💖