Document not found (404)
+This URL is invalid, sorry. Please use the navigation bar or search to continue.
+ +This URL is invalid, sorry. Please use the navigation bar or search to continue.
+ +ruxgo -b 命令用于构建您的项目，需确保当前目录下存在 config_<platform>.toml。
要构建当前项目，您可以执行以下操作：
+ruxgo -b [--path <路径>] [--gen-cc] [--gen-vsc]
+--path <路径>: 指定一个特定的目录（需存在 config_<platform>.toml）来执行构建操作。如果不提供，则默认在当前目录下执行。--gen-cc: 生成 compile_commands.json 文件，它包含了编译项目的所有命令。--gen-vsc: 生成 Visual Studio Code 的配置文件 .vscode/c_cpp_properties.json，它包含了项目的编译器配置和头文件路径。当执行 ruxgo -b 命令后，将会在当前目录下创建一个名为 ruxgo_bld/ 的构建目录，包括以下内容：
ruxgo_bld/
+├── bin/
+├── obj_linux/ 或 obj_win32/
+├── target/
+├── *.hash
+├── compile_commands.json (如果启用了gen_cc)
+├── .vscode/c_cpp_properties.json (如果启用了gen_vsc)
+└── ruxmusl/ (如果使用了ruxmusl用户库)
+bin/： 存放构建过程中生成的静态库、动态库、目标文件或可执行文件 。obj_linux/obj_win32： 存放编译源码生成的中间对象文件 （ *.o ）。target： 存放构建 ruxos 后生成的 target 文件。*.hash： 存放构建过程中生成的 hash 文件，用来实现增量构建。compile_commands.json： 存放构建过程中的所有编译命令，如果启用了 gen_cc。.vscode/c_cpp_properties.json： 存放项目的 vscode 配置，如果启用了 gen_vsc。ruxmusl/： 存放构建 ruxmusl 后生成的中间文件及静态库，如果使用了 ruxmusl 。ruxgo -c 命令用于清理项目，需确保当前目录下存在 config_<platform>.toml。
要清理构建的项目，您可以执行以下操作：
+ruxgo -c [--path <路径>]
+--path <路径>: 指定一个特定的目录（需存在 config_<platform>.toml）来执行清理操作。如果不提供，则默认在当前目录下执行。执行 ruxgo -c 命令后，ruxgo 提供了一个多选界面，让用户选择要清理的过程文件，按下 Esc 键则退出当前命令，按下空格（Space）键则选中要清理的项目。具体内容如下：
All/： 删除项目所有内容。App_bins/： 删除构建的 app 可执行文件及其相关库。Obj/： 删除编译源码生成的中间对象文件（*.o）。OS/： 删除 ruxos 的构建目录。Ulib/： 删除 Ulib 的构建内容，如 ruxlibc 或 ruxmusl。需要确保在执行目录下存在正确的配置文件，或者使用 --path 指定包含这些文件的目录。
ruxgo help 命令用于显示 ruxgo 工具的帮助信息，包括其各个子命令的详细说明。
要获取 ruxgo 工具或其任一子命令的帮助信息，您可以执行以下操作：
ruxgo help [子命令]
+显示 ruxgo 的总体帮助信息：
ruxgo help
+查看关于 init 命令的详细帮助：
ruxgo help init
+查看关于 pkg 命令的详细帮助：
ruxgo help pkg
+ruxgo help 将显示 ruxgo 工具的总体帮助信息，包括所有可用的命令和选项。ruxgo help init，将显示该特定子命令的详细帮助信息。当您开始一个新项目时，通常需要一些基本的框架设置。ruxgo 提供了 init 命令来帮助您快速开始一个新的 C 或 C++ 项目。
要初始化一个新项目，使用以下命令：
+ruxgo init <项目名称> [--c] [--cpp]
+<项目名称>: 指定新项目的名称。--c: 初始化一个 C 语言项目。--cpp: 初始化一个 C++ 语言项目。注意：--c 和 --cpp 选项不能同时使用。如果都不指定，则默认创建一个 C++ 项目。
当运行 ruxgo init 命令后，将会在当前目录下创建一个新的项目目录，其中包括以下内容：
<项目名称>/
+├── src/
+│ ├── main.c 或 main.cpp
+│ └── include/
+├── .gitignore
+├── README.md
+├── LICENSE
+└── config_<platform>.toml
+src/：包含所有源代码文件和配置文件。src/include：用于存放头文件。.gitignore：用于指定 git 忽略的文件和目录。README.md 和 LICENSE：项目的基本文档。config_<platform>.toml：项目的配置文件，根据运行平台的不同而变化（例如 config_linux.toml 或 config_win32.toml）。初始化一个名为 “my_project” 的 C++ 项目：
+ruxgo init my_project --cpp
+初始化一个名为 “my_project” 的 C 项目：
+ruxgo init my_project --c
+--help 选项可以查看更多命令帮助。ruxgo init 将不会继续执行，并显示错误信息。config_<platform>.toml 文件，您可以自定义编译器选项和其他构建设置。ruxgo pkg 命令用于管理软件包，包括列出、拉取、更新和清理软件包等。
要使用 ruxgo pkg 命令，您可以执行以下操作：
ruxgo pkg [选项]
+可选项如下：
+-l, --list: 列出远程仓库中可用的软件包。-p, --pull <PKG_NAME>: 从远程仓库拉取特定软件包。-r, --run <APP_BIN>: 运行特定的应用程序二进制文件。-u, --update <PKG_NAME>: 更新特定软件包。-c, --clean <PKG_NAME>: 清理特定软件包。--clean-all: 清理所有软件包。-h, --help: 打印帮助信息。下载的文件保存在 ruxgo_pkg/ 目录中，具体内容如下：
app-bin/: 存放 app 可执行文件及其对应脚本。ruxos/: ruxos 存储位置。rux-*/: app 源码存储位置。cache/: 存放 packages 信息的缓存。列出所有可用的软件包：
+ruxgo pkg --list
+从远程仓库拉取名为 “example_pkg” 的软件包：
+ruxgo pkg --pull example_pkg
+更新名为 “example_pkg” 的软件包：
+ruxgo pkg --update example_pkg
+清理名为 “example_pkg” 的软件包：
+ruxgo pkg --clean example_pkg
+清理所有软件包：
+ruxgo pkg --clean-all
+--help 选项可以查看更多命令帮助。ruxgo -r 命令用于运行项目中的可执行文件，需确保当前目录下存在 config_<platform>.toml。
要运行构建的项目，您可以执行以下操作：
+ruxgo -r [--path <路径>] [--bin-args <参数列表>]
+--path <路径>: 指定一个特定的目录（需存在 config_<platform>.toml）来执行运行操作。如果不提供，则默认在当前目录下执行。--bin-args=<参数列表>: 提供一系列运行时参数传递给项目的可执行文件，参数跟在=后面且以逗号分隔。执行 ruxgo -r 命令后，将会运行 bin/ 目录下的可执行文件。需要确保在执行目录下存在正确的配置文件，或者使用 --path 指定包含这些文件的目录。
首先，确保您的系统上已安装 ruxgo。如果尚未安装，请参考 Ruxgo 安装 。
+之后使用如下命令初始化一个 C 项目：
+ruxgo init my_project --c
+初始化完成后，切换到 my_project 目录，使用 ruxgo 构建并运行：
+ruxgo -b
+ruxgo -r
+如果您想在 RuxOS 上运行，将 my_project 下的config_<platform>.toml文件修改为如下:
[build]
+compiler = "gcc"
+
+[os]
+name = "ruxos"
+services = []
+ulib = "ruxlibc"
+
+[os.platform]
+name = "x86_64-qemu-q35"
+mode = "release"
+log = "info"
+
+[os.platform.qemu]
+graphic = "n"
+
+[[targets]]
+name = "main"
+src = "./src/"
+include_dir = "./src/include/"
+type = "exe"
+cflags = "-g -Wall -Wextra"
+linker = "rust-lld -flavor gnu"
+ldflags = ""
+deps = []
+之后将 my_project 复制到 ruxos/apps/c 目录下，切换到 my_project 目录，使用 ruxgo 构建并运行：
+ruxgo -b
+ruxgo -r
+[build] 模块描述了编译器的类型。它包含 compiler。
compiler: 指定编译器类型，例如: “gcc”。[os] 模块是可选的。如果你想在本地运行，[build] 和 [targets] 是完全满足，如果你想在 RuxOS 上运行，则需要添加[os] 模块。
+添加 [os] 模块后，原有 [targets] 模块的一些内容将会发生改变。例如:
+当 [os] 模块的平台是 “x86_64-qemu-q35” 时，编译器类型不再是 “gcc”，它将变成 “x86_64-linux-musl-gcc”。此外，所有 [targets] 的 cflags 都默认添加了 “-nostdinc -fno-builtin -ffreestanding -Wall”，当 [targets] 类型是 “exe” 时，ldflags 还默认添加了 “-nostdlib -static -no-pie –gc-sections”，你不需要去手动添加它们。当然，根据架构和平台的不同，还有其他默认的添加及改变。
+Ruxgo 这么做是为了，如果你能在本地跑通一个程序，那么只需要将定制的 [os] 模块拼接到你本地跑通的模块上，即可实现在 RuxOS 上流畅的运行，而不需要额外的操作!
+具体 [os] 模块描述如下:
+name: 指定操作系统的名称。
services: 指定操作系统可以提供的服务，类似于 RuxOS 中的 features。
ulib: 指定想要使用的用户库，可选项有: “ruxlibc”，“ruxmusl”。
platform: 如果需要，请在 [os.platform] 中进行配置。
如果你想进一步配置平台，可以在 [os.platform] 中实现。如果为空，则使用默认值。具体细节如下:
+name: 指定操作系统在哪个平台上运行，可选项有: “x86_64-qemu-q35”， “aarch64-qemu-virt”， “riscv64-qemu-virt”。默认值为 “x86_64-qemu-q35”。
smp: 指定cpu数量。默认值为 “1”。
mode: 指定构建模式，可选项有: “release”，“debug”。默认值为 “release”。
log: 指定日志级别，可选项有: “warn”，“error”，“info”，“debug” 和 “trace”。默认值为 “warn”。
v: 指定 verbose 级别，可选项有: “”，“1”，“2”。默认值为 “”。
qemu: 如果需要，请在 [os.platform.qemu] 中进行配置。
如果你的平台依赖于 qemu ，你需要在 [os.platform.qemu] 中进一步配置它。如果为空，则使用默认值。具体细节如下:
+blk: 指定是否启用存储设备（virtio-blk）。默认值为 “n”。
net: 指定是否启用网络设备（virtio-net）。默认值为 “n”。
graphic: 指定是否启用显示设备和图形输出（virtio-gpu）。默认值为“n“。
debug: 指定是否启用 gdb 服务，启用后监听本地 1234 端口。默认值为“n“。
disk_img: 指定虚拟磁盘镜像的路径。默认值为 “./disk_img”。
v9p: 指定是否启用 virtio-9p 设备。默认值为 “n”。
v9p_path: 指定 virtio-9p 后端的主机路径。默认值为 “./”。
qemu_log: 指定是否启用 QEMU 日志（日志文件为 “qemu.log” ）。默认值为 “n”。
net_dump: 指定是否启用网络包转储（日志文件为 “netdump.pcap” ）。默认值为 “n”。
net_dev: 指定 QEMU 网络设备后端类型: “user” 或 “tap”。默认值为 “user”。
ip: 指定 IPv4 地址。QEMU “user” 网络设备的默认值为 “10.0.2.15”。
gw: 指定 IPv4 地址的网关。QEMU “user” 网络设备的默认值为 “10.0.2.2”。
args: 指定命令行参数，以逗号分隔。它用于传递特定的变量，如argc、argv。默认值为 “”。
envs: 指定环境变量，键值对之间用逗号分隔。默认值为 “”。
Ruxgo 设计充分考虑构建过程的效率、可靠性和可维护性，同时充分适应 RuxOS 的构件化特性：
+多样化的编译选项：Ruxgo 支持多种编译器（如 GCC、Clang、MSVC）和多样化的中间过程（如生成静态库、动态库、目标文件等），为最佳性能提供灵活选择。
+增量与并行构建：通过增量构建，Ruxgo 只编译修改过的文件或模块，大幅缩短构建时间。同时利用多核处理器同时编译多个文件，实现并行构建，进一步提高效率。
+简化的配置文件：完全使用 Toml 文件来描述构建参数，避免使用复杂的语法和依赖规则的构建流程。开发者只专注于构建逻辑，而非配置文件的复杂性
+依赖管理与可移植性：结合包管理功能和 crate.io 生态来简化外部库和组件的依赖管理。同时代码尽量使用平台无关的 API，增强跨平台兼容性。
+构建过程模块化：构建过程以 Target 为中心，按照不同的 Target 模块来配置源文件和依赖库。构建应用程序可以像搭积木一样进行。
+源码和构建目录分离：构建过程中生成的中间文件都会被放置在构建目录ruxgo_bld/中，防止构建过程中文件冲突和混乱。
友好的编译错误诊断：使用更友好的编译器错误输出显示，包括清晰的错误提示、指向源代码行数等信息。
+[targets] 模块是 Toml 的核心部分，主要用于描述源代码的构建过程和库之间的依赖关系，如下所示:
+name: 指定目标的名称，如果是 “dll” 类型，必须以 “lib_” 开头。
src: 指定目标源代码的路径，会递归构建该目录下的所有源文件。
src_only: 可选。如果你只想使用src中的某些源文件，可以在此处指定。
src_exclude: 可选。如果你想要排除src中的某些源文件或目录，可以在此处指定。
include_dir: 指定目标源代码的头文件路径，允许向量类型以支持多个头文件路径。
type: 指定目标的类型，可以是 “static”、“dll”、“object” 或 “exe”。需要注意的是，在一个 Toml 文件中只能有一个 “exe” 目标，但可以有多个其他类型的目标。
cflags: 指定目标的编译选项。
archive: 可选。如果目标类型是 “static”，你可以指定一个归档工具来创建静态库。
linker: 可选。指定用于链接动态库或其他目标文件的链接工具。如果该值缺失，则默认根据compiler指定。
ldflags: 指定目标的链接选项。
deps: 指定当前目标依赖的其他目标。
下面是 sqlite3 的 Toml 文件示例，具体运行可参考 apps/sqlite3 下的 README.md 。
带有库和可执行文件的示例文件（在本地运行）:
+[build]
+compiler = "gcc"
+
+[[targets]]
+name = "libsqlite3"
+src = "./sqlite-amalgamation-3410100"
+src_exclude = ["shell.c"]
+include_dir = "./sqlite-amalgamation-3410100"
+type = "static"
+cflags = "-w -DSQLITE_THREADSAFE=0 -DSQLITE_OMIT_FLOATING_POINT -DSQLITE_OMIT_LOAD_EXTENSION -DSQLITE_DEBUG"
+archive = "ar"
+ldflags = "rcs"
+
+[[targets]]
+name = "local_sqlite3"
+src = "./"
+src_exclude = ["sqlite-amalgamation-3410100"]
+include_dir = "./"
+type = "exe"
+cflags = ""
+ldflags = ""
+deps = ["libsqlite3"]
+带有库和可执行文件的示例文件（在ruxos上运行）:
+[build]
+compiler = "gcc"
+
+[os]
+name = "ruxos"
+services = ["fp_simd","alloc","paging","fs","blkfs"]
+ulib = "ruxlibc"
+
+[os.platform]
+name = "x86_64-qemu-q35"
+smp = "4"
+mode = "release"
+log = "error"
+
+[os.platform.qemu]
+blk = "y"
+graphic = "n"
+
+[[targets]]
+name = "libsqlite3"
+src = "./sqlite-amalgamation-3410100"
+src_exclude = ["shell.c"]
+include_dir = "./sqlite-amalgamation-3410100"
+type = "static"
+cflags = "-w -DSQLITE_THREADSAFE=0 -DSQLITE_OMIT_FLOATING_POINT -DSQLITE_OMIT_LOAD_EXTENSION -DSQLITE_DEBUG"
+archive = "ar"
+ldflags = "rcs"
+
+[[targets]]
+name = "ruxos_sqlite3"
+src = "./"
+src_exclude = ["sqlite-amalgamation-3410100"]
+include_dir = "./"
+type = "exe"
+cflags = ""
+linker = "rust-lld -flavor gnu"
+ldflags = ""
+deps = ["libsqlite3"]
+由于 C/C++ 项目需要处理复杂的项目配置，包括库依赖、编译选项、链接选项等，TOML 文件格式提供了一个清晰、结构化且易于理解的方式来组织这些信息。它使得开发者可以轻松地查看和编辑项目设置，同时确保这些设置的精确性和一致性。
+Ruxgo 采用 config_<platform>.toml 文件来配置各个项目（<platform>根据运行平台的不同而变化，例如 config_linux.toml 或 config_win32.toml）。此外，由于 TOML 的跨平台和语言无关特性，ruxgo 可以更容易地集成到不同的环境和工作流中，提高了其适应性和可扩展性。
config_<platform>.toml 文件由一个 [build] 模块和多个 [targets] 模块组成。如果你想在 RuxOS 上运行，可以添加 [os] 模块。
在深入探讨 Ruxgo 之前，有必要强调构建工具在任何软件开发项目中的重要性。构建工具不仅负责将源代码转换为可执行程序，还涉及依赖管理、自动化构建和测试、以及代码质量控制等关键环节。尤其对于 unikernel 操作系统，这些工具不仅需要支持标准的构建流程，还要适应 unikernel 的特殊要求，如高度的模块化、特定环境下的优化构建等。
+RuxOS ，作为一个基于 Rust 语言开发的轻量级 unikernel 操作系统，面临着独特的挑战和需求。初期，RuxOS 采用了 Make 构建工具，依赖其灵活性和广泛的应用兼容性，成功地开发并移植了一些 C/C++ 应用程序。但随着项目的发展，Make 的一些局限性开始显现。例如:
+因此，RuxOS 需要一个更加专业和高效的构建工具——这就是 Ruxgo 的起源。Ruxgo 是一个纯 Rust 编写的构建工具，与 RuxOS 完美融合。与其他 unikernel 操作系统类似，如 Unikraft 使用 Kraft，IncludeOS 使用 Conan，RuxOS 使用 Ruxgo 不仅解决了 Make 在现代软件开发中的局限性，还完全利用了 Rust 语言及其生态系统的优势。
+相较于原有的 Make 构建工具，Ruxgo 具有以下显著特点：
+ + +要安装ruxgo可执行文件，您首先需要安装 Rust 和 Cargo。按照Rust安装页面上的说明操作。Ruxgo 目前至少需要 Rust 1.74 版本。
一旦您安装了 Rust，就可以使用以下命令来构建和安装 Ruxgo:
+cargo install ruxgo
+这将自动从crates.io下载并构建 Ruxgo，并将其安装到 Cargo 的全局二进制目录（默认为~/.cargo/bin/）。
发布到 crates.io 的版本将稍微落后于 GitHub 上托管的版本。如果您需要最新版本，您可以自己构建 Ruxgo 的 git 版本：
+cargo install --git https://github.com/syswonder/ruxgo.git ruxgo
+注意:
+如果您在安装时遇到问题，可能需要安装一些构建依赖项，请参考 RuxOS 下的README.md.
+ +Ruxgo 是一个类似 Cargo 的构建工具，用于构建 C 和 C++ 应用程序。与传统的 Make 构建工具不同，Ruxgo 的构建过程仅依赖一个 Toml 文件，其摒弃了繁杂的语法和规则限制，使得编译过程回归到更为简洁的状态。如果你对 Makefile 感到疲倦，Ruxgo 绝对值得你尝试，它能让你的构建过程变得更加轻松和高效。
+要安装ruxgo可执行文件，您首先需要安装 Rust 和 Cargo。按照Rust安装页面上的说明操作。Ruxgo 目前至少需要 Rust 1.74 版本。
一旦您安装了 Rust，就可以使用以下命令来构建和安装 Ruxgo:
+cargo install ruxgo
+这将自动从crates.io下载并构建 Ruxgo，并将其安装到 Cargo 的全局二进制目录（默认为~/.cargo/bin/）。
发布到 crates.io 的版本将稍微落后于 GitHub 上托管的版本。如果您需要最新版本，您可以自己构建 Ruxgo 的 git 版本：
+cargo install --git https://github.com/syswonder/ruxgo.git ruxgo
+注意:
+如果您在安装时遇到问题，可能需要安装一些构建依赖项，请参考 RuxOS 下的README.md.
+本指南将为您提供有关如何使用 Ruxgo 开发 C/C++ 应用程序的所有信息。
+在深入探讨 Ruxgo 之前，有必要强调构建工具在任何软件开发项目中的重要性。构建工具不仅负责将源代码转换为可执行程序，还涉及依赖管理、自动化构建和测试、以及代码质量控制等关键环节。尤其对于 unikernel 操作系统，这些工具不仅需要支持标准的构建流程，还要适应 unikernel 的特殊要求，如高度的模块化、特定环境下的优化构建等。
+RuxOS ，作为一个基于 Rust 语言开发的轻量级 unikernel 操作系统，面临着独特的挑战和需求。初期，RuxOS 采用了 Make 构建工具，依赖其灵活性和广泛的应用兼容性，成功地开发并移植了一些 C/C++ 应用程序。但随着项目的发展，Make 的一些局限性开始显现。例如:
+因此，RuxOS 需要一个更加专业和高效的构建工具——这就是 Ruxgo 的起源。Ruxgo 是一个纯 Rust 编写的构建工具，与 RuxOS 完美融合。与其他 unikernel 操作系统类似，如 Unikraft 使用 Kraft，IncludeOS 使用 Conan，RuxOS 使用 Ruxgo 不仅解决了 Make 在现代软件开发中的局限性，还完全利用了 Rust 语言及其生态系统的优势。
+相较于原有的 Make 构建工具，Ruxgo 具有以下显著特点：
+Ruxgo 设计充分考虑构建过程的效率、可靠性和可维护性，同时充分适应 RuxOS 的构件化特性：
+多样化的编译选项：Ruxgo 支持多种编译器（如 GCC、Clang、MSVC）和多样化的中间过程（如生成静态库、动态库、目标文件等），为最佳性能提供灵活选择。
+增量与并行构建：通过增量构建，Ruxgo 只编译修改过的文件或模块，大幅缩短构建时间。同时利用多核处理器同时编译多个文件，实现并行构建，进一步提高效率。
+简化的配置文件：完全使用 Toml 文件来描述构建参数，避免使用复杂的语法和依赖规则的构建流程。开发者只专注于构建逻辑，而非配置文件的复杂性
+依赖管理与可移植性：结合包管理功能和 crate.io 生态来简化外部库和组件的依赖管理。同时代码尽量使用平台无关的 API，增强跨平台兼容性。
+构建过程模块化：构建过程以 Target 为中心，按照不同的 Target 模块来配置源文件和依赖库。构建应用程序可以像搭积木一样进行。
+源码和构建目录分离：构建过程中生成的中间文件都会被放置在构建目录ruxgo_bld/中，防止构建过程中文件冲突和混乱。
友好的编译错误诊断：使用更友好的编译器错误输出显示，包括清晰的错误提示、指向源代码行数等信息。
+首先，确保您的系统上已安装 ruxgo。如果尚未安装，请参考 Ruxgo 安装 。
+之后使用如下命令初始化一个 C 项目：
+ruxgo init my_project --c
+初始化完成后，切换到 my_project 目录，使用 ruxgo 构建并运行：
+ruxgo -b
+ruxgo -r
+如果您想在 RuxOS 上运行，将 my_project 下的config_<platform>.toml文件修改为如下:
[build]
+compiler = "gcc"
+
+[os]
+name = "ruxos"
+services = []
+ulib = "ruxlibc"
+
+[os.platform]
+name = "x86_64-qemu-q35"
+mode = "release"
+log = "info"
+
+[os.platform.qemu]
+graphic = "n"
+
+[[targets]]
+name = "main"
+src = "./src/"
+include_dir = "./src/include/"
+type = "exe"
+cflags = "-g -Wall -Wextra"
+linker = "rust-lld -flavor gnu"
+ldflags = ""
+deps = []
+之后将 my_project 复制到 ruxos/apps/c 目录下，切换到 my_project 目录，使用 ruxgo 构建并运行：
+ruxgo -b
+ruxgo -r
+由于 C/C++ 项目需要处理复杂的项目配置，包括库依赖、编译选项、链接选项等，TOML 文件格式提供了一个清晰、结构化且易于理解的方式来组织这些信息。它使得开发者可以轻松地查看和编辑项目设置，同时确保这些设置的精确性和一致性。
+Ruxgo 采用 config_<platform>.toml 文件来配置各个项目（<platform>根据运行平台的不同而变化，例如 config_linux.toml 或 config_win32.toml）。此外，由于 TOML 的跨平台和语言无关特性，ruxgo 可以更容易地集成到不同的环境和工作流中，提高了其适应性和可扩展性。
config_<platform>.toml 文件由一个 [build] 模块和多个 [targets] 模块组成。如果你想在 RuxOS 上运行，可以添加 [os] 模块。
[build] 模块描述了编译器的类型。它包含 compiler。
compiler: 指定编译器类型，例如: “gcc”。[targets] 模块是 Toml 的核心部分，主要用于描述源代码的构建过程和库之间的依赖关系，如下所示:
+name: 指定目标的名称，如果是 “dll” 类型，必须以 “lib_” 开头。
src: 指定目标源代码的路径，会递归构建该目录下的所有源文件。
src_only: 可选。如果你只想使用src中的某些源文件，可以在此处指定。
src_exclude: 可选。如果你想要排除src中的某些源文件或目录，可以在此处指定。
include_dir: 指定目标源代码的头文件路径，允许向量类型以支持多个头文件路径。
type: 指定目标的类型，可以是 “static”、“dll”、“object” 或 “exe”。需要注意的是，在一个 Toml 文件中只能有一个 “exe” 目标，但可以有多个其他类型的目标。
cflags: 指定目标的编译选项。
archive: 可选。如果目标类型是 “static”，你可以指定一个归档工具来创建静态库。
linker: 可选。指定用于链接动态库或其他目标文件的链接工具。如果该值缺失，则默认根据compiler指定。
ldflags: 指定目标的链接选项。
deps: 指定当前目标依赖的其他目标。
[os] 模块是可选的。如果你想在本地运行，[build] 和 [targets] 是完全满足，如果你想在 RuxOS 上运行，则需要添加[os] 模块。
+添加 [os] 模块后，原有 [targets] 模块的一些内容将会发生改变。例如:
+当 [os] 模块的平台是 “x86_64-qemu-q35” 时，编译器类型不再是 “gcc”，它将变成 “x86_64-linux-musl-gcc”。此外，所有 [targets] 的 cflags 都默认添加了 “-nostdinc -fno-builtin -ffreestanding -Wall”，当 [targets] 类型是 “exe” 时，ldflags 还默认添加了 “-nostdlib -static -no-pie –gc-sections”，你不需要去手动添加它们。当然，根据架构和平台的不同，还有其他默认的添加及改变。
+Ruxgo 这么做是为了，如果你能在本地跑通一个程序，那么只需要将定制的 [os] 模块拼接到你本地跑通的模块上，即可实现在 RuxOS 上流畅的运行，而不需要额外的操作!
+具体 [os] 模块描述如下:
+name: 指定操作系统的名称。
services: 指定操作系统可以提供的服务，类似于 RuxOS 中的 features。
ulib: 指定想要使用的用户库，可选项有: “ruxlibc”，“ruxmusl”。
platform: 如果需要，请在 [os.platform] 中进行配置。
如果你想进一步配置平台，可以在 [os.platform] 中实现。如果为空，则使用默认值。具体细节如下:
+name: 指定操作系统在哪个平台上运行，可选项有: “x86_64-qemu-q35”， “aarch64-qemu-virt”， “riscv64-qemu-virt”。默认值为 “x86_64-qemu-q35”。
smp: 指定cpu数量。默认值为 “1”。
mode: 指定构建模式，可选项有: “release”，“debug”。默认值为 “release”。
log: 指定日志级别，可选项有: “warn”，“error”，“info”，“debug” 和 “trace”。默认值为 “warn”。
v: 指定 verbose 级别，可选项有: “”，“1”，“2”。默认值为 “”。
qemu: 如果需要，请在 [os.platform.qemu] 中进行配置。
如果你的平台依赖于 qemu ，你需要在 [os.platform.qemu] 中进一步配置它。如果为空，则使用默认值。具体细节如下:
+blk: 指定是否启用存储设备（virtio-blk）。默认值为 “n”。
net: 指定是否启用网络设备（virtio-net）。默认值为 “n”。
graphic: 指定是否启用显示设备和图形输出（virtio-gpu）。默认值为“n“。
debug: 指定是否启用 gdb 服务，启用后监听本地 1234 端口。默认值为“n“。
disk_img: 指定虚拟磁盘镜像的路径。默认值为 “./disk_img”。
v9p: 指定是否启用 virtio-9p 设备。默认值为 “n”。
v9p_path: 指定 virtio-9p 后端的主机路径。默认值为 “./”。
qemu_log: 指定是否启用 QEMU 日志（日志文件为 “qemu.log” ）。默认值为 “n”。
net_dump: 指定是否启用网络包转储（日志文件为 “netdump.pcap” ）。默认值为 “n”。
net_dev: 指定 QEMU 网络设备后端类型: “user” 或 “tap”。默认值为 “user”。
ip: 指定 IPv4 地址。QEMU “user” 网络设备的默认值为 “10.0.2.15”。
gw: 指定 IPv4 地址的网关。QEMU “user” 网络设备的默认值为 “10.0.2.2”。
args: 指定命令行参数，以逗号分隔。它用于传递特定的变量，如argc、argv。默认值为 “”。
envs: 指定环境变量，键值对之间用逗号分隔。默认值为 “”。
下面是 sqlite3 的 Toml 文件示例，具体运行可参考 apps/sqlite3 下的 README.md 。
带有库和可执行文件的示例文件（在本地运行）:
+[build]
+compiler = "gcc"
+
+[[targets]]
+name = "libsqlite3"
+src = "./sqlite-amalgamation-3410100"
+src_exclude = ["shell.c"]
+include_dir = "./sqlite-amalgamation-3410100"
+type = "static"
+cflags = "-w -DSQLITE_THREADSAFE=0 -DSQLITE_OMIT_FLOATING_POINT -DSQLITE_OMIT_LOAD_EXTENSION -DSQLITE_DEBUG"
+archive = "ar"
+ldflags = "rcs"
+
+[[targets]]
+name = "local_sqlite3"
+src = "./"
+src_exclude = ["sqlite-amalgamation-3410100"]
+include_dir = "./"
+type = "exe"
+cflags = ""
+ldflags = ""
+deps = ["libsqlite3"]
+带有库和可执行文件的示例文件（在ruxos上运行）:
+[build]
+compiler = "gcc"
+
+[os]
+name = "ruxos"
+services = ["fp_simd","alloc","paging","fs","blkfs"]
+ulib = "ruxlibc"
+
+[os.platform]
+name = "x86_64-qemu-q35"
+smp = "4"
+mode = "release"
+log = "error"
+
+[os.platform.qemu]
+blk = "y"
+graphic = "n"
+
+[[targets]]
+name = "libsqlite3"
+src = "./sqlite-amalgamation-3410100"
+src_exclude = ["shell.c"]
+include_dir = "./sqlite-amalgamation-3410100"
+type = "static"
+cflags = "-w -DSQLITE_THREADSAFE=0 -DSQLITE_OMIT_FLOATING_POINT -DSQLITE_OMIT_LOAD_EXTENSION -DSQLITE_DEBUG"
+archive = "ar"
+ldflags = "rcs"
+
+[[targets]]
+name = "ruxos_sqlite3"
+src = "./"
+src_exclude = ["sqlite-amalgamation-3410100"]
+include_dir = "./"
+type = "exe"
+cflags = ""
+linker = "rust-lld -flavor gnu"
+ldflags = ""
+deps = ["libsqlite3"]
+当您开始一个新项目时，通常需要一些基本的框架设置。ruxgo 提供了 init 命令来帮助您快速开始一个新的 C 或 C++ 项目。
要初始化一个新项目，使用以下命令：
+ruxgo init <项目名称> [--c] [--cpp]
+<项目名称>: 指定新项目的名称。--c: 初始化一个 C 语言项目。--cpp: 初始化一个 C++ 语言项目。注意：--c 和 --cpp 选项不能同时使用。如果都不指定，则默认创建一个 C++ 项目。
当运行 ruxgo init 命令后，将会在当前目录下创建一个新的项目目录，其中包括以下内容：
<项目名称>/
+├── src/
+│ ├── main.c 或 main.cpp
+│ └── include/
+├── .gitignore
+├── README.md
+├── LICENSE
+└── config_<platform>.toml
+src/：包含所有源代码文件和配置文件。src/include：用于存放头文件。.gitignore：用于指定 git 忽略的文件和目录。README.md 和 LICENSE：项目的基本文档。config_<platform>.toml：项目的配置文件，根据运行平台的不同而变化（例如 config_linux.toml 或 config_win32.toml）。初始化一个名为 “my_project” 的 C++ 项目：
+ruxgo init my_project --cpp
+初始化一个名为 “my_project” 的 C 项目：
+ruxgo init my_project --c
+--help 选项可以查看更多命令帮助。ruxgo init 将不会继续执行，并显示错误信息。config_<platform>.toml 文件，您可以自定义编译器选项和其他构建设置。ruxgo pkg 命令用于管理软件包，包括列出、拉取、更新和清理软件包等。
要使用 ruxgo pkg 命令，您可以执行以下操作：
ruxgo pkg [选项]
+可选项如下：
+-l, --list: 列出远程仓库中可用的软件包。-p, --pull <PKG_NAME>: 从远程仓库拉取特定软件包。-r, --run <APP_BIN>: 运行特定的应用程序二进制文件。-u, --update <PKG_NAME>: 更新特定软件包。-c, --clean <PKG_NAME>: 清理特定软件包。--clean-all: 清理所有软件包。-h, --help: 打印帮助信息。下载的文件保存在 ruxgo_pkg/ 目录中，具体内容如下：
app-bin/: 存放 app 可执行文件及其对应脚本。ruxos/: ruxos 存储位置。rux-*/: app 源码存储位置。cache/: 存放 packages 信息的缓存。列出所有可用的软件包：
+ruxgo pkg --list
+从远程仓库拉取名为 “example_pkg” 的软件包：
+ruxgo pkg --pull example_pkg
+更新名为 “example_pkg” 的软件包：
+ruxgo pkg --update example_pkg
+清理名为 “example_pkg” 的软件包：
+ruxgo pkg --clean example_pkg
+清理所有软件包：
+ruxgo pkg --clean-all
+--help 选项可以查看更多命令帮助。ruxgo help 命令用于显示 ruxgo 工具的帮助信息，包括其各个子命令的详细说明。
要获取 ruxgo 工具或其任一子命令的帮助信息，您可以执行以下操作：
ruxgo help [子命令]
+显示 ruxgo 的总体帮助信息：
ruxgo help
+查看关于 init 命令的详细帮助：
ruxgo help init
+查看关于 pkg 命令的详细帮助：
ruxgo help pkg
+ruxgo help 将显示 ruxgo 工具的总体帮助信息，包括所有可用的命令和选项。ruxgo help init，将显示该特定子命令的详细帮助信息。ruxgo -b 命令用于构建您的项目，需确保当前目录下存在 config_<platform>.toml。
要构建当前项目，您可以执行以下操作：
+ruxgo -b [--path <路径>] [--gen-cc] [--gen-vsc]
+--path <路径>: 指定一个特定的目录（需存在 config_<platform>.toml）来执行构建操作。如果不提供，则默认在当前目录下执行。--gen-cc: 生成 compile_commands.json 文件，它包含了编译项目的所有命令。--gen-vsc: 生成 Visual Studio Code 的配置文件 .vscode/c_cpp_properties.json，它包含了项目的编译器配置和头文件路径。当执行 ruxgo -b 命令后，将会在当前目录下创建一个名为 ruxgo_bld/ 的构建目录，包括以下内容：
ruxgo_bld/
+├── bin/
+├── obj_linux/ 或 obj_win32/
+├── target/
+├── *.hash
+├── compile_commands.json (如果启用了gen_cc)
+├── .vscode/c_cpp_properties.json (如果启用了gen_vsc)
+└── ruxmusl/ (如果使用了ruxmusl用户库)
+bin/： 存放构建过程中生成的静态库、动态库、目标文件或可执行文件 。obj_linux/obj_win32： 存放编译源码生成的中间对象文件 （ *.o ）。target： 存放构建 ruxos 后生成的 target 文件。*.hash： 存放构建过程中生成的 hash 文件，用来实现增量构建。compile_commands.json： 存放构建过程中的所有编译命令，如果启用了 gen_cc。.vscode/c_cpp_properties.json： 存放项目的 vscode 配置，如果启用了 gen_vsc。ruxmusl/： 存放构建 ruxmusl 后生成的中间文件及静态库，如果使用了 ruxmusl 。ruxgo -r 命令用于运行项目中的可执行文件，需确保当前目录下存在 config_<platform>.toml。
要运行构建的项目，您可以执行以下操作：
+ruxgo -r [--path <路径>] [--bin-args <参数列表>]
+--path <路径>: 指定一个特定的目录（需存在 config_<platform>.toml）来执行运行操作。如果不提供，则默认在当前目录下执行。--bin-args=<参数列表>: 提供一系列运行时参数传递给项目的可执行文件，参数跟在=后面且以逗号分隔。执行 ruxgo -r 命令后，将会运行 bin/ 目录下的可执行文件。需要确保在执行目录下存在正确的配置文件，或者使用 --path 指定包含这些文件的目录。
ruxgo -c 命令用于清理项目，需确保当前目录下存在 config_<platform>.toml。
要清理构建的项目，您可以执行以下操作：
+ruxgo -c [--path <路径>]
+--path <路径>: 指定一个特定的目录（需存在 config_<platform>.toml）来执行清理操作。如果不提供，则默认在当前目录下执行。执行 ruxgo -c 命令后，ruxgo 提供了一个多选界面，让用户选择要清理的过程文件，按下 Esc 键则退出当前命令，按下空格（Space）键则选中要清理的项目。具体内容如下：
All/： 删除项目所有内容。App_bins/： 删除构建的 app 可执行文件及其相关库。Obj/： 删除编译源码生成的中间对象文件（*.o）。OS/： 删除 ruxos 的构建目录。Ulib/： 删除 Ulib 的构建内容，如 ruxlibc 或 ruxmusl。需要确保在执行目录下存在正确的配置文件，或者使用 --path 指定包含这些文件的目录。
在ruxgo/apps/目录下放置了所有经过测试的 Toml 文件。目前，有两种方法构建应用程序：
如果在本地构建，你只需要在ruxgo/apps/<name>/local目录下下载 app 的源代码，然后使用 ruxgo 构建并运行它。
如果在 RuxOS 上构建，你需要将config_linux.toml从ruxgo/apps/<name>/ruxos复制到ruxos/apps/c/<name>，然后下载 app 的源代码并使用 ruxgo 来构建并运行它。
注: 有关详细信息，请参阅每个 app 目录下的 README.md。以下应用程序已获支持:
+ + +在ruxgo/apps/目录下放置了所有经过测试的 Toml 文件。目前，有两种方法构建应用程序：
如果在本地构建，你只需要在ruxgo/apps/<name>/local目录下下载 app 的源代码，然后使用 ruxgo 构建并运行它。
如果在 RuxOS 上构建，你需要将config_linux.toml从ruxgo/apps/<name>/ruxos复制到ruxos/apps/c/<name>，然后下载 app 的源代码并使用 ruxgo 来构建并运行它。
注: 有关详细信息，请参阅每个 app 目录下的 README.md。以下应用程序已获支持:
+ + +