نام (NAME)

uncrustify - زیباساز و مرتب‌ساز کدهای منبع C، C++، C#، D، Java و Pawn

خلاصه دستور (SYNOPSIS)

uncrustify [OPTIONS] [FILES]

توضیحات (DESCRIPTION)

اگر هیچ فایل ورودی مشخص نشود، ورودی از stdin خوانده می‌شود.
در صورت خواندن از stdin، باید زبان را با استفاده از -l مشخص کنید.

اگر -F استفاده شود یا فایل‌ها در خط فرمان مشخص شده باشند، نام فایل خروجی PFX + "/" + filename + SFX خواهد بود.
مگر آنکه البته از گزینه‌های --replace یا --no-backup استفاده شده باشد.

هنگام خواندن از stdin یا پردازش یک فایل منفرد با گزینهٔ '-f'، خروجی به stdout فرستاده می‌شود، مگر اینکه با -o FILE تغییر مسیر داده شود.

خطاها همیشه به stderr فرستاده می‌شوند.

گزینه‌ها (OPTIONS)

گزینه‌های پایه (Basic Options):

-c CFG: استفاده از فایل پیکربندی CFG، یا مقادیر پیش‌فرض اگر CFG برابر '-' تنظیم شده باشد.
در صورت عدم تعیین، uncrustify از $UNCRUSTIFY_CONFIG یا $HOME/.uncrustify.cfg استفاده خواهد کرد.
-f FILE: پردازش فایل منفرد FILE و ارسال خروجی به stdout یا فایل مشخص‌شده با -o.
-o FILE: تغییر مسیر خروجی به FILE.
استفاده به همراه -f، --update-config، --update-config-with-doc، --universalindent.
--check: متن جدید را در خروجی چاپ نمی‌کند، بلکه بررسی می‌کند که آیا هنگام پردازش فایل(ها) تغییری ایجاد می‌شود یا خیر. وضعیت هر فایل در stderr چاپ می‌شود. اگر تغییری رخ ندهد کد وضعیت خروج EXIT_SUCCESS و در غیر این صورت EXIT_FAILURE خواهد بود.
-F FILE: خواندن نام فایل‌های مورد پردازش از FILE، یک نام فایل در هر خط. اگر FILE برابر ´-´ باشد، نام فایل‌ها به جای فایل از ورودی استاندارد خوانده می‌شوند.
می‌توانید این فایل را با دستوری مانند ´find . -name "*.c" > list.txt´ بسازید.
این گزینه با -f قابل جمع نیست.
--prefix PFX: افزودن پیشوند PFX به مسیر نام فایل خروجی.
این گزینه با -f، --replace یا --no-backup قابل جمع نیست.
--suffix SFX: افزودن پسوند SFX به نام فایل خروجی.
اگر هیچ‌کدام از SFX یا PFX مشخص نشده باشند، مقدار پیش‌فرض '.uncrustify' است.
این گزینه با -f، --replace یا --no-backup قابل جمع نیست.
--frag: فرض را بر این می‌گذارد که ورودی یک قطعه‌کد است و خط اول تورفتگی مناسب دارد.
--replace: جایگزینی فایل‌های منبع (یک نسخهٔ پشتیبان ایجاد می‌کند).
این گزینه با -f، --prefix یا --suffix قابل جمع نیست.
--no-backup: جایگزینی فایل‌ها بدون ایجاد نسخهٔ پشتیبان. زمانی که فایل‌ها تحت سامانه کنترل نسخه هستند بسیار کاربردی است.
این گزینه با -f، --prefix یا --suffix قابل جمع نیست.
--if-changed: نوشتن در stdout (یا ساخت FILE خروجی) فقط در صورتی که تغییری شناسایی شود.
--mtime: حفظ زمان تغییر (mtime) در فایل‌های جایگزین‌شده.
-l: تعیین صریح زبان: C، CPP، D، CS، JAVA، PAWN، VALA، OC، OC+
-t: بارگذاری یک فایل حاوی انواع داده‌ای (معمولاً مورد نیاز نیست)
-q: حالت بی‌صدا - عدم ارسال خروجی به stderr (گزینهٔ -L اولویت دارد)

گزینه‌های پیکربندی/راهنما (Config/Help Options):

-h -? --help --usage: چاپ این پیام و خروج
--version: چاپ نسخه و خروج
--count-options: چاپ تعداد گزینه‌های در دسترس و خروج
--show-config: چاپ مستندات گزینه‌ها و خروج
--update-config: تولید یک فایل پیکربندی جدید.
--update-config-with-doc: تولید یک فایل پیکربندی جدید همراه با توضیحات تعبیه‌شدهٔ مربوط به نحوهٔ استفاده.
--universalindent: تولید یک فایل پیکربندی برای Universal Indent GUI.
--detect: تشخیص پیکربندی از روی یک فایل منبع. به همراه '-f FILE' استفاده شود. تشخیص در حال حاضر نسبتاً محدود است.
--tracking space:FILE: آماده‌سازی اطلاعات ردگیری فاصله‌ها برای اشکال‌زدایی.
--tracking nl:FILE: آماده‌سازی اطلاعات ردگیری خطوط جدید برای اشکال‌زدایی.
--tracking start:FILE: آماده‌سازی اطلاعات ردگیری آغاز دستورها برای اشکال‌زدایی. با گزینهٔ -o قابل استفاده نیست.

گزینه‌های اشکال‌زدایی (Debug Options):

-p FILE: تخلیه اطلاعات اشکال‌زدایی در FILE، یا به stdout اگر FILE برابر '-' باشد.
باید در ترکیب با '-f FILE' استفاده شود.
-ds FILE --dump-steps FILE: تخلیه اطلاعات تجزیه در مراحل گوناگون فرایند قالب‌بندی.
این گزینه مجموعه‌ای از فایل‌ها به نام 'FILE_nnn.log' ایجاد می‌کند که هر کدام
متناظر با یک مرحله از قالب‌بندی در uncrustify هستند.
فایل 'FILE_000.log' گزینه‌های قالب‌بندی مورد استفاده را فهرست می‌کند.
باید در ترکیب با '-f FILE' استفاده شود.
-L SEV: تنظیم شدت لاگ (به log_levels.h مراجعه کنید)
-s: نمایش شدت لاگ در پیام‌های لاگ
--decode FLAG: چاپ FLAG به‌صورت متنی و خروج

مثال‌ها (EXAMPLES)

خواندن یک فایل D از stdin، خروجی به stdout.: cat foo.d | uncrustify -q -c my.cfg -l d
پردازش یک فایل، خروجی به stdout.: uncrustify -c my.cfg -d foo.d
پردازش یک درخت منبع، خروجی در درختی دیگر.: find src -name "*.[ch]" > files.txt
uncrustify -c my.cfg -F files.txt --prefix out
پردازش در‌جای (in‐place) یک درخت منبع.: uncrustify -c my.cfg --no-backup $(find src -name "*.[ch]")

نکات (NOTES)

از یادداشت‌های حاوی ' *INDENT-OFF*' و ' *INDENT-ON*' برای غیرفعال کردن پردازش بخش‌هایی از فایل منبع استفاده کنید.

نویسندگان (AUTHORS)

نوشته‌شده توسط Ben Gardner

گزارش باگ‌ها (BUGS)

از سامانه پیگیری اشکالات در http://sourceforge.net/projects/uncrustify استفاده کنید

کپی‌رایت و تکثیر (COPYRIGHT)

حق نشر 2006‐2014 متعلق به Ben Gardner است.
حق نشر 2015, 2016 متعلق به Guy Maurel است.

مجوز (LICENSE)

مجوز گنو GPL نسخهٔ ۲ یا بالاتر http://gnu.org/licenses/gpl.html

این یک نرم‌افزار آزاد است؛ برای شرایط رونوشت‌برداری به کد منبع مراجعه کنید. هیچ‌گونه ضمانتی وجود ندارد؛ حتی برای قابلیت فروش یا تناسب با یک هدف خاص.