.\" Manual for wmrc.
.TH "wikiman" 1 "12 May 2025" "wikiman 2.14" "wikiman manual"

.SH "نام (NAME)"
.B wikiman
\- موتور جستجوی آفلاین برای صفحات راهنما (man)، Arch Wiki، Gentoo Wiki و سایر مستندات.

.SH "خلاصه دستور (SYNOPSIS)"
.B wikiman
[-q] [-a] [-p] [-k] [-c]
.br
        [-l <comma separated languages>] [-s <comma separated sources>]
.br
        [-f <fuzzy finder>] [-H <html viewer>] [-R] <keyword>...
.br
.B wikiman
-S
.br
.B wikiman
-W <shell>
.br
.B wikiman
-v
.br
.B wikiman
-h

اگر هیچ کلیدواژه‌ای مشخص نشود، تمام صفحه‌ها نمایش داده می‌شوند.

.SH "توضیحات (DESCRIPTION)"
.P
ابزار wikiman یک موتور جستجوی آفلاین برای صفحات راهنما (man pages)، Arch Wiki، Gentoo Wiki و سایر مستندات است.

ابزار wikiman یک رابط کاربری ساده را برای مرور مستندات، بدون نیاز به دقت کامل در کلیدواژه‌ها یا اتصال به اینترنت فراهم می‌کند.
این هدف با بهره‌گیری از جستجوی تمام‌متن برای ویکی‌ها، تطبیق جزئی نام و توضیحات برای صفحات man، و پالایش فازی (fuzzy) برای نتایج جستجو محقق شده است.

.SH "گزینه‌ها (OPTIONS)"
.HP
.B -l
<comma separated languages>
.br
زبان(های) جستجو
.br
پیش‌فرض: en

.HP
.B -s
<comma separated sources>
.br
منابع مورد استفاده
.br
پیش‌فرض: (تمام منابع موجود)

.HP
.B -f
<fuzzy finder>
.br
ابزار جستجوی فازی (fuzzy finder) مورد استفاده
.br
پیش‌فرض: fzf

.HP
.B -q
.br
فعال‌سازی حالت جستجوی سریع

.HP
.B -a
.br
فعال‌سازی حالت عملگر AND

.HP
.B -p
.br
غیرفعال‌سازی پیش‌نمایش سریع نتایج

.HP
.B -k
.br
باز نگه داشتن برنامه پس از مشاهده یک نتیجه

.HP
.B -c
.br
نمایش ستون منبع

.HP
.B -H
<html viewer>
.br
نمایش‌دهنده صفحات HTML
.br
پیش‌فرض: w3m

.HP
.B -R
.br
چاپ خروجی خام

.HP
.B -S
.br
فهرست کردن منابع موجود و خروج

.HP
.B -W
<shell>
.br
چاپ کد ابزارک (widget) برای پوسته مشخص‌شده و خروج

.HP
.B -v
.br
چاپ نگارش و خروج

.HP
.B -h
.br
نمایش راهنما و خروج

.SH "پیکربندی (CONFIGURATION)"

محل پیش‌فرض فایل پیکربندی کاربر:
.I
~/.config/wikiman/wikiman.conf
(اگر متغیر XDG_CONFIG_HOME تنظیم نشده باشد).

محل فایل پیکربندی سراسری سیستم:
.I
/etc/wikiman.conf

.SS "منابع (Sources)"
sources =

.SS "یابنده فازی (Fuzzy finder)"
fuzzy_finder = fzf

.SS "حالت جستجوی سریع (Quick search mode)"
quick_search = false

.SS "حالت عملگر AND (AND operator mode)"
and_operator = false

.SS "خروجی خام (Raw output)"
raw_output = false

.SS "زبان(ها) (Language(s))"
man_lang = en

wiki_lang = en
.PP
.B
فهرست کردن تمام زبان‌های man به‌جز انگلیسی (en):
.br
find '/usr/share/man' -maxdepth 1 -type d -not -name 'man*' -printf '%P '
.PP
.B
فهرست کردن تمام زبان‌های Arch Wiki:
.br
find '/usr/share/doc/arch-wiki/html' -maxdepth 1 -type d -printf '%P '
.PP
.B
فهرست کردن تمام زبان‌های مستندات FreeBSD:
.br
find '/usr/share/doc/freebsd-docs' -maxdepth 1 -type d -printf '%P '

.SS "پیش‌نمایش TUI (TUI preview)"
tui_preview = true

.SS "باز نگه داشتن TUI (TUI keep open)"
tui_keep_open = false

.SS "نمایش ستون منبع در TUI (TUI show source column)"
tui_source_column = false

.SS "نمایش‌دهنده TUI برای صفحات HTML (TUI viewer for HTML pages)"
tui_html = w3m

.SH "منابع اضافی (ADDITIONAL SOURCES)"

پوشه پیش‌فرض منابع کاربر:
.I
~/.config/wikiman/sources
(اگر متغیر XDG_CONFIG_HOME تنظیم نشده باشد).

پوشه منابع سراسری سیستم:
.I
/usr/share/wikiman/sources

.SS "نصب یک منبع (Installing a source)"
برای نصب یک منبع اضافی با نام <name>، آن را با استفاده از Makefile مربوط به Wikiman دریافت و نصب کنید:

sudo make install source-<name>