.\" generated with Ronn-NG/v0.10.1
.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
.TH "PUPPET\-DOC" "8" "January 2025" "Vox Pupuli" "OpenVox manual"
.SH "نام (NAME)"
\fBpuppet\-doc\fR \- تولید مراجع Puppet برای OpenVox
.SH "خلاصه دستور (SYNOPSIS)"
یک مرجع برای تمام انواع Puppet تولید می‌کند\. تا حد زیادی برای استفادهٔ داخلی در نظر گرفته شده است\. (منسوخ‌شده)
.SH "نحوه استفاده (USAGE)"
puppet doc [\-h|\-\-help] [\-l|\-\-list] [\-r|\-\-reference \fIreference\-name\fR]
.SH "توضیحات (DESCRIPTION)"
این دستور منسوخ‌شده یک سند Markdown را در خروجی استاندارد (stdout) تولید می‌کند که تمام انواع (types) نصب‌شدهٔ Puppet یا تمامی آرگومان‌های مجاز برای برنامه‌های اجرایی puppet را توصیف می‌کند\. این دستور تا حد زیادی برای استفادهٔ داخلی در نظر گرفته شده است و برای تولید اسناد مرجعی استفاده می‌شود که می‌توانند در یک وب‌سایت منتشر شوند\.
.P
برای مستندسازی ماژول‌های Puppet (و تمام کاربردهای دیگر)، ماژول "puppet\-strings" جایگزین این دستور شده است \- برای اطلاعات بیشتر https://github\.com/puppetlabs/puppetlabs\-strings را ببینید\.
.P
این دستور (puppet\-doc) پس از آنکه خط‌لولهٔ پردازش مستندات داخلی puppetlabs به‌طور کامل بر پایهٔ puppet\-strings قرار گرفت، حذف خواهد شد\.
.SH "گزینه‌ها (OPTIONS)"
.TP
\-\-help
چاپ این پیام راهنما\.
.TP
\-\-reference
ساخت یک مرجع خاص\. دریافت فهرستی از مراجع با اجرای 'puppet doc \-\-list'\.
.SH "مثال (EXAMPLE)"
.nf
$ puppet doc \-r type > /tmp/type_reference\.markdown
.fi
.SH "نویسنده (AUTHOR)"
Luke Kanies
.SH "حق نشر (COPYRIGHT)"
Copyright (c) 2011 Puppet Inc\. Copyright (c) 2024 Vox Pupuli Licensed under the Apache 2\.0 License