مرجع سريع

ورقة غش صياغة صفحات CLIP لأوامر سطر الأوامر

دليل مرجعي سريع لمواصفات Command Line Interface Pages (CLIP): تخطيط الصفحات، والعناصر النائبة، ومعاملات الخيارات المتكررة.

· تاريخ النشر

CLIP (Command Line Interface Pages) هي مواصفات markdown مهيكلة لمراجع أوامر الطرفية وصفحات man المبسطة.

تخطيط بنية الصفحة

# command_name

> وصف موجز يشرح وظيفة الأمر.
> مزيد من المعلومات: https://example.com/docs

- وصف مهمة توضيحية:

`command --option {{argument}}`

صيغة العناصر النائبة (Placeholder Syntax)

العناصر النائبة الأولية (Primitive Placeholders)

- إيقاف تنفيذ الطرفية مؤقتاً لعدد محدد من الثواني:

`sleep {int seconds: 2}s`

العناصر النائبة للخيارات والوسائط المتكررة

- إنشاء أرشيف وكتابته في ملف:

`tar {option mode: --create, -c} {option: --file, -f} {/?file archive: target.tar} {/?path+ input}`
  • {int name: default}: معيار رقم صحيح ذو نوع محدد.
  • {option: --flag, -f}: خيار أو راية لسطر الأوامر.
  • {/?file name: target.tar}: مسار ملف اختياري.
  • {/?path+ input}: وسيط مسار أو أكثر قابل للتكرار.

المراجع

موضوعات ذات صلة