نام (NAME)

texdoc - یافتن و مشاهده مستندات در TeX Live

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

texdoc [OPTION]... NAME...
texdoc [OPTION]... ACTION

توضیحات (DESCRIPTION)

تلاش برای یافتن مستندات مناسب TeX برای NAME(های) مشخص‌شده. همچنین می‌توان ACTION داده‌شده را اجرا کرد و خارج شد.

گزینه‌ها (OPTIONS)

-w, --view: استفاده از حالت مشاهده: باز کردن یک نمایشگر. (پیش‌فرض)
-m, --mixed: استفاده از حالت ترکیبی (مشاهده یا نمایش فهرست).
-l, --list: استفاده از حالت فهرست: نمایش فهرستی از نتایج.
-s, --showall: استفاده از حالت نمایش همه: نمایش نتایج «نامناسب» در کنار سایر نتایج.
-i, --interact: استفاده از منوهای تعاملی. (پیش‌فرض)
-I, --nointeract: استفاده از فهرست‌های ساده، بدون نیاز به تعامل.
-M, --machine: خروجی ماشین‌خوان برای فهرست‌ها (شامل -I نیز می‌شود).
-q, --quiet: نادیده گرفتن هشدارها و اکثر پیام‌های خطا.
-v, --verbose: چاپ اطلاعات تکمیلی (مانند دستور نمایشگر).
-D, --debug: فعال‌سازی تمام خروجی‌های اشکال‌زدایی (معادل "--debug=all").
-d LIST, --debug=LIST: فعال‌سازی خروجی‌های اشکال‌زدایی محدود به دسته‌های مشخص‌شده در LIST.
دسته‌های در دسترس: config، files، search، docfile، score، texdocs، tlpdb، version، view، و all برای فعال‌سازی تمام آن‌ها.
-c NAME=VALUE: تنظیم مقدار گزینه پیکربندی NAME روی VALUE.

عملیات‌ها (ACTIONS)

-h, --help: چاپ این پیام راهنما.
-V, --version: چاپ شماره نسخه.
-f, --files: چاپ فهرست فایل‌های پیکربندی استفاده‌شده.
--just-view FILE: نمایش FILE داده‌شده با مسیر کامل (بدون جستجو).
--print-completion SHELL: چاپ تکمیل خودکار شل برای SHELL.

محیط (ENVIRONMENT)

متغیرهای محیطی زیر را می‌توان با علامت دونقطه تفکیک کرد و برای تنظیم نمایشگرها به کار برد:

BROWSER, BROWSER_texdoc: تنظیم دستور مورد استفاده برای اسناد HTML.
DVIVIEWER, DVIVIEWER_texdoc: تنظیم دستور مورد استفاده برای اسناد DVI.
MDVIEWER, MDVIEWER_texdoc: تنظیم دستور مورد استفاده برای اسناد Markdown.
PAGER, PAGER_texdoc: تنظیم دستور مورد استفاده برای اسناد متنی.
PDFVIEWER, PDFVIEWER_texdoc: تنظیم دستور مورد استفاده برای اسناد PDF.
PSVIEWER, PSVIEWER_texdoc: تنظیم دستور مورد استفاده برای اسناد PS.

متغیرهای محیطی زیر نیز استفاده می‌شوند:

LANG, LC_ALL, LANGUAGE, LANGUAGE_texdoc: تنظیم لوکال که بر نتایج جستجو تأثیر می‌گذارد.
TEXDOCS: علاوه بر اسناد موجود در پایگاه‌داده TeX Live، ابزار Texdoc مستندات را در درخت‌های TEXMF مشخص‌شده توسط متغیر kpathsea به نام TEXDOCS نیز جستجو می‌کند.

فایل‌ها (FILES)

<texmf>/texdoc/texdoc.cnf، خروجی گزینه --files را مشاهده کنید.

وضعیت خروج (EXIT STATUS)

دستور texdoc با یکی از مقادیر زیر خارج می‌شود:

0: موفقیت‌آمیز.
1: خطای داخلی.
2: خطای استفاده نادرست.
3: هیچ مستنداتی یافت نشد.

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

گزارش باگ‌ها به texdoc@tug.org.
صفحه خانگی Texdoc: http://tug.org/texdoc
منبع: https://github.com/TeX-Live/texdoc

حق نشر (COPYRIGHT)

حق نشر 2008-2025 Manuel Pe'gourie'-Gonnard, Takuto Asakura, the TeX Live Team.
مجوز: نسخه ۳ یا بالاتر GNU GPL http://gnu.org/licenses/gpl.html.
این یک نرم‌افزار آزاد است: شما در تغییر و بازتوزیع آن آزاد هستید.

همچنین ببینید (SEE ALSO)

مستندات کامل در قالب یک راهنمای PDF نگهداری می‌شود. دستور

texdoc texdoc

باید به شما دسترسی به راهنمای کامل را ارائه دهد.