mirror of
https://github.com/fluffos/fluffos
synced 2026-08-12 18:26:06 -04:00
c914f03d66
* docs: add local full-text search and a contributor README Add @easyops-cn/docusaurus-search-local to the Docusaurus site so the docs get an offline search bar (index built at build time, no external service). English and zh-CN pages are both indexed, and matched terms are highlighted on the target page. Add docs/README.md describing the Docusaurus setup, local dev/build commands, search behavior, directory layout, and gotchas; exclude it from the published site alongside CLAUDE.md. Point the root README's docs/ entry at it. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01TSzcESzU9947zkGzQ6SMmE * docs: remove dead framework leftovers, fix index generation, complete the nav Delete the VitePress (.vitepress/) and Jekyll (_layouts/, css/) leftovers, the one-shot migration scripts (fix_md_header.py, fix_seealso.py), and the stale keywords.json snapshot; prune the matching .gitignore entries and docusaurus exclude patterns. Rewrite gen_index.py for Docusaurus: it emitted dead .html links and legacy 'layout: doc' frontmatter, choked on non-markdown entries, and dropped nested categories — regenerating an index would have broken it. It now emits the extension-less links the site actually uses, links nested category indexes (restoring apply/* on the zh-CN index), and refuses to run on the docs root. Fix update_index.sh's copy-paste titles (zh-CN efun/build were titled 'APPLY'), stop it clobbering the hand-written lpc/index.md, and cover cli/. Regenerated indexes pick up the missing driver/ffi-plan entry. add_missing_efuns.py now takes the keywords.json path as an argument instead of requiring a stale copy. Move CNAME and the Google site-verification file into static/ so they actually reach the published build output. Complete the sidebar: link the CLI category to cli/index and add the missing portbind/symbol/generate_keywords pages, and expose the previously orphaned stdlib section under Reference. Promote onBrokenLinks to 'throw' now the build is warning-free, and drop the empty Demo section from the landing page. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01TSzcESzU9947zkGzQ6SMmE * docs: strip legacy 'layout: doc' frontmatter from all pages Mechanical sweep removing the Jekyll-era 'layout: doc' line from every doc page's frontmatter (Docusaurus ignores it), and the matching line from the templates in docs/CLAUDE.md so new pages don't reintroduce it. No content changes. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01TSzcESzU9947zkGzQ6SMmE --------- Co-authored-by: Claude <noreply@anthropic.com>
40 lines
No EOL
2 KiB
Markdown
40 lines
No EOL
2 KiB
Markdown
---
|
|
title: cli / driver
|
|
---
|
|
# cli / driver
|
|
|
|
`driver` is the main binary produced from FluffOS Project.
|
|
|
|
## Usage
|
|
|
|
```bash
|
|
./driver [flags] config_file
|
|
```
|
|
|
|
## Flags
|
|
|
|
| Flag | Description |
|
|
|--------------------------|---------------------------------------------------------------------------------------------------------------------------|
|
|
| `-f<flag>` | After initialization, before opening network connections, driver will call `void flag(string)` function on master object. |
|
|
| `-d<category>` | Enable debug logging, this flag can occur multiple times. This is same as calling `set_debug_level()` EFUN. |
|
|
| `--tracing <trace_file>` | Enable LPC tracing |
|
|
| `--generate-config` | Print a starter config file (all options, with defaults and comments) to stdout and exit. Redirect to a file to use it. |
|
|
|
|
## Debug logging Categories
|
|
|
|
| Category | Description |
|
|
|-----------------|--------------------------------------|
|
|
| `call_out` | Callouts |
|
|
| `d_flag` | Legacy combination of various events |
|
|
| `connections` | external connections |
|
|
| `mapping` | Mapping operations |
|
|
| `sockets` | LPC Sockets related logs |
|
|
| `comp_func_tab` | Compilation |
|
|
| `LPC` | LPC execution |
|
|
| `LPC_line` | LPC execution |
|
|
| `event` | Events |
|
|
| `dns` | DNS resolution logs |
|
|
| `file` | Filesystem operations |
|
|
| `add_action` | add_action packages related logs |
|
|
| `telnet` | Telnet protocol |
|
|
| `websocket` | Websocket protocol | |