نام (NAME)

newhelp - ایجاد پایگاه‌داده راهنمای معیارهای کارایی

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

$PCP_BINADM_DIR/newhelp [-vV?] [-D debug] [-n pmnsfile] [-o outputfile] [file ...]

توضیحات (DESCRIPTION)

برنامهٔ newhelp فایل‌های متنی راهنمای Performance Co-Pilot را که توسط Performance Metric Domain Agents (PMDAs) استفاده می‌شوند، تولید می‌کند.

به‌طور معمول newhelp روی فضای نام پیش‌فرض معیارهای کارایی (PMNS) عمل می‌کند؛ با این حال اگر گزینهٔ -n مشخص شده باشد، یک فضای نام جایگزین از فایل pmnsfile بارگذاری می‌شود.

هنگامی که تنها یک فایل ورودی وجود دارد، نام پایهٔ پایگاه‌داده جدید از نام file ورودی مشتق می‌شود، در غیر این صورت باید از پرچم -o برای نام‌گذاری صریح پایگاه‌داده استفاده شود. اگر هیچ فایل ورودی ارائه نشود، newhelp از جریان ورودی استاندارد می‌خواند که در این حالت پرچم -o باید مشخص گردد.

اگر نام فایل خروجی برابر با foo تعیین شود، newhelp فایل‌های foo.dir و foo.pag را ایجاد خواهد کرد.

پرچم -V باعث چاپ پیام‌های پرجزئیات در هنگام تجزیه ورودی توسط newhelp می‌شود.

خط نخست هر مدخل در یک فایل منبع راهنما، شامل یک نویسهٔ «@» در آغاز خط است که پس از آن یک فاصله و سپس نام معیار کارایی و یک خط شرح درباره معیار می‌آید. خط‌های بعدی (تا خط بعدی که با «@» آغاز شود یا انتهای فایل) می‌توانند شامل شرح تفصیلی راهنما باشند؛ برای مثال:

#
# This is an example of newhelp's input syntax
#
@ kernel.all.cpu.idle CPU idle time
A cumulative count of the number of milliseconds
of CPU idle time, summed over all processors.

شناسه‌های عددی سه‌بخشی معیارها (PMIDها) را می‌توان به جای نام معیارها استفاده کرد، برای نمونه 60.0.23 به جای kernel.all.cpu.idle در مثال بالا. به غیر از معیارهای پویا (جایی که وجود یک معیار برای یک PMDA شناخته شده است، اما در PMNS قابل مشاهده نیست و در نتیجه نامی ندارد که برای newhelp شناخته‌شده باشد)، استفاده از این شکل نحوی توصیه نمی‌شود.

خطوطی که با «#» آغاز می‌شوند، و همچنین خط‌های خالی درون فایل پیش از نخستین «@»، نادیده گرفته می‌شوند. متن تفصیلی راهنما اختیاری است.

به عنوان یک حالت خاص، نام «معیاری» به شکل NNN.MM (برای مقادیر عددی NNN و MM) به عنوان شناسهٔ دامنهٔ نمونه (instance domain) تفسیر می‌شود و متن، دامنهٔ نمونه را توصیف می‌کند.

گزینه‌ها (OPTIONS)

گزینه‌های موجود خط فرمان عبارتند از:

-o output, --output=outout: تعیین نام پایه برای فایل‌های output.
-n pmnsfile, --namespace=pmnsfile: بارگذاری یک فضای نام جایگزین برای معیارهای کارایی (PMNS(5)) از فایل pmnsfile.
-v version, --version=version: تنظیم نسخه خروجی. این گزینه منسوخ شده است و تنها مقدار پشتیبانی‌شده 2 است.
-V, --verbose: چاپ خروجی پرجزئیات.
-?, --help: نمایش پیام راهنمای استفاده و خروج.

فایل‌ها (FILES)

$PCP_VAR_DIR/pmns/*: فایل‌های مشخصات پیش‌فرض PMNS

محیط پی‌سی‌پی (PCP ENVIRONMENT)

متغیرهای محیطی با پیشوند PCP_ برای تعیین پارامترهای نام فایل و دایرکتوری مورد استفاده توسط PCP به کار می‌روند. در هر نصب، فایل /etc/pcp.conf حاوی مقادیر محلی برای این متغیرها است. متغیر $PCP_CONF می‌تواند برای تعیین یک فایل پیکربندی جایگزین استفاده شود، همان‌طور که در pcp.conf(5) شرح داده شده است.

برای متغیرهای محیطی مؤثر بر ابزارهای PCP، به pmGetOptions(3) مراجعه کنید.

گزینه‌های اشکال‌زدایی (DEBUGGING OPTIONS)

گزینهٔ -D یا --debug خروجی عیب‌یابی‌های تکمیلی را در stderr فعال می‌کند تا به تفکیک و دسته‌بندی مشکلات کمک کند، اگرچه این اطلاعات گاهی مبهم بوده و در درجه اول برای راهنمایی توسعه‌دهندگان طراحی شده است تا کاربران نهایی. debug یک فهرست جداشده با کاما از گزینه‌های اشکال‌زدایی است؛ از pmdbg(1) همراه با گزینهٔ -l برای به‌دست آوردن فهرستی از گزینه‌های اشکال‌زدایی موجود و معانی آن‌ها استفاده کنید.

همچنین ببینید (SEE ALSO)

chkhelp(1), PMAPI(3), pmLookupInDomText(3), pmLookupText(3), pcp.conf(5), pcp.env(5) و PMNS(5).