شرح صفوف ومحتوى الفقرة
عند فحص أي توثيق مدمج في أنظمة Linux أو macOS أو Windows، يظهر أمامك سطر مختصر يسمى Synopsis يشرح طريقة تركيب الأمر. يعتمد هذا السطر على رموز قياسية تحدد ما يجب كتابته حرفياً وما هو إلزامي أو اختياري أو متبادل أو قابل للتكرار.
القاعدة الذهبية هنا بسيطة: الأقواس والرموز الوصفية مثل [ ] و< > و| توضّح القواعد فقط، ولا تُكتب أبداً عند تنفيذ الأمر الفعلي في موجه الأوامر.
مفكك رموز صيغ الأوامر
- الكلمات الحرفية الثابتة (
date،man،Get-Help): تُكتب كما هي تماماً دون تغيير أو حذف. - القيم الإلزامية (
<PAGE>،<String>): استبدل الرمز مع أقواسه الزاوية بقيمة حقيقية مطلوبة. - العناصر الاختيارية (
[OPTION]،[-s SECTION]): يمكنك كتابتها عند الحاجة أو تجاهلها بأمان. - الخيارات المتبادلة والتكرار (
{-u | -R}و...): الخط العمودي|يعني اختيار بديل واحد فقط، أما...فتعني قابلية تكرار القيمة.
Synopsis vs Actual Commandتحويل الصيغة إلى أمر فعلي
مقارنة الصيغة الوصفية في التوثيق مع التنفيذ الفعلي الخالي من الأقواس.
نص
# Documentation Synopsis (DO NOT copy brackets literally):
date [-u | -R]
man [-s SECTION] <PAGE>...
# Valid Executed Commands:
date
date -u
man date
man -s 5 passwd
Executed Synopsis Commands Outputتنفيذ الصيغ بعد إزالة الأقواس
تنفيذ فعلي داخل الطرفية يثبت حذف الأقواس الوصفية عند كتابة الأمر.