نام (NAME)

puppet-doc - تولید مراجع Puppet برای OpenVox

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

یک مرجع برای تمام انواع Puppet تولید می‌کند. تا حد زیادی برای استفادهٔ داخلی در نظر گرفته شده است. (منسوخ‌شده)

نحوه استفاده (USAGE)

puppet doc [-h|--help] [-l|--list] [-r|--reference reference-name]

توضیحات (DESCRIPTION)

این دستور منسوخ‌شده یک سند Markdown را در خروجی استاندارد (stdout) تولید می‌کند که تمام انواع (types) نصب‌شدهٔ Puppet یا تمامی آرگومان‌های مجاز برای برنامه‌های اجرایی puppet را توصیف می‌کند. این دستور تا حد زیادی برای استفادهٔ داخلی در نظر گرفته شده است و برای تولید اسناد مرجعی استفاده می‌شود که می‌توانند در یک وب‌سایت منتشر شوند.

برای مستندسازی ماژول‌های Puppet (و تمام کاربردهای دیگر)، ماژول "puppet-strings" جایگزین این دستور شده است - برای اطلاعات بیشتر https://github.com/puppetlabs/puppetlabs-strings را ببینید.

این دستور (puppet-doc) پس از آنکه خط‌لولهٔ پردازش مستندات داخلی puppetlabs به‌طور کامل بر پایهٔ puppet-strings قرار گرفت، حذف خواهد شد.

گزینه‌ها (OPTIONS)

--help: چاپ این پیام راهنما.
--reference: ساخت یک مرجع خاص. دریافت فهرستی از مراجع با اجرای 'puppet doc --list'.

مثال (EXAMPLE)

$ puppet doc -r type > /tmp/type_reference.markdown

نویسنده (AUTHOR)

Luke Kanies