نام (NAME)

xmms2 - رابط رسمی خط فرمان XMMS2

خلاصه دستور (SYNOPSIS)

xmms2 [دستور] [آرگومان‌ها]
xmms2 help [دستور]

توضیحات (DESCRIPTION)

XMMS2 بازطراحی پخش‌کننده موسیقی XMMS (https://en.wikipedia.org/wiki/XMMS) است. این برنامه از یک ساختار کلاینت-سرور بهره می‌برد که اجازه می‌دهد چندین رابط کاربری متنی و گرافیکی (حتی به‌صورت هم‌زمان!) استفاده شوند. تمامی قالب‌های صوتی متداول به کمک افزونه‌ها پشتیبانی می‌شوند. علاوه بر این، یک کتابخانه رسانه‌ای انعطاف‌پذیر برای سازماندهی موسیقی‌ها فراهم شده است.

xmms2 رابط کاربری رسمی و خط فرمانی XMMS2 است.

فراخوانی (INVOCATION)

حالت درون‌خطی (Inline mode)

اگر یک دستور به‌عنوان آرگومان به xmms2 داده شود، آن دستور تفسیر خواهد شد و پس از پایان کار، xmms2 خارج می‌شود.

حالت تعاملی (Interactive mode)

xmms2 از طریق readline یک محیط قدرتمند شبیه پوسته ارائه می‌دهد که به کاربر امکان می‌دهد دستورات را در اعلان ورودی وارد کند و از ویژگی‌های معمول و سودمندی مانند بسط نام مسیر (pathname expansion) و ویرایش خط بهره‌مند شود.

دستورات (COMMANDS)

تمامی دستورات گزینه -h/--help را می‌پذیرند که راهنمای همان دستور را نمایش می‌دهد.

شناسه pattern به تعریف یک مجموعه اشاره دارد (بخش PATTERN در ادامه را ببینید).

شناسه position الگویی برای تطبیق موقعیت‌های فهرست پخش است. در صورت عدم ذکر در دستور، پیش‌فرض انتهای فهرست پخش خواهد بود (بخش POSITION PATTERN در ادامه را ببینید).

دستورات عمومی (General Commands)

add [ -f [-N] [-P] [-A key=value]... ] [-p playlist] [-n | -a position] [-o prop[,...]] [-j] arguments...
add [-p playlist] [-n | -a position] [-o prop[,...]] [-j] pattern...

افزودن رسانه به یک لیست پخش. تلاش می‌کند حدس بزند که آیا arguments بیانگر یک pattern است یا نشان‌دهنده مسیرهای فایل است. این رفتار را می‌توان با اجبار نوع از طریق -f و -t بازنویسی کرد. اگر مسیرهای فایل شامل نویسه‌های * یا ? باشند، تلاش می‌شود آن‌ها گسترش یابند. در صورت عدم یافتن تطابق، تلاش خواهد شد نویسه‌های * و ? به عنوان بخشی از URL اضافه شوند.

-f, --file

اجبار به در نظر گرفتن arguments به عنوان مسیرهای فایل.

-P, --pls

اجبار به در نظر گرفتن arguments به عنوان فایل‌های لیست پخش. این گزینه مستلزم -f است.

-t, --pattern

اجبار به در نظر گرفتن arguments به عنوان یک الگو (pattern).

-N, --non-recursive

پوشه‌ها به صورت بازگشتی اضافه نشوند.

-p, --playlist playlist

افزودن رسانه به playlist به‌جای لیست پخش فعال.

-n, --next

افزودن رسانه پس از قطعه جاری.

-a, --at position

افزودن رسانه در موقعیت داده‌شده.

-A, --attribute key=value

افزودن رسانه با صفت key=value داده‌شده. می‌تواند چندین بار تکرار شود. فقط هنگام افزودن فایل‌های جدید به کتابخانه رسانه معتبر است.

-o, --order prop[,...]

افزودن رسانه‌ها مرتب‌شده بر اساس لیست مشخصه‌ها که با کاما جدا شده‌اند. اگر یک مشخصه دارای پیشوند - باشد، رسانه‌ها بر اساس آن مشخصه به ترتیب معکوس مرتب می‌شوند.

-j, --jump

پرش به رسانه تازه اضافه‌شده و آغاز پخش آن.

exit

خروج از رابط کاربری شبیه به خط فرمان (shell-like).

help [-a] command

نمایش راهنمای command. این معادل command -h است. اگر command یک نام مستعار (alias) باشد، تعریف نام مستعار را نمایش می‌دهد. اگر دستوری مشخص نشود، تمام دستورات موجود را فهرست می‌کند.

-a, --alias

در صورتی که command مشخص نشده باشد، نام‌های مستعار موجود را فهرست می‌کند. در غیر این صورت، اثری ندارد.

info [pattern | positions...]

نمایش مشخصه‌های تمام رسانه‌های منطبق با pattern یا در موقعیت‌های داده‌شده. بدون آرگومان، مشخصه‌های قطعه جاری را نمایش می‌دهد.

jump [-b] pattern|position

پرش به نخستین رسانه منطبق با pattern یا به موقعیت داده‌شده.

-b, --backward

پرش به عقب به نخستین رسانه منطبق با الگو.

list [-p name] [pattern | positions...]

فهرست کردن محتویات یک لیست پخش (به‌طور پیش‌فرض لیست پخش فعال). اگر pattern داده شود، محتویات بیشتر فیلتر شده و تنها رسانه‌های منطبق نمایش داده می‌شوند.

-p, --playlist

فهرست کردن playlist، به‌جای لیست پخش فعال.

move [-p playlist] [-n | -a position] pattern | positions...

انتقال موارد در داخل یک لیست پخش (به‌طور پیش‌فرض لیست پخش فعال).

-p, --playlist playlist

لیست پخش (playlist) برای اعمال عملیات روی آن.

-n, --next

انتقال قطعه‌های منطبق به بعد از قطعه جاری.

-a, --at position

انتقال قطعه‌های منطبق با یک فاصله (offset) یا به یک موقعیت (position).

next [offset]

پرش به آهنگ بعدی. اگر offset ارائه شود، مانند jump +offset عمل می‌کند.

pause

مکث در پخش.

play

آغاز پخش.

prev [offset]

پرش به آهنگ قبلی. اگر offset ارائه شود، مانند jump -offset عمل می‌کند.

remove [-p playlist] pattern | positions...

حذف رسانه‌های منطبق از یک لیست پخش (به‌طور پیش‌فرض لیست پخش فعال).

-p, --playlist playlist

حذف از playlist، به‌جای لیست پخش فعال.

current [-r seconds] [-f format]

نمایش وضعیت پخش، به‌طور مداوم یا یک‌باره.

-r, --refresh seconds

تنظیم تأخیر، بر حسب ثانیه، میان هر نوسازی فراداده‌های پخش جاری. اگر 0 باشد، فراداده فقط یک‌بار چاپ می‌شود (پیش‌فرض) و دستور فوراً خارج می‌شود. در حالت نوسازی، کنترل پایه‌ای بر روی لیست پخش فعال فراهم می‌شود.

-f, --format format

تنظیم رشته قالب استفاده‌شده برای نمایش اطلاعات وضعیت، به‌جای رشته موجود در فایل پیکربندی (بخش FORMAT STRING را در زیر ببینید).

search [-o prop1[,prop2...]] [-l prop1[,prop2...] ] pattern

جستجو و چاپ تمام رسانه‌های منطبق با pattern.

-o, --order prop1[,prop2...]

نمایش نتایج جستجو مرتب‌شده بر اساس لیست مشخصه‌های داده‌شده. اگر یک مشخصه دارای پیشوند '-' باشد، نتایج بر اساس آن مشخصه به ترتیب معکوس مرتب می‌شوند.

-l, --columns prop1[,prop2...]

لیست properties جهت استفاده به عنوان ستون‌ها.

seek time | offset

پیمایش به زمان نسبی یا مطلق در قطعه جاری.

stop

توقف پخش.

toggle

تغییر وضعیت پخش (پخش/توقف موقت).

دستورات لیست پخش (Playlist Commands)

playlist clear [playlist]

پاک کردن یک لیست پخش. به‌طور پیش‌فرض، لیست پخش فعال را پاک می‌کند.

playlist config [-t type] [-s history] [-u upcoming] [-i coll] [-j playlist] [playlist]

پیکربندی یک لیست پخش با تغییر نوع، ویژگی‌ها و موارد دیگر آن. به‌طور پیش‌فرض، لیست پخش فعال را پیکربندی می‌کند.

-t, --type type

تغییر type (نوع) لیست پخش: list، queue، pshuffle.

-s, --history size

مقدار size (اندازه) تاریخچه قطعات پخش‌شده (برای queue، pshuffle).

-u, --upcoming upcoming

تعداد قطعات پیش‌رو (upcoming) جهت نگهداری (برای pshuffle).

-i, --input collection

مجموعه (collection) ورودی برای لیست پخش (برای pshuffle). پیش‌فرض 'All Media' است.

-j, --jumplist playlist

پرش به یک playlist دیگر هنگام رسیدن به انتهای لیست پخش.

playlist create [-s] [-p playlist] name

ایجاد یک لیست پخش جدید.

-s, --switch

رفتن و سوئیچ به لیست پخش تازه ایجادشده.

-p, --playlist playlist

کپی کردن محتوای لیست پخش در لیست پخش جدید.

playlist list [-a]

فهرست کردن تمام لیست‌های پخش.

-a, --all

شامل کردن لیست‌های پخش پنهان.

playlist remove playlist

حذف لیست پخش داده‌شده.

playlist rename [-f] [-p playlist] newname

تغییر نام یک لیست پخش. به‌طور پیش‌فرض، نام لیست پخش فعال را تغییر می‌دهد.

-f, --force

تغییر نام اجباری لیست پخش و بازنویسی روی لیست پخش موجود در صورت نیاز.

-p, --playlist

تغییر نام لیست پخش داده‌شده.

playlist shuffle [playlist]

برزدن (shuffle) یک لیست پخش. به‌طور پیش‌فرض، لیست پخش فعال را برمی‌زند.

playlist sort [-p playlist] [prop] ...

مرتب‌سازی یک لیست پخش. به‌طور پیش‌فرض، لیست پخش فعال را مرتب می‌کند. برای مرتب‌سازی معکوس، پیشوند '-' را به ویژگی‌ها اضافه کنید. اگر هیچ ویژگی‌ای مشخص نشود، لیست پخش بر اساس هنرمند (artist)، آلبوم (album) و شماره قطعه (track number) مرتب می‌شود.

-p, --playlist

مرتب‌سازی لیست پخش داده‌شده.

playlist switch playlist

تغییر لیست پخش فعال.

دستورات مجموعه (Collection Commands)

collection config collection [attrname [attrvalue]]

دریافت یا تنظیم مشخصه‌های مجموعه داده‌شده. اگر نام مشخصه‌ای ارائه نشود، تمام مشخصه‌ها فهرست می‌شوند. اگر فقط نام مشخصه ارائه شود، مقدار آن مشخصه نمایش داده می‌شود. اگر هم نام مشخصه و هم مقدار آن ارائه شوند، مقدار جدید مشخصه تنظیم می‌شود.

collection create [-f] [-e] [-c collection] name [pattern]

ایجاد یک مجموعه جدید. اگر الگو ارائه شود، برای تعریف مجموعه استفاده می‌شود. در غیر این صورت، مجموعه جدید شامل کل کتابخانه رسانه خواهد بود.

-f, --force

اجبار در ایجاد مجموعه و بازنویسی روی مجموعه موجود در صورت نیاز.

-c, --collection collection

کپی کردن یک مجموعه موجود در مجموعه جدید.

-e, --empty

مقداردهی اولیه یک مجموعه خالی.

collection list

فهرست کردن تمام مجموعه‌ها.

collection show collection

نمایش توضیحات خوانا برای انسان از یک مجموعه.

collection remove collection

حذف یک مجموعه.

collection rename [-f] oldname newname

تغییر نام یک مجموعه.

-f, --force

اجبار در تغییر نام مجموعه و بازنویسی روی مجموعه موجود در صورت نیاز.

دستورات سرور (Server Commands)

server browse URL

مرور یک نشانی اینترنتی (URL) از طریق افزونه‌های xform موجود در دیمن.

server config [name [value]]

دریافت یا تنظیم مقادیر پیکربندی. اگر نام یا مقداری ارائه نشود، تمام مقادیر پیکربندی فهرست می‌شوند. اگر فقط نام ارائه شود، محتوای مقدار پیکربندی مربوطه نمایش داده می‌شود. اگر هم نام و هم مقدار ارائه شوند، محتوای جدید برای مقدار پیکربندی تنظیم می‌شود.

نام مقدار پیکربندی مشمول بسط نویسه‌های عام شل (shell wildcard expansion) است، به‌طوری که می‌توان چندین مقدار را هم‌زمان پرس‌وجو کرد (اما نه تنظیم).

server import [-N] path

وارد کردن فایل‌های جدید به کتابخانه رسانه. به‌طور پیش‌فرض، پوشه‌ها به‌صورت بازگشتی وارد می‌شوند.

-N, --non-recursive

عدم وارد کردن پوشه‌ها به‌صورت بازگشتی.

server plugins

فهرست کردن افزونه‌های بارگذاری‌شده در سرور.

server property [-i | -s | -D] [-S] mid [name [value]]

دریافت یا تنظیم ویژگی‌های یک رسانه مشخص. اگر نام یا مقداری ارائه نشود، تمام ویژگی‌ها فهرست می‌شوند. اگر فقط نام ارائه شود، مقدار آن ویژگی نمایش داده می‌شود. اگر هم نام و هم مقدار ارائه شوند، مقدار جدید برای ویژگی تنظیم می‌شود.

به‌طور پیش‌فرض، عملیات تنظیم از منبع "client/xmms2-cli" استفاده می‌کنند، در حالی که عملیات فهرست و نمایش از source-preference استفاده می‌کنند. برای نادیده گرفتن این رفتار از گزینه --source استفاده کنید.

به‌طور پیش‌فرض، از مقدار برای تعیین اینکه باید به‌صورت یک رشته یا عدد صحیح ذخیره شود استفاده می‌شود. برای نادیده گرفتن این رفتار از فلگ --int یا --string استفاده کنید.

-i, --int

اجبار به در نظر گرفتن مقدار به‌صورت عدد صحیح.

-s, --string

اجبار به در نظر گرفتن مقدار به‌صورت رشته.

-D, --delete

حذف ویژگی انتخاب‌شده.

-S, --source

منبع ویژگی.

server rehash [pattern]

محاسبه مجدد هش (rehash) رسانه‌های منطبق با الگو، یا کل کتابخانه رسانه در صورت عدم ارائه الگو.

server remove [pattern]

حذف رسانه‌های منطبق از کتابخانه رسانه.

server shutdown

خاموش کردن سرور.

server stats

نمایش آمارهای مربوط به سرور: مدت زمان بالا بودن (uptime)، نسخه، اندازه کتابخانه رسانه و غیره.

server sync

ذخیره فوری مجموعه‌ها روی دیسک. (در غیر این صورت فقط هنگام خاموش شدن یا ۱۰ ثانیه پس از آخرین تغییر در مجموعه‌ها انجام می‌شود.)

server volume [-c name] [value]

دریافت یا تنظیم بلندی صدا (در محدوده ۰-۱۰۰). اگر مقداری ارائه شود، بلندی صدا روی value تنظیم می‌شود. در غیر این صورت، بلندی صدای فعلی نمایش داده می‌شود. به‌طور پیش‌فرض، این دستور روی تمام کانال‌های صوتی اعمال می‌شود. برای نادیده گرفتن این رفتار از فلگ --channel استفاده کنید. تغییرات نسبی در بلندی صدا با قرار دادن پیشوند + یا - قبل از value امکان‌پذیر است.

-c, --channel

دریافت یا تنظیم بلندی صدا فقط برای کانال مشخص‌شده.

الگو (PATTERN)

الگوها برای جستجوی آهنگ‌ها در کتابخانه چندرسانه‌ای به کار می‌روند؛ بسته به پوسته مورد استفاده، ممکن است برخی از این الگوها نیاز به اسکیپ کردن (با '\') داشته باشند. ویژگی‌ها را می‌توان در خروجی xmms2 info مشاهده کرد.

<property>:<string>

تطبیق آهنگ‌هایی که ویژگی آن‌ها با رشته مطابقت دارد. یک ? در رشته بیانگر یک نویسه عام منفرد و یک * بیانگر چند نویسه عام است.

<property>~<string>

تطبیق فازی آهنگ‌هایی که ویژگی آن‌ها با رشته مطابقت دارد. معادل با تطبیق با <property>:*<string>*.

<property><operation><number>

عملگر می‌تواند <، <=، > یا >= باشد؛ الگو آهنگ‌هایی را تطبیق می‌دهد که ویژگی آن‌ها مقداری عددی و در مقایسه با عدد داده‌شده، کوچکتر، کوچکتر یا مساوی، بزرگتر، یا بزرگتر یا مساوی است.

+<property>

تطبیق آهنگ‌هایی که دارای این ویژگی هستند.

in:<namespace>/<collection>

تطبیق آهنگ‌ها در مجموعه داده‌شده. فضای نام می‌تواند Playlists یا Collections باشد.

NOT <pattern>

تطبیق مکمل الگو.

تطبیق آهنگ‌هایی که با هر دو الگو مطابقت دارند.

<pattern> OR <pattern>

تطبیق آهنگ‌هایی که حداقل با یکی از دو الگو مطابقت دارند.

( <pattern> )

تطبیق آهنگ‌های منطبق بر الگو، مورد استفاده برای گروه‌بندی تطبیق‌های AND و OR.

<string>

تطبیق آهنگ‌هایی که هنرمند، عنوان یا آلبوم آن‌ها با رشته مطابقت دارد.

~<string>

تطبیق فازی آهنگ‌هایی که هنرمند، عنوان یا آلبوم آن‌ها با رشته مطابقت دارد.

#<number>

تطبیق یک شناسه خاص در کتابخانه چندرسانه‌ای.

الگوی موقعیت (POSITION PATTERN)

الگوهای موقعیت به همراه دستوراتی استفاده می‌شوند که روی محتوای فهرست پخش عمل می‌کنند.

M_N

انتخاب مدخل‌های فهرست پخش در بازه‌ای از M موقعیت قبل از آهنگ فعلی تا N موقعیت پس از آن. هر دو مقدار M و N را می‌توان نادیده گرفت که در این صورت پیش‌فرض 0 خواهد بود.

-N

انتخاب آهنگ در N موقعیت قبل از آهنگ فعلی.

+N

انتخاب آهنگ در N موقعیت بعد از آهنگ فعلی.

pos0,pos1,...,posN

انتخاب یک تا چند موقعیت از فهرست پخش.

رشته قالب‌بندی (FORMAT STRING)

دستوراتی که فراداده‌ها را به صورت قالب‌بندی‌شده نمایش می‌دهند را می‌توان با کمک رشته‌های قالب‌بندی تعریف‌شده توسط کاربر مانند نمونه زیر سفارشی‌سازی کرد:

´${artist} - ${title}´

هنگام ارسال فراداده، نام هنرمند و عنوان در رشته حاصل درج خواهد شد. علاوه بر فراداده ارائه‌شده از سوی کتابخانه چندرسانه‌ای، فهرست ویژگی‌های زیر نیز در دسترس است:

position

موقعیت فعلی در فهرست پخش.

playback_status

وضعیت پخش به صورت یک رشته (Stopped، Playing، Paused، Unknown).

playtime

مدت زمان پخش‌شده از آهنگ در حال پخش.

duration

مدت زمان کل آهنگ فعلی، به صورت دقیقه:ثانیه همراه با صفر پیشین.

minutes

بخش دقیقه از مدت زمان آهنگ فعلی، همراه با صفر پیشین.

seconds

بخش ثانیه از مدت زمان آهنگ فعلی، همراه با صفر پیشین.

نام‌های مستعار (ALIASES)

فهرستی از نام‌های مستعار دستورات در زمان اجرا از بخش [alias] در فایل پیکربندی خوانده می‌شود. نحو دستورات xmms2 تا حدی شبیه به bash و سایر پوسته‌ها است. یک نام مستعار توسط فهرستی از دستورات و آرگومان‌های جداشده با نقطه-ویرگول تعریف می‌شود. گسترش پارامترها پشتیبانی می‌شود (بخش گسترش در زیر را ببینید).