نام (NAME)

demandoc — استخراج صرفاً بخش‌های متنی راهنماهای یونیکس

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

demandoc [-w] [file ...]

توضیحات (DESCRIPTION)

ابزار demandoc تنها بخش‌های متنی فایل‌های راهنمای خوش‌ساخت mdoc(7) و man(7) در UNIX را استخراج می‌کند.

به‌طور پیش‌فرض، demandoc ورودی استاندارد را تجزیه کرده و با حفظ موقعیت سطر و ستون، تنها گره‌های متنی را خروجی می‌دهد. دنباله‌های فرار (Escape sequences) از خروجی حذف می‌شوند.

آرگومان‌های آن به شرح زیر هستند:

-w

خروجی فهرستی از کلمات. این گزینه هر کلمه از متن را در یک سطر مجزا خروجی می‌دهد. یک "کلمه", در این حالت، به عبارت‌های جداشده با فاصله‌ای اشاره دارد که حداقل با دو حرف آغاز شده و شامل هیچ دنباله فراری نباشند. نشانه‌های نگارشی ابتدا و انتهای کلمات (علامت‌های نقل‌قول، نشانه‌گذاری جملات و غیره) حذف می‌شوند.

file ...

فایل‌های ورودی.

اگر سندی خوش‌ساخت (well-formed) نباشد، نادیده گرفته می‌شود.

پرچم‌های -i, -k, -m و -p برای حفظ سازگاری فراخوانی با ابزار سنتی deroff، بدون هیچ هشداری نادیده گرفته می‌شوند.

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

ابزار demandoc با یکی از مقادیر زیر خارج می‌شود:

0

هیچ خطایی رخ نداد.

6

یک خطای سیستم‌عامل رخ داد؛ برای مثال اتمام حافظه یا خطای دسترسی به فایل‌های ورودی. چنین خطاهایی باعث می‌شوند demandoc بلافاصله خارج شود، که احتمالاً در میانه تجزیه یا قالب‌بندی یک فایل رخ می‌دهد. پایگاه‌های داده خروجی آسیب‌دیده هستند و باید حذف شوند.

مثال‌ها (EXAMPLES)

کاربرد سنتی demandoc برای بررسی املای راهنماها در BSD است. این کار به‌صورت زیر انجام می‌شود (با فرض املای بریتانیایی):

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

mandoc(1), man(7), mdoc(7)

تاریخچه (HISTORY)

ابزار demandoc جایگزین ابزار سنتی deroff برای مدیریت اسناد امروزی man(7) و mdoc(7) می‌شود.

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

ابزار demandoc توسط Kristaps Dzonsons <kristaps@bsd.lv> نوشته شده است.