.\" Man page generated from reStructuredText
.\" by the Docutils 0.22.2 manpage writer.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "ctags-json-output" "5" "" "1.0" "Universal Ctags"
.SH "نام (NAME)"
ctags-json-output \- خروجی ctags بر پایه قالب JSON
.SH "خلاصه دستور (SYNOPSIS)"
.nf
\fBctags\fP \-\-output\-format=json ...
.fi
.sp
.SH "توضیحات (DESCRIPTION)"
.sp
ابزار Universal Ctags از قالب خروجی JSON \%<https://www.json.org> (به طور دقیق‌تر JSON Lines \%<https://jsonlines.org>) در صورتی که فایل اجرایی ctags با \fBlibjansson\fP کامپایل شده باشد پشتیبانی می‌کند. خروجی JSON به طور پیش‌فرض به خروجی استاندارد ارسال می‌شود.
.SH "قالب (FORMAT)"
.sp
هر سطر JSON نمایانگر یک برچسب (tag) است.
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ ctags \-\-extras=+p \-\-output\-format=json \-\-fields=\-s input.py
{\(dq_type\(dq: \(dqptag\(dq, \(dqname\(dq: \(dqJSON_OUTPUT_VERSION\(dq, \(dqpath\(dq: \(dq1.0\(dq, \(dqpattern\(dq: \(dqin development\(dq}
{\(dq_type\(dq: \(dqptag\(dq, \(dqname\(dq: \(dqTAG_FILE_SORTED\(dq, \(dqpath\(dq: \(dq1\(dq, \(dqpattern\(dq: \(dq0=unsorted, 1=sorted, 2=foldcase\(dq}
\&...
{\(dq_type\(dq: \(dqtag\(dq, \(dqname\(dq: \(dqKlass\(dq, \(dqpath\(dq: \(dq/tmp/input.py\(dq, \(dqpattern\(dq: \(dq/^class Klass:$/\(dq, \(dqlanguage\(dq: \(dqPython\(dq, \(dqkind\(dq: \(dqclass\(dq}
{\(dq_type\(dq: \(dqtag\(dq, \(dqname\(dq: \(dqmethod\(dq, \(dqpath\(dq: \(dq/tmp/input.py\(dq, \(dqpattern\(dq: \(dq/^    def method(self):$/\(dq, \(dqlanguage\(dq: \(dqPython\(dq, \(dqkind\(dq: \(dqmember\(dq, \(dqscope\(dq: \(dqKlass\(dq, \(dqscopeKind\(dq: \(dqclass\(dq}
\&...
.EE
.UNINDENT
.UNINDENT
.sp
کلیدی که با \fB_\fP شروع نمی‌شود به یک فیلد از ctags نگاشت می‌شود.
گزینه‌های \(dq\fB\-\-output\-format=json \-\-list\-fields\fP\(dq فهرست این فیلدها را نمایش می‌دهند.
.sp
کلیدی که با \fB_\fP آغاز می‌شود نشان‌دهنده فرا‌داده (متادیتا) مربوط به آن سطر JSON است. در حال حاضر فقط کلید \fB_type\fP استفاده می‌شود. اگر مقدار این کلید \fBtag\fP باشد، سطر JSON نشان‌دهنده یک برچسب معمولی است. اگر مقدار آن \fBptag\fP باشد، سطر نشان‌دهنده یک شبه‌برچسب (pseudo\-tag) است.
.sp
قالب خروجی ممکن است در آینده تغییر کند. شبه‌برچسب \fBJSON_OUTPUT_VERSION\fP به ابزارهای کلاینت این امکان را می‌دهد تا تغییرات را مدیریت کنند. نسخه فعلی \(dq1.0\(dq است. یک ابزار کلاینت می‌تواند با استفاده از کلید \fBpath\fP، شماره نسخه را از شبه‌برچسب استخراج کند.
.sp
قالب خروجی JSON به تازگی طراحی شده و محدودیت‌های موجود در قالب فایل پیش‌فرض برچسب‌ها را ندارد.
.INDENT 0.0
.IP \(bu 2
مقادیر کلید \fBkind\fP در قالب فلگ‌های نام طولانی ارائه می‌شوند و هیچ مقدار تک‌حرفی در اینجا وجود ندارد.
.IP \(bu 2
نام‌های محدوده (Scope) و انواع محدوده دارای کلیدهای متمایز هستند: \fBscope\fP و \fBscopeKind\fP\&.
این مقادیر در قالب پیش‌فرض فایل tags با یکدیگر ترکیب شده بودند.
.UNINDENT
.SH "نوع داده مورد استفاده در فیلد (DATA TYPE USED IN A FIELD)"
.sp
مقادیر بیشتر کلیدها در قالب نوع رشته‌ای (string) در JSON نمایش داده می‌شوند.
با این حال، برخی از آن‌ها در قالب نوع‌های رشته‌ای، عددی صحیح (integer) یا بولی (boolean) هستند.
.sp
گزینه‌های \(dq\fB\-\-output\-format=json \-\-list\-fields\fP\(dq نشان می‌دهند که چه نوع داده‌ای در فیلدهای JSON به کار رفته است.
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ ctags \-\-output\-format=json \-\-list\-fields
#LETTER NAME           ENABLED LANGUAGE         JSTYPE FIXED DESCRIPTION
F       input          yes     NONE             s\-\-    no    input file
\&...
P       pattern        yes     NONE             s\-b    no    pattern
\&...
f       file           yes     NONE             \-\-b    no    File\-restricted scoping
\&...
e       end            no      NONE             \-i\-    no    end lines of various items
\&...
.EE
.UNINDENT
.UNINDENT
.sp
ستون \fBJSTYPE\fP نوع داده‌ها را نشان می‌دهد.
.INDENT 0.0
.TP
.B \(aq\fBs\fP\(aq
رشته (string)
.TP
.B \(aq\fBi\fP\(aq
عدد صحیح (integer)
.TP
.B \(aq\fBb\fP\(aq
بولی (boolean - مقدار true یا false)
.UNINDENT
.sp
به عنوان مثال، مقدار فیلد \fBpattern\fP در ctags یک مقدار رشته‌ای یا بولی می‌گیرد.
.SH "نسخه‌ها (VERSIONS)"
.SS "تغییرات از زمان \(dq0.0\(dq (Changes since 0.0)"
.INDENT 0.0
.IP \(bu 2
کلید جدید \fBkindName\fP برای شبه‌برچسب \fBTAG_ROLE_DESCRIPTION\fP
.sp
کلید \fBkindName\fP برای ذخیره نام نوع در شبه‌برچسب‌های \fBTAG_ROLE_DESCRIPTION\fP اضافه شده است.
.sp
در نسخه 0.0، یک شبه‌برچسب \(dqTAG_ROLE_DESCRIPTION\(dq به این شکل چاپ می‌شد:
.INDENT 2.0
.INDENT 3.5
.sp
.EX
{\(dq_type\(dq: \(dqptag\(dq, \(dqname\(dq: \(dqTAG_ROLE_DESCRIPTION\(dq,
                  \(dqparserName\(dq: \(dqLANG!KIND\(dq, }
.EE
.UNINDENT
.UNINDENT
.sp
در نسخه 1.0، به این شکل چاپ می‌شود:
.INDENT 2.0
.INDENT 3.5
.sp
.EX
{\(dq_type\(dq: \(dqptag\(dq, \(dqname\(dq: \(dqTAG_ROLE_DESCRIPTION\(dq,
                  \(dqparserName\(dq: \(dqLANG\(dq,
                  \(dqkindName\(dq: \(dqKIND\(dq,  }
.EE
.UNINDENT
.UNINDENT
.UNINDENT
.SH "همچنین ببینید (SEE ALSO)"
.sp
ctags(1), tags(5), ctags\-client\-tools(7)
.\" End of generated man page.