.\"	$Id: demandoc.1,v 1.8 2014/09/12 00:10:26 schwarze Exp $
.\"
.\" Copyright (c) 2011 Kristaps Dzonsons <kristaps@bsd.lv>
.\"
.\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
.\" copyright notice and this permission notice appear in all copies.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
.Dd $Mdocdate: September 12 2014 $
.Dt DEMANDOC 1
.Os
.Sh "نام (NAME)"
.Nm demandoc
.Nd استخراج صرفاً بخش‌های متنی راهنماهای یونیکس
.Sh "خلاصه دستور (SYNOPSIS)"
.Nm demandoc
.Op Fl w
.Op Ar
.Sh "توضیحات (DESCRIPTION)"
ابزار
.Nm
تنها بخش‌های متنی فایل‌های راهنمای خوش‌ساخت
.Xr mdoc 7
و
.Xr man 7
در
.Ux
را استخراج می‌کند.
.Pp
به‌طور پیش‌فرض،
.Nm
ورودی استاندارد را تجزیه کرده و با حفظ موقعیت سطر و ستون، تنها گره‌های متنی را خروجی می‌دهد.
دنباله‌های فرار (Escape sequences) از خروجی حذف می‌شوند.
.Pp
آرگومان‌های آن به شرح زیر هستند:
.Bl -tag -width Ds
.It Fl w
خروجی فهرستی از کلمات.
این گزینه هر کلمه از متن را در یک سطر مجزا خروجی می‌دهد.
یک
.Qq کلمه ,
در این حالت، به عبارت‌های جداشده با فاصله‌ای اشاره دارد که حداقل با دو حرف آغاز شده و شامل هیچ دنباله فراری نباشند.
نشانه‌های نگارشی ابتدا و انتهای کلمات
.Pq علامت‌های نقل‌قول، نشانه‌گذاری جملات و غیره
حذف می‌شوند.
.It Ar
فایل‌های ورودی.
.El
.Pp
اگر سندی خوش‌ساخت (well-formed) نباشد، نادیده گرفته می‌شود.
.Pp
پرچم‌های
.Fl i ,
.Fl k ,
.Fl m
و
.Fl p
برای حفظ سازگاری فراخوانی با ابزار سنتی deroff، بدون هیچ هشداری نادیده گرفته می‌شوند.
.Sh "وضعیت خروج (EXIT STATUS)"
ابزار
.Nm
با یکی از مقادیر زیر خارج می‌شود:
.Pp
.Bl -tag -width Ds -compact
.It 0
هیچ خطایی رخ نداد.
.It 6
یک خطای سیستم‌عامل رخ داد؛ برای مثال اتمام حافظه یا خطای دسترسی به فایل‌های ورودی.
چنین خطاهایی باعث می‌شوند
.Nm
بلافاصله خارج شود، که احتمالاً در میانه تجزیه یا قالب‌بندی یک فایل رخ می‌دهد.
پایگاه‌های داده خروجی آسیب‌دیده هستند و باید حذف شوند.
.El
.Sh "مثال‌ها (EXAMPLES)"
کاربرد سنتی
.Nm
برای بررسی املای راهنماها در
.Bx
است.
این کار به‌صورت زیر انجام می‌شود (با فرض املای بریتانیایی):
.Pp
.Dl $ demandoc -w file.1 | spell -b
.Sh "همچنین ببینید (SEE ALSO)"
.Xr mandoc 1 ,
.Xr man 7 ,
.Xr mdoc 7
.Sh "تاریخچه (HISTORY)"
ابزار
.Nm
جایگزین ابزار سنتی deroff برای مدیریت اسناد امروزی
.Xr man 7
و
.Xr mdoc 7
می‌شود.
.Sh "نویسندگان (AUTHORS)"
ابزار
.Nm
توسط
.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv
نوشته شده است.