.TH \%refer 1 "2026-03-15" "groff 1.24.1"
.SH "نام (NAME)"
\%refer \- پردازش ارجاعات کتابشناسی برای groff
.
.
.\" ====================================================================
.\" Legal Terms
.\" ====================================================================
.\"
.\" Copyright (C) 1989-2024 Free Software Foundation, Inc.
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of
.\" this manual under the conditions for verbatim copying, provided that
.\" the entire resulting derived work is distributed under the terms of
.\" a permission notice identical to this one.
.\"
.\" Permission is granted to copy and distribute translations of this
.\" manual into another language, under the above conditions for
.\" modified versions, except that this permission notice may be
.\" included in translations approved by the Free Software Foundation
.\" instead of in the original English.
.
.
.\" Save and disable compatibility mode (for, e.g., Solaris 10/11).
.do nr *groff_refer_1_man_C \n[.cp]
.cp 0
.
.\" Define fallback for groff 1.23's MR macro if the system lacks it.
.nr do-fallback 0
.if !\n(.f           .nr do-fallback 1 \" mandoc
.if  \n(.g .if !d MR .nr do-fallback 1 \" older groff
.if !\n(.g           .nr do-fallback 1 \" non-groff *roff
.if \n[do-fallback]  \{\
.  de MR
.    ie \\n(.$=1 \
.      I \%\\$1
.    el \
.      IR \%\\$1 (\\$2)\\$3
.  .
.\}
.rr do-fallback
.
.
.\" ====================================================================
.SH "خلاصه دستور (SYNOPSIS)"
.\" ====================================================================
.
.SY \%refer
.RB [ \-bCenPRS ]
.RB [ \-a\~\c
.IR n ]
.RB [ \-B
.IB field . macro\c
]
.RB [ \-c\~\c
.IR fields ]
.RB [ \-f\~\c
.IR n ]
.RB [ \-i\~\c
.IR fields ]
.RB [ \-k\~\c
.IR field ]
.RB [ \-l\~\c
.IR range-expression ]
.RB [ \-p\~\c
.IR database-file ]
.RB [ \-s\~\c
.IR fields ]
.RB [ \-t\~\c
.IR n ]
.RI [ file\~ .\|.\|.]
.YS
.
.
.P
.SY \%refer
.B \-\-help
.YS
.
.
.P
.SY \%refer
.B \-v
.YS
.
.SY \%refer
.B \%\-\-version
.YS
.
.
.\" ====================================================================
.SH "توضیحات (DESCRIPTION)"
.\" ====================================================================
.
پیاده‌سازی گنو از
.I \%refer \" generic
بخشی از سامانه قالب‌بندی اسناد
.MR groff 1
است.
.
.I \%refer
یک پیش‌پردازنده
.MR \%troff 1
است که استنادها و ارجاعات کتاب‌شناختی را با جستجوی کلیدواژه‌های مشخص‌شده در یک سند ورودی
.MR roff 7
آماده می‌سازد؛ این امر نیاز به تایپ دستی چنین یادداشت‌هایی را برطرف کرده
و اجازه می‌دهد شیوه استناد در خروجی قالب‌بندی‌شده، به طور مستقل و سامان‌مند تغییر یابد.
.
این برنامه محتوای هر
.I file
را در جریان خروجی استاندارد کپی می‌کند، هر
.I استناد
بین خطوطی که با
.B .[
و
.B .]\&
آغاز می‌شوند را جستجو کرده و آن را با یک مرجع کتاب‌شناختی جایگزین می‌نماید.
.
علاوه بر این، نسخه گنو
.I refer \" GNU
خطوط بین موارد آغازشونده با
.B .R1
و
.B .R2
را به عنوان دستورالعمل‌هایی تفسیر می‌کند که نحوه پردازش استنادها را هدایت می‌نمایند.
.
.I \%refer
درخواست‌های
.B lf
مربوط به
.I roff
را تفسیر و تولید می‌کند تا نام فایل‌ها و شماره خطوط در پیام‌های تولیدشده توسط دستوراتی که خروجی آن را می‌خوانند، به درستی سند منبع را توصیف کنند.
.
به طور معمول،
.I \%refer
مستقیماً توسط کاربر اجرا نمی‌شود،
بلکه با مشخص کردن گزینه
.B \-R
در
.MR groff 1
فراخوانی می‌گردد.
.
اگر هیچ عملوند
.IR file ی
داده نشود،
یا اگر
.I file
برابر با
.RB \[lq] \- \[rq]
باشد،
.I \%refer
جریان ورودی استاندارد را می‌خواند.
.
.
.P
یک استناد، اثری را از طریق ارجاع به یک
.I "رکورد کتاب‌شناختی"
حاوی جزئیات آن مشخص می‌کند.
.
با فهرست کردن کلیدواژه‌هایی که مدخل اثر را به طور یکتا شناسایی می‌کنند، اثر مورد نظر را از یک پایگاه‌داده رکوردها انتخاب کنید.
.
در روش دیگر، یک سند می‌تواند در همان نقطه‌ای که استناد در آن رخ می‌دهد، رکوردی برای اثر مشخص نماید.
.
یک سند می‌تواند بنا به تمایل، از هر یک از این دو راهبرد یا هر دوی آن‌ها استفاده کند.
.
.
.P
برای هر استناد،
.I \%refer
یک
.I نشان
در متن تولید می‌کند، مانند یک شماره بالانویس پاورقی یا \[lq][Lesk1978a]\[rq].
.
یک نشان شامل یک
.I برچسب
در بین
.I قلاب‌ها
است.
.
این نشان می‌تواند به روش‌های گوناگون از متن اطراف و از برچسب‌های دیگر جدا شود.
.
.I \%refer
درخواست‌های زبان
.I roff
تولید می‌کند که توسط یک سند یا یک بسته ماکرو مانند
.\" .IR man ,
.IR me ،
.IR mm ،
.IR mom
یا
.I ms
قابل استفاده است تا برای هر استناد یک ارجاع قالب‌بندی‌شده تولید شود.
.
مرجع یک استناد می‌تواند بلافاصله پس از وقوع آن در خروجی ظاهر شود
(مانند پاورقی‌ها)،
یا مراجع ممکن است
.I انباشته
شوند و خروجی متناظر بعداً در سند ظاهر گردد
(مانند پی‌نوشت‌ها).
.
هنگامی که مراجع انباشته می‌شوند،
استنادهای متعدد به یک مرجع یکسان، یک مدخل قالب‌بندی‌شده واحد را تولید می‌کنند.
.
.
.P
تفسیر خطوط بین نشانه‌های
.B .R1
و
.B .R2
به عنوان دستورات پیش‌پردازنده، یک قابلیت گسترش‌یافته در
.I \%refer \" GNU
گنو است.
.
اسنادی که از این ویژگی استفاده می‌کنند همچنان می‌توانند توسط
.I \%refer \" AT&T
نسخه AT&T پردازش شوند؛ این کار با افزودن خطوط زیر:
.
.RS
.EX
\&.de R1
\&.ig R2
\&..
.EE
.RE
.
به ابتدای سند انجام می‌پذیرد.
.
ورودی فوق باعث می‌شود
.I troff \" generic
همه چیز بین
.B .R1
و
.B .R2
را نادیده بگیرد.
.
اثرات برخی از دستورات
.I \%refer \" generic
از طریق گزینه‌های خط فرمان نیز قابل دستیابی است؛
این گزینه‌ها برای سازگاری با
.IR \%refer \" AT&T
نسخه AT&T پشتیبانی می‌شوند.
.
معمولاً استفاده از دستورات راحت‌تر است.
.
.
.\" ====================================================================
.SS "رکوردهای کتاب‌شناختی"
.\" ====================================================================
.
یک رکورد کتاب‌شناختی، اثر مورد ارجاع را با جزئیات کافی توصیف می‌کند تا بتوان آن را طبق استانداردهای پذیرفته‌شده شفافیت علمی و حرفه‌ای استناد داد.
.
قالب رکورد امکان یادداشت‌نویسی و گسترش را فراهم می‌سازد که یک سند می‌تواند از آن استفاده کرده یا آن را نادیده بگیرد.
.
یک رکورد توالی متنی ساده‌ای از
.I فیلدها
است (یک فیلد در هر خط)، که هر کدام شامل یک علامت درصد
.BR % ،
یک نویسه حرفی‌عددی برای رده‌بندی آن،
یک فاصله،
و محتوای آن فیلد است.
.
اگر محتوای یک فیلد خالی باشد،
فیلد نادیده گرفته می‌شود.
.
.
.P
معمولاً چنین رکوردهایی در یک
.I "پایگاه‌داده کتاب‌شناختی"
سازمان‌دهی می‌شوند که در آن هر مدخل با خطوط خالی یا مرزهای فایل از یکدیگر جدا می‌گردد.
.
این شیوه اسناد را از نیاز به نگهداری داده‌های کتاب‌شناختی در خود معاف می‌کند.
.
برنامه‌های
.MR \%lookbib 1
و
.MR lkbib 1
یک پایگاه‌داده کتاب‌شناختی را بررسی می‌کنند،
و
.MR \%indxbib 1
آن را نمایه‌سازی می‌کند تا بازیابی از آن سرعت گیرد و زمان پردازش سند کاهش یابد.
.
استفاده از این ابزارها اختیاری است.
.
.
.br
.ne 4v
.P
کاربردهای متداول مدخل‌های فیلدهای کتاب‌شناختی به شرح زیر است.
.
درون یک رکورد،
فیلدهایی غیر از
.B %A
و
.B %E
جایگزین رخدادهای قبلی خود می‌شوند.
.
ترتیب فیلدهای چندگانه
.B %A
و
.B %E
حائز اهمیت است.
.
.
.TP
.B %A
نام یک نویسنده را مشخص می‌کند.
.
اگر نام شامل پسوندی مانند \[lq]Jr.\&\[rq]
یا \[lq]III\[rq] باشد،
باید با یک کاما از نام خانوادگی جدا شود.
.
توصیه می‌کنیم همیشه یک فیلد
.B %A
یا یک فیلد
.B %Q
ارائه دهید.
.
.
.TP
.B %B
عنوان کتابی را که مقاله مورد استناد در آن گردآوری شده است ثبت می‌کند.
.
فیلدهای
.B %J
و
.BR %T
را ببینید.
.
.
.TP
.B %C
نام شهر یا سایر مکان‌های انتشار را مشخص می‌کند.
.
.
.TP
.B %D
تاریخ انتشار را نشان می‌دهد.
.
سال را به طور کامل مشخص کنید.
.\" even if the title of the conference proceedings abbreviates it
.
اگر ماه مشخص شده است،
به جای شماره آن از نام ماه استفاده کنید؛
تنها سه حرف اول نیاز است.
.
توصیه می‌کنیم همیشه یک فیلد
.B %D
ارائه دهید؛
اگر تاریخ نامشخص است،
از
.RB \[lq] "in press" \[rq]
یا
.RB \[lq] unknown \[rq]
به عنوان محتوای آن استفاده کنید.
.
.
.TP
.B %E
نام یک ویراستار کتابی را که مقاله مورد استناد در آن گردآوری شده است مشخص می‌کند.
.
در مواردی که یک اثر ویراستار دارد اما نویسنده‌ای ندارد،
ویراستاران را در فیلدهای
.B %A
نام ببرید و
.RB \[lq] ,\~(ed.)\& \[rq]
یا
.RB \[lq] ,\~(eds.)\& \[rq]
را به آخرین مورد از آن‌ها پیوست نمایید.
.
.
.TP
.B %G
شماره سفارش دولتی ایالات متحده،
شابک (ISBN)،
شناسه برخط شیء (DOI)،
یا سایر شناسه‌های یکتا را ثبت می‌کند.
.
.
.TP
.B %I
نام ناشر (منتشرکننده) را مشخص می‌کند.
.
.
.TP
.B %J
نام مجله‌ای را که مقاله مورد استناد در آن گردآوری شده است ثبت می‌کند.
.
فیلدهای
.B %B
و
.BR %T
را ببینید.
.
.
.TP
.B %K
کلیدواژه‌هایی را که برای کمک به جستجو در نظر گرفته شده‌اند فهرست می‌کند.
.
.
.TP
.B %L
یک برچسب است؛
معمولاً در مدخل‌های پایگاه‌داده استفاده نمی‌شود،
اما می‌تواند قالب برچسبی را که در غیر این صورت تعیین می‌شد بازنویسی کند.
.
.
.TP
.B %N
شماره دوره یا انتشار مجله‌ای را که مقاله مورد استناد در آن گردآوری شده است ثبت می‌کند.
.
.
.TP
.B %O
اطلاعات اضافی (\[lq]سایر\[rq]) را ارائه می‌دهد،
که معمولاً در انتهای مرجع قرار می‌گیرد.
.
.
.TP
.B %P
شماره صفحات اثری را که بخشی از یک مجموعه بزرگ‌تر است فهرست می‌کند.
.
یک بازه را با
.IB m \- \c
.IR n
مشخص کنید.
.\" XXX: Why not \[en]?  Does that break?
.
.
.TP
.B %Q
در صورتی که هیچ فیلد
.B %A
وجود نداشته باشد،
نام یک نویسنده سازمانی را مشخص می‌کند.
.
تنها یک فیلد
.B %Q
مجاز است.
.
.
.TP
.B %R
شناسه‌ای برای یک گزارش،
پایان‌نامه،
یادداشت اداری،
یا سایر آثار منتشرنشده است.
.
.
.TP
.B %S
عنوان مجموعه‌ای (series) را که اثر مورد استناد به آن تعلق دارد ثبت می‌کند.
.
.
.TP
.B %T
عنوان اثر است.
.
فیلدهای
.B %B
و
.BR %J
را ببینید.
.
.
.TP
.B %V
شماره جلد مجله یا کتاب حاوی اثر مورد استناد است.
.
.
.TP
.B %X
یک یادداشت توضیحی (annotation) است.
.
طبق عرف،
در سند استنادکننده قالب‌بندی نمی‌شود.
.
.
.P
اگر از ویژگی قدیمی و رو به زوال \[lq]رشته‌های نشانه‌گذاری اعراب\[rq] در بسته‌های ماکروی
.I ms
یا
.I me
استفاده می‌شود،
چنین رشته‌هایی باید پس از نویسه‌ای که قرار است علامت‌گذاری شود قرار گیرند؛
یک سند
.I ms
باید پیش از استفاده از آن‌ها ماکروی
.B AM
را فراخوانی کند.
.
رشته‌های اعراب را در گیومه قرار ندهید:
به جای دو علامت از یک
.B \e
استفاده کنید.
.
برای یک رویکرد امروزی به مسئله نشانه‌های تفکیک‌کننده،
.MR groff_char 7
را ببینید.
.
.
.\" ====================================================================
.SS "استنادها"
.\" ====================================================================
.
استنادها قالب مشخصی دارند.
.
.RS
.EX
.BI .[ opening-text
.IR "flags keyword\~" .\|.\|.
.I field
\&.\|.\|.
.BI .] closing-text
.EE
.RE
.
.
.P
موارد
.IR opening-text ،
.I closing-text
و
.I flags
اختیاری هستند،
و تنها لازم است یک
.I keyword
یا
.I field
مشخص شود.
.
اگر کلیدواژه‌ها حضور داشته باشند،
.I \%refer
پایگاه(های) داده کتاب‌شناختی را برای یافتن یک مرجع یکتا که با آن‌ها مطابقت دارد جستجو می‌کند.
.
تطابق‌های چندگانه خطا هستند؛
کلیدواژه‌های بیشتری اضافه کنید تا ابهام مرجع برطرف شود.
.
در صورت عدم وجود کلیدواژه‌ها،
.I فیلدها
رکورد کتاب‌شناختی را تشکیل می‌دهند.
.
در غیر این صورت،
.I فیلدها
داده‌های اضافی را برای جایگزینی یا تکمیل داده‌های موجود در مرجع مشخص می‌کنند.
.
هنگامی که مراجع در حال انباشته شدن هستند و کلیدواژه‌ها وجود دارند،
.I فیلدهای
اضافی را حداکثر در اولین استناد به یک مرجع خاص مشخص کنید؛
آن‌ها برای تمامی استنادهای بعدی به آن اعمال می‌شوند.
.
.
.br
.ne 2v
.P
موارد
.I opening-text
و
.I closing-text
ورودی‌های
.I roff
هستند که برای قرار دادن برچسب در قلاب استفاده می‌شوند،
و دستور
.B \%bracket\-label
را بازنویسی می‌کنند.
.
فاصله‌های ابتدا و انتها حائز اهمیت هستند.
.
اگر هر یک از این موارد غیرخالی باشد،
آرگومان متناظر دستور
.B \%bracket\-label
استفاده نمی‌شود؛
این رفتار را با پرچم‌های
.B [
و
.B ]
تغییر دهید.
.
.
.br
.ne 3v
.P
مورد
.I flags
فهرستی از نویسه‌های غیرحرفی‌عددی است که هر یک از آن‌ها نحوه رفتار با استناد مشخص را تغییر می‌دهد.
.
نسخه AT&T برنامه
.I \%refer \" AT&T
آن‌ها را نادیده می‌گیرد زیرا غیرحرفی‌عددی هستند.
.
آن‌ها نسخه گنو
.I \%refer \" GNU
را به شرح زیر هدایت می‌کنند.
.
.
.TP
.B #
از برچسب مشخص‌شده توسط دستور
.B \%short\-label
(در صورت وجود) استفاده می‌کند.
.
در غیر این صورت
.I \%refer
از برچسب عادی استفاده می‌نماید.
.
به طور معمول،
یک برچسب کوتاه سبک‌های استناد نویسنده-تاریخ متشکل از یک نام،
یک سال،
و در صورت لزوم یک حرف ابهام‌زدا را پیاده‌سازی می‌کند.
.
.RB \[lq] # \[rq]
برای القای چنین برچسب (شبه) عددی در نظر گرفته شده است.
.
.
.TP
.B [
قبل از
.I opening-text ،
اولین آرگومان داده‌شده به دستور
.B \%bracket\-label
را قرار می‌دهد.
.
.
.TP
.B ]
بعد از
.I closing-text ،
دومین آرگومان داده‌شده به دستور
.B \%bracket\-label
را قرار می‌دهد.
.
.
.P
یک مزیت پرچم‌های
.B [
و
.B ]
نسبت به استفاده از
.I opening-text
و
.I closing-text
این است که می‌توانید شیوه قلاب‌بندی سند را در یک مکان با استفاده از دستور
.B \%bracket\-label
به‌روزرسانی کنید.
.
مزیت دیگر این است که در صورت استفاده از پرچم‌ها، مرتب‌سازی و ادغام استنادها لزوماً مهار نمی‌شود.
.
.
.P
برنامه
.I \%refer
هر برچسب حاصل از یک استناد را به خط ورودی
.I roff
پیش از نشانه
.B .[
پیوست می‌کند.
.
اگر چنین خطی وجود نداشته باشد،
.I \%refer
یک پیام هشدار تشخیصی صادر می‌کند.
.
.
.P
هیچ نمادگذاری خاصی برای استناد به چندین مرجع به صورت متوالی وجود ندارد.
.
از توالی استنادها، یکی برای هر مرجع، بدون هیچ فاصله‌ای بین آن‌ها استفاده کنید.
.
.I \%refer
تمام برچسب‌های آن‌ها را به خط پیش از اولین مورد متصل می‌کند.
.
این برچسب‌ها ممکن است مرتب یا ادغام شوند.
.
توضیحات مربوط به عبارت برچسب
.BR <> ،
و دستورات
.B \%sort\-adjacent\-labels
و
.B \%abbreviate\-label\-ranges
را ببینید.
.
اگر استناد یک برچسب دارای
.I opening-text
یا
.I closing-text
غیرخالی باشد، آن برچسب ادغام نمی‌شود.
.
با این حال،
برچسب‌های دو استناد مجاور،
که اولی از پرچم
.B ]
و بدون هیچ
.I closing-text
استفاده می‌کند،
و دومی از پرچم
.B [
و بدون هیچ
.I opening-text
استفاده می‌کند،
ممکن است مرتب و ادغام شوند
حتی اگر
.I opening-text
اولی یا
.I closing-text
دومی غیرخالی باشد.
.
(برای جلوگیری از این عملیات،
از توالی گریز نویسه ساختگی
.B \[rs]&
به عنوان
.I closing-text
اولی استفاده کنید.)
.
.
.\" ====================================================================
.SS "دستورها"
.\" ====================================================================
.
دستورها بین خطوطی قرار دارند که با
.B .R1
و
.B .R2
آغاز می‌شوند.
.
گزینه
.B \-R
مانع از شناسایی این خطوط می‌گردد.
.
هنگامی که
.I \%refer
با یک خط
.B .R1
مواجه می‌شود،
هرگونه مراجع انباشته‌شده را تخلیه می‌کند.
.
نه خطوط
.B .R1
و نه
.BR .R2 ،
و نه هیچ‌چیز بین آن‌ها،
در خروجی نوشته نمی‌شوند.
.
.
.P
دستورها با خطوط جدید یا نقطه-ویرگول از هم جدا می‌شوند.
.
علامت هش
.RB ( # )
معرف یک یادداشت است که تا انتهای خط ادامه می‌یابد،
اما خط جدید را پنهان نمی‌کند.
.
هر دستور به کلماتی تفکیک می‌شود.
.
کلمات با فاصله یا جهش (tab) از هم جدا می‌شوند.
.
کلمه‌ای که با یک گیومه دوگانه (خنثی)
.RB ( \[dq] )
آغاز می‌شود، تا گیومه دوگانه بعدی که پس از آن گیومه دوگانه دیگری نیامده باشد امتداد می‌یابد.
.
اگر چنین گیومه دوگانه‌ای وجود نداشته باشد،
کلمه تا انتهای خط ادامه می‌یابد.
.
جفت‌های گیومه دوگانه درون کلمه‌ای که با گیومه دوگانه آغاز شده است، به یک گیومه دوگانه تقلیل می‌یابند.
.
نه علامت هش و نه نقطه-ویرگول در داخل گیومه دوگانه شناسایی نمی‌شوند.
.
یک خط را می‌توان با خاتمه دادن آن با یک ممیز وارونه
.RB \[lq]\^ \[rs] \[rq]
ادامه داد؛
این کار در همه‌جا به جز پس از علامت هش کار می‌کند.
.
.
.LP
.ds n \fR*\fP\"
هر
.I نام
دستور که با \*n علامت‌گذاری شده است، دارای یک دستور منفی مرتبط به صورت
.BI no\- name
است که اثر
.I name
را خنثی می‌کند.
.
به عنوان مثال،
دستور
.B no\-sort
مشخص می‌کند که مراجع نباید مرتب شوند.
.
دستورات منفی هیچ آرگومانی نمی‌پذیرند.
.
.
.LP
در توضیحات زیر هر آرگومان باید یک کلمه واحد باشد؛
.I field
برای یک حرف تکی بزرگ یا کوچک نام‌گذاری فیلد به کار می‌رود؛
.I fields
برای توالی‌ای از چنین حروفی به کار می‌رود؛
.I m
و
.I n
برای اعداد غیرمنفی به کار می‌روند؛
.I string
برای یک رشته دلخواه به کار می‌رود؛
.I file
برای نام یک فایل به کار می‌رود.
.
.
.TP
.BI abbreviate\*n\~ fields\~string1\~string2\~string3\~string4
نام‌های کوچک
.IR fields
را مخفف می‌کند.
.
حرف آغازین با
.IR string1
از حرف آغازین دیگر،
با
.IR string2
از نام خانوادگی،
و با
.IR string3
از هر چیز دیگری
(مانند \[lq]von\[rq] یا \[lq]de\[rq])
جدا خواهد شد.
.
پیش‌فرض این‌ها یک نقطه به همراه یک فاصله است.
.
در یک نام کوچک خط‌تیره‌دار،
حرف آغازین بخش اول نام با
.IR string4
از خط‌تیره جدا می‌شود؛
پیش‌فرض این مورد یک نقطه است.
.
هیچ تلاشی برای مدیریت ابهاماتی که ممکن است از اختصار ناشی شوند صورت نمی‌گیرد.
.
نام‌ها پیش از مرتب‌سازی و پیش از ساخت برچسب مخفف می‌شوند.
.
.
.TP
.BI abbreviate\-label\-ranges\*n\~ string
.
سه یا تعداد بیشتری برچسب مجاور که به مراجع متوالی اشاره دارند،
به برچسبی متشکل از برچسب اول،
به دنبال آن
.IR string ،
و به دنبال آن برچسب آخر مخفف می‌شوند.
.
این قابلیت عمدتاً برای برچسب‌های عددی مفید است.
.
اگر
.I string
حذف شود،
مقدار پیش‌فرض آن
.RB \[lq] \- \[rq]
خواهد بود.
.
.
.TP
.B accumulate\*n
مراجع را به جای نوشتن هر یک از آن‌ها در زمان مواجهه،
انباشته می‌کند.
.
مراجع انباشته‌شده هر زمان که مرجعی به شکل:
.
.RS
.RS
.EX
.B .[
.B $LIST$
.B .]
.EE
.RE
.
دیده شود،
پس از پردازش تمام فایل‌های ورودی،
و هر زمان که یک خط
.B .R1
شناسایی گردد،
نوشته خواهند شد.
.RE
.
.
.TP
.BI annotate\*n\~ "field string"
مورد
.I field
یک یادداشت توضیحی است؛
آن را در انتهای مرجع به صورت پاراگرافی که پیش از آن خط:
.
.RS
.IP
.BI . string
.
.
.LP
آمده است چاپ می‌کند.
اگر
.I string
حذف شود،
پیش‌فرض آن
.B AP
خواهد بود؛
اگر
.I field
نیز حذف شود،
پیش‌فرض آن
.B X
خواهد بود.
.
تنها یک فیلد می‌تواند یادداشت توضیحی باشد.
.RE
.
.
.TP
.BI articles\~ string\~\c
\&.\|.\|.
هر
.I string
یک حرف تعریف معین یا نامعین است،
و هنگام مرتب‌سازی باید در ابتدای فیلدهای
.B T
نادیده گرفته شود.
.
در ابتدا،
\[lq]a\[rq]،
\[lq]an\[rq]
و
\[lq]the\[rq]
به عنوان حروف تعریف شناخته می‌شوند.
.
.
.TP
.BI bibliography\~ file\~\c
\&.\|.\|.
.
تمام مراجع موجود در هر
.I file
پایگاه‌داده کتاب‌شناختی را می‌نویسد.
.
این دستور باید آخرین مورد در یک بلوک
.BR .R1 / .R2
باشد.
.
.
.TP
.BI bracket\-label\~ "string1 string2 string3"
در متن،
هر برچسب را درون
.I string1
و
.I string2
قرار می‌دهد.
.
وقوع
.I string2
که بلافاصله پس از آن
.I string1
بیاید،
به
.I string3
تبدیل خواهد شد.
.
رفتار پیش‌فرض به شرح زیر است.
.
.RS \" RS twice to get inboard of the tagged paragraph indentation.
.RS
.EX
bracket\-label \e*([. \e*(.] \[dq], \[dq]
.EE
.RE
.RE
.
.
.TP
.BI capitalize\~ fields
فیلدهای
.I fields
را به حروف بزرگ و حروف بزرگ کوچک تبدیل می‌کند.
.
.
.TP
.B compatible\*n
خطوط
.B .R1
و
.B .R2
را حتی اگر با نویسه‌ای غیر از فاصله یا خط جدید دنبال شوند،
شناسایی می‌کند.
.
.
.TP
.BI database\~ file\~\c
\&.\|.\|.
هر
.I file
پایگاه‌داده کتاب‌شناختی را جستجو می‌کند.
.
برای هر
.IR file ،
اگر نمایه‌ای به نام
.RI file \%.i
که توسط
.MR \%indxbib 1
ایجاد شده باشد موجود باشد،
آنگاه به جای آن جستجو خواهد شد؛
هر نمایه می‌تواند چندین پایگاه‌داده را پوشش دهد.
.
.
.TP
.BI date\-as\-label\*n\~ string
رشته
.I string
یک عبارت برچسب است که رشته‌ای را مشخص می‌کند تا پس از ساخت برچسب، جایگزین فیلد
.B D
شود.
.
برای شرح عبارت‌های برچسب، زیربخش \[lq]عبارت‌های برچسب\[rq] در ادامه را ببینید.
.
این دستور زمانی مفید است که شما برچسب‌های صریح در فهرست مراجع نمی‌خواهید،
بلکه می‌خواهید هرگونه رفع ابهام لازم را با مقید کردن تاریخ به نحوی مدیریت کنید.
.
برچسب مورد استفاده در متن معمولاً ترکیبی از نویسنده و تاریخ خواهد بود.
.
در بیشتر موارد باید از دستور
.B \%no\-label\-in\-reference
نیز استفاده نمایید.
.
برای مثال،
.
.RS \" RS twice to get inboard of the tagged paragraph indentation.
.RS
.EX
date\-as\-label D.+yD.y%a*D.\-y
.EE
.RE
.
یک حرف رفع ابهام را به بخش سال فیلد
.B D
در مرجع پیوست خواهد کرد.
.RE
.
.
.TP
.B default\-database\*n
پایگاه‌داده پیش‌فرض باید جستجو شود.
.
این رفتار پیش‌فرض است،
بنابراین نسخه منفی این دستور مفیدتر است.
.
برنامه
.I \%refer
در اولین باری که نیاز به انجام جستجو دارد،
مشخص می‌کند که آیا پایگاه‌داده پیش‌فرض باید جستجو شود یا خیر.
.
بنابراین دستور
.B \%no\-default\-database
باید پیش از آن زمان صادر شود تا موثر واقع گردد.
.
.
.TP
.BI discard\*n\~ fields
هنگامی که مرجع خوانده می‌شود،
.I fields
باید دور ریخته شوند؛
هیچ تعریف رشته‌ای برای
.I fields
در خروجی نوشته نخواهد شد.
.
در ابتدا،
.I fields
برابر با
.B XYZ
هستند.
.
.
.TP
.BI et\-al\*n\~ "string m n"
استفاده از
.RB \[lq] "et al" \[rq]
(و دیگران) را در ارزیابی عبارت‌های
.B @
درون عبارت‌های برچسب پیکربندی می‌کند.
.
اگر
.I u
تعداد نویسندگان لازم برای بدون ابهام ساختن توالی نویسندگان باشد و کل تعداد نویسندگان
.I t
باشد،
آنگاه
.IR t \|\-\| u
نویسنده آخر با
.I string
جایگزین خواهند شد،
به شرط آن که
.IR t \|\-\| u
کمتر از
.I m
نباشد و
.I t
کمتر از
.IR n
نباشد.
.
رفتار پیش‌فرض به شرح زیر است.
.
.RS \" RS twice to get inboard of the tagged paragraph indentation.
.RS
.EX
et\-al " et al" 2 3
.EE
.RE
.
به نبود نقطه در انتهای این مخفف توجه داشته باشید،
که مسلماً درست نیست.
.
.RI ( "Et al" [.]
مخفف
.I "et alli"
است،
همان‌طور که
.I etc.\&
مخفف
.IR "et cetera" است.)
.RE
.
.
.TP
.BI include\~ file
فایل
.I file
را درج کرده و محتویات آن را به عنوان دستور تفسیر می‌کند.
.
.
.TP
.BI join\-authors\~ "string1 string2 string3"
چندین نویسنده را با
.IR string ها
به هم متصل می‌کند.
.
هنگامی که دقیقاً دو نویسنده وجود داشته باشد،
آن‌ها با
.IR string1
به هم متصل می‌شوند.
.
هنگامی که بیش از دو نویسنده وجود داشته باشد،
همه به جز دو نویسنده آخر با
.IR string2 ،
و دو نویسنده آخر با
.IR string3
به هم متصل خواهند شد.
.
اگر
.I string3
حذف شود،
پیش‌فرض آن
.IR string1
خواهد بود؛
اگر
.I string2
نیز حذف شود،
آن نیز به طور پیش‌فرض
.IR string1
خواهد شد.
.
برای مثال،
.
.RS
.RS
.EX
join\-authors \[dq] and \[dq] \[dq], \[dq] \[dq], and \[dq]
.EE
.RE
.
روش پیش‌فرض برای پیوند دادن نویسندگان را بازیابی می‌کند.
.RE
.
.
.TP
.B label\-in\-reference\*n
هنگام نوشتن مرجع در خروجی،
رشته
.B [F
را به عنوان برچسب مرجع تعریف می‌کند.
.
این رفتار پیش‌فرض است،
بنابراین نسخه منفی این دستور کاربردی‌تر است.
.
.
.TP
.B label\-in\-text\*n
برای هر مرجع یک برچسب در متن خروجی می‌دهد.
.
برچسب طبق توضیحات دستور
.B \%bracket\-label
از متن اطراف جدا خواهد شد.
.
این رفتار پیش‌فرض است،
بنابراین نسخه منفی این دستور کاربردی‌تر است.
.
.
.TP
.BI label\~ string
رشته
.I string
یک عبارت برچسب است که نحوه برچسب‌گذاری هر مرجع را توصیف می‌کند.
.
.
.TP
.BI separate\-label\-second\-parts\~ string
هنگام ادغام برچسب‌های دو بخشی،
بخش دوم از برچسب دوم را با
.I string
از برچسب اول جدا می‌کند.
.
توضیحات مربوط به عبارت برچسب
.B <>
را ببینید.
.
.
.TP
.B move\-punctuation\*n
در متن،
هرگونه علائم نگارشی در انتهای خط را به بعد از برچسب منتقل می‌کند.
.
توصیه می‌کنیم از این دستور استفاده کنید مگر آن که از اعداد بالانویس به عنوان برچسب بهره می‌برید.
.
.
.TP
.BI reverse\*n\~ string
فیلدهایی را که نام آن‌ها در
.I string
آمده است معکوس می‌کند.
.
یک عدد صحیح اختیاری پس از نام فیلد،
تعداد چنین فیلدهایی را به مقدار ارائه‌شده محدود می‌سازد؛
عدم ذکر عدد صحیح به معنای عدم وجود محدودیت است.
.
.
.TP
.BI search\-ignore\*n\~ fields
هنگام جستجوی کلیدها در پایگاه‌های داده‌ای که نمایه‌ای برای آن‌ها وجود ندارد،
محتویات
.I fields
را نادیده می‌گیرد.
.
در ابتدا،
فیلدهای
.B XYZ
نادیده گرفته می‌شوند.
.
.
.TP
.BI search\-truncate\*n\~ n
تنها ایجاب می‌کند که
.I n
نویسه اول کلیدها ارائه شوند.
.
در عمل هنگام جستجوی یک کلید،
کلمات موجود در پایگاه‌داده به حداکثر
.I n
و طول کلید کوتاه می‌شوند.
.
در ابتدا،
.I n
برابر با\~6 است.
.
.
.TP
.BI short\-label\*n\~ string
رشته
.I string
یک عبارت برچسب است که سبکی جایگزین
(معمولاً کوتاه‌تر)
از برچسب را مشخص می‌سازد.
.
این مورد زمانی استفاده می‌شود که پرچم
.B #
در استناد داده شده باشد.
.
هنگام استفاده از برچسب‌های سبک نویسنده-تاریخ،
هویت نویسنده یا نویسندگان گاهی از بافت متن مشخص است،
و بنابراین ممکن است مطلوب باشد که نویسنده یا نویسندگان از برچسب حذف شوند.
.
دستور
.B \%short\-label
معمولاً برای مشخص کردن برچسبی حاوی صرفاً یک تاریخ و احیاناً یک حرف رفع ابهام استفاده خواهد شد.
.
.
.TP
.BI sort\*n\~ string
مراجع را بر اساس
.I string
مرتب می‌کند.
.
مراجع به طور خودکار انباشته خواهند شد.
.
رشته
.I string
باید فهرستی از نام‌های فیلد باشد که هر کدام با یک عدد دنبال می‌شوند،
و نشان می‌دهند که چه تعداد فیلد با آن نام باید برای مرتب‌سازی استفاده شود.
.
.RB \[lq] + \[rq]
می‌تواند برای نشان دادن این که همه فیلدهای دارای آن نام باید استفاده شوند، به کار رود.
.
همچنین
.B .\&
می‌تواند برای نشان دادن این که مراجع باید با استفاده از برچسب (آزمایشی) مرتب شوند، به کار رود.
.
(زیربخش \[lq]عبارت‌های برچسب\[rq] در ادامه، مفهوم برچسب آزمایشی را توصیف می‌کند.)
.
.
.TP
.B sort\-adjacent\-labels\*n
برچسب‌هایی را که در متن مجاور هستند، بر اساس موقعیت آن‌ها در فهرست مراجع مرتب می‌کند.
.
این دستور معمولاً باید در صورتی که دستور
.B \%abbreviate\-label\-ranges
صادر شده باشد،
یا اگر عبارت برچسب شامل عبارت
.B <>
باشد، استفاده شود.
.
این دستور هیچ اثری ندارد مگر آن که مراجع در حال انباشته شدن باشند.
.
.
.\" ====================================================================
.SS "عبارت‌های برچسب"
.\" ====================================================================
.
عبارت‌های برچسب می‌توانند هم به صورت عادی و هم به صورت آزمایشی ارزیابی شوند.
.
نتیجه ارزیابی عادی برای خروجی استفاده می‌شود.
.
نتیجه ارزیابی آزمایشی،
که
.I "برچسب آزمایشی"
نامیده می‌شود،
برای جمع‌آوری اطلاعاتی استفاده می‌شود که ارزیابی عادی برای رفع ابهام برچسب به آن نیاز دارد.
.
عبارت‌های برچسب مشخص‌شده توسط دستورات
.B \%date\-as\-label
و
.B \%short\-label
به صورت آزمایشی ارزیابی نمی‌شوند.
.
ارزیابی عادی و آزمایشی برای همه انواع عبارت‌ها به جز عبارت‌های
.BR @ ،
.BR *
و
.B %
یکسان هستند.
.
توضیحات زیر برای ارزیابی عادی به کار می‌روند،
مگر آن که خلاف آن مشخص شده باشد.
.
.
.TP 8n \" "expr-n" + 2n
.IR field\~ [ n ]
بخش
.IR n م
از
.IR field
است.
.
اگر
.I n
حذف شود،
پیش‌فرض آن\~1 است.
.
.
.TP
.BI \[aq] string \[aq]
نویسه‌های درون
.I string
به صورت تحت‌اللفظی.
.
.
.TP
.B @
تمام نویسندگان متصل‌شده به گونه‌ای که توسط دستور
.B \%join\-authors
مشخص شده است.
.
کل نام هر نویسنده استفاده می‌شود.
.
با این حال،
اگر مراجع بر اساس نویسنده مرتب شده باشند
(یعنی مشخصه مرتب‌سازی با
.RB \[lq] A+ \[rq]
آغاز شود)،
آنگاه نام خانوادگی نویسندگان به جای آن استفاده خواهد شد،
به شرط آن که این کار ابهام ایجاد نکند،
و همچنین ممکن است یک زیرتوالی اولیه از نویسندگان به جای همه نویسندگان استفاده شود،
باز هم به شرط آن که این کار ابهامی به وجود نیاورد.
.
به ازای هر دو اثر مرجع با
.I n
نویسنده،
استفاده از تنها نام خانوادگی برای نویسنده
.IR n م
یک مرجع،
مبهم تلقی می‌شود اگر مرجع دیگر در
.IR n \|\-\|1
نویسنده اول مشترک باشد،
نویسندگان
.IR n م
هر مرجع یکسان نباشند،
اما نام خانوادگی نویسندگان
.IR n م
آن‌ها یکسان
.I باشد.
.
یک زیرتوالی اولیه سره از توالی نویسندگان برای یک مرجع، مبهم تلقی می‌شود اگر مرجعی با توالی دیگری از نویسندگان وجود داشته باشد که آن زیرتوالی را نیز به عنوان یک زیرتوالی اولیه سره داشته باشد.
.
هنگامی که یک زیرتوالی اولیه از نویسندگان استفاده می‌شود،
نویسندگان باقی‌مانده با رشته مشخص‌شده توسط دستور
.B \%et\-al
جایگزین می‌شوند؛
این دستور ممکن است شرایط اضافی دیگری را نیز که پیش از استفاده از زیرتوالی اولیه باید برآورده شوند مشخص کند.
.
علامت
.B @
به صورت آزمایشی به یک نمایش رسمی و معیار (canonical) از نویسندگان ارزیابی می‌شود،
به گونه‌ای که نویسندگانی که برای اهداف مرتب‌سازی برابر ارزیابی می‌شوند، نمایش یکسانی داشته باشند.
.
.
.TP
.BI % n
.TQ
.B %a
.TQ
.B %A
.TQ
.B %i
.TQ
.B %I
شماره سریالی مرجع که بر اساس نویسه پس از
.B %
قالب‌بندی شده است.
شماره سریالی یک مرجع برابر است با\~1 به علاوه تعداد مراجع پیشین با برچسب آزمایشی یکسان با این مرجع.
.
این عبارت‌ها به صورت آزمایشی به یک رشته خالی ارزیابی می‌شوند.
.
.TP
.IB expr *
اگر مرجع دیگری با برچسب آزمایشی یکسان با این مرجع وجود داشته باشد،
آنگاه
.IR expr ،
در غیر این صورت یک رشته خالی.
.
این عبارت به صورت آزمایشی به یک رشته خالی ارزیابی می‌شود.
.
.
.TP
.IB expr + n
.TQ
.IB expr \- n
تعداد
.I n
حرف بزرگ یا کوچک یا رقم اول
.RB ( + )
یا آخر
.RB ( \- )
از
.IR expr .
.
نویسه‌های ویژه
.I roff
(مانند
.BR \e(\[aq]a )
به عنوان یک حرف تکی شمرده می‌شوند.
.
رشته‌های اعراب حفظ می‌شوند اما در شمارش کل به حساب نمی‌آیند.
.
.
.TP
.IB expr .l
مورد
.I expr
تبدیل‌شده به حروف کوچک.
.
.
.TP
.IB expr .u
مورد
.I expr
تبدیل‌شده به حروف بزرگ.
.
.
.TP
.IB expr .c
مورد
.I expr
تبدیل‌شده به حروف بزرگ و حروف بزرگ کوچک.
.
.
.TP
.IB expr .r
مورد
.I expr
معکوس‌شده به طوری که نام خانوادگی در ابتدا باشد.
.
.
.TP
.IB expr .a
مورد
.I expr
همراه با نام‌های کوچک مخفف‌شده.
.
فیلدهای مشخص‌شده در دستور
.B \%abbreviate
پیش از ارزیابی هرگونه برچسب مخفف می‌شوند.
.
بنابراین
.B .a
تنها زمانی مفید است که می‌خواهید یک فیلد در برچسب مخفف شود اما در مرجع مخفف نگردد.
.
.
.TP
.IB expr .y
بخش سال از
.IR expr .
.
.
.TP
.IB expr .+y
بخش قبل از سال از
.IR expr ،
یا کل
.I expr
اگر شامل سال نباشد.
.
.
.TP
.IB expr .\-y
بخش بعد از سال از
.IR expr ،
یا یک رشته خالی اگر
.I expr
شامل سال نباشد.
.
.
.TP
.IB expr .n
بخش نام خانوادگی از
.IR expr .
.
.
.TP
.IB expr1 \[ti] expr2
مورد
.I expr1
به جز اینکه اگر آخرین نویسه
.I expr1
برابر با
.B \-
باشد،
با
.IR expr2
جایگزین خواهد شد.
.
.
.TP
.I expr1 expr2
الحاق
.I expr1
و
.IR expr2 .
.
.
.TP
.IB expr1 | expr2
اگر
.I expr1
غیرخالی باشد آنگاه
.I expr1
وگرنه
.IR expr2 .
.
.
.TP
.IB expr1 & expr2
اگر
.I expr1
غیرخالی باشد
آنگاه
.I expr2
وگرنه یک رشته خالی.
.
.
.TP
.IB expr1 ? expr2 : expr3
اگر
.I expr1
غیرخالی باشد
آنگاه
.I expr2
وگرنه
.IR expr3 .
.
.
.TP
.BI < expr >
برچسب در دو بخش است،
که با
.I expr
از هم جدا می‌شوند.
.
دو برچسب دو بخشی مجاور که بخش اول یکسانی دارند با پیوست کردن بخش دوم برچسب دوم به برچسب اول با فاصله‌گذاری رشته مشخص‌شده در دستور
.B \%separate\-label\-second\-parts
(در ابتدا، یک کاما به همراه یک فاصله) ادغام می‌شوند؛
برچسب حاصل نیز یک برچسب دو بخشی با همان بخش اول قبل از ادغام خواهد بود،
و بنابراین برچسب‌های بیشتری نیز می‌توانند با آن ادغام شوند.
.
مجاز است که بخش اول خالی باشد؛
این حالت ممکن است برای عبارت‌های مورد استفاده در دستور
.B \%short\-label
مطلوب باشد.
.
.
.TP
.BI ( expr )
مشابه
.IR expr .
.
برای گروه‌بندی استفاده می‌شود.
.
.
.LP
عبارت‌های بالا به ترتیب اولویت
(بیشترین اولویت در ابتدا)
فهرست شده‌اند؛
.B &
و
.B |
اولویت یکسانی دارند.
.
.
.\" ====================================================================
.SS "رابط ماکرو"
.\" ====================================================================
.
هر مرجع با یک فراخوانی از ماکروی
.B ]\-
آغاز می‌شود.
.
رشته
.B [F
به عنوان برچسب این مرجع تعریف خواهد شد،
مگر آن که دستور
.B \%no\-label\-in\-reference
داده شده باشد.
.
سپس مجموعه‌ای از تعاریف رشته‌ای،
یکی برای هر فیلد، می‌آید:
رشته
.BI [ X
متناظر با فیلد
.I X
است.
.
ثبات
.B [P
در صورتی که فیلد
.B P
حاوی بازه‌ای از صفحات باشد، برابر با\~1 تنظیم می‌شود.
.
ثبات‌های
.BR [T ،
.B [A
و
.B [O
بسته به این که آیا فیلدهای
.BR T ،
.B A
و
.B O
با هر یک از نویسه‌های
.B .?!\&
(نویسه پایان جمله) خاتمه می‌یابند یا خیر، برابر با\~1 تنظیم می‌شوند.
.
ثبات
.B [E
در صورتی که رشته
.B [E
شامل بیش از یک نام باشد، برابر با\~1 تنظیم خواهد شد.
.
به دنبال مرجع، فراخوانی ماکروی
.B ][
می‌آید.
.
اولین آرگومان این ماکرو عددی را مشخص می‌کند که نوع مرجع را نشان می‌دهد.
.
اگر یک مرجع شامل فیلد
.B J
باشد، به عنوان نوع\~1 دسته‌بندی می‌شود،
در غیر این صورت اگر شامل فیلد
.B B
باشد، نوع\~3 خواهد بود،
در غیر این صورت اگر شامل فیلد
.B G
یا
.B R
باشد، نوع\~4 خواهد بود،
در غیر این صورت اگر شامل فیلد
.B I
باشد، نوع\~2 خواهد بود،
وگرنه نوع\~0 خواهد بود.
.
آرگومان دوم یک نام نمادین برای این نوع است:
.BR other ،
.BR \%journal\-article ،
.BR book ،
.BR \%article\-in\-book
یا
.BR \%tech\-report .
.
گروه‌هایی از مراجع که انباشته شده‌اند یا توسط دستور
.B \%bibliography
تولید شده‌اند، با فراخوانی ماکروی
.B ]<
شروع شده و با فراخوانی ماکروی
.B ]>
خاتمه می‌یابند.
.
.
.br
.ne 5v
.\" ====================================================================
.SH "گزینه‌ها (OPTIONS)"
.\" ====================================================================
.
گزینه
.B \-\-help
پیام راهنمای نحوه استفاده را نمایش می‌دهد،
در حالی که
.B \-v
و
.B \%\-\-version
اطلاعات نگارش را نمایش می‌دهند؛
همگی پس از آن خارج می‌شوند.
.
.
.TP
.B \-R
خطوط آغازشونده با
.BR .R1 / .R2
را شناسایی نمی‌کند.
.
.
.P
سایر گزینه‌ها معادل دستورات
.I \%refer
هستند.
.
.
.TP 16n
.BI \-a\~ n
.B reverse
.BI A n
.
.
.TP
.B \-b
.B "\%no\-label\-in\-text; \%no\-label\-in\-reference"
.
.
.TP
.B \-B
در ادامه ببینید.
.
.
.TP
.BI \-c\~ fields
.B capitalize
.I fields
.
.
.TP
.B \-C
.B compatible
.
.
.TP
.B \-e
.B accumulate
.
.
.TP
.BI \-f\~ n
.B \%label
.BI % n
.
.
.TP
.BI \-i\~ fields
.B search\-ignore
.I fields
.
.
.TP
.B \-k
.B \%label
.B L\[ti]%a
.
.
.TP
.BI \-k\~ field
.B \%label
.IB field \[ti]%a
.
.
.TP
.B \-l
.B \%label
.B A.nD.y%a
.
.
.TP
.BI \-l\~ m
.B \%label
.BI A.n+ m D.y%a
.
.
.TP
.BI \-l\~, n
.B \%label
.BI A.nD.y\- n %a
.
.
.TP
.BI \-l\~ m , n
.B \%label
.BI A.n+ m D.y\- n %a
.
.
.TP
.B \-n
.B \%no\-default\-database
.
.
.TP
.BI \-p\~ db-file
.B database
.I db-file
.
.
.TP
.B \-P
.B move\-punctuation
.
.
.TP
.BI \-s\~ spec
.B sort
.I spec
.
.
.TP
.B \-S
.B \%label \[dq](A.n|Q) \[aq], \[aq] (D.y|D)\[dq]; \
\%bracket-\%label \[dq]\~(\[dq]\~)\~\[dq];\~\[dq]
.
.
.TP
.BI \-t\~ n
.B search\-truncate
.I n
.
.
.P
گزینه
.B B
دارای معادل‌های دستوری است با این تمایز که نام‌های فایل مشخص‌شده در خط فرمان به جای شیوه معمول، به گونه‌ای پردازش می‌شوند که گویی آرگومان‌های دستور
.B \%bibliography
هستند.
.
.
.TP 16n
.B \-B
.B "annotate X AP; \%no\-label\-in\-reference"
.
.
.TP
.BI \-B\~ field . macro
.B annotate
.I field
.IB macro ;
.B \%no\-label\-in\-reference
.
.
.\" ====================================================================
.SH "وضعیت خروج (EXIT STATUS)"
.\" ====================================================================
.
برنامه
.I \%refer
در صورت عملکرد موفقیت‌آمیز با
.RB وضعیت\~ 0 ،
اگر نتواند آرگومان‌های خط فرمان خود را تفسیر کند با
.RB وضعیت\~ 2 ،
و در صورت مواجهه با خطا در حین اجرا با
.RB وضعیت\~ 1
خارج می‌شود.
.
.
.\" ====================================================================
.SH "محیط (ENVIRONMENT)"
.\" ====================================================================
.
.TP 9n \" "REFER" + 2n + hand-tuned for PDF
.I REFER
نام فایلی را به این متغیر اختصاص دهید تا پایگاه‌داده پیش‌فرض را بازنویسی کند.
.
.
.\" ====================================================================
.SH "فایل‌ها (FILES)"
.\" ====================================================================
.
.TP
.I /usr/\:\%dict/\:\%papers/\:\%Ind
پایگاه‌داده پیش‌فرض.
.
.
.TP
.RI file \%.i
فایل‌های نمایه.
.
.
.TP
.I /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac/\:refer\:.tmac
ماکروها و رشته‌هایی را تعریف می‌کند که ادغام با بسته‌های ماکرویی را که مایل به پشتیبانی از
.IR \%refer
هستند تسهیل می‌نماید.
.
.
.LP
.I \%refer
از فایل‌های موقت استفاده می‌کند.
صفحه راهنمای
.MR groff 1
را برای جزئیات محل ایجاد چنین فایل‌هایی ببینید.
.
.
.\" ====================================================================
.SH "اشکال‌زدایی و گزارش باگ (REPORTING BUGS)"
.\" ====================================================================
.
در عبارت‌های برچسب،
عبارت‌های
.B <>
در داخل عبارت‌های
.BI . char
نادیده گرفته می‌شوند.
.
.
.\" ====================================================================
.SH "مثال‌ها (EXAMPLES)"
.\" ====================================================================
.
ما می‌توانیم عملکرد
.I \%refer
را با یک پایگاه‌داده کتاب‌شناختی نمونه شامل یک مدخل و یک سند ساده
.I roff
برای استناد به آن مدخل نشان دهیم.
.
.
.P
.RS
.EX
$ \c
.B cat > my\-db\-file
.B %A Daniel P.\[rs]& Friedman
.B %A Matthias Felleisen
.B %C Cambridge, Massachusetts
.B %D 1996
.B %I The MIT Press
.B %T The Little Schemer, Fourth Edition
$ \c
.B refer -p my\-db\-file
.B Read the book
.B .[
.B friedman
.B .]
.B on your summer vacation.
.I <Control+D>
\&.lf 1 \-
Read the book\[rs]*([.1\[rs]*(.]
\&.ds [F 1
\&.]\-
\&.ds [A Daniel P. Friedman and Matthias Felleisen
\&.ds [C Cambridge, Massachusetts
\&.ds [D 1996
\&.ds [I The MIT Press
\&.ds [T The Little Schemer, Fourth Edition
\&.nr [T 0
\&.nr [A 0
\&.][ 2 book
\&.lf 5 \-
on your summer vacation.
.EE
.RE
.
.
.P
مثال بالا به ما نشان می‌دهد که
.I \%refer
الف) یک برچسب \[lq]1\[rq] تولید می‌کند؛
ب) آن برچسب را درون درون‌یابی‌های رشته‌های
.RB \[lq] [. \[rq]
و
.RB \[lq] .] \[rq]
قرار می‌دهد؛
ج) ماکروی
.RB \[lq] ]\- \[rq]
را فراخوانی می‌کند؛
د) رشته‌ها و ثبات‌های حاوی برچسب و داده‌های کتاب‌شناختی را برای مرجع تعریف می‌کند؛
هـ) ماکروی
.RB \[lq] ][ \[rq]
را فراخوانی می‌نماید؛
و و) از درخواست
.B lf
برای بازیابی شماره خطوط ورودی استفاده می‌کند.
.
همان‌طور که در زیربخش \[lq]رابط ماکرو\[rq] در بالا ذکر شد،
این مسئولیت سند است که اطلاعات را به شکل مفیدی به کار گرفته و قالب‌بندی نماید.
.
بیایید ببینیم چگونه می‌توانیم
.MR groff_ms 7
را برای این کار به خدمت بگیریم.
.
.
.P
.RS
.EX
$ \c
.B REFER=my\-db\-file groff \-R \-ms
.B .LP
.B Read the book
.B .[
.B friedman
.B .]
.B on your summer vacation.
.B Commentary is available.\[rs]*{*\[rs]*}
.B .FS \[rs]*{*\[rs]*}
.B Space reserved for penetrating insight.
.B .FE
.EE
.RE
.
.
.LP
سازوکار شماره‌گذاری خودکار پاورقی در
.I ms
از شماره‌گذاری برچسب‌های
.I \%refer
آگاه نیست،
بنابراین ما به صورت دستی یک پاورقی نمادین (بالانویس‌شده) را برای حاشیه غیرکتاب‌شناختی خود مشخص کرده‌ایم.
.
.
.\" ====================================================================
.SH "همچنین ببینید (SEE ALSO)"
.\" ====================================================================
.
\[lq]Refer \[em] A Bibliography System\[rq],
توسط Bill Tuthill،
1983، \" 4.2BSD, /usr/doc/refer/refer.bib
Computing Services,
University of California,
Berkeley.
.
.
.P
\[lq]Some Applications of Inverted Indexes on the Unix System\[rq],
توسط M.\& E.\& Lesk،
1978،
AT&T Bell Laboratories Computing Science Technical Report No.\& 69.
.
.
.P
.MR \%indxbib 1 ,
.MR \%lookbib 1 ,
.MR lkbib 1
.
.
.\" Restore compatibility mode (for, e.g., Solaris 10/11).
.cp \n[*groff_refer_1_man_C]
.do rr *groff_refer_1_man_C
.
.
.\" Local Variables:
.\" fill-column: 72
.\" mode: nroff
.\" End:
.\" vim: set filetype=groff textwidth=72: