.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.TH lx 1 "lux-cli 0.43.5"
.SH "نام (NAME)"
lx \- مدیر بسته‌ای مجلل و مدرن برای زبان لُوآ (Lua)
.SH "خلاصه دستور (SYNOPSIS)"
\fBlx\fR [\fB\-\-dev\fR] [\fB\-\-server\fR] [\fB\-\-extra\-servers\fR] [\fB\-\-namespace\fR] [\fB\-\-lua\-dir\fR] [\fB\-\-lua\-version\fR] [\fB\-\-tree\fR] [\fB\-\-cache\-dir\fR] [\fB\-\-data\-dir\fR] [\fB\-\-vendor\-dir\fR] [\fB\-\-variables\fR] [\fB\-\-profile\fR] [\fB\-\-verbose\fR] [\fB\-\-no\-progress\fR] [\fB\-\-no\-prompt\fR] [\fB\-\-nvim\fR] [\fB\-\-no\-tfa\fR] [\fB\-\-timeout\fR] [\fB\-\-max\-jobs\fR] [\fB\-\-no\-luarc\fR] [\fB\-\-no\-wrap\-bin\fR] [\fB\-\-user\-agent\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR] <\fIsubcommands\fR>
.SH "توضیحات (DESCRIPTION)"
یک مدیر بسته مجلل و مدرن برای زبان لُوآ (Lua).
.SH "گزینه‌ها (OPTIONS)"
.TP
\fB\-\-dev\fR
فعال‌سازی مخازن فرعی در سرورهای luarocks برای مشخصات بسته‌های (rockspecs) نسخه‌های در حال توسعه.
.TP
\fB\-\-server\fR \fI<server>\fR
دریافت بسته‌ها (rocks) یا مشخصات بسته‌ها (rockspecs) از این سرور (دارای اولویت بالاتر نسبت به فایل پیکربندی).
.TP
\fB\-\-extra\-servers\fR \fI<extra\-server>\fR
دریافت بسته‌ها یا مشخصات بسته‌ها از این سرورها علاوه بر سرور اصلی (تنظیمات موجود در فایل پیکربندی را نادیده می‌گیرد).
.TP
\fB\-\-namespace\fR \fI<namespace>\fR
تعیین فضای‌نام (namespace) سرور luarocks برای استفاده.
.TP
\fB\-\-lua\-dir\fR \fI<prefix>\fR
تعیین دایرکتوری مورد نظر برای نصب Lua در صورتی که یافت نشود.
.TP
\fB\-\-lua\-version\fR \fI<ver>\fR
تعیین اینکه از کدام نسخه نصب‌شده Lua استفاده شود.
نسخه‌های معتبر عبارتند از: \*(Aq5.1\*(Aq، \*(Aq5.2\*(Aq، \*(Aq5.3\*(Aq، \*(Aq5.4\*(Aq، \*(Aq5.5\*(Aq، \*(Aqjit\*(Aq و \*(Aqjit52\*(Aq.
اگر تنظیم نشده باشد، Lux تلاش می‌کند نسخه Lua را شناسایی کند:
.sp
\(bu از پروژه جاری، در صورتی که نیازمندی دقیق نسخه Lua در آن مشخص شده باشد.
.br
\(bu از نسخه نصب‌شده Lua که در متغیر محیطی PATH در دسترس است.
.TP
\fB\-\-tree\fR \fI<tree>\fR
مشخص کردن درختی که عملیات روی آن انجام می‌شود. در یک فضای کاری (workspace)، می‌توان از این گزینه برای مشخص کردن یک درخت فضای کاری مستقل (detached) استفاده کرد.
.TP
\fB\-\-cache\-dir\fR \fI<cache\-dir>\fR
مشخص کردن دایرکتوری حافظه موقت (کَش)، برای مثال برای مانیفست‌های luarocks.
.TP
\fB\-\-data\-dir\fR \fI<data\-dir>\fR
مشخص کردن دایرکتوری داده، که درخت نصب پیش‌فرض کاربر در آن قرار دارد (مانند ‎~/.local/share/lux).
.TP
\fB\-\-vendor\-dir\fR \fI<vendor\-dir>\fR
مشخص کردن دایرکتوری حاوی سورس‌کدها و RockSpecهای محلی مستقل (vendored). هنگام ساخت یا نصب یک بسته با این فلگ، Lux منابع را به جای سرور راه دور، از \fI<vendor\-dir>\fR دریافت خواهد کرد.
.TP
\fB\-\-variables\fR \fI<variable>\fR
بازنویسی متغیرهای پیکربندی.
مثال:
.sp
.B lx \-v "LUA=/path/to/lua" ...
.TP
\fB\-\-profile\fR \fI<profile>\fR
پروفایل ساخت مورد استفاده هنگام کامپایل بسته‌ها. پیش‌فرض: \fBrelease\fR
.sp
\fIمقادیر ممکن:\fR
.sp
\(bu release
.br
\(bu dev
.TP
\fB\-\-verbose\fR
نمایش خروجی پرجزئیات از دستورات اجرا شده و فعال‌سازی لاگ‌های DEBUG. برای فعال‌سازی لاگ‌های TRACE، متغیر محیطی \fBRUST_LOG=trace\fR را تنظیم کنید.
.TP
\fB\-\-no\-progress\fR
عدم چاپ نوارهای پیشرفت یا نشانگرهای چرخان (spinners).
.TP
\fB\-\-no\-prompt\fR \fI<NO_PROMPT>\fR
رد کردن اعلان‌ها و انتخاب گزینه پیش‌فرض. نمایش اعلان‌ها به‌طور پیش‌فرض در محیط‌های ترمینال/TTY فعال است.
.sp
\fIمقادیر ممکن:\fR
.sp
\(bu true
.br
\(bu false
.TP
\fB\-\-nvim\fR
پیکربندی lux برای نصب بسته‌های نئوویما (Neovim).
.TP
\fB\-\-no\-tfa\fR
غیرفعال کردن اعلان‌های کد احراز هویت دومرحله‌ای (2FA). اکیداً توصیه می‌شود به جای آن 2FA را فعال کنید؛ ببینید:
https://luarocks.org/settings/two\-factor\-auth
.TP
\fB\-\-timeout\fR \fI<seconds>\fR
مدت‌زمان انتظار برای عملیات‌های شبکه، بر حسب ثانیه. مقدار 0 به معنای عدم وجود محدودیت زمانی است (انتظار نامحدود). مقدار پیش‌فرض 30 است.
.TP
\fB\-\-max\-jobs\fR \fI<MAX_JOBS>\fR
حداکثر اندازه بافر برای کارهای موازی، مانند دانلود rockspecها و نصب بسته‌ها. مقدار 0 به معنای نامحدود است. مقدار پیش‌فرض 0 است.
.TP
\fB\-\-no\-luarc\fR
عدم تولید یا به‌روزرسانی فایل \fB.luarc.json\fR هنگام ساخت یک پروژه.
.TP
\fB\-\-no\-wrap\-bin\fR
پوشش‌بندی نکردن (عدم wrap) اسکریپت‌های اجرایی \fBbin\fR در Lua.
.TP
\fB\-\-user\-agent\fR \fI<USER_AGENT>\fR
رشته عامل کاربر (User Agent) تنظیمی هنگام ارسال درخواست‌های وب. پیش‌فرض "lux/<version>" است.
.TP
\fB\-h\fR, \fB\-\-help\fR
چاپ پیام راهنما
.TP
\fB\-V\fR, \fB\-\-version\fR
چاپ نسخه برنامه
.SH "زیردستورها (SUBCOMMANDS)"
.TP
lux\-cli\-add(1)
افزودن یک وابستگی به پروژه جاری
.TP
lux\-cli\-build(1)
ساخت/کامپایل یک پروژه
.TP
lux\-cli\-check(1)
[آزمایشی] بررسی نوع داده‌ها (Type check) در پروژه جاری بر اساس حاشیه‌نویسی‌های EmmyLua/LuaCATS. از فایل‌های \fB.emmyrc.json\fR و \fB.luarc.json\fR در دایرکتوری پروژه پیروی می‌کند.
.TP
lux\-cli\-config(1)
تعامل با پیکربندی lux
.TP
lux\-cli\-debug(1)
دستورات داخلی برای اشکال‌زدایی خود ابزار Lux
.TP
lux\-cli\-dist(1)
آماده‌سازی پروژه Lux برای توزیع
.TP
lux\-cli\-doc(1)
نمایش مستندات مربوط به یک بسته (rock) نصب‌شده
.TP
lux\-cli\-download(1)
دانلود یک فایل بسته (rock) خاص از سرور luarocks
.TP
lux\-cli\-fmt(1)
فرمت‌بندی کدهای پروژه با استفاده از stylua
.TP
lux\-cli\-generate\-rockspec(1)
تولید یک فایل rockspec از روی یک پروژه
.TP
lux\-cli\-info(1)
نمایش متادیتا برای هر بسته (rock)
.TP
lux\-cli\-install(1)
نصب یک بسته (rock) برای استفاده در سیستم
.TP
lux\-cli\-install\-rockspec(1)
نصب یک rockspec محلی برای استفاده در سیستم
.TP
lux\-cli\-install\-lua(1)
نصب دستی و مدیریت هدرهای Lua برای نسخه‌های مختلف Lua
.TP
lux\-cli\-lint(1)
بررسی خطاهای ساختاری (Lint) در پروژه جاری با استفاده از \fBluacheck\fR
.TP
lux\-cli\-list(1)
فهرست کردن بسته‌های (rocks) نصب‌شده فعلی
.TP
lux\-cli\-lua(1)
اجرای lua با تنظیم متغیرهای \fBLUA_PATH\fR و \fBLUA_CPATH\fR بر روی درخت lux مشخص‌شده
.TP
lux\-cli\-new(1)
ایجاد یک پروژه جدید Lua
.TP
lux\-cli\-outdated(1)
فهرست کردن بسته‌های قدیمی
.TP
lux\-cli\-pack(1)
ایجاد یک بسته فشرده (packed rock) برای توزیع، با بسته‌بندی سورس‌کدها یا فایل‌های باینری
.TP
lux\-cli\-path(1)
بازگرداندن مسیر بسته‌های پیکربندی‌شده فعلی
.TP
lux\-cli\-pin(1)
سنجاق کردن یک بسته موجود، جهت جلوگیری از هرگونه به‌روزرسانی آن بسته
.TP
lux\-cli\-purge(1)
حذف تمام بسته‌های نصب‌شده از یک درخت
.TP
lux\-cli\-remove(1)
حذف یک بسته از وابستگی‌های \fBlux.toml\fR در پروژه جاری
.TP
lux\-cli\-run(1)
اجرای پروژه جاری با آرگومان‌های ارائه‌شده
.TP
lux\-cli\-exec(1)
اجرای دستوری که توسط lux نصب شده است. اگر دستور پیدا نشود، بسته‌ای هم‌نام با آن دستور نصب خواهد شد.
.TP
lux\-cli\-search(1)
جستجو در سرورهای luarocks
.TP
lux\-cli\-test(1)
اجرای مجموعه آزمون‌ها در دایرکتوری پروژه جاری.
ابزار Lux از باطن‌های آزمون (test backends) زیر که در جدول \fB[test]\fR فایل \fBlux.toml\fR تعیین می‌شوند، پشتیبانی می‌کند:
.sp
\fB\- busted:\fR
.sp
https://lunarmodules.github.io/busted
.sp
مثال:
.EX
[test]
type = "busted"
flags = [ ] # گزینه‌های خط فرمان اختیاری برای ارسال به busted
.EE
.sp
در صورتی که باطن آزمون تعیین نشده باشد، دستور \fBlx test\fR به‌طور پیش‌فرض از \fBbusted\fR استفاده خواهد کرد اگر:
.sp
\(bu فایل \fB.busted\fR در ریشه پروژه وجود داشته باشد،
.br
\(bu یا \fBbusted\fR یکی از وابستگی‌های آزمون (\fItest_dependencies\fR) باشد.
.sp
\fB\- busted\-nlua:\fR
.br
[در حال حاضر در ویندوز دارای ایراد است]
یک باطن ساخت برای اجرای آزمون‌های busted با استفاده از نئوویما (Neovim) به عنوان مفسر Lua. برای آزمودن افزونه‌های نئوویما استفاده می‌شود.
.sp
مثال:
.EX
[test]
type = "busted-nlua"
flags = [ ] # گزینه‌های خط فرمان اختیاری برای ارسال به busted
.EE
.sp
در صورتی که باطن آزمون تعیین نشده باشد، دستور \fBlx test\fR به‌طور پیش‌فرض از \fBbusted\-nlua\fR استفاده خواهد کرد اگر:
.sp
\(bu فایل \fB.busted\fR در ریشه پروژه وجود داشته باشد،
.br
\(bu یا \fBbusted\fR و \fBnlua\fR جزو وابستگی‌های آزمون (\fItest_dependencies\fR) باشند.
.sp
\fB\- command:\fR
.br
نام یا مسیر فایل دستور شل که مجموعه آزمون را اجرا خواهد کرد.
.sp
مثال:
.EX
[test]
type = "command"
command = "make"
flags = [ "test" ]
.EE
.sp
\fB\- script:\fR
.br
مسیر نسبی به اسکریپت Lua که مجموعه آزمون را اجرا خواهد کرد.
.sp
مثال:
.EX
[test]
type = "script"
script = "tests.lua" # انتظار وجود فایل tests.lua در ریشه پروژه را دارد
flags = [ ] # آرگومان‌های اختیاری ارسالی به اسکریپت آزمون
.EE
.TP
lux\-cli\-uninstall(1)
حذف یک بسته از سیستم
.TP
lux\-cli\-unpin(1)
برداشتن سنجاق از یک بسته موجود، که اجازه به‌روزرسانی بسته را می‌دهد
.TP
lux\-cli\-update(1)
به‌روزرسانی تمامی بسته‌های یک پروژه
.TP
lux\-cli\-upload(1)
تولید یک rockspec برای پروژه Lux و آپلود آن به مخزن عمومی luarocks.
می‌توانید یک الگوی منبع (source template) برای بسته‌های انتشار (release) و توسعه (dev) در فایل \fBlux.toml\fR تعیین کنید.
.sp
مثال:
.EX
[source]
url = "https://host.com/owner/$(PACKAGE)/refs/tags/$(REF).zip"
dev = "git+https://host.com/owner/$(PACKAGE).git"
.EE
.sp
می‌توانید از متغیرهای زیر در الگوی منبع استفاده کنید:
.sp
\(bu \fB$(PACKAGE)\fR: نام بسته.
.br
\(bu \fB$(VERSION)\fR: نسخه بسته.
.br
\(bu \fB$(REF)\fR: برچسب (tag) یا بازنگری git (اگر در یک مخزن git باشد).
.br
\(bu همچنین می‌توانید متغیرهای محیطی را با \fB$(<VAR_NAME>)\fR تعیین کنید.
.sp
اگر مقدار \fBversion\fR در فایل \fBlux.toml\fR تنظیم نشده باشد، lux کامیت جاری را برای برچسب‌های SemVer جستجو کرده و در صورت یافتن، از آن برای تولید نسخه بسته استفاده می‌کند.
.TP
lux\-cli\-util(1)
دستورات کم‌کاربرد مانند تولید فایل‌های تکمیل خودکار دستورات شل و صفحات راهنما
.TP
lux\-cli\-vendor(1)
قرار دادن وابستگی‌های یک پروژه یا RockSpec به‌طور محلی و مستقل (Vendor کردن). هنگام ساخت یا نصب یک بسته با گزینه \fB\-\-vendor\-dir\fR یا گزینه پیکربندی \fB[vendor_dir]\fR، ابزار Lux سورس‌ها را به جای سرور راه دور، از \fI<vendor\-dir>\fR دریافت خواهد کرد.
.TP
lux\-cli\-which(1)
مشخص کردن اینکه کدام فایل با نام ماژول داده‌شده مطابقت دارد
.TP
lux\-cli\-shell(1)
اجرای یک شل تعاملی با متغیرهای محیطی تنظیم‌شده PATH، LUA_PATH، LUA_CPATH و LUA_INIT
.TP
lux\-cli\-sync(1)
همگام‌سازی درخت پروژه با \fBlux.toml\fR فعلی، جهت اطمینان از نصب صحیح تمامی بسته‌ها
.TP
lux\-cli\-help(1)
چاپ این پیام یا راهنمای زیردستور(های) داده‌شده
.SH "نسخه (VERSION)"
v0.43.5
.SH "نویسندگان (AUTHORS)"
vhyrro <vhyrro@gmail.com>, mrcjkb <marc@jakobi.dev>