Γρήγορη αναφορά

Σημειώσεις σύνταξης σελίδων CLIP

Γρήγορος οδηγός αναφοράς για την προδιαγραφή Command Line Interface Pages (CLIP): διατάξεις σελίδων, σύμβολα κράτησης θέσης και επαναλαμβανόμενες επιλογές.

· Δημοσιεύτηκε

Το CLIP (Command Line Interface Pages) είναι μια δομημένη προδιαγραφή markdown για αναφορές εντολών τερματικού και απλοποιημένες σελίδες man.

Διάταξη δομής σελίδας

# command_name

> Σύντομη περιγραφή της λειτουργίας της εντολής.
> Περισσότερες πληροφορίες: https://example.com/docs

- Περιγραφή παραδείγματος εργασίας:

`command --option {{argument}}`

Σύνταξη δεσμευτικών θέσης (Placeholder Syntax)

Πρωτόγονα σύμβολα κράτησης θέσης

- Παύση εκτέλεσης τερματικού για συγκεκριμένο αριθμό δευτερολέπτων:

`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}: Ένα ή περισσότερα επαναλαμβανόμενα ορίσματα διαδρομής.

Αναφορές

Σχετικά θέματα