.de1 NOP
.  it 1 an-trap
.  if \\n[.$] \,\\$*\/
..
.ie t \
.ds B-Font [CB]
.ds I-Font [CI]
.ds R-Font [CR]
.el \
.ds B-Font B
.ds I-Font I
.ds R-Font R
.TH getdefs 1 "23 Apr 2025" "GNU AutoGen (1.5)" "User Commands"
.\"
.\" DO NOT EDIT THIS FILE (in-mem file)
.\"
.\" It has been AutoGen-ed
.\" From the definitions ./opts.def
.\" and the template file agman-cmd
.SH "نام (NAME)"
getdefs \- استخراج تعاریف و اطلاعات فرمتبندیشده از پروندههای کد منبع
.SH "خلاصه دستور (SYNOPSIS)"
\f\*[B-Font]getdefs\fP
[\f\*[I-Font]option\-name\f[] \f\*[I-Font]value\f[]]
.sp \n(Ppu
.ne 2

تمامی آرگومان‌ها گزینه‌های نام‌دار هستند.
.sp \n(Ppu
.ne 2

اگر هیچ آرگومان
\fBinput\fP
مشخص نشده باشد یا مقدار آن به‌سادگی "-" باشد، و اگر
\fBstdin\fP
یک
\fBtty\fP
نباشد، فهرست پرونده‌های ورودی از
\fBstdin\fP
خوانده خواهد شد.
.SH "توضیحات (DESCRIPTION)"
این برنامه تعاریف AutoGen را از فهرستی از پرونده‌های کد منبع استخراج می‌کند.
تعاریف توسط
\fB/*=<entry-type> <entry-name>\n\fP
و
\fB=*/\n\fP
محدود و مشخص می‌شوند.
.SH "گزینه‌ها (OPTIONS)"
.SS "مشخص کردن تعاریف مورد نظر و اطلاعات مربوط به آنها"
.TP
.NOP defs\-to\-get=\f\*[I-Font]reg\-ex\f[]
عبارت منظم (Regexp) برای جستجو پس از "/*=".
.sp
اگر تنها تعاریفی از یک دسته‌بندی خاص، یا حتی با نام‌هایی منطبق با الگوهایی مشخص را می‌خواهید، این عبارت منظم را برای متنی که باید پس از
\fB/*=\fP
بیاید، تعیین کنید.
.TP
.NOP subblock=\f\*[I-Font]sub\-def\f[]
نام‌های تعاریف زیربلوک (subblock).
این گزینه می‌تواند به تعداد نامحدود تکرار شود.
.sp
این گزینه برای ایجاد مدخل‌های کوتاه و مختصر برای تعاریف تو در تو استفاده می‌شود.
به عنوان مثال، با:
.sp
.IR "استفاده از subblock بدین صورت:"
\fB--subblock=arg=argname,type,null\fP
.sp
.IR "و تعریف یک \fBarg\fP بدین شکل:"
\fBarg: this, char *\fP
.sp
.IR "سپس گسترش می‌یابد به:"
\fBarg = { argname = this; type = "char *"; @\fP;}
.br
رشتهٔ "this, char *" در محل کاماها جدا شده و فاصله‌های خالی آن حذف می‌شوند. شما می‌توانید به جای کاما از نویسه‌های دیگر استفاده کنید، با این شرط که رشتهٔ مقدار را با یک نویسهٔ نشانه‌گذاری غیر از نقل‌قول تکی یا دوتایی آغاز نمایید. همچنین می‌توانید مقادیر میانی را با قرار دادن کاماها در کنار یکدیگر بدون فاصله در میان آنها حذف کنید. به عنوان مثال، "+mumble++yes+" گسترش خواهد یافت به:
.br
\fBarg = { argname = mumble; null = "yes"; @\fP;}.
.TP
.NOP listattr=\f\*[I-Font]def\f[]
صفت با فهرستی از مقادیر.
این گزینه می‌تواند به تعداد نامحدود تکرار شود.
.sp
این گزینه برای ایجاد مدخل‌های مختصر برای تعاریفی استفاده می‌شود که عموماً چندین بار تکرار می‌شوند؛ یعنی تمایل دارند فهرستی از مقادیر باشند. به عنوان مثال، با تعریف
.br
\fBlistattr=foo\fP
متن:
.br
\fBfoo: this, is, a, multi-list\fP
سپس گسترش خواهد یافت به:
.br
\fBfoo = 'this', 'is', 'a', 'multi-list';\fP
.br
متن‌ها با کاماها جدا شده و فاصله‌های خالی حذف می‌شوند. می‌توانید با شروع رشتهٔ مقدار با یک نویسهٔ نشانه‌گذاری غیر از نقل‌قول تکی یا دوتایی، از نویسه‌هایی غیر از کاما استفاده کنید.
.SS "تعیین نحوه شماره‌گذاری تعاریف"
.TP
.NOP ordering [=\f\*[I-Font]file\-name\f[]], \f\*[B-Font]\-\-no\-ordering\f[]
مرتب‌سازی الفبایی یا استفاده از پرونده نام‌برده‌شده.
حالت
\fIno\-ordering\fP
گزینه را غیرفعال می‌کند.
این گزینه به صورت پیش‌فرض فعال است.
.sp
به‌طور پیش‌فرض، مرتب‌سازی بر اساس نام مدخل و به صورت الفبایی است. اگر ترتیب اهمیتی ندارد از
\fBno-ordering\fP
استفاده کنید. برای مرتب‌سازی بدون حساسیت به بزرگی و کوچکی حروف از
\fBordering\fP
بدون آرگومان استفاده کنید. اگر ترتیب زمانی اهمیت دارد از
\fBordering=<file-name>\fP
استفاده کنید.
دستور getdefs محتوای متنی
\fBfile-name\fP
را مدیریت و نگهداری می‌کند. نیازی به وجود قبلی
\fBfile-name\fP
نیست.
.TP
.NOP first\-index=\f\*[I-Font]first\-index\f[]
نخستین نمایه (index) برای اعمال به گروه‌ها.
این گزینه یک عدد صحیح را به عنوان آرگومان دریافت می‌کند.
مقدار پیش‌فرض
\f\*[I-Font]first\-index\f[]
برای این گزینه برابر است با:
.ti +4
 0
.sp
به‌طور پیش‌فرض، نخستین وقوع یک تعریف نام‌دار نمایه‌ای برابر با صفر خواهد داشت. گاهی اوقات لازم است این مقدار رزرو شود. با استفاده از این گزینه می‌توانید نقطهٔ آغاز متفاوتی را مشخص کنید.
.SS "گزینه‌های درج تعریف"
.TP
.NOP filelist [=\f\*[I-Font]file\f[]]
درج نام پرونده‌های منبع در تعاریف.
.sp
نام هر پرونده ورودی را در تعاریف خروجی درج می‌کند.
اگر هیچ آرگومانی ارائه نشود، قالب آن چنین خواهد بود:
.nf
    infile = '%s';
.fi
اگر آرگومانی ارائه شود، به جای
\fBinfile\fP
از آن رشته برای نام مدخل استفاده خواهد شد.
.TP
.NOP assign=\f\*[I-Font]ag\-def\f[]
انتساب‌های سراسری.
این گزینه می‌تواند به تعداد نامحدود تکرار شود.
.sp
آرگومان مربوط به هر نمونه از این گزینه، تنها با افزودن یک سمی‌کولن در انتهای آن به تعاریف خروجی درج خواهد شد.
.TP
.NOP common\-assign=\f\*[I-Font]ag\-def\f[]
انتساب‌های مشترک برای تمامی بلوک‌ها.
این گزینه می‌تواند به تعداد نامحدود تکرار شود.
.sp
آرگومان مربوط به هر نمونه از این گزینه، تنها با افزودن یک سمی‌کولن در انتهای آن به هر تعریف خروجی درج خواهد شد.
.TP
.NOP copy=\f\*[I-Font]file\f[]
پرونده(ها) برای کپی در تعاریف.
این گزینه می‌تواند به تعداد نامحدود تکرار شود.
.sp
محتوای هر پرونده که توسط این گزینه‌ها نام برده شود، در تعاریف خروجی درج خواهد شد.
.TP
.NOP srcfile [=\f\*[I-Font]file\f[]]
درج نام پرونده منبع در هر تعریف.
.sp
نام پرونده ورودی را که تعریفی در آن یافت شده است، در تعریف خروجی درج می‌کند.
اگر هیچ آرگومانی ارائه نشود، قالب آن چنین خواهد بود:
.nf
    srcfile = '%s';
.fi
اگر آرگومانی ارائه شود، به جای
\fBsrcfile\fP
از آن رشته برای نام مدخل استفاده خواهد شد.
.TP
.NOP linenum [=\f\*[I-Font]def\-name\f[]]
درج شماره خط پرونده منبع در هر تعریف.
.sp
شماره خط در پرونده ورودی را که تعریفی در آن یافت شده است، در تعریف خروجی درج می‌کند.
اگر هیچ آرگومانی ارائه نشود، قالب آن چنین خواهد بود:
.nf
    linenum = '%s';
.fi
اگر آرگومانی ارائه شود، به جای
\fBlinenum\fP
از آن رشته برای نام مدخل استفاده خواهد شد.
.SS "تعیین پرونده‌هایی که باید برای نشانگرها جستجو شوند"
.TP
.NOP input=\f\*[I-Font]src\-file\f[]
پرونده ورودی برای جستجوی تعاریف.
این گزینه می‌تواند به تعداد نامحدود تکرار شود.
این گزینه، گزینهٔ پیش‌فرض است.
.sp
تمامی پرونده‌هایی که باید برای تعاریف جستجو شوند، باید در خط فرمان مشخص شوند یا از
\fBstdin\fP
خوانده شوند. اگر تنها یک گزینهٔ
\fBinput\fP
وجود داشته باشد و مقدار آن رشتهٔ "-" باشد، فهرست پرونده‌های ورودی از
\fBstdin\fP
خوانده می‌شود. اگر یک آرگومان خط فرمان نام گزینه نباشد و شامل عملگر انتساب
(\fB=\fP)
نباشد، به‌طور پیش‌فرض به عنوان نام پرونده ورودی در نظر گرفته می‌شود.
حداقل یک پرونده ورودی باید مشخص شود.
.SS "گزینه‌های تعیین وضعیت خروجی تعاریف:"
.TP
.NOP output=\f\*[I-Font]file\f[]
پرونده خروجی برای باز کردن.
این گزینه عضوی از دسته گزینه‌های autogen است.
.sp
اگر خروجی را به یک فرایند AutoGen ارسال نمی‌کنید، می‌توانید در عوض نام یک پرونده خروجی را مشخص نمایید.
.TP
.NOP autogen [=\f\*[I-Font]ag\-cmd\f[]], \f\*[B-Font]\-\-no\-autogen\f[]
فراخوانی AutoGen با تعاریف.
شکل
\fIno\-autogen\fP
این گزینه را غیرفعال خواهد کرد.
این گزینه به‌طور پیش‌فرض فعال است.
این گزینه عضوی از دسته گزینه‌های autogen است.
.sp
این حالت پیش‌فرض خروجی است. مشخص کردن
\fBno-autogen\fP
معادل با
\fBoutput=-\fP
است. اگر آرگومانی به این گزینه بدهید، آن برنامه به گونه‌ای اجرا می‌شود که گویی AutoGen است و ورودی استاندارد آن بر روی تعاریف خروجی این برنامه تنظیم می‌شود.
.TP
.NOP template=\f\*[I-Font]file\f[]
نام الگو (Template Name).
.sp
نام الگوی مورد استفاده برای تولید خروجی نهایی را مشخص می‌کند.
.TP
.NOP agarg=\f\*[I-Font]ag\-opt\f[]
آرگومان AutoGen.
این گزینه می‌تواند به تعداد نامحدود تکرار شود.
این گزینه نباید در ترکیب با هیچ یک از گزینه‌های زیر استفاده شود:
output.
.sp
این یک آرگومان عبوری (pass-through) است. این گزینه به شما امکان می‌دهد هر آرگومان دلخواهی را برای ارسال به AutoGen مشخص کنید.
.TP
.NOP base\-name=\f\*[I-Font]name\f[]
نام پایه برای پرونده(های) خروجی.
این گزینه نباید در ترکیب با هیچ یک از گزینه‌های زیر استفاده شود:
output.
.sp
هنگامی که خروجی به AutoGen فرستاده می‌شود، یک نام پایه باید ارائه شده یا مشتق گردد. اگر این گزینه ارائه نشود، مقدار آن از گزینهٔ
\fBtemplate\fP
گرفته می‌شود. اگر آن هم ارائه نشده باشد، به نام پایهٔ دایرکتوری جاری تنظیم می‌گردد.
.TP
.NOP help
نمایش اطلاعات نحوه استفاده و خروج.
.TP
.NOP more-help
ارسال اطلاعات مبسوط نحوه استفاده از طریق یک صفحه‌بند (pager).
.TP
.NOP save-opts [=\f\*[I-Font]cfgfile\f[]]
ذخیره وضعیت گزینه‌ها در
\fIcfgfile\fP.
مقدار پیش‌فرض،
\fIآخرین\fP
پرونده پیکربندی فهرست‌شده در بخش
\fBپیش‌تنظیمات گزینه‌ها (OPTION PRESETS)\fP
در زیر است. دستور پس از به‌روزرسانی پرونده پیکربندی خارج خواهد شد.
.TP
.NOP load-opts=\f\*[I-Font]cfgfile\f[], \f\*[I-Font]no-load-opts\f[]
بارگذاری گزینه‌ها از
\fIcfgfile\fP.
حالت
\fIno-load-opts\fP
بارگذاری پرونده‌های پیکربندی قبلی config/rc/ini را غیرفعال می‌کند. گزینهٔ
\fI\-\-no-load-opts\fP
زودتر و خارج از نوبت معمول بررسی می‌شود.
.TP
.NOP version [{\f\*[I-Font]v|c|n\f[]}]
نمایش نسخه برنامه و خروج. حالت پیش‌فرض 'v' است که نسخه ساده را نشان می‌دهد. حالت 'c' اطلاعات حق نشر را چاپ می‌کند و 'n' اعلان کامل حق نشر را چاپ خواهد کرد.
.PP
.SH "پیش‌تنظیمات گزینه‌ها (OPTION PRESETS)"
هر گزینه‌ای که به عنوان
\fInot presettable\fP
(غیرقابل پیش‌تنظیم) علامت‌گذاری نشده باشد، ممکن است با بارگذاری مقادیر از پرونده(های) پیکربندی ("RC" یا ".INI") پیش‌تنظیم شود. پرونده
\fIhomerc\fP
برابر با
"\fI/dev/null\fP"
است، مگر اینکه یک دایرکتوری باشد. در آن صورت، پروندهٔ
"\fI.getdefsrc\fP"
درون آن دایرکتوری جستجو می‌شود.
.SH "پرونده‌ها (FILES)"
برای پرونده‌های پیکربندی به بخش
\fBپیش‌تنظیمات گزینه‌ها (OPTION PRESETS)\fP
مراجعه کنید.
.SH "وضعیت خروج (EXIT STATUS)"
یکی از مقادیر خروج زیر بازگردانده خواهد شد:
.TP
.NOP 0 " (EXIT_SUCCESS)"
اجرای موفقیت‌آمیز برنامه.
.TP
.NOP 1 " (EXIT_FAILURE)"
عملیات ناموفق بود یا نحو دستور معتبر نبود.
.TP
.NOP 2 " (EXIT_INVALID_INPUT)"
پرونده ورودی مشخص‌شده یک پرونده معمولی نبود.
.TP
.NOP 3 " (EXIT_NO_MEM)"
حافظه کافی برای انجام عملیات در دسترس نیست.
.TP
.NOP 66 " (EX_NOINPUT)"
پرونده پیکربندی مشخص‌شده بارگذاری نشد.
.TP
.NOP 70 " (EX_SOFTWARE)"
کتابخانه libopts با یک خطای عملیاتی داخلی مواجه شد. لطفاً آن را به نشانی autogen-users@lists.sourceforge.net گزارش دهید. با تشکر.
.PP
.SH "همچنین ببینید (SEE ALSO)"
این برنامه به‌طور کامل‌تر در بخش Getdefs از فصل Add\-On در مستندات سیستم Info برنامهٔ
\fBAutoGen\fP
مستند شده است.
.SH "نویسندگان (AUTHORS)"
Bruce Korb
.SH "حق نشر (COPYRIGHT)"
حق نشر \(co 1999-2018 متعلق به Bruce Korb است؛ تمامی حقوق محفوظ است.
این برنامه تحت شرایط مجوز عمومی همگانی گنو (GNU GPL)، نسخه ۳ یا جدیدتر منتشر شده است.
.SH "گزارش اشکالات (BUGS)"
لطفاً گزارش‌های اشکال را به نشانی autogen-users@lists.sourceforge.net ارسال کنید.
.SH "نکات (NOTES)"
این صفحه راهنما توسط
\fIAutoGen\fP
از روی تعاریف گزینه‌های
\fBgetdefs\fP
تولید شده است.