zmk.OS(5)

include z.mk $(eval $(call ZMK.Import,OS)) The module provides information about the operating system executing zmk.

Section 5 zmk-doc bookworm source

Description

UNTITLED() LOCAL UNTITLED()

NAME

OS — module providing operating system information

SYNOPSIS

include z.mk

$(eval $(call ZMK.Import,OS))

DESCRIPTION

The module OS provides information about the operating system executing zmk. It can be used to provide tailored behavior and account for differences between UNIX flavours.

TARGETS

This module does not provide any targets.

VARIABLES

This module provides the following variables.

OS.Kernel

Identifier of the operating system kernel.

Known values are listed in the following table.

Image grohtml-19026-1.png

OS.ImageFormat

Identifier or the application image format used.

Image grohtml-19026-2.png

Due to cross-compiling it is more useful to look at Toolchain.ImageFormat instead.

IMPLEMENTATION NOTES

Windows is detected by the presence and specific value of the OS environment variable. All other kernels are identified by invoking uname -s.

HISTORY

The OS module first appeared in zmk 0.1

AUTHORS

Zygmunt Krynicki <me@zygoon.pl> zmk 0.5.1 May 3, 2020 zmk.OS(5)