tetromino-xlock-bindings
| Crates.io | tetromino-xlock-bindings |
| lib.rs | tetromino-xlock-bindings |
| version | 0.1.0+v5.77 |
| source | src |
| created_at | 2024-05-19 16:41:03.325639 |
| updated_at | 2024-05-19 16:41:03.325639 |
| description | Rust bindings for xlock, suitable for writing a custom "mode". |
| homepage | https://github.com/d-e-s-o/tetromino |
| repository | https://github.com/d-e-s-o/tetromino.git |
| max_upload_size | |
| id | 1245080 |
| size | 19,292 |
Daniel Müller (d-e-s-o)
documentation
README
tetromino-xlock-bindings
tetromino-xlock-bindings provides the means for creating bindings
for xlock(1) -- a popular X11 screen lock. The bindings are suitable
for writing a custom "mode", e.g., in the form of a module.
Usage
The crate comes with pre-generated bindings for a given version of
xlock that can be used directly as any other crate. xlock appears to
be taking compatibility into account and so there is a chance that
bindings generated for one version end up producing binaries that are
compatible with another version. It also seems as if few if any
configured features affect the ABI or API, likely rendering the
default bindings suitable in a reasonable number of use cases.
That being said, the crate provides the means for generating updated bindings as follows:
- a build with the
download-xlock-sourcefeature enabled will download thexlocksource code intoxlock-src/- the
XLOCK_VERSIONenvironment variable is honored, specifying the version to download (defaults to5.73) - alternatively, the
XLOCK_SRC_ARCHIVE_URLenvironment variable can be used to specify a URL of atar.xzthat will be downloaded and extracted intoxlock-src/
- the
- if the
generate-xlock-bindingsfeature is enabled,bindings.rswill be regenerated- by default bindings will be generated based on contents in
xlock-src/ - however, if the
XLOCK_SRC_ROOTenvironment variable is set an attempt is made to create them based on data in the referenced directory
- by default bindings will be generated based on contents in
If you don't have xlock installed, you can build it directly from
xlock-src (after downloading the source code; see above). Please refer
to instructions provided in the source code.
Note that by default all xlock "modes" are statically linked into the
binary at build time, making it rather cumbersome to ship a new "mode".
In recent versions xlock comes with experimental support for modules
(shared objects), which can be discovered at start-up time. You most
likely want to configure xlock to include support for modules (refer
to their build instructions for how to go about that).