.Dd December 17, 2017
.Dt NVIM 1
.Os
.Sh "نام (NAME)"
.Nm nvim
.Nd ویرایش متن \- ویرایشگر نئو‌ویم، نسل جدید ویم
.Sh "خلاصه دستور (SYNOPSIS)"
.Nm
.Op Ar options
.Op Ar file ...
.Nm
.Op Ar options
.Fl
.Nm
.Op Ar options
.Fl t Ar tag
.Nm
.Op Ar options
.Fl q Op Ar errorfile
.Sh "توضیحات (DESCRIPTION)"
.Nm
یک ویرایشگر متن بر پایه ویم (Vim) است.
برای اجرای
.Nm
می‌توانید آن را همراه با هر تعداد گزینه و/یا فایل اجرا کنید:
.Pp
.Dl nvim [گزینه‌ها] [فایل ...]
.Pp
دستورات در
.Nm
با دونقطه
.Pq Sq \&:
آغاز می‌شوند. عبارت \(lq:help موضوع\(rq را تایپ کنید تا راهنمای موضوع مورد نظر نمایش داده شود.
از کلید <Tab> و CTRL-D برای تکمیل خودکار موضوعات راهنما استفاده کنید (\(lq:help cmdline-completion\(rq).
.Pp
بخش راهنمای \(lqquickref\(rq یک مرجع فشرده و سریع از امکانات ویرایشگر است:
.Dl :help quickref
.Pp
اگر در کار با ویم یا نئو‌ویم تازه‌کار هستید، آموزش ۳۰ دقیقه‌ای تعاملی را آغاز کنید:
.Dl :Tutor
.Pp
پس از نصب یا به‌روزرسانی نئو‌ویم، اجرای بررسی خودکار سلامت سیستم پیشنهاد می‌شود:
.Dl :checkhealth
.Bl -tag -width Fl
.It Ar file ...
فایل یا فایل‌ها برای ویرایش.
برای هر فایل یک بافر باز می‌شود.
برای جابه‌جایی میان بافرها، از دستورات
.Ic :next
و
.Ic :previous
استفاده کنید.
.It Fl
متن را از ورودی استاندارد (stdin) تا رسیدن به
.Dv EOF
می‌خواند، سپس یک بافر با آن متن باز می‌کند.
ورودی کاربر از خروجی خطای استاندارد (stderr) که باید یک ترمینال باشد خوانده می‌شود.
.El
.Sh "گزینه‌ها (OPTIONS)"
.Bl -tag -width Fl
.It Fl t Ar tag
برچسب
.Ar tag
را در فایل tags می‌یابد، فایل مربوطه به عنوان فایل جاری باز شده و دستور مرتبط اجرا می‌شود.
مکان‌نما در موقعیت برچسب در فایل قرار می‌گیرد.
.Ic ":help tag-commands"
.It Fl q Op Ar errorfile
حالت رفع سریع خطا (QuickFix).
اولین خطا را در
.Ar errorfile
نمایش می‌دهد.
اگر
.Ar errorfile
مشخص نشود، از مقدار گزینه \(aqerrorfile\(aq استفاده می‌شود (پیش‌فرض
.Cm errors.err
است).
خطاهای بعدی با دستور
.Ic :cnext
قابل پیمایش هستند.
.Ic ":help quickfix"
.It Fl -
پایان گزینه‌ها.
آرگومان‌های بعدی به عنوان نام فایل حقیقی در نظر گرفته می‌شوند، حتی اگر با خط تیره
.Pq Sq -
شروع شوند.
.It Fl e
حالت Ex، خواندن ورودی استاندارد به عنوان دستورات Ex.
.Ic ":help Ex-mode"
.It Fl E
حالت Ex، خواندن ورودی استاندارد به عنوان متن ساده.
.Ic ":help Ex-mode"
.It Fl es
حالت غیرتعاملی و خاموش Ex، خواندن stdin به عنوان دستورات Ex.
برای اسکریپت‌نویسی بسیار مفید است زیرا برعکس
.Fl e
هیچ رابط کاربری (UI) را راه‌اندازی نمی‌کند.
.Ic ":help silent-mode"
.It Fl \&Es
حالت غیرتعاملی و خاموش Ex، خواندن stdin به عنوان متن ساده.
برای اسکریپت‌نویسی مناسب است زیرا برعکس
.Fl E
هیچ رابط کاربری را راه‌اندازی نمی‌کند.
.Ic ":help silent-mode"
.It Fl d
حالت مقایسه تفاوت‌ها (Diff mode).
تفاوت میان دو تا هشت فایل را نمایش می‌دهد، مشابه با
.Xr sdiff 1 .
.Ic ":help diff"
.It Fl R
حالت فقط‌خواندنی (Read-only).
گزینه \(aqreadonly\(aq را فعال می‌کند.
به معنای اعمال
.Fl n
نیز هست.
بافرها قابل ویرایش هستند، اما در صورتی که به فایلی متصل باشند نمی‌توان آن‌ها را روی دیسک نوشت مگر با افزودن علامت تعجب به دستورات Ex، مانند
.Ic :w\&! .
.Ic ":help 'readonly'"
.It Fl m
غیرفعال کردن ذخیره تغییرات روی فایل‌ها با بازنشانی گزینه \(aqwrite\(aq.
نوشتن روی فایل غیرفعال می‌شود اما ویرایش بافرها همچنان ممکن است.
.It Fl M
غیرفعال کردن هرگونه تغییر. گزینه‌های \(aqwrite\(aq و \(aqmodifiable\(aq را غیرفعال می‌کند تا امکان تغییر فایل و بافر سلب شود.
.It Fl b
حالت باینری برای ویرایش فایل‌های باینری و اجرایی.
.Ic ":help edit-binary"
.It Fl A
حالت عربی.
گزینه \(aqarabic\(aq را فعال می‌کند.
.It Fl H
حالت عبری.
گزینه‌های \(aqhkmap\(aq و \(aqrightleft\(aq را فعال می‌کند.
.It Fl V Ns Oo Ar N Oc Ns Op Ar file
حالت پرگویی (Verbose).
پیام‌های اشکال‌زدایی را چاپ می‌کند.
.Ar N
سطح پرگویی است که پیش‌فرض آن
.Cm 10
است.
در صورت مشخص شدن
.Ar file ،
پیام‌ها به جای چاپ روی صفحه در فایل
.Ar file
ذخیره می‌شوند.
.Ic ":help 'verbose'"
.It Fl D
حالت اشکال‌زدایی اسکریپت‌های ویم (Vimscript debug mode).
هنگام اجرای اولین دستور از یک اسکریپت فعال می‌شود.
.Ic ":help debug-mode"
.It Fl n
غیرفعال کردن استفاده از فایل‌های مبادله (Swap files).
مقدار گزینه \(aqupdatecount\(aq را روی
.Cm 0
تنظیم می‌کند. برای ویرایش فایل‌ها روی رسانه‌های ذخیره‌سازی کند مفید است.
.It Fl r Op Ar file
حالت بازیابی (Recovery mode).
اگر
.Ar file
مشخص نشود، فهرستی از فایل‌های سواپ همراه با اطلاعات بازیابی ارائه می‌دهد.
در غیر این صورت فایل سواپ
.Ar file
برای بازیابی یک نشست کاری متوقف‌شده استفاده می‌شود.
.Ic ":help recovery"
.It Fl L Op Ar file
نام مستعار برای
.Fl r .
.It Fl u Ar vimrc
استفاده از فایل
.Ar vimrc
به جای مسیر پیش‌فرض
.Pa ~/.config/nvim/init.vim .
اگر مقدار
.Ar vimrc
برابر
.Cm NORC
باشد، هیچ فایل پیکربندی اولیه‌ای (به جز افزونه‌ها) بارگذاری نمی‌شود.
اگر مقدار برابر
.Cm NONE
باشد، بارگذاری افزونه‌ها نیز لغو می‌گردد.
.Ic ":help initialization"
.It Fl i Ar shada
استفاده از
.Ar shada
به جای مسیر پیش‌فرض
.Pa ~/.local/state/nvim/shada/main.shada .
اگر مقدار برابر
.Cm NONE
باشد، خواندن و نوشتن فایل ShaDa انجام نمی‌شود.
.Ic ":help shada"
.It Fl -noplugin
جلوگیری از بارگذاری افزونه‌ها.
توسط
.Cm -u NONE
نیز اعمال می‌شود.
.It Fl -clean
اجرای نئو‌ویم با تنظیمات اولیه کارخانه (تنها افزونه‌های داخلی، بدون کانفیگ کاربر و بدون shada).
.Ic ":help --clean"
.It Fl o Ns Op Ar N
باز کردن
.Ar N
پنجره افقی روی هم.
در صورت حذف
.Ar N ،
برای هر فایل یک پنجره باز می‌شود.
.It Fl O Ns Op Ar N
مشابه با
.Fl o ،
اما پنجره‌ها را به صورت عمودی در کنار هم می‌چیند.
.It Fl p Ns Op Ar N
مشابه با
.Fl o ،
اما برای برگه‌ها (Tabs).
.It Cm + Ns Op Ar linenum
برای اولین فایل، مکان‌نما را روی شماره خط
.Ar linenum
قرار می‌دهد.
در صورت عدم تعیین شماره خط، مکان‌نما روی آخرین خط قرار می‌گیرد.
.It Cm +/ Ns Op Ar pattern
برای اولین فایل، مکان‌نما را روی اولین تطابق الگوی
.Ar pattern
قرار می‌دهد.
.It Cm + Ns Ar command , Fl c Ar command
اجرای
.Ar command
پس از خواندن اولین فایل. تا ۱۰ دستور مجاز است.
.It Fl -cmd Ar command
مشابه با
.Fl c ،
اما دستور را پیش از پردازش هر فایل vimrc اجرا می‌کند.
.It Fl l Ar script Op Ar args
اجرای اسکریپت لوآ
.Ar script
همراه با آرگومان‌های اختیاری
.Op Ar args .
.It Fl S Op Ar session
اجرای فایل نشست
.Ar session
پس از خواندن اولین فایل.
.It Fl s Ar scriptin
خواندن دستورات حالت عادی از فایل
.Ar scriptin .
.It Fl w Ar scriptout
ثبت تمام کلیدهای فشرده‌شده در فایل
.Ar scriptout .
.It Fl W Ar scriptout
مشابه
.Fl w ،
اما فایل موجود را رونویسی (truncate) می‌کند.
.It Fl -startuptime Ar file
ثبت زمان‌بندی پیام‌های آغاز به کار در
.Ar file
برای ریشه‌یابی کندی اجرای اولیه.
.It Fl -api-info
چاپ متادیتای API به صورت سریال‌شده با msgpack و خروج.
.It Fl -embed
استفاده از stdin و stdout به عنوان کانال ارتباطی msgpack-rpc.
.It Fl -headless
اجرا بدون محیط کاربری تصویری (Headless).
.It Fl -listen Ar address
راه‌اندازی سرور RPC روی این سوکت TCP یا پایپ.
.It Fl h , -help
چاپ اطلاعات راهنما و خروج.
.It Fl v , -version
چاپ اطلاعات نسخه و خروج.
.El
.Sh "محیط (ENVIRONMENT)"
.Bl -tag -width Fl
.It Ev NVIM_APPNAME
نام زیرپوشه‌های استفاده‌شده در هر دایرکتوری کاربری XDG (پیش‌فرض
.Cm nvim
است).
.It Ev NVIM_LOG_FILE
مسیر فایل لاگ سطح پایین، معمولاً در
.Pa ~/.local/state/nvim/nvim.log .
.It Ev VIM
جهت تعیین مسیر فایل‌های کاربر مانند init.vim.
.It Ev VIMRUNTIME
جهت تعیین مسیر فایل‌های زمان اجرا (مستندات، هایلایت نحو و...).
.It Ev XDG_CONFIG_HOME
مسیر دایرکتوری محلی پیکربندی کاربر (پیش‌فرض
.Pa ~/.config
است).
.It Ev XDG_STATE_HOME
مسیر نگهداری داده‌های وضعیتی نئو‌ویم مانند swap، پشتیبان و فایلهای ShaDa (پیش‌فرض
.Pa ~/.local/state
است).
.It Ev XDG_DATA_HOME
مسیر ذخیره‌سازی فایل‌های زمان اجرای نئو‌ویم (پیش‌فرض
.Pa ~/.local/share
است).
.It Ev VIMINIT
دستورات Ex که باید هنگام راه‌اندازی اولیه اجرا شوند.
.It Ev SHELL
پوسته پیش‌فرضی که برای ویژگی‌هایی مانند
.Ic :terminal
و
.Ic :!
استفاده می‌شود.
.El
.Sh "فایل‌ها (FILES)"
.Bl -tag -width "~/.config/nvim/init.vim"
.It Pa ~/.config/nvim/init.lua
فایل پیکربندی کاربر نئو‌ویم با زبان Lua.
.It Pa ~/.config/nvim
دایرکتوری پیکربندی کاربر نئو‌ویم.
.It Pa $VIM/sysinit.vim
فایل پیکربندی سراسری سیستم نئو‌ویم.
.It Pa $VIM
دایرکتوری زمان اجرای سراسری نئو‌ویم.
.El
.Sh "نویسندگان (AUTHORS)"
نئو‌ویم توسط Thiago de Arruda پایه‌گذاری شد.
بخش عمده ویم توسط Bram Moolenaar نوشته شده است.
ویم بر اساس Stevie توسعه یافته که توسط Tim Thompson و Tony Andrews و G.R. (Fred) Walter طراحی شده بود.
به ":help credits" مراجعه نمایید.