lux-cli-util-man(1)

✨ NAME ✨

okay so this is the manpage for lux-cli-util-man, bestie — it lives in the General Commands Manual, and its whole iconic job is: Generate manpages. That’s it. That’s the assignment. 💅

🛠️ SYNOPSIS 🛠️

lux-cli util man <--target-dir> [--server] [--extra-servers]
[--namespace] [--lua-dir] [--lua-version] [--tree] [--cache-dir]
[--data-dir] [--variables] [--profile] [--verbose] [--no-progress]
[--no-prompt] [--preset] [--nvim] [--no-tfa] [--timeout] [--max-jobs]
[--no-luarc] [--no-wrap-bin] [--user-agent] [-h|--help]

💖 DESCRIPTION 💖

Generate manpages — yes girl, that is literally the description. lux-cli util man is the utility command that generates manpages, and we are obsessed with the simplicity. 🎀

🌸 OPTIONS 🌸

• --target-dir <TARGET_DIR> — The target directory in which to save man pages. This is where the manpage magic gets dropped, no cap. 📁
• --server <server> — Fetch rocks/rockspecs from this server (takes priority over config file). She said “config file who?” — this one wins. 👑
• --extra-servers <extra-server> — Fetch rocks/rockspecs from these servers in addition to the main server. Overrides any entries in the config file. Extra servers, extra flavor. ✨
• --namespace <namespace> — Specify the luarocks server namespace to use. Keep the lowercase luarocks exactly as-is, bestie.
• --lua-dir <prefix> — Specify the directory in which to install Lua if not found. Gotta know where Lua lives. 🐍
• --lua-version <ver> — Which Lua installation to use. Valid versions are: '5.1', '5.2', '5.3', '5.4', '5.5', 'jit' and 'jit52'. If not set, Lux will attempt to detect the Lua version:
  • From the current project, if it has an exact Lua version requirement.
  • From the Lua installation that is available on the PATH.
• --tree <tree> — Which tree to operate on. In a workspace, this can be used to specify a detached workspace tree. tree behavior, very demure. 🌳
• --cache-dir <cache-dir> — Specifies the cache directory, e.g. for luarocks manifests. Cache girl summer. 💾
• --data-dir <data-dir> — Specifies the data directory, in which the default user install tree resides (e.g. ~/.local/share/lux). Home sweet data home. 🏠
• --variables <variable> — Override config variables. Example: lx -v "LUA=/path/to/lua" ... — yes, keep the quotes and the ..., it’s giving exact example energy. 🫶
• --profile <profile> — The build profile to use when compiling packages. Default: release. Possible values:
  • release
  • dev
• --verbose — Display verbose output of commands executed, enabling DEBUG logs. To enable TRACE logs, set RUST_LOG=trace. Talkative queen. 🗣️
• --no-progress — Don’t print any progress bars or spinners. No little animations, just vibes.
• --no-prompt <NO_PROMPT> — Skip prompts, selecting the default option. Prompting is enabled by default in terminal/TTY environments. Possible values:
  • true
  • false
• --preset <preset> — Configure Lux for a specific environment. Valid presets are: 'nvim'. Possible values:
  • nvim: Configure Lux for Neovim plugins
• --nvim — [DEPRECATED] Configure lux for installing Neovim packages. Use --preset nvim instead. She’s deprecated but still cute — please use the preset, bestie. 🫠
• --no-tfa — Disable prompts for two-factor authentication (2FA) codes. It is strongly recommended to enable 2FA instead see (https://luarocks.org/settings/two-factor-auth). Security princess behavior: enable 2FA. 🔐
• --timeout <seconds> — Timeout on network operations, in seconds. 0 means no timeout (wait forever). Default is 30. Waiting forever is a choice, and Lux will let you make it. 💀
• --max-jobs <MAX_JOBS> — Maximum buffer size for parallel jobs, such as downloading rockspecs and installing rocks. 0 means no limit. Default is 0. Parallel jobs go brrr. 🔥
• --no-luarc — Do not generate or update a .luarc.json file when building a project. No .luarc.json, no problem. 🚫
• --no-wrap-bin — Do not wrap Lua bin scripts. Keep those bin scripts exactly as they are.
• --user-agent <USER_AGENT> — The user agent to set when making web requests. Default is "lux/<version>". Internet manners, but make it branded. 🌐
• -h, --help — Print help (see a summary with -h). When in doubt, ask for help — literally. 🙋‍♀️

footer check bestie: it says man and lux-cli-util-man(1) — that’s the source/version/date situation this page gives us, so byeee 🫶💖