.\" Generated by scdoc 1.11.5
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "SCDOC" "5" "2026\-07\-07"
.PP
.SH "نام (NAME)"
.PP
scdoc \- قالب سند برای نگارش صفحات راهنما
.PP
.SH "سینتکس (SYNTAX)"
.PP
پرونده‌های ورودی باید از کدگذاری UTF\-8 استفاده کنند.\&
.PP
.SS "مقدمه (Preamble)"
.PP
هر پرونده scdoc باید با مقدمه زیر آغاز شود:
.PP
.RS 4
\fINAME\fR(\fIsection\fR) ["left_footer" ["center_header"]]
.PP
.RE
\fINAME\fR نام صفحه راهنمایی است که می‌نویسید، و \fIsection\fR بخشی است که برای آن می‌نویسید (برای اطلاعات بیشتر درباره بخش‌های راهنما، \fIman\fR(1) را ببینید).\&
.PP
\fIleft_footer\fR و \fIcenter_header\fR آرگومان‌های اختیاری هستند که متن قرارگرفته در آن مکان‌ها را در صفحه راهنمای تولیدشده تنظیم می‌کنند و \fBباید\fR با علامت نقل‌قول دوتایی محصور شوند.\&
.PP
.SS "عناوین بخش‌ها (Section headers)"
.PP
هر بخش از صفحه راهنمای شما باید با چیزی شبیه به موارد زیر آغاز شود:
.PP
.RS 4
# HEADER NAME
.PP
.RE
عناوین زیربخش‌ها نیز شناخته می‌شوند \- از دو علامت هش استفاده کنید.\& هر عنوان باید در هر دو طرف خود یک خط خالی داشته باشد.\&
.PP
.SS "پاراگراف‌ها (Paragraphs)"
.PP
یک پاراگراف جدید را با یک خط خالی آغاز کنید.\&
.PP
.SS "شکست خط (Line breaks)"
.PP
با پایان دادن یک خط با ++ یک شکست خط درج کنید.\&
.PP
نتیجه شبیه به
.br
این خواهد بود.\&
.PP
.SS "قالب‌بندی (Formatting)"
.PP
متن را می‌توان با ستاره و زیرخط \fBتوپر\fR یا \fIزیرخط‌دار\fR کرد: *bold* یا _underlined_.\& زیرخط‌ها در میان_کلمات نادیده گرفته می‌شوند.\&
.PP
.SS "تورفتگی (Indentation)"
.PP
می‌توانید خطوط را با نویسه تب (\fB\et\fR) دندانه‌دار کنید تا به اندازه ۴ فاصله در خروجی تورفته شوند.\& خطوط تورفته نمی‌توانند حاوی عناوین بخش‌ها باشند.\&
.PP
.RS 4
نتیجه شبیه به چیزی مانند این خواهد بود.\&
.PP
می‌توانید از چندین خط و بیشتر انواع \fIقالب‌بندی\fR استفاده کنید.\&
.PP
.RE
تورفتگی را کم کنید تا به حالت عادی برگردید، یا دوباره تورفتگی ایجاد کنید تا عمق تورفتگی افزایش یابد.\&
.PP
.SS "فهرست‌ها (Lists)"
.PP
می‌توانید فهرست‌های نشانه‌دار را با خط تیره (\-) شروع کنید، مانند زیر:
.PP
.nf
.RS 4
\- Item 1
\- Item 2
	\- Subitem 1
	\- Subitem 2
\- Item 3
.fi
.RE
.PP
نتیجه شبیه به این خواهد بود:
.PP
.PD 0
.IP \(bu 4
Item 1
.IP \(bu 4
Item 2
.RS 4
.IP \(bu 4
Subitem 1
.IP \(bu 4
Subitem 2
.RE
.IP \(bu 4
Item 3
.PD
.PP
همچنین می‌توانید ورودی‌های طولانی را با دادن همان سطح تورفتگی، به اضافه دو فاصله، در خط دیگری ادامه دهید.\& آن‌ها به عنوان یک ورودی فهرست واحد رندر می‌شوند.\&
.PP
.nf
.RS 4
\- Item 1 is pretty long so let\&'s
  break it up onto two lines
\- Item 2 is shorter
	\- But its children can go on
	  for a while
.fi
.RE
.PP
.PD 0
.IP \(bu 4
Item 1 is pretty long so let'\&s
break it up onto two lines
.IP \(bu 4
Item 2 is shorter
.RS 4
.IP \(bu 4
But its children can go on
for a while
.PD
.PP
.RE
.SS "فهرست‌های شماره‌دار (Numbered lists)"
.PP
فهرست‌های شماره‌دار شبیه فهرست‌های معمولی هستند، اما به‌جای خط تیره (\-) با نقطه (.\&) شروع می‌شوند، مانند زیر:
.PP
.nf
.RS 4
\&. Item 1
\&. Item 2
\&. Item 3,
  with multiple lines
.fi
.RE
.PP
.PD 0
.IP 1. 4
Item 1
.IP 2. 4
Item 2
.IP 3. 4
Item 3,
with multiple lines
.PD
.PP
.SS "جدول‌ها (Tables)"
.PP
برای شروع یک جدول، یک خط خالی و سپس هر تعداد سطر اضافه کنید.\&
.PP
هر سطر از جدول باید با | یا : برای شروع یک سطر یا ستون جدید به ترتیب آغاز شود (یا فاصله برای ادامه خانه قبلی در چندین خط)، و به دنبال آن [ یا \- یا ] برای تراز کردن محتوا به چپ، وسط یا راست، و سپس یک فاصله و محتوای آن خانه بیاید.\& می‌توانید به‌جای مشخص‌کننده تراز از فاصله استفاده کنید تا تراز همان ستون در سطر قبلی به ارث برسد.\& هر سطر باید تعداد ستون‌های یکسانی داشته باشد؛ ستون‌های خالی مجاز هستند.\&
.PP
نخستین نویسه از اولین سطر محدود به | نیست و معنای خاصی دارد.\& علامت [ جدولی با حاشیه در اطراف هر خانه ایجاد می‌کند.\& علامت | جدولی بدون حاشیه ایجاد می‌کند.\& علامت ] جدولی با یک حاشیه در اطراف کل جدول ایجاد می‌کند.\&
.PP
برای پایان دادن به جدول خود، یک خط خالی بعد از آخرین سطر اضافه کنید.\&
.PP
.nf
.RS 4
[[ *Foo*
:\- _Bar_
:\-
|  *Row 1*
:  Hello
:] world!
|  *Row 2*
:  こんにちは
:  世界
   !
.fi
.RE
.PP
.TS
allbox;l c c
l c r
l c r.
T{
\fBFoo\fR
T}	T{
\fIBar\fR
T}	T{

T}
T{
\fBRow 1\fR
T}	T{
Hello
T}	T{
world!\&
T}
T{
\fBRow 2\fR
T}	T{
こんにちは
T}	T{
世界 !\&
T}
.TE
.sp 1
همچنین می‌توانید ستون‌ها را طوری تنظیم کنید که فضای موجود را با < (تراز چپ)، = (تراز وسط) و > (تراز راست) پر کنند، مانند زیر:
.PP
.nf
.RS 4
[[ *Normal column*
:< Expanded column
|  *Foo*
:  Bar
.fi
.RE
.PP
.TS
allbox;l lx
l lx.
T{
\fBNormal column\fR
T}	T{
Expanded column
T}
T{
\fBFoo\fR
T}	T{
Bar
T}
.TE
.sp 1
.SS "متن تحت‌اللفظی (Literal text)"
.PP
می‌توانید قالب‌بندی scdoc را خاموش کرده و متن را به‌صورت تحت‌اللفظی با کدهای گریز و بلوک‌های تحت‌اللفظی خروجی دهید.\& درج یک \e در متن منبع شما باعث می‌شود نماد پس از آن به عنوان تحت‌اللفظی تلقی شده و مستقیماً در خروجی کپی شود.\& همچنین می‌توانید بلوک‌هایی از نحو تحت‌اللفظی مانند زیر ایجاد کنید:
.PP
.nf
.RS 4
```
_This formatting_ will *not* be interpreted by scdoc\&.
```
.fi
.RE
.PP
این بلوک‌ها یک سطح تورفته خواهند شد.\& توجه داشته باشید که متن تحت‌اللفظی در نمایش‌دهنده man به‌صورت کلمه‌به‌کلمه نشان داده می‌شود \- یعنی ابزاری برای درج ماکروهای roff سفارشی شما در خروجی نیست.\& توجه داشته باشید که \e همچنان در داخل بلوک‌های تحت‌اللفظی تفسیر می‌شود، که به عنوان مثال می‌تواند برای خروجی دادن \``` در داخل یک بلوک تحت‌اللفظی مفید باشد.\&
.PP
.SS "توضیحات (Comments)"
.PP
خطوطی که با ; و یک فاصله شروع می‌شوند نادیده گرفته می‌شوند.\&
.PP
.nf
.RS 4
; This is a comment
.fi
.RE
.PP
.SH "قراردادها (CONVENTIONS)"
.PP
طبق قرارداد، تمام اسناد scdoc باید به طور دقیق روی ۸۰ ستون شکسته شوند.\&
.PP
.SH "همچنین ببینید (SEE ALSO)"
.PP
\fIscdoc\fR(1)
.PP
.SH "نویسندگان (AUTHORS)"
.PP
نگهداری توسط Drew DeVault <sir@cmpwn.\&com>.\& سورس‌های به‌روز را می‌توان در
<https://git.\&sr.\&ht/\(tisircmpwn/scdoc>
یافت و باگ‌ها یا وصله‌ها را می‌توان از طریق ایمیل به
\(tisircmpwn/public\-inbox@lists.\&sr.\&ht
ارسال کرد.\&