halibut(1) Simon Tatham halibut(1)

halibut - ابزار قالب‌بندی مستندات چندفرمت

halibut [گزینه‌ها] file1.but [file2.but ...]

دستور halibut مجموعه‌ای از فایل‌های ورودی مشخص‌شده را می‌خواند، آن‌ها را در قالب یک سند ترکیب می‌کند و آن سند را در یک یا چند فرمت خروجی می‌دهد.

گزینه‌های خط فرمان موجود می‌توانند فرمت‌های خروجی Halibut را پیکربندی کرده و جنبه‌های دیگر عملکرد آن را تنظیم نمایند.

گزینه‌های خط فرمان پشتیبانی‌شده توسط halibut عبارتند از:

باعث تولید یک فایل خروجی با فرمت متن ساده (plain text) می‌شود. اگر پارامتر اختیاری filename ارائه شود، فایل متنی خروجی با همان نام ذخیره خواهد شد. در غیر این صورت، نام فایل متنی خروجی همان نامی خواهد بود که در فایل‌های ورودی مشخص شده است، یا اگر نامی تعیین نشده باشد، output.txt در نظر گرفته می‌شود.
باعث تولید یک یا چند فایل خروجی در قالب HTML می‌شود. اگر پارامتر اختیاری filename مشخص شود، دقیقاً یک فایل خروجی HTML با همان نام تولید می‌شود که شامل کل سند خواهد بود. در غیر این صورت ممکن است یک یا چند فایل HTML به عنوان خروجی تولید شوند؛ این مورد و نام فایل‌ها بر اساس آنچه در فایل‌های ورودی مشخص شده تعیین می‌شوند، یا اگر هیچ نامی تعیین نشده باشد مجموعه‌ای از نام‌های پیش‌فرض که با Contents.html شروع می‌شوند استفاده خواهند شد.
باعث تولید فایل خروجی در قالب راهنمای اچ‌تی‌ام‌ال ویندوز (Windows HTML Help) می‌شود. اگر پارامتر اختیاری filename ارائه شود، فایل راهنمای خروجی با همان نام ذخیره خواهد شد. در غیر این صورت، نام فایل بر اساس فایل‌های ورودی یا در صورت عدم تعیین، output.chm خواهد بود.
باعث تولید فایل خروجی در فرمت قدیمی راهنمای ویندوز (Windows Help) می‌شود. اگر پارامتر اختیاری filename ارائه شود، فایل راهنمای خروجی با همان نام ذخیره خواهد شد. در غیر این صورت نام فایل بر اساس فایل‌های ورودی یا output.hlp خواهد بود.

فایل راهنمای خروجی باید به پسوند .hlp ختم شود؛ اگر چنین نباشد، پسوند .hlp به آن اضافه خواهد شد. یک فایل فهرست ثانویه نیز در کنار فایل راهنمای اصلی ایجاد می‌شود که نام آن مشابه بوده ولی به پسوند .cnt ختم می‌شود (مثلاً output.cnt اگر فایل اصلی output.hlp باشد).

باعث تولید فایل خروجی در قالب صفحات راهنمای یونیکس (man) می‌شود. اگر پارامتر اختیاری filename ارائه شود، صفحه راهنمای خروجی با همان نام ذخیره خواهد شد. در غیر این صورت نام بر اساس فایل‌های ورودی یا output.1 خواهد بود.
باعث تولید فایل خروجی info می‌شود. اگر پارامتر اختیاری filename ارائه شود، فایل info با همان نام ذخیره خواهد شد. در غیر این صورت، نام فایل طبق فایل‌های ورودی یا output.info خواهد بود.

به‌طور پیش‌فرض، مگر اینکه با استفاده از دستورالعمل \cfg{info-max-file-size}{0} به گونه دیگری تنظیم شود، خروجی info به چندین فایل تقسیم می‌شود. فایل اصلی نام مشخص‌شده شما را خواهد داشت و فایل‌های وابسته پسوندهای -1، -2 و غیره خواهند داشت.

باعث تولید یک فایل خروجی در قالب PDF می‌شود. اگر پارامتر اختیاری filename ارائه شود، فایل PDF خروجی با همان نام ذخیره خواهد شد. در غیر این صورت، نام فایل PDF طبق فایل‌های ورودی یا output.pdf خواهد بود.
باعث تولید یک فایل خروجی در قالب پست‌اسکریپت (PostScript) می‌شود. اگر پارامتر اختیاری filename ارائه شود، فایل پست‌اسکریپت خروجی با همان نام ذخیره خواهد شد. در غیر این صورت، نام فایل طبق فایل‌های ورودی یا output.ps خواهد بود.
یک دستورالعمل پیکربندی به ورودی‌های پردازش‌شده توسط Halibut اضافه می‌کند. استفاده از این گزینه دقیقاً معادل افزودن یک فایل ورودی اضافی به خط فرمان است که شامل دستورالعمل \cfg{word}{word}{word...} باشد.
مجموعه نویسه‌های فرضی فایل‌های ورودی را از حالت پیش‌فرض ASCII تغییر می‌دهد.
فهرست مجموعه‌های نویسه شناخته‌شده برای Halibut را نمایش می‌دهد.
فهرست قلم‌های شناخته‌شده برای Halibut (به‌صورت درونی یا از طریق ارسال فایل ورودی) را نمایش می‌دهد.
باعث می‌شود هنگامی که Halibut با خطایی در فایل ورودی مواجه شد، علاوه بر شماره سطر، شماره ستون را نیز گزارش کند.
خلاصه‌ای از گزینه‌های خط فرمان برنامه را نمایش می‌دهد.
شماره نسخه Halibut را گزارش می‌کند.
مجوز برنامه (MIT) را نمایش می‌دهد.

برای اطلاعات بیشتر درباره Halibut، از جمله جزئیات کامل فرمت فایل‌های ورودی، به کتابچه راهنمای کامل آن مراجعه کنید. اگر این راهنما به‌صورت محلی روی سیستم شما نصب نشده است، می‌توانید آن را در وب‌سایت Halibut بیابید:

https://www.chiark.greenend.org.uk/~sgtatham/halibut

این صفحه راهنما چندان کامل و جامع نیست.

2004‐04‐08 Halibut