GTAGS.CONF(5) File Formats Manual GTAGS.CONF(5)

gtags.conf - داده‌های پیکربندی سامانه برچسب‌گذاری گنو گلوبال (GNU Global)

´gtags.conf´
´~/.globalrc´

فایل ´gtags.conf´ حاوی داده‌های پیکربندی برای دستورات global(1)، gozilla(1)، gtags(1) و htags(1) است. این دستورات به ترتیب زیر به دنبال فایل‌های پیکربندی می‌گردند و تنظیمات را از اولین فایلی که موجود و قابل خواندن باشد می‌خوانند:

(1) --gtagsconf file
(2) $GTAGSCONF
(3) [project root]/gtags.conf
(4) [project root]/[objdir]/gtags.conf
(5) $HOME/.globalrc
(6) /etc/gtags.conf
(7) [sysconfdir]/gtags.conf

مقدار [sysconfdir] به‌طور پیش‌فرض ´/usr/local/etc´ است؛ می‌توانید آن را با استفاده از گزینه --sysconfdir در اسکریپت پیکربندی (configure) تغییر دهید. مقدار [objdir] نیز به‌طور پیش‌فرض ´obj´ است؛ که می‌توانید آن را از طریق متغیرهای GTAGSOBJDIR یا MAKEOBJDIR تغییر دهید.

نحو (Syntax) نگارش این فایل، به جز چند مورد توسعه‌یافته که در ادامه شرح داده شده است، مشابه termcap(5) است. یک فایل شامل یک یا چند رکورد است. شما باید با استفاده از یک برچسب (label)، یک رکورد را انتخاب کنید. برچسب پیش‌فرض ´default´ است. در صورتی که متغیر GTAGSLABEL تنظیم شده باشد، مقدار آن استفاده می‌شود. لطفاً توجه داشته باشید که مفهوم ´default´ با مفهوم آن در termcap(5) متفاوت است.

خطوطی که با ´#´ شروع می‌شوند نادیده گرفته می‌شوند. یک رکورد شامل یک یا چند فیلد است که با ´:´ از یکدیگر جدا شده و با یک خط جدید پایان می‌یابد. فیلد اول باید حاوی نام برچسب باشد. هر یک از فیلدهای بعدی شامل تعریف یک متغیر است. سه نوع متغیر در این فایل وجود دارد:

بولی (Boolean)
این نوع هیچ مقداری ندارد؛ وجود متغیر به معنای درست (true) و عدم وجود آن به معنای نادرست (false) است.
عددی (Number)
این نوع پس از علامت ´#´ یک مقدار عددی دارد.
رشته‌ای (String)
این نوع پس از علامت ´=´ یک مقدار رشته‌ای دارد. بیشتر متغیرها از نوع رشته‌ای هستند.

اگر داده‌ها شامل ´:´ یا خط جدید باشند، باید با استفاده از ´\´ اسکیپ (quote) شوند. استفاده از فیلد خالی مجاز است، اما کاربرد یا معنای خاصی ندارد.

هنگامی که بیش از یک تعریف برای یک متغیر وجود داشته باشد، تعریف پیشین در نظر گرفته می‌شود. به عنوان یک استثنا، تمامی مقادیر متغیرهای skip، langmap و gtags_parser پذیرفته شده و به ترتیب به یکدیگر متصل می‌شوند.

قابلیت جایگزینی متغیرها مشابه با sh(1) در دسترس است. می‌توانید با استفاده از پیشوند ´$´ به هر متغیر رشته‌ای ارجاع دهید. به عنوان مثال، در نمونه زیر متغیر b دارای مقدار ´XYZ´ خواهد بود:

:a=Y:b=X${a}Z:

متغیر Tc یک متغیر ویژه است؛ این متغیر تعاریف موجود در یک رکورد دیگر را بارگذاری می‌کند. این قابلیت مشابه با tc در termcap(5) است. نحو نگارش آن به صورت زیر می‌باشد:
tc=label[@file]
اگر تنها یک label ارائه شود، tc از رکوردی خوانده می‌شود که توسط همان label در همان فایل مشخص شده است. اگر @file نیز ارائه شده باشد، tc از رکوردی خوانده می‌شود که توسط label در file مشخص‌شده تعیین گردیده است. مسیر file باید یک مسیر مطلق باشد و نباید شامل متغیرها شود. بر خلاف termcap(5)، می‌توانید از tc در هر زمان و در هر کجا استفاده کنید.

درباره متغیرهای مربوط به هر دستور، لطفاً به صفحه راهنمای اختصاصی همان دستور مراجعه کنید.

می‌توانید از متغیرهای محیطی زیر به عنوان متغیر رشته‌ای استفاده کنید. در صورتی که این متغیرها تنظیم شده باشند، متغیرهای محیطی با همین نام‌ها پیش از اجرای دستور اعمال می‌شوند:
GREP_COLOR
GREP_COLORS
GTAGSBLANKENCODE
GTAGSCACHE
GTAGSFORCECPP
GTAGSGLOBAL
GTAGSGTAGS
GTAGSLIBPATH
GTAGSLOGGING
GTAGSTHROUGH
GTAGS_OPTIONS
HTAGS_OPTIONS
MAKEOBJDIR
MAKEOBJDIRPREFIX
TMPDIR

متغیرهای زیر نیز به عنوان متغیر رشته‌ای در دسترس هستند. به‌طور پیش‌فرض، هر یک از آن‌ها حاوی مسیر دایرکتوری تعیین‌شده توسط اسکریپت پیکربندی (configure) است:
bindir
datadir
libdir
localstatedir
sysconfdir

متغیرهای محیطی زیر بر نحوه اجرای دستورات تأثیر می‌گذارند:

اگر این متغیر تنظیم شده باشد، مقدار آن به عنوان فایل پیکربندی استفاده می‌شود.
اگر این متغیر تنظیم شده باشد، مقدار آن به عنوان برچسب فایل پیکربندی استفاده می‌شود. مقدار پیش‌فرض default است.

global(1)، gozilla(1)، gtags(1)، htags(1).

سامانه برچسب‌گذاری کد منبع گنو گلوبال (GNU Global)
(http://www.gnu.org/software/global).

فایل gtags.conf نخستین بار در Global-3.0 (سال ۱۹۹۸) ظاهر شد.

Nov 2015 GNU Project