.TH git-annex-examinekey 1
.SH "نام (NAME)"
git-annex-examinekey \- چاپ اطلاعات ذخیره‌شده در یک کلید ضمیمه
.PP
.SH "خلاصه دستور (SYNOPSIS)"
.B git annex examinekey
[\fIkey\fR ...]
.PP
.SH "توضیحات (DESCRIPTION)"
این دستور سطح پایین (plumbing\-level) یک کلید را دریافت کرده و اطلاعاتی را چاپ می‌کند که صرفاً با بررسی همان کلید قابل تعیین هستند.
.PP
.SH "گزینه‌ها (OPTIONS)"
.TP
\fB\-\-format=value\fR
استفاده از قالب‌بندی سفارشی برای خروجی.
.IP
مقدار مشخص‌شده یک رشته قالب است که در آن
.B ${var}
به مقدار متغیر بسط داده می‌شود. برای راست‌چین کردن متغیر با فاصله‌های خالی، از
.B ${var;width}
استفاده کنید؛ برای چپ‌چین کردن متغیر، از
.B ${var;\-width}
استفاده کنید؛ برای گریز دادن (اسکیپ کردن) نویسه‌های نامتعارف (شامل نویسه‌های کنترلی) در یک متغیر، از
.B ${escaped_var}
استفاده نمایید.
.IP
برای تولید مسیری از بالاترین سطح مخزن به شیء git-annex برای یک کلید، از
.B ${objectpath}
استفاده کنید. برای تولید مقدار یک فایل اشاره‌گر git-annex برای یک کلید، از
.B ${objectpointer}
استفاده نمایید.
.IP
این متغیرها نیز برای استفاده در قالب‌ها در دسترس هستند:
.BR ${key} ،
.BR ${backend} ،
.BR ${bytesize} ،
.BR ${humansize} ،
.BR ${keyname} ،
.BR ${hashdirlower} ،
.BR ${hashdirmixed} ،
.B ${mtime}
(برای فیلد mtime از یک کلید WORM) و
.B ${file}
(زمانی که نام یک فایل به examinekey داده شده باشد).
.IP
همچنین،
.B '\en'
خط جدید،
.B '\e000'
نویسه تهی (NULL) و غیره است.
.IP
قالب خروجی پیش‌فرض مشابه با
.B \-\-format='${escapedkey}\en'
است، به جز زمانی که خروجی به ترمینال ارسال می‌شود که نویسه‌های کنترلی اسکیپ خواهند شد.
.TP
\fB\-\-json\fR
فعال‌سازی خروجی JSON. این گزینه برای تجزیه خروجی توسط برنامه‌هایی که از git-annex استفاده می‌کنند در نظر گرفته شده است. هر خط از خروجی یک شیء JSON است.
.TP
\fB\-\-json\-error\-messages\fR
پیام‌هایی که در حالت عادی به جریان خطای استاندارد ارسال می‌شدند، در عوض درون JSON قرار می‌گیرند.
.TP
\fB\-\-migrate\-to\-backend=backend\fR
تلاش برای مهاجرت کلید ورودی به پشتیبان جدید مشخص‌شده. در صورت موفقیت، اطلاعات مربوط به کلید مهاجرت‌یافته چاپ می‌شود؛ در غیر این صورت، اطلاعات کلید ورودی چاپ خواهد شد.
.IP
این گزینه تنها مهاجرت‌های سریع را انجام می‌دهد؛ محتوای کلید مجدداً هش‌گذاری نخواهد شد و عملیات پرهزینه مشابهی انجام نمی‌گیرد.
.IP
یک روش برای استفاده از این گزینه، افزودن یک پسوند به کلید است:
.IP
.EX
git-annex examinekey SHA256\-\-xxx \-\-migrate\-to\-backend=SHA256E \-\-filename=foo.tar.gz
.EE
.IP
یا برای حذف پسوند از یک کلید:
.IP
.EX
git-annex examinekey SHA256E\-\-xxx.tar.gz \-\-migrate\-to\-backend=SHA256
.EE
.TP
\fB\-\-filename=name\fR
نام فایلی که با کلید مرتبط است، مانند یک فایل در درخت کاری (work tree).
نیازی به وجود داشتن این فایل نیست. این گزینه هنگام استفاده از
.B \-\-migrate\-to\-backend
برای افزودن پسوند به کلید مورد نیاز است.
.TP
\fB\-\-batch\fR
فعال‌سازی حالت دسته‌ای (batch mode)؛ حالتی که در آن خطی حاوی یک کلید از ورودی استاندارد (stdin) خوانده شده، اطلاعات مربوط به آن به خروجی استاندارد (stdout) فرستاده می‌شود و این فرآیند تکرار می‌گردد.
.IP
به منظور ارائه نام فایل مرتبط با کلید نیز می‌توان خط ورودی را با قالب «$key $file» ارسال کرد.
.PP
همچنین می‌توان از
.BR git\-annex\-common\-options (1)
استفاده کرد.
.SH "همچنین ببینید (SEE ALSO)"
.BR git\-annex (1)
.PP
.SH "نویسنده (AUTHOR)"
Joey Hess <id@joeyh.name>