.TH makeskel 1 "11 November 2004" "Free Pascal" "FPC unit description file generator"
.SH "نام (NAME)"
makeskel \- تولید فایل توصیف برای \fBfpdoc\fP

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

\fBmakeskel\fP [\-\-descr=filename] [\-\-disable-arguments] 
[\-\-disable-errors] [\-\-disable-function-results] 
[\-\-disable-private] [\-\-disable-protected] 
[\-\-disable-seealso] [\-\-emit-class-separator] 
[\-\-help] [\-\-lang=language] [\-\-output=filename] 
[\-\-update]
\-\-package=name \-\-input=cmdline

.SH "توضیحات (DESCRIPTION)"

.B makeskel
یک فایل منبع یونیت Free Pascal را پویش کرده و یک فایل توصیف اسکلتی (قالب اولیه) برای آن تولید می‌کند. این برنامه برای تمام شناسه‌های یافت‌شده در بخش interface یونیت، گره‌هایی ایجاد می‌کند؛ هرچند این رفتار با استفاده از برخی گزینه‌ها قابل تنظیم است. همچنین می‌تواند یک فایل XML موجود را به‌روزرسانی کند، که در این صورت تنها برای شناسه‌هایی گره ایجاد می‌کند که تا پیش از آن گره‌ای برایشان وجود نداشته است.

.SH "نحوه استفاده (USAGE)"

شما می‌توانید 
.B makeskel
را تنها با آرگومان‌های ضروری 
.B input
و
.B package
فراخوانی کنید. این دستور باید دست‌کم شامل نام فایل یونیتی باشد که باید برای آن مستندات تولید شود، و همچنین نام بسته‌ای که یونیت به آن تعلق دارد. خروجی 
.B makeskel 
به‌طور پیش‌فرض به خروجی استاندارد ارسال خواهد شد.

.SH "گزینه‌ها (OPTIONS)"

.B makeskel
گزینه‌های متعددی دارد که اغلب اختیاری هستند و در بیشتر موارد از مقادیر پیش‌فرض استفاده خواهد شد.

.TP
.BI \-\-descr=descfile
این گزینه باید همراه با گزینهٔ 
.I update 
استفاده شود. این گزینه نام یک فایل توصیف 
.B descfile
را که باید به‌روزرسانی شود، مشخص می‌کند. توجه داشته باشید که فایل باید حاوی XML معتبر باشد، در غیر این صورت به‌روزرسانی با شکست مواجه خواهد شد. این گزینه می‌تواند بیش از یک بار مشخص شود.
.TP
.BI \-\-disable-arguments
اگر این گزینه مشخص شود، 
.B makeskel
برای آرگومان‌های توابع و رویه‌ها (procedures) گره‌ای ایجاد نخواهد کرد. به‌طور پیش‌فرض، برای توابع و رویه‌ها نیز گره‌های مستندات تولید می‌شوند.
.TP
.BI \-\-disable-errors
به‌طور پیش‌فرض، هر گره مستندات شامل یک گره 
.I errors
نیز خواهد بود (به‌جز برای شناسه‌هایی که این مورد برایشان کاربردی ندارد، مانند آرگومان‌های تابع). اگر این گزینه مشخص شود، هیچ گره 
.I errors
ای تولید نخواهد شد.
.TP
.BI \-\-disable-function-results
به‌طور پیش‌فرض، برای توابع یک گره 
.I result
جهت توصیف نتیجه تابع تولید می‌شود. اگر این گزینه مشخص شود، هیچ گره نتیجه تابعی تولید نخواهد شد.
.TP
.BI \-\-disable-private
به‌طور پیش‌فرض، گره‌های مستندات برای فیلدها یا متدهای خصوصی (private) یک کلاس نیز تولید می‌شوند. اگر این گزینه مشخص شود، از تولید گره برای فیلدها یا متدهای خصوصی صرف‌نظر می‌شود.
.TP
.B \-\-disable-protected
به‌طور پیش‌فرض، گره‌های مستندات برای فیلدها یا متدهای حفاظت‌شده (protected) یک کلاس نیز تولید می‌شوند. اگر این گزینه مشخص شود، از تولید گره برای فیلدها یا متدهای حفاظت‌شده صرف‌نظر می‌شود.
.TP
.B \-\-emit-class-separator
اگر این گزینه مشخص شود، یک توضیح (کامنت) قابل مشاهده حاوی نام کلاسی که گره‌های مستندات آن در ادامه می‌آیند، میان گره‌های دو کلاس درج می‌شود تا ناوبری و پیمایش آسان‌تر شود.
.TP
.BI \-\-help
یک متن راهنمای کوتاه نمایش داده و خارج می‌شود.
.TP
.BI \-\-input=cmd
فایل ورودی (منبع) برای پردازش. می‌توان چندین فایل ورودی مشخص کرد. این فرمان می‌تواند شامل گزینه‌های معتبر کامپایلر باشد؛ در حال حاضر گزینه‌های 
.I \-Fipath
(مسیر جستجو) و
.I \-dmacro
(تعریف ماکرو) شناسایی می‌شوند.
.TP
.BI \-\-lang=language
زبان فایل خروجی را تعیین می‌کند. این کار عمدتاً رشته‌های مورد استفاده برای سرآیندها را در بخش‌های گوناگون فایل‌های مستندات تنظیم می‌کند (به‌طور پیش‌فرض انگلیسی هستند). در حال حاضر، گزینه‌های معتبر عبارتند از:
.RS
.TP
.I de 
آلمانی.
.TP
.I fr
فرانسوی.
.TP
.I nl
هلندی.
.RE
.TP
.BI \-\-output=filename 
این گزینه به 
.B makeskel
می‌گوید که خروجی کجا ارسال شود. اگر این گزینه مشخص نشود، خروجی به خروجی استاندارد (صفحه نمایش) فرستاده می‌شود.
.TP
.BI \-\-package=packagename
این گزینه الزامی است. این گزینه نام بسته را مشخص می‌کند. تمام گره‌ها درون گره‌ای با صفت 
.B name 
برابر با 
.I packagename
تولید خواهند شد.
.TP
.BI \-\-update
حالت به‌روزرسانی را فعال می‌کند. در این حالت، خروجی فایلی خواهد بود که تنها شامل گره‌های ناموجود برای تکمیل مستندات فایل‌های ورودی است. گره‌های موجود باید با آرگومان 
.B descr
مشخص شوند. توجه داشته باشید که فایل خروجی 
.I نباید
همان فایل ورودی (توصیف) باشد؛ باید یک فایل جداگانه مشخص شود (یا هیچ فایلی مشخص نشود، که در این حالت خروجی به خروجی استاندارد هدایت می‌شود).

.SH "همچنین ببینید (SEE ALSO)"
.IP 
.BR  ppc386 (1)
.BR  latex (1)
.BR  fpdoc (1)