{"id":13439853,"url":"https://github.com/sysprog21/lkmpg","last_synced_at":"2026-02-02T08:13:00.538Z","repository":{"id":37535159,"uuid":"388260535","full_name":"sysprog21/lkmpg","owner":"sysprog21","description":"The Linux Kernel Module Programming Guide (updated for 5.0+ kernels)","archived":false,"fork":false,"pushed_at":"2025-05-06T02:58:08.000Z","size":8757,"stargazers_count":7926,"open_issues_count":19,"forks_count":563,"subscribers_count":152,"default_branch":"master","last_synced_at":"2025-05-06T03:32:53.591Z","etag":null,"topics":["books","c","device-driver","documentation","kernel","linux","linux-kernel","linux-kernel-driver","linux-kernel-module","lkm","lkmpg"],"latest_commit_sha":null,"homepage":"https://sysprog21.github.io/lkmpg/","language":"TeX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"osl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sysprog21.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-07-21T22:24:43.000Z","updated_at":"2025-05-06T02:54:53.000Z","dependencies_parsed_at":"2023-01-30T22:01:25.895Z","dependency_job_id":"f5938566-d551-41f0-a3c3-abd4a40961e7","html_url":"https://github.com/sysprog21/lkmpg","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sysprog21%2Flkmpg","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sysprog21%2Flkmpg/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sysprog21%2Flkmpg/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sysprog21%2Flkmpg/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sysprog21","download_url":"https://codeload.github.com/sysprog21/lkmpg/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253990466,"owners_count":21995774,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["books","c","device-driver","documentation","kernel","linux","linux-kernel","linux-kernel-driver","linux-kernel-module","lkm","lkmpg"],"created_at":"2024-07-31T03:01:17.662Z","updated_at":"2026-02-02T08:13:00.499Z","avatar_url":"https://github.com/sysprog21.png","language":"TeX","funding_links":[],"categories":["HarmonyOS","TeX","1. [Kernel](https://linux-kernel-labs.github.io/refs/heads/master/)-Space Driver"],"sub_categories":["Windows Manager","1.2 [Kernel](https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/7/html/kernel_administration_guide) [Module](https://en.wikipedia.org/wiki/Loadable_kernel_module)"],"readme":"# The Linux Kernel Module Programming Guide\n\nThis project keeps the Linux Kernel Module Programming Guide up to date, with [working examples](examples/) for recent 5.x and 6.x kernel versions.\nThe guide has been around since 2001 and most copies of it on the web only describe old 2.6.x kernels.\n\nThe book can be freely accessed via https://sysprog21.github.io/lkmpg/ or [latest PDF file](https://github.com/sysprog21/lkmpg/releases).\nThe original guide may be found at [Linux Documentation Project](http://www.tldp.org/LDP/lkmpg/).\nYou may check other [freely available programming books](https://ebookfoundation.github.io/free-programming-books-search/) listed by The [Free Ebook Foundation](https://ebookfoundation.org/) or [Linux online books](https://onlinebooks.library.upenn.edu/webbin/book/browse?type=lcsubc\u0026key=Linux) collected by [The Online Books Page](https://onlinebooks.library.upenn.edu/).\n\n## Getting Started\n\n### Summary\n1. Get the latest source code from the [GitHub page](https://github.com/sysprog21/lkmpg).\n2. Install the prerequisites.\n3. Generate PDF and/or HTML documents.\n\n### Step 1: Get the latest source code\n\nMake sure you can run `git` with an Internet connection.\n\n```shell\n$ git clone https://github.com/sysprog21/lkmpg.git \u0026\u0026 cd lkmpg\n```\n\n### Step 2: Install the prerequisites\n\nTo generate the book from source, [TeXLive](https://www.tug.org/texlive/) ([MacTeX](https://www.tug.org/mactex/)) is required.\n\nFor Ubuntu Linux, macOS, and other Unix-like systems, run the following command(s):\n\n```bash\n# Debian / Ubuntu\n$ sudo apt install make texlive-full\n\n# Arch / Manjaro\n$ sudo pacman -S make texlive-binextra texlive-bin\n\n# macOS\n$ brew install mactex\n$ sudo tlmgr update --self\n```\n\nNote that `latexmk` is required to generated PDF, and it probably has been installed on your OS already. If not, please follow the [installation guide](https://mg.readthedocs.io/latexmk.html#installation).\n\nIn macOS systems, package `Pygments` may not be pre-installed. If not, please refer to the [installation guide](https://pygments.org/download/) before generate documents.\n\nAlternatively, using [Docker](https://docs.docker.com/) is recommended, as it guarantees the same dependencies with our GitHub Actions workflow.\nAfter install [docker engine](https://docs.docker.com/engine/install/) on your machine, pull the docker image [twtug/lkmpg](https://hub.docker.com/r/twtug/lkmpg) and run in isolated containers.\n\n```shell\n# pull docker image and run it as container\n$ docker pull twtug/lkmpg\n$ docker run --rm -it -v $(pwd):/workdir twtug/lkmpg\n```\n\n[nerdctl](https://github.com/containerd/nerdctl) is a Docker-compatible command line tool for [containerd](https://containerd.io/), and you can replace the above `docker` commands with `nerdctl` counterparts.\n\n### Step 3: Generate PDF and/or HTML documents\n\nNow we could build document with following commands:\n\n```bash\n$ make all              # Generate PDF document\n$ make html             # Convert TeX to HTML\n$ make clean            # Delete generated files\n```\n\n## License\n\nThe Linux Kernel Module Programming Guide is a free book; you may reproduce and/or modify it under the terms of the [Open Software License](https://opensource.org/licenses/OSL-3.0).\nUse of this work is governed by a copyleft license that can be found in the `LICENSE` file.\n\nThe complementary sample code is licensed under GNU GPL version 2, as same as Linux kernel.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsysprog21%2Flkmpg","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsysprog21%2Flkmpg","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsysprog21%2Flkmpg/lists"}