OpenBox rc.xml Generator (Scheme/Sexpr to XML)

unbox requires the following dependencies to build:

• A sane UNIX system (i.e. gcc, pkg-config, etc.)
• Guile 2.0 (or higher)
• Openbox (to have an actual use)

To compile and install unbox run:

$ make
$ make install-user
# make install

unbox uses a number of different flags and options. To view a help page you can use the '-h' flag and to view the currently installed version of unbox you can use the '-v' flag. In order to generate an rc.xml from the default file ('/.config/unbox/rc.scm') you can simply run unbox. This will place the output in the same folder ('/.config/unbox/rc.xml'). If you want to use a different output file, you can use the '-o' flag like so: unbox -o rc1.xml. If you want to use a different input file, you simply add its name after the command: unbox my_rc.scm. Note that this will not change the default output name, so if you want that to generate a file named my_rc.scm, you must use unbox my_rc.scm -o my_rc.xml. If you want the XML output to be formatted to the correct XML standards (and have xmllint installed on your system), you can use the '-f' flag.

unbox uses a Scheme syntax for configurations. The syntax should be compliant with Guile version 2.0. However, the configuration can be managed entirely by custom macros and functions, so it is not necessary to use any additional Scheme code in your configuration.

All configurations should be declared inside of (rc ...) to export the config. Inside of this, simply put the list of configuration options. Every configuration option is written in the s-expression syntax: (<name> <args>*). Arguments to these should be one of the following:

• Numbers
• Strings (enclosed within double quotes: "example")
• More nodes
• Commonly typed exceptions [1]

[1] - These exceptions include:

• yes ("Yes")
• no ("No")
• undermouse ("UnderMouse")
• smart ("Smart")
• x-center (equivalent to "center")
• y-center (equivalent to "center")
• always ("Always")
• never ("Never")
• nonpixel/non-pixel ("Nonpixel")
• top ("Top")
• centered ("Center")
• fixed ("Fixed")

As a general rule, all node names are the same as their XML names. However, names which use camel case are instead switched to kebab case (so that "myNode" becomes "my-node" and so on). Additionally, some XML names use snake case, so these too use kebab case (meaning that "my_node" becomes "my-node").

Finally, line comments can be inserted after one or more semicolons.

A basic example exists below:

;; This is an example config.
;; It is nowhere near complete
;; but it does showcase some
;; of unbox's features
(rc
  (resistance
    (strenth 10)
    (screen-edge-strength 10)))

If you're interested in helping out this project or find a problem with it, there are a number of ways you can contribute. One of the best ways is to open up a issue on the Github repository to report bugs, missing features, or inconsistent behaviour. Additionally, you are encouraged to fork the repository and add features to improve the project for others (or fix bugs that you find). Finally, if you're interested in contributing to the community as a whole, please help with documentation efforts or by sharing your configs so that others can use them as examples to build off of.