IVNSS 自动售货机网络 GIT 仓库 - lkmpgcn/blob - README_CN.md

   1 # Linux 内核模块编程指南
   2
   3 注意：简体中文部分，基于原git仓库如下提交：
   4       5fd15075f26048cb5d9f00d3b3aa5861543002ed
   5       开始简体中文翻译工作。
   6
   7 简体中文版本项目发起人：Felix Lee <felix@ivnss.com>
   8 项目启动日期： 2023年9月9日
   9
  10 本项目保持Linux内核模块编程指南及时更新，使用[工作示例](example/)于最近的5.x内
  11 核版本。
  12 本指南从2001年起就已经发布，并且在网页上可获得的大多本指南的版本，只是基于旧的
  13 2.6.x内核进行说明。
  14
  15
  16 本书可通过网络访问 https://sysprog21.github.io/lkmpg/ 或 [最新PDF文件]
  17 (https://github.com/sysprog21/lkmpg/releases)自由获得。
  18 最初版本的指南，可以从 [Linux文档项目](http://www.tldp.org/LDP/lkmpg/) 上找到。
  19 你可以从其它资源找到该指南，如 [自由可用的编程书籍]
  20 (https://ebookfoundation.github.io/free-programming-books-search/) ,其也被列于
  21 [自由电子书基金会](https://ebookfoundation.org/) 或 [Linux 在线电子书]
  22 (https://onlinebooks.library.upenn.edu/webbin/book/browse?type=lcsubc&key=Linux),
  23 也被收藏于[在线书籍网页](https://onlinebooks.library.upenn.edu/).
  24
  25 ## 开始启航
  26
  27 ### 概括
  28 1. 从 [GitHub 网页](https://github.com/sysprog21/lkmpg) 得到最新源代码。
  29 2. 安装先决需求软件包。
  30 3. 产生 PDF 与/或 HTML 文档。
  31
  32 ### 第一步：得到最新源代码
  33
  34 确保在你可以访问互联网的情况下，可以运行git工具软件。
  35
  36 ```shell
  37 $ git clone https://github.com/sysprog21/lkmpg.git && cd lkmpg
  38 ```
  39
  40 ### 第二步：安装先决需求软件包
  41
  42 要从源代码生成本书, [TeXLive](https://www.tug.org/texlive/)
  43  ([MacTeX](https://www.tug.org/mactex/)) 软件包是必需安装的。
  44
  45 对于 Ubuntu Linux, macOS, 与其它 Unix 风格的系统, 运行下列命令：
  46
  47 ```bash
  48 # Debian / Ubuntu
  49 $ sudo apt install make texlive-full
  50
  51 # Arch / Manjaro
  52 $ sudo pacman -S make texlive-binextra texlive-bin
  53
  54 # macOS
  55 $ brew install mactex
  56 $ sudo tlmgr update --self
  57 ```
  58
  59 注意为产生PDF文件 `latexmk` 是必须的，并且该软件可能在你的系统上已经被安装了。
  60 如未安装，按照[安装指南](https://mg.readthedocs.io/latexmk.html#installation)。
  61
  62 在 macOS 系统上，包`Pyments`可能没有被预安装。如未安装，在产生文档前请参考[安装
  63 指南](https://pygments.org/download/) 。
  64
  65 另外，被推荐使用[Docker](https://docs.docker.com/)，因为它担保我们的 GitHub 行
  66 为工作流相同的依赖关系。
  67 在你的机器上安装 [docker 引擎](https://docs.docker.com/engine/install/) 之后，
  68 拉取docker镜像[twtug/lkmpg](https://hub.docker.com/r/twtug/lkmpg)并安装容器。
  69
  70
  71 ```shell
  72 # pull docker image and run it as container
  73 $ docker pull twtug/lkmpg
  74 $ docker run --rm -it -v $(pwd):/workdir twtug/lkmpg
  75 ```
  76
  77 [nerdctl](https://github.com/containerd/nerdctl) 是一个 Docker 兼容的命令行工具
  78 用于 [containerd](https://containerd.io/)，并且你可以替换上面的 `docker` 命令，
  79 使用 `nerdctl` 同行。
  80
  81 ### 第三步: 产生 PDF 与/或 HTML 文档
  82
  83 现在我们可以使用下面的命令编译文档：
  84
  85 ```bash
  86 $ make all              # Generate PDF document
  87 $ make html             # Convert TeX to HTML
  88 $ make clean            # Delete generated files
  89 ```
  90
  91 ## 许可协议
  92
  93 Linux内核模块编程指南是一本自由书籍；你可以在遵守[开源软件许可协议]
  94 (https://opensource.org/licenses/OSL-3.0) 条款的基础之上重生成/修改本书内容。
  95 相关工作进行，由条款存在于`LICENSE`文件中的条款定义的版权许可协议决定。
  96
  97
  98 补充示例代码，在GNU GPL 版本2 条款下被允许使用，与Linux内核使用相同的许可协议。