.TH "lightdm-webkit2-greeter" "1" "2016.01.10"
.nh
.ad l
.SH "نام (NAME)"
lightdm-webkit2-greeter \- خوش‌آمدگوی LightDM با استفاده از webkit2 برای اعمال پوسته
.SH "خلاصه دستور (SYNOPSIS)"
.PP
خوش‌آمدگوی LightDM که از webkit2 برای پوسته‌گذاری از طریق HTML/JavaScript استفاده می‌کند\&.
.PP
.SH "توضیحات (DESCRIPTION)"
.PP
برنامه lightdm-webkit2-greeter یک خوش‌آمدگوی LightDM است که برای پوسته‌گذاری از webkit2 استفاده می‌کند\&. پوسته‌ها را می‌توان با ترکیبی از HTML و JavaScript نوشت\&.
.PP
.SH "رابط برنامه‌نویسی جاوااسکریپت پوسته (THEME JAVASCRIPT API)"
لطفاً توجه داشته باشید تمام ویژگی‌ها و توابعی که با عنوان «منسوخ‌شده» (deprecated) مشخص شده‌اند، صرفاً برای سازگاری با نسخه‌های پیشین در دسترس هستند و در نسخه‌های آینده‌ی lightdm-webkit2-greeter حذف خواهند شد\&. توسعه‌دهندگان پوسته نباید از ویژگی‌ها یا توابع منسوخ‌شده در کارهای جدید استفاده کنند و برای اطمینان از تداوم عملکرد صحیح، باید آثار موجود را که از این موارد منسوخ استفاده می‌کنند به‌روزرسانی نمایند\&.
.PP
توابع زیر \fBباید\fR توسط پوسته‌ی خوش‌آمدگو ارائه شده و روی شیء سراسری «window» قابل فراخوانی باشند\&.
.PP
\fBshow_prompt(text, type)\fR
.RS 4
این تابع زمانی فراخوانی می‌شود که LightDM به هر دلیلی نیاز به اعلان ورودی از سوی کاربر داشته باشد، مانند درخواست گذرواژه\&. پارامتر «text» متن اعلان است، و پارامتر «type» یا «text» برای یک اعلان مرئی، یا «password» برای اعلانی است که ورودی آن باید پنهان شود\&.
.RE
.PP
\fBshow_message(text, type)\fR
.RS 4
این تابع زمانی فراخوانی می‌شود که LightDM نیاز به نمایش اطلاعاتی به کاربر داشته باشد\&. پارامتر «text» متن پیام است، و پارامتر «type» یا «info» برای پیام‌های اطلاع‌رسانی، یا «error» برای پیام‌های خطایی است که LightDM با آن‌ها مواجه شده است\&.
.RE
.PP
\fBauthentication_complete()\fR
.RS 4
این تابع زمانی توسط LightDM فراخوانی می‌شود که فرایند احراز هویت به پایان رسیده باشد\&.
.RE
.PP
\fBautologin_timer_expired()\fR
.RS 4
این تابع زمانی توسط LightDM فراخوانی می‌شود که زمان‌سنج ورود خودکار کاربر منقضی شده باشد\&. خوش‌آمدگو باید فرایند احراز هویت را بازنشانی کند\&.
.RE
.PP
توابع زیر برای فراخوانی توسط خوش‌آمدگو جهت اجرای عملیات در LightDM در دسترس هستند\&.
.PP
\fBlightdm\&.authenticate(username)\fR
.RS 4
نام کاربری کاربری را که می‌خواهیم احراز هویت را با آن آغاز کنیم مشخص می‌کند\&. توجه داشته باشید که اگر lightdm.authenticate را بدون آرگومان فراخوانی کنید، LightDM (از طریق PAM) تابع show_prompt() را برای درخواست نام کاربری فراخوانی خواهد کرد\&. تابع قدیمی‌تر lightdm\&.start_authentication() منسوخ شده است\&.
.RE
.PP
\fBlightdm\&.authenticate_as_guest()\fR
.RS 4
احراز هویت به عنوان کاربر مهمان\&.
.RE
.PP
\fBlightdm\&.cancel_authentication()\fR
.RS 4
احراز هویت هر کاربری را که در حال حاضر در فرایند احراز هویت است لغو می‌کند\&.
.RE
.PP
\fBlightdm\&.cancel_autologin()\fR
.RS 4
احراز هویت کاربر ورود خودکار را لغو می‌کند\&. تابع قدیمی‌تر lightdm\&.cancel_timed_login() منسوخ شده است\&.
.RE
.PP
\fBlightdm\&.get_hint(hint_name)\fR
.RS 4
مقدار راهنمای (hint) نام‌گذاری‌شده ارائه‌شده توسط LightDM را برمی‌گرداند\&.
.RE
.PP
\fBlightdm\&.suspend()\fR
.RS 4
در صورتی که خوش‌آمدگو اختیارات لازم را داشته باشد، سیستم را معلق (suspend) می‌کند\&.
.RE
.PP
\fBlightdm\&.hibernate()\fR
.RS 4
در صورتی که خوش‌آمدگو اختیارات لازم را داشته باشد، سیستم را به خواب زمستانی (hibernate) می‌برد\&.
.RE
.PP
\fBlightdm\&.start_session_sync(session)\fR
.RS 4
پس از اینکه LightDM کاربر را با موفقیت احراز هویت کرد، با فراخوانی این تابع نشست کاربر را آغاز کنید\&. پارامتر «session» نشست کاربرِ احراز هویت شده است\&. اگر هیچ نشستی ارسال نشود، کاربر احراز هویت شده با نشست پیش‌فرض سیستم آغاز به کار می‌کند\&. تابع قدیمی‌تر lightdm\&.login(user, session) منسوخ شده است\&.
.RE
.PP
\fBlightdm\&.respond(text)\fR
.RS 4
هنگامی که LightDM درخواست ورودی کرد، پاسخ را به LightDM ارائه می‌دهد\&. تابع منسوخ‌شده «provide_secret» نام داشت\&. این تابع همچنان برای سازگاری با گذشته در دسترس است، اما توسعه‌دهندگان خوش‌آمدگو باید به استفاده از lightdm.respond() روی بیاورند\&.
.RE
.PP
\fBlightdm\&.restart()\fR
.RS 4
در صورتی که خوش‌آمدگو اختیارات لازم را داشته باشد، سیستم را بازراه‌اندازی (restart) می‌کند\&.
.RE
.PP
\fBlightdm\&.set_language(lang)\fR
.RS 4
زبان را برای نشست فعلی LightDM تنظیم می‌کند\&.
.RE
.PP
\fBlightdm\&.shutdown()\fR
.RS 4
در صورتی که خوش‌آمدگو اختیارات لازم را داشته باشد، سیستم را خاموش می‌کند\&.
.RE
.PP
متغیرهای در دسترس درون خوش‌آمدگو عبارتند از:
.PP
\fBlightdm\&.authentication_user\fR
.RS 4
String\&. نام کاربریِ کاربری که در حال احراز هویت است، یا null در صورتی که هیچ احراز هویتی در جریان نباشد\&.
.RE
.PP
\fBlightdm\&.autologin_guest\fR
.RS 4
Boolean\&. مشخص می‌کند که آیا کاربر مهمان باید برای ورود خودکار استفاده شود یا خیر\&.
.RE
.PP
\fBlightdm\&.autologin_timeout\fR
.RS 4
Number\&. تعداد ثانیه‌های انتظار پیش از ورود خودکار به سیستم\&. متغیر قدیمی‌تر lightdm\&.timed_user_delay منسوخ شده است\&.
.RE
.PP
\fBlightdm\&.autologin_user\fR
.RS 4
String\&. نام حساب کاربری‌ای که باید پس از سپری شدن زمان تأخیر ورود خودکار، به‌طور خودکار وارد شود\&. متغیر قدیمی‌تر lightdm\&.timed_login_user منسوخ شده است\&.
.RE
.PP
\fBlightdm\&.can_hibernate\fR
.RS 4
Boolean\&. آیا سیستم توسط خوش‌آمدگو امکان رفتن به خواب زمستانی را دارد یا خیر\&.
.RE
.PP
\fBlightdm\&.can_restart\fR
.RS 4
Boolean\&. آیا سیستم توسط خوش‌آمدگو امکان بازراه‌اندازی شدن را دارد یا خیر\&.
.RE
.PP
\fBlightdm\&.can_shutdown\fR
.RS 4
Boolean\&. آیا سیستم توسط خوش‌آمدگو امکان خاموش شدن را دارد یا خیر\&.
.RE
.PP
\fBlightdm\&.can_suspend\fR
.RS 4
Boolean\&. آیا سیستم توسط خوش‌آمدگو امکان معلق شدن را دارد یا خیر\&.
.RE
.PP
\fBlightdm\&.default_session\fR
.RS 4
String\&. نام نشست پیش‌فرض (همان‌طور که در lightdm.conf پیکربندی شده است)\&.
.RE
.PP
\fBlightdm\&.has_guest_account\fR
.RS 4
Boolean\&. مشخص می‌کند که یک حساب کاربری مهمان برای ورود در دسترس است یا خیر\&.
.RE.PP
\fBlightdm\&.hide_users\fR
.RS 4
بولی (Boolean)\&. کل فهرست کاربران نباید نمایش داده شود\&.
.RE
.PP
\fBlightdm\&.hostname\fR
.RS 4
رشته (String)\&. نام میزبان سیستم\&.
.RE
.PP
\fBlightdm\&.is_authenticated\fR
.RS 4
بولی (Boolean)\&. نشان می‌دهد که آیا کاربر با موفقیت احراز هویت شده است یا خیر\&.
.RE
.PP
\fBlightdm\&.in_authentication\fR
.RS 4
بولی (Boolean)\&. نشان می‌دهد که آیا lightdm در حال حاضر در مرحلهٔ احراز هویت است یا خیر\&.
.RE
.PP
\fBlightdm\&.language\fR
.RS 4
رشته (String)\&. زبان انتخاب‌شدهٔ کنونی\&. نام متغیر قدیمی‌تر
lightdm\&.default_language منسوخ شده است\&.
.RE
.PP
\fBlightdm\&.layout\fR
.RS 4
رشته (String)\&. نام چیدمان صفحه‌کلید فعال کنونی\&. برای تغییر
چیدمان، یک نام چیدمان معتبر به این متغیر اختصاص دهید\&. نام متغیر قدیمی‌تر
lightdm\&.default_layout منسوخ شده است\&.
.RE
.PP
\fBlightdm\&.layouts\fR
.RS 4
آرایه (Array)\&. چیدمان‌های صفحه‌کلید موجود روی سیستم\&. آرایه‌ای
از اشیاء LightDMLayout را بازمی‌گرداند\&.
.RE
.PP
\fBlightdm\&.num_users\fR
.RS 4
عدد (Number)\&. تعداد کاربرانی که قادر به ورود به سیستم هستند\&.
.RE
.PP
\fBlightdm\&.select_guest\fR
.RS 4
بولی (Boolean)\&. کاربر مهمان باید به‌طور پیش‌فرض برای ورود انتخاب شود\&.
.RE
.PP
\fBlightdm\&.select_user\fR
.RS 4
رشته (String)\&. نام کاربری که باید به‌طور پیش‌فرض برای ورود انتخاب شود\&.
.RE
.PP
\fBlightdm\&.sessions\fR
.RS 4
آرایه (Array)\&. نشست‌های موجود روی سیستم\&. آرایه‌ای از
اشیاء LightDMSession را بازمی‌گرداند\&.
.RE
.PP
\fBlightdm\&.users\fR
.RS 4
آرایه (Array)\&. کاربرانی که قادر به ورود هستند\&. آرایه‌ای از اشیاء
LightDMUser را بازمی‌گرداند\&.
.RE
.PP
فراخوانی‌های زیر را می‌توان برای خواندن کلیدهای پیکربندی از فایل پیکربندی
lightdm-webkit2-greeter انجام داد\&.
.PP
config\&.get_str(section, key)\fR
.RS 4
مقدار رشته‌ای مرتبط با کلید زیر بخش "section" در فایل پیکربندی را بازمی‌گرداند\&.
.RE
.PP
config\&.get_num(section, key)\fR
.RS 4
مقدار عددی مرتبط با کلید زیر بخش "section" در فایل پیکربندی را بازمی‌گرداند\&.
.RE
.PP
config\&.get_bool(section, key)\fR
.RS 4
مقدار بولی مرتبط با کلید زیر بخش "section" در فایل پیکربندی را بازمی‌گرداند\&.
.RE
.PP
شیء greeterutil دارای توابع کمکی است که به منظور آسان‌تر کردن کار
سازندگان پوسته طراحی شده‌اند\&.
.PP
greeterutil\&.dirlist(path)\fR
.RS 4
آرایه‌ای از رشته‌های نام فایل‌های موجود در "path"، یا در صورت عدم
وجود مسیر، مقدار Null را بازمی‌گرداند\&.
.RE
.PP
greeterutil\&.txt2html(txt)\fR
.RS 4
یک تبدیل ساده به HTML از متن دریافت‌شده را بازمی‌گرداند\&. خطوط جدید با
<br> جایگزین می‌شوند و نویسه‌های \&&، <، > و " با معادل‌های HTML
خود جایگزین می‌گردند\&.
.RE
.PP
لطفاً برای فهرست کامل فراخوانی‌های موجود به مستندات LightDM API مراجعه
کنید\&. ابزار lightdm-webkit2-greeter تمام LightDM API را پیاده‌سازی می‌کند\&.
.PP.SH "پیکربندی (CONFIGURATION)"
.PP
\fB/etc/lightdm/lightdm-webkit2-greeter\&.conf\fR
.RS 4
فایل کلیدی (Keyfile) حاوی یک کلید: webkit-theme\&. این کلید باید مشخص کند که greeter از کدام پوسته استفاده کند\&.
.RE
.SH "فایل‌ها (FILES)"
.PP
\fB/usr/share/lightdm-webkit/themes\fR
.RS 4
دایرکتوری محل ذخیرهٔ پوسته‌ها\&.
.RE
.SH "مثال‌ها (EXAMPLES)"
.PP
لطفاً پوسته‌های «antergos» و «simple» را که همراه با lightdm-webkit2-greeter عرضه می‌شوند بررسی کنید\&.
.SH "همچنین ببینید (SEE ALSO)"
.PP
http://people\&.ubuntu\&.com/~robert-ancell/lightdm/reference/core\&.html
.SH "نویسندگان (AUTHORS)"
.PP
نسخهٔ قدیمی lightdm-webkit-greeter توسط Robert Ancell <robert\&.ancell\&@canonical\&.com\&> نوشته شد\&.
این برنامه توسط توسعه‌دهندگان Antergos <dev@antergos\&.com> به webkit2 پورت شد\&. همچنین شامل بهبودهای کدی است که توسط Scott Balneaves <sbalneav@ltsp\&.org> مشارکت شده است\&.